path: root/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/test/java/org/openecomp/sdcrests/vsp/rest/services/OrchestrationTemplateCandidateImplTest.java

/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.sdcrests.vsp.rest.services;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.vspUploadAlreadyInProgress;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Objects;
import java.util.Optional;
import java.util.UUID;
import javax.activation.DataHandler;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.tuple.Pair;
import org.apache.cxf.jaxrs.ext.multipart.Attachment;
import org.apache.cxf.jaxrs.ext.multipart.ContentDisposition;
import org.jetbrains.annotations.NotNull;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentMatchers;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;
import org.openecomp.core.utilities.orchestration.OnboardingTypesEnum;
import org.openecomp.sdc.activitylog.ActivityLogManager;
import org.openecomp.sdc.be.csar.storage.ArtifactStorageManager;
import org.openecomp.sdc.be.csar.storage.MinIoArtifactInfo;
import org.openecomp.sdc.be.csar.storage.MinIoStorageArtifactStorageConfig;
import org.openecomp.sdc.be.csar.storage.MinIoStorageArtifactStorageConfig.Credentials;
import org.openecomp.sdc.be.csar.storage.MinIoStorageArtifactStorageConfig.EndPoint;
import org.openecomp.sdc.be.csar.storage.PackageSizeReducer;
import org.openecomp.sdc.be.csar.storage.StorageFactory;
import org.openecomp.sdc.common.errors.CoreException;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
import org.openecomp.sdc.vendorsoftwareproduct.OrchestrationTemplateCandidateManager;
import org.openecomp.sdc.vendorsoftwareproduct.VendorSoftwareProductManager;
import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspUploadStatus;
import org.openecomp.sdc.vendorsoftwareproduct.types.OrchestrationTemplateActionResponse;
import org.openecomp.sdc.vendorsoftwareproduct.types.UploadFileResponse;
import org.openecomp.sdc.vendorsoftwareproduct.types.UploadFileStatus;
import org.openecomp.sdc.vendorsoftwareproduct.types.ValidationResponse;
import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.FilesDataStructure;
import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.Module;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.FileDataStructureDto;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.OrchestrationTemplateActionResponseDto;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.UploadFileResponseDto;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.VspUploadStatusDto;

class OrchestrationTemplateCandidateImplTest {

    private final Logger logger = LoggerFactory.getLogger(OrchestrationTemplateCandidateImplTest.class);
    private final String candidateId = UUID.randomUUID().toString();
    private final String softwareProductId = UUID.randomUUID().toString();
    private final String versionId = UUID.randomUUID().toString();
    private final String user = "cs0008";
    @Mock
    private OrchestrationTemplateCandidateManager candidateManager;
    @Mock
    private VendorSoftwareProductManager vendorSoftwareProductManager;
    @Mock
    private ActivityLogManager activityLogManager;
    @Mock
    private ArtifactStorageManager artifactStorageManager;
    @Mock
    private PackageSizeReducer packageSizeReducer;
    @Mock
    private OrchestrationTemplateCandidateUploadManager orchestrationTemplateCandidateUploadManager;
    @Mock
    private StorageFactory storageFactory;
    @Mock
    private Attachment fileToUpload;
    @InjectMocks
    private OrchestrationTemplateCandidateImpl orchestrationTemplateCandidate;

    @BeforeEach
    public void setUp() {
        try {
            MockitoAnnotations.openMocks(this);
            UploadFileResponse uploadFileResponse = new UploadFileResponse();
            uploadFileResponse.setOnboardingType(OnboardingTypesEnum.ZIP);
            uploadFileResponse.setNetworkPackageName("test");
            when(candidateManager.upload(any(), any())).thenReturn(uploadFileResponse);

            // get using the candidate manager.
            Optional<Pair<String, byte[]>> zipFile = Optional.of(Pair.of("Hello", "World".getBytes()));

            when(candidateManager.get(
                ArgumentMatchers.eq(candidateId),
                ArgumentMatchers.any())).thenReturn(zipFile);

            when(vendorSoftwareProductManager.get(
                ArgumentMatchers.eq(softwareProductId),
                ArgumentMatchers.any())).thenReturn(zipFile);

            OrchestrationTemplateActionResponse processResponse = new OrchestrationTemplateActionResponse();
            processResponse.setStatus(UploadFileStatus.Success);
            when(candidateManager.process(
                ArgumentMatchers.eq(candidateId),
                ArgumentMatchers.any())).thenReturn(processResponse);

            ValidationResponse vr = new ValidationResponse();
            when(candidateManager.updateFilesDataStructure(
                ArgumentMatchers.eq(candidateId),
                ArgumentMatchers.any(),
                ArgumentMatchers.any())).thenReturn(vr);

            FilesDataStructure fds = new FilesDataStructure();
            fds.setArtifacts(Arrays.asList("a", "b"));
            fds.setNested(Arrays.asList("foo", "bar"));
            fds.setUnassigned(Arrays.asList("c", "d"));
            fds.setModules(Arrays.asList(new Module(), new Module()));

            when(candidateManager.getFilesDataStructure(
                ArgumentMatchers.eq(candidateId),
                ArgumentMatchers.any())).thenReturn(Optional.of(fds));

        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
    }

    @Test
    void uploadSignedTest() throws IOException {
        final String vspId = "vspId";
        final String versionId = "versionId";
        when(orchestrationTemplateCandidateUploadManager.findLatestStatus(vspId, versionId, user)).thenReturn(Optional.empty());
        final UUID lockId = UUID.randomUUID();
        when(orchestrationTemplateCandidateUploadManager.putUploadInProgress(vspId, versionId, user))
            .thenReturn(createVspUploadStatus(lockId, VspUploadStatus.UPLOADING));
        when(orchestrationTemplateCandidateUploadManager.putUploadInValidation(vspId, versionId, user))
            .thenReturn(createVspUploadStatus(lockId, VspUploadStatus.VALIDATING));
        when(orchestrationTemplateCandidateUploadManager.putUploadInProcessing(vspId, versionId, user))
            .thenReturn(createVspUploadStatus(lockId, VspUploadStatus.PROCESSING));
        Response response = orchestrationTemplateCandidate
            .upload(vspId, versionId, mockAttachment("filename.zip", this.getClass().getResource("/files/sample-signed.zip")), user);
        assertEquals(Status.OK.getStatusCode(), response.getStatus());
        assertTrue(((UploadFileResponseDto) response.getEntity()).getErrors().isEmpty());
    }

    @Test
    void uploadNotSignedTest() throws IOException {
        final String vspId = "vspId";
        final String versionId = "versionId";
        when(orchestrationTemplateCandidateUploadManager.findLatestStatus(vspId, versionId, user)).thenReturn(Optional.empty());
        final UUID lockId = UUID.randomUUID();
        when(orchestrationTemplateCandidateUploadManager.putUploadInProgress(vspId, versionId, user))
            .thenReturn(createVspUploadStatus(lockId, VspUploadStatus.UPLOADING));
        when(orchestrationTemplateCandidateUploadManager.putUploadInValidation(vspId, versionId, user))
            .thenReturn(createVspUploadStatus(lockId, VspUploadStatus.VALIDATING));
        when(orchestrationTemplateCandidateUploadManager.putUploadInProcessing(vspId, versionId, user))
            .thenReturn(createVspUploadStatus(lockId, VspUploadStatus.PROCESSING));
        Response response = orchestrationTemplateCandidate.upload(vspId, versionId,
            mockAttachment("filename.csar", this.getClass().getResource("/files/sample-not-signed.csar")), user);
        assertEquals(Status.OK.getStatusCode(), response.getStatus());
        assertTrue(((UploadFileResponseDto) response.getEntity()).getErrors().isEmpty());
    }

    @NotNull
    private VspUploadStatusDto createVspUploadStatus(final UUID lockId, final VspUploadStatus uploadStatus) {
        final VspUploadStatusDto vspUploadStatusProcessing = new VspUploadStatusDto();
        vspUploadStatusProcessing.setLockId(lockId);
        vspUploadStatusProcessing.setStatus(uploadStatus);
        return vspUploadStatusProcessing;
    }

    @Test
    void uploadNotSignedArtifactStorageManagerIsEnabledTest() throws IOException {
        when(storageFactory.createArtifactStorageManager()).thenReturn(artifactStorageManager);
        when(artifactStorageManager.isEnabled()).thenReturn(true);
        when(artifactStorageManager.getStorageConfiguration()).thenReturn(new MinIoStorageArtifactStorageConfig
            (true, new EndPoint("host", 9000, false), new Credentials("accessKey", "secretKey"), "tempPath", 10_000_000));

        final Path path = Path.of("src/test/resources/files/sample-not-signed.csar");
        final String vspId = "vspId";
        final String versionId = "versionId";
        when(artifactStorageManager.upload(eq(vspId), eq(versionId), any())).thenReturn(new MinIoArtifactInfo("vspId", "name"));
        final byte[] bytes = Files.readAllBytes(path);
        when(packageSizeReducer.reduce(any())).thenReturn(bytes);

        final VspUploadStatusDto vspUploadStatusDto = new VspUploadStatusDto();
        vspUploadStatusDto.setStatus(VspUploadStatus.UPLOADING);
        when(orchestrationTemplateCandidateUploadManager.findLatestStatus(vspId, versionId, user)).thenReturn(Optional.of(vspUploadStatusDto));
        when(orchestrationTemplateCandidateUploadManager.putUploadInValidation(vspId, versionId, user)).thenReturn(new VspUploadStatusDto());
        when(orchestrationTemplateCandidateUploadManager.putUploadInProcessing(vspId, versionId, user)).thenReturn(new VspUploadStatusDto());

        Response response = orchestrationTemplateCandidate.upload(vspId, versionId,
            mockAttachment("filename.csar", this.getClass().getResource("/files/sample-not-signed.csar")), user);
        assertEquals(Status.OK.getStatusCode(), response.getStatus());
        assertTrue(((UploadFileResponseDto) response.getEntity()).getErrors().isEmpty());
    }

    private Attachment mockAttachment(final String fileName, final URL fileToUpload) throws IOException {
        final Attachment attachment = Mockito.mock(Attachment.class);
        final InputStream inputStream = Mockito.mock(InputStream.class);
        when(attachment.getContentDisposition()).thenReturn(new ContentDisposition("test"));
        final DataHandler dataHandler = Mockito.mock(DataHandler.class);
        when(dataHandler.getName()).thenReturn(fileName);
        when(attachment.getDataHandler()).thenReturn(dataHandler);
        when(dataHandler.getInputStream()).thenReturn(inputStream);
        when(inputStream.transferTo(any(OutputStream.class))).thenReturn(0L);
        byte[] bytes = "upload package Test".getBytes();
        if (Objects.nonNull(fileToUpload)) {
            try {
                bytes = IOUtils.toByteArray(fileToUpload);
            } catch (final IOException e) {
                logger.error("unexpected exception", e);
                fail("Not able to convert file to byte array");
            }
        }
        when(attachment.getObject(ArgumentMatchers.any())).thenReturn(bytes);
        return attachment;
    }

    @Test
    void uploadSignNotValidTest() throws IOException {
        //given
        final VspUploadStatusDto vspUploadStatusDto = new VspUploadStatusDto();
        vspUploadStatusDto.setStatus(VspUploadStatus.UPLOADING);
        when(orchestrationTemplateCandidateUploadManager.findLatestStatus(candidateId, versionId, user))
            .thenReturn(Optional.of(vspUploadStatusDto));
        when(orchestrationTemplateCandidateUploadManager.putUploadInValidation(candidateId, versionId, user)).thenReturn(new VspUploadStatusDto());
        //when
        Response response = orchestrationTemplateCandidate
            .upload(candidateId, versionId, mockAttachment("filename.zip", null), user);
        //then
        assertEquals(Status.NOT_ACCEPTABLE.getStatusCode(), response.getStatus());
        assertFalse(((UploadFileResponseDto) response.getEntity()).getErrors().isEmpty());
    }

    @Test
    void testCandidateGet() throws IOException {
        Response rsp = orchestrationTemplateCandidate.get(candidateId, versionId, user);
        assertEquals(Response.Status.OK.getStatusCode(), rsp.getStatus(), "Response status equals");
        assertNotEquals(rsp.getHeaderString("Content-Disposition").indexOf("Candidate"), -1);
        byte[] content = (byte[]) rsp.getEntity();
        assertEquals("World", new String(content));
    }

    @Test
    void testVendorSoftwareProductGet() throws IOException {
        Response rsp = orchestrationTemplateCandidate.get(softwareProductId, versionId, user);
        assertEquals(Response.Status.OK.getStatusCode(), rsp.getStatus(), "Response status equals");
        assertNotEquals(rsp.getHeaderString("Content-Disposition").indexOf("Processed"), -1);
        byte[] content = (byte[]) rsp.getEntity();
        assertEquals("World", new String(content));
    }

    @Test
    void testMissingGet() throws IOException {
        Response rsp = orchestrationTemplateCandidate.get(UUID.randomUUID().toString(), versionId, user);
        assertEquals(Response.Status.NOT_FOUND.getStatusCode(), rsp.getStatus(), "Response status equals");
    }

    @Test
    void testAbort() {
        try {
            Response rsp = orchestrationTemplateCandidate.abort(candidateId, versionId);
            assertEquals(Response.Status.OK.getStatusCode(), rsp.getStatus(), "Response status equals");
            assertNull(rsp.getEntity());
        } catch (Exception ex) {
            logger.error("unexpected exception", ex);
            fail("abort should not throw an exception");
        }
    }

    @Test
    void testProcess() {
        try {
            Response rsp = orchestrationTemplateCandidate.process(candidateId, versionId, user);
            assertEquals(Response.Status.OK.getStatusCode(), rsp.getStatus(), "Response status equals");
            assertNotNull(rsp.getEntity());
            OrchestrationTemplateActionResponseDto dto = (OrchestrationTemplateActionResponseDto) rsp.getEntity();
            assertEquals(UploadFileStatus.Success, dto.getStatus(), "status check");
        } catch (Exception ex) {
            logger.error("unexpected exception", ex);
            fail("abort should not throw an exception");
        }
    }

    @Test
    void testFilesDataStructureUpload() {
        try {
            FileDataStructureDto dto = new FileDataStructureDto();
            dto.setArtifacts(Arrays.asList("a", "b", "c"));
            Response rsp = orchestrationTemplateCandidate.updateFilesDataStructure(candidateId, versionId, dto, user);
            assertEquals(Response.Status.OK.getStatusCode(), rsp.getStatus(), "Response status equals");
        } catch (Exception ex) {
            logger.error("unexpected exception", ex);
            fail("abort should not throw an exception");
        }
    }

    @Test
    void testFilesDataStructureGet() {
        try {
            FileDataStructureDto dto = new FileDataStructureDto();
            dto.setArtifacts(Arrays.asList("a", "b", "c"));
            Response rsp = orchestrationTemplateCandidate.getFilesDataStructure(candidateId, versionId, user);
            assertEquals(Response.Status.OK.getStatusCode(), rsp.getStatus(), "Response status equals");
        } catch (Exception ex) {
            logger.error("unexpected exception", ex);
            fail("abort should not throw an exception");
        }
    }

    @Test
    void finishUploadMustBeCalledWhenExceptionHappensTest() {
        //given
        final VspUploadStatusDto vspUploadStatusDto = createVspUploadStatus(UUID.randomUUID(), VspUploadStatus.UPLOADING);
        when(orchestrationTemplateCandidateUploadManager.findLatestStatus(candidateId, versionId, user)).thenReturn(Optional.empty());
        when(orchestrationTemplateCandidateUploadManager.putUploadInProgress(candidateId, versionId, user)).thenReturn(vspUploadStatusDto);
        final RuntimeException forcedException = new RuntimeException();
        when(fileToUpload.getDataHandler()).thenThrow(forcedException);
        //when
        final RuntimeException actualException = assertThrows(RuntimeException.class,
            () -> orchestrationTemplateCandidate.upload(candidateId, versionId, fileToUpload, user));
        //then
        assertEquals(forcedException, actualException);
        verify(orchestrationTemplateCandidateUploadManager)
            .putUploadAsFinished(candidateId, versionId, vspUploadStatusDto.getLockId(), VspUploadStatus.ERROR, user);
    }

//    @Test
//    void uploadTestWithLatestStatusComplete() {
//        final VspUploadStatusDto vspUploadStatusDto = new VspUploadStatusDto();
//        vspUploadStatusDto.setComplete(true);
//        //given
//        when(orchestrationTemplateCandidateUploadManager.findLatestStatus(candidateId, versionId, user)).thenReturn(Optional.of(vspUploadStatusDto));
//        final Attachment mock = Mockito.mock(Attachment.class);
//        when(mock.getDataHandler()).thenReturn(Mockito.mock(DataHandler.class));
//        //when
//        final CoreException actualException = assertThrows(CoreException.class,
//            () -> orchestrationTemplateCandidate.upload(candidateId, versionId, mock, user));
//        final CoreException expectedException = couldNotAcceptPackageNoUploadInProgress(candidateId, versionId).get();
//        //then
//        assertEquals(expectedException.code().id(), actualException.code().id());
//        assertEquals(expectedException.code().message(), actualException.code().message());
//        verify(orchestrationTemplateCandidateUploadManager).findLatestStatus(candidateId, versionId, user);
//    }

    @Test
    void uploadTestWithUploadInProgress() {
        final VspUploadStatusDto vspUploadStatusDto = new VspUploadStatusDto();
        vspUploadStatusDto.setComplete(false);
        vspUploadStatusDto.setStatus(VspUploadStatus.PROCESSING);
        //given
        when(orchestrationTemplateCandidateUploadManager.findLatestStatus(candidateId, versionId, user)).thenReturn(Optional.of(vspUploadStatusDto));
        final Attachment mock = Mockito.mock(Attachment.class);
        when(mock.getDataHandler()).thenReturn(Mockito.mock(DataHandler.class));
        //when
        final CoreException actualException = assertThrows(CoreException.class,
            () -> orchestrationTemplateCandidate.upload(candidateId, versionId, mock, user));
        final CoreException expectedException = vspUploadAlreadyInProgress(candidateId, versionId).get();
        //then
        assertEquals(expectedException.code().id(), actualException.code().id());
        assertEquals(expectedException.code().message(), actualException.code().message());
        verify(orchestrationTemplateCandidateUploadManager).findLatestStatus(candidateId, versionId, user);
    }

}