IngestExternalImplTest.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/
package fr.gouv.vitam.ingest.external.core;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.mockito.Matchers.anyObject;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;

import fr.gouv.vitam.common.guid.GUID;
import fr.gouv.vitam.common.guid.GUIDFactory;
import fr.gouv.vitam.common.parameter.ParameterHelper;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.powermock.api.mockito.PowerMockito;
import org.powermock.core.classloader.annotations.PowerMockIgnore;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner;

import fr.gouv.vitam.common.PropertiesUtils;
import fr.gouv.vitam.common.format.identification.FormatIdentifier;
import fr.gouv.vitam.common.format.identification.FormatIdentifierFactory;
import fr.gouv.vitam.common.format.identification.exception.FileFormatNotFoundException;
import fr.gouv.vitam.common.format.identification.exception.FormatIdentifierBadRequestException;
import fr.gouv.vitam.common.format.identification.exception.FormatIdentifierFactoryException;
import fr.gouv.vitam.common.format.identification.exception.FormatIdentifierNotFoundException;
import fr.gouv.vitam.common.format.identification.exception.FormatIdentifierTechnicalException;
import fr.gouv.vitam.common.format.identification.model.FormatIdentifierResponse;
import fr.gouv.vitam.common.format.identification.siegfried.FormatIdentifierSiegfried;
import fr.gouv.vitam.common.server.application.junit.AsyncResponseJunitTest;
import fr.gouv.vitam.common.thread.RunWithCustomExecutor;
import fr.gouv.vitam.common.thread.RunWithCustomExecutorRule;
import fr.gouv.vitam.common.thread.VitamThreadPoolExecutor;
import fr.gouv.vitam.common.thread.VitamThreadUtils;
import fr.gouv.vitam.ingest.external.common.config.IngestExternalConfiguration;


@RunWith(PowerMockRunner.class)
@PowerMockIgnore("javax.net.ssl.*")
@PrepareForTest({FormatIdentifierFactory.class})
public class IngestExternalImplTest {
    private static final String PATH = "/tmp";
    private static final String SCRIPT_SCAN_CLAMAV = "scan-clamav.sh";
    private static final String CONTEXT_ID = "DEFAULT_WORKFLOW";
    private static final String EXECUTION_MODE = "continu";
    IngestExternalImpl ingestExternalImpl;
    private InputStream stream;
    private static final Integer TENANT_ID = 0;

    @Rule
    public RunWithCustomExecutorRule runInThread =
        new RunWithCustomExecutorRule(VitamThreadPoolExecutor.getDefaultExecutor());


    private static final long timeoutScanDelay = 60000;

    @Before
    public void setUp() {
        final IngestExternalConfiguration config = new IngestExternalConfiguration();
        config.setPath(PATH);
        config.setAntiVirusScriptName(SCRIPT_SCAN_CLAMAV);
        config.setTimeoutScanDelay(timeoutScanDelay);
        ingestExternalImpl = new IngestExternalImpl(config);
        PowerMockito.mockStatic(FormatIdentifierFactory.class);
    }

    @RunWithCustomExecutor
    @Test
    public void getFormatIdentifierFactoryThenThrowFormatIdentifierNotFoundException() throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierFactory identifierFactory = PowerMockito.mock(FormatIdentifierFactory.class);
        when(FormatIdentifierFactory.getInstance()).thenReturn(identifierFactory);
        when(identifierFactory.getFormatIdentifierFor(anyObject()))
            .thenThrow(new FormatIdentifierNotFoundException(""));
        stream = PropertiesUtils.getResourceAsStream("no-virus.txt");
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());
        final AsyncResponseJunitTest responseAsync = new AsyncResponseJunitTest();
        PreUploadResume model =
            ingestExternalImpl.preUploadAndResume(stream, CONTEXT_ID, EXECUTION_MODE, guid, responseAsync);
        assertEquals(Status.BAD_REQUEST.getStatusCode(), ingestExternalImpl.upload(model, guid).getStatus());
    }

    @RunWithCustomExecutor
    @Test
    public void getFormatIdentifierFactoryError() throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierFactory identifierFactory = PowerMockito.mock(FormatIdentifierFactory.class);
        when(FormatIdentifierFactory.getInstance()).thenReturn(identifierFactory);
        when(identifierFactory.getFormatIdentifierFor(anyObject())).thenThrow(new FormatIdentifierFactoryException(""));
        stream = PropertiesUtils.getResourceAsStream("no-virus.txt");
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());
        final AsyncResponseJunitTest responseAsync = new AsyncResponseJunitTest();
        PreUploadResume model =
            ingestExternalImpl.preUploadAndResume(stream, CONTEXT_ID, EXECUTION_MODE, guid, responseAsync);
        assertEquals(Status.BAD_REQUEST.getStatusCode(), ingestExternalImpl.upload(model, guid).getStatus());

    }

    @RunWithCustomExecutor
    @Test
    public void getFormatIdentifierFactoryThenThrowFormatIdentifierTechnicalException() throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierFactory identifierFactory = PowerMockito.mock(FormatIdentifierFactory.class);
        when(FormatIdentifierFactory.getInstance()).thenReturn(identifierFactory);
        when(identifierFactory.getFormatIdentifierFor(anyObject()))
            .thenThrow(new FormatIdentifierTechnicalException(""));
        stream = PropertiesUtils.getResourceAsStream("no-virus.txt");
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());
        final AsyncResponseJunitTest responseAsync = new AsyncResponseJunitTest();
        PreUploadResume model =
            ingestExternalImpl.preUploadAndResume(stream, CONTEXT_ID, EXECUTION_MODE, guid, responseAsync);

        assertEquals(Status.BAD_REQUEST.getStatusCode(), ingestExternalImpl.upload(model, guid).getStatus());
    }

    @RunWithCustomExecutor
    @Test
    public void getFormatIdentifierFactoryThenThrowFileFormatNotFoundException() throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierFactory identifierFactory = PowerMockito.mock(FormatIdentifierFactory.class);
        when(FormatIdentifierFactory.getInstance()).thenReturn(identifierFactory);

        final FormatIdentifier formatIdentifierMock = PowerMockito.mock(FormatIdentifier.class);
        when(identifierFactory.getFormatIdentifierFor(anyObject())).thenReturn(formatIdentifierMock);
        when(formatIdentifierMock.analysePath(anyObject())).thenThrow(new FileFormatNotFoundException(""));
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());

        stream = PropertiesUtils.getResourceAsStream("no-virus.txt");
        final AsyncResponseJunitTest responseAsync = new AsyncResponseJunitTest();
        PreUploadResume model =
            ingestExternalImpl.preUploadAndResume(stream, CONTEXT_ID, EXECUTION_MODE, guid, responseAsync);

        assertEquals(Status.BAD_REQUEST.getStatusCode(), ingestExternalImpl.upload(model, guid).getStatus());
    }

    @RunWithCustomExecutor
    @Test
    public void getFormatIdentifierFactoryThenThrowFormatIdentifierBadRequestException() throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierFactory identifierFactory = PowerMockito.mock(FormatIdentifierFactory.class);
        when(FormatIdentifierFactory.getInstance()).thenReturn(identifierFactory);

        final FormatIdentifier formatIdentifierMock = PowerMockito.mock(FormatIdentifier.class);
        when(identifierFactory.getFormatIdentifierFor(anyObject())).thenReturn(formatIdentifierMock);
        when(formatIdentifierMock.analysePath(anyObject())).thenThrow(new FormatIdentifierBadRequestException(""));

        stream = PropertiesUtils.getResourceAsStream("no-virus.txt");
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());
        final AsyncResponseJunitTest responseAsync = new AsyncResponseJunitTest();
        PreUploadResume model =
            ingestExternalImpl.preUploadAndResume(stream, CONTEXT_ID, EXECUTION_MODE, guid, responseAsync);

        assertEquals(Status.BAD_REQUEST.getStatusCode(), ingestExternalImpl.upload(model, guid).getStatus());
    }


    @RunWithCustomExecutor
    @Test
    public void formatNotSupportedInInternalReferential() throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierSiegfried siegfried =
            getMockedFormatIdentifierSiegfried();
        when(siegfried.analysePath(anyObject())).thenReturn(getNotSupprtedFormatIdentifierResponseList());
        stream = PropertiesUtils.getResourceAsStream("no-virus.txt");
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());

        final AsyncResponseJunitTest responseAsync = new AsyncResponseJunitTest();
        PreUploadResume model =
            ingestExternalImpl.preUploadAndResume(stream, CONTEXT_ID, EXECUTION_MODE, guid, responseAsync);

        assertEquals(Status.BAD_REQUEST.getStatusCode(), ingestExternalImpl.upload(model, guid).getStatus());
    }


    @RunWithCustomExecutor
    @Test
    public void formatSupportedInInternalReferential() throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierSiegfried siegfried =
            getMockedFormatIdentifierSiegfried();
        when(siegfried.analysePath(anyObject())).thenReturn(getFormatIdentifierZipResponse());
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());

        stream = PropertiesUtils.getResourceAsStream("no-virus.txt");
        //        ingestExternalImpl.upload(stream, CONTEXT_ID, EXECUTION_MODE, guid);
    }

    @RunWithCustomExecutor
    @Test
    public void givenFixedVirusFile()
        throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierSiegfried siegfried =
            getMockedFormatIdentifierSiegfried();
        when(siegfried.analysePath(anyObject())).thenReturn(getFormatIdentifierTarResponse());
        stream = PropertiesUtils.getResourceAsStream("fixed-virus.txt");
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());

        final AsyncResponseJunitTest responseAsync = new AsyncResponseJunitTest();
        PreUploadResume model =
            ingestExternalImpl.preUploadAndResume(stream, CONTEXT_ID, EXECUTION_MODE, guid, responseAsync);

        assertEquals(Status.BAD_REQUEST.getStatusCode(), ingestExternalImpl.upload(model, guid).getStatus());
    }

    @RunWithCustomExecutor
    @Test
    public void givenUnFixedVirusFileAndSupportedMediaType()
        throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierSiegfried siegfried =
            getMockedFormatIdentifierSiegfried();
        when(siegfried.analysePath(anyObject())).thenReturn(getFormatIdentifierTarResponse());
        stream = PropertiesUtils.getResourceAsStream("unfixed-virus.txt");
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());
        final AsyncResponseJunitTest responseAsync = new AsyncResponseJunitTest();
        PreUploadResume model =
            ingestExternalImpl.preUploadAndResume(stream, CONTEXT_ID, EXECUTION_MODE, guid, responseAsync);

        assertEquals(Status.BAD_REQUEST.getStatusCode(), ingestExternalImpl.upload(model, guid).getStatus());
    }

    private List<FormatIdentifierResponse> getFormatIdentifierZipResponse() {
        final List<FormatIdentifierResponse> list = new ArrayList<>();
        list.add(new FormatIdentifierResponse("ZIP Format", "application/zip",
            "x-fmt/263", "pronom"));
        return list;
    }

    @RunWithCustomExecutor
    @Test
    public void givenNoVirusFile() throws Exception {
        VitamThreadUtils.getVitamSession().setTenantId(TENANT_ID);
        final FormatIdentifierSiegfried siegfried =
            getMockedFormatIdentifierSiegfried();
        when(siegfried.analysePath(anyObject())).thenReturn(getFormatIdentifierZipResponse());
        stream = PropertiesUtils.getResourceAsStream("no-virus.txt");
        final AsyncResponseJunitTest responseAsync = new AsyncResponseJunitTest();
        final GUID guid = GUIDFactory.newEventGUID(ParameterHelper.getTenantParameter());
        PreUploadResume model =
            ingestExternalImpl.preUploadAndResume(stream, CONTEXT_ID, EXECUTION_MODE, guid, responseAsync);

               final Response xmlResponse =
                   ingestExternalImpl.upload(model, guid);
                assertNotNull(xmlResponse);
        //        assertEquals(200, xmlResponse.getStatus());
    }

    private List<FormatIdentifierResponse> getFormatIdentifierTarResponse() {
        final List<FormatIdentifierResponse> list = new ArrayList<>();
        list.add(new FormatIdentifierResponse("TAR Format", "application/x-tar",
            "x-fmt/263", "pronom"));
        return list;
    }


    private List<FormatIdentifierResponse> getNotSupprtedFormatIdentifierResponseList() {
        final List<FormatIdentifierResponse> list = new ArrayList<>();
        list.add(new FormatIdentifierResponse("xsd Format", "application/xsd",
            "x-fmt/263", "pronom"));
        return list;
    }


    private FormatIdentifierSiegfried getMockedFormatIdentifierSiegfried()
        throws FormatIdentifierNotFoundException, FormatIdentifierFactoryException, FormatIdentifierTechnicalException {
        final FormatIdentifierSiegfried siegfried = mock(FormatIdentifierSiegfried.class);
        final FormatIdentifierFactory identifierFactory = PowerMockito.mock(FormatIdentifierFactory.class);
        when(FormatIdentifierFactory.getInstance()).thenReturn(identifierFactory);
        when(identifierFactory.getFormatIdentifierFor(anyObject())).thenReturn(siegfried);
        return siegfried;
    }
}