From 049d078d8abbe637b213a2f14c2192379208c168 Mon Sep 17 00:00:00 2001 From: "andre.schmid" Date: Wed, 15 Dec 2021 19:44:06 +0000 Subject: Onboarding upload control Brings the initial structure to control asynchronously a VSP package upload during the onboarding. Instead of blocking the UI, the upload and processing status will be controlled by the backend, so the frontend can query it and control the behaviour of the UI. Updates the upload endpoint to obtain/verify an upload lock, and creates a second endpoint to check for the upload status. Change-Id: If1c43fb4f0b11e1d8a5627578bafc75f266393c2 Issue-ID: SDC-3826, SDC-3827 Signed-off-by: andre.schmid --- .../dao/VspUploadStatusRecordAccessor.java | 44 ++++++++++++ .../dao/VspUploadStatusRecordDao.java | 84 ++++++++++++++++++++++ .../dao/type/VspUploadStatus.java | 42 +++++++++++ .../dao/type/VspUploadStatusRecord.java | 75 +++++++++++++++++++ .../dao/type/VspUploadStatusTest.java | 48 +++++++++++++ 5 files changed, 293 insertions(+) create mode 100644 openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/VspUploadStatusRecordAccessor.java create mode 100644 openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/VspUploadStatusRecordDao.java create mode 100644 openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatus.java create mode 100644 openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatusRecord.java create mode 100644 openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/test/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatusTest.java (limited to 'openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src') diff --git a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/VspUploadStatusRecordAccessor.java b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/VspUploadStatusRecordAccessor.java new file mode 100644 index 0000000000..84ffde6ae4 --- /dev/null +++ b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/VspUploadStatusRecordAccessor.java @@ -0,0 +1,44 @@ +/* + * - + * ============LICENSE_START======================================================= + * Copyright (C) 2022 Nordix Foundation. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.openecomp.sdc.vendorsoftwareproduct.dao; + +import com.datastax.driver.mapping.Result; +import com.datastax.driver.mapping.annotations.Accessor; +import com.datastax.driver.mapping.annotations.Query; +import java.util.UUID; +import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspUploadStatusRecord; + +/** + * Cassandra accessor for the {@link VspUploadStatusRecord} + */ +@Accessor +public interface VspUploadStatusRecordAccessor { + + @Query("SELECT * FROM vsp_upload_status WHERE vsp_id = ? AND vsp_version_id = ?") + Result findAllByVspIdAndVspVersionId(final String vspId, final String vspVersionId); + + @Query("SELECT * FROM vsp_upload_status WHERE vsp_id = ? AND vsp_version_id = ? AND is_complete = FALSE") + Result findAllIncomplete(final String vspId, final String vspVersionId); + + @Query("SELECT * FROM vsp_upload_status WHERE vsp_id = ? AND vsp_version_id = ? AND lock_id = ?") + Result findByVspIdAndVersionIdAndLockId(final String vspId, final String vspVersionId, final UUID lockId); +} diff --git a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/VspUploadStatusRecordDao.java b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/VspUploadStatusRecordDao.java new file mode 100644 index 0000000000..3329eb176b --- /dev/null +++ b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/VspUploadStatusRecordDao.java @@ -0,0 +1,84 @@ +/* + * - + * ============LICENSE_START======================================================= + * Copyright (C) 2022 Nordix Foundation. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.openecomp.sdc.vendorsoftwareproduct.dao; + +import java.util.List; +import java.util.Optional; +import java.util.UUID; +import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspUploadStatusRecord; + +/** + * Data Access Object for the package upload process status record. + */ +public interface VspUploadStatusRecordDao { + + /** + * Creates an upload status record. + * + * @param vspUploadStatusRecord the upload status record to create + */ + void create(final VspUploadStatusRecord vspUploadStatusRecord); + + /** + * Updates an upload status record. + * + * @param vspUploadStatusRecord the upload status record to update + */ + void update(final VspUploadStatusRecord vspUploadStatusRecord); + + /** + * Finds all upload status record by Vendor Software Product id and its version id. + * + * @param vspId the Vendor Software Product id + * @param vspVersionId the Vendor Software Product version id + * @return a list with all the status record found that matches the criteria + */ + List findAllByVspIdAndVersionId(final String vspId, final String vspVersionId); + + /** + * Finds all upload status record by Vendor Software Product id and its version id. + * + * @param vspId the Vendor Software Product id + * @param vspVersionId the Vendor Software Product version id + * @return a list with all the status record found that matches the criteria + */ + Optional findByVspIdAndVersionIdAndLockId(final String vspId, final String vspVersionId, final UUID lockId); + + /** + * Finds all uploads in progress by Vendor Software Product id and its version id. + * + * @param vspId the Vendor Software Product id + * @param vspVersionId the Vendor Software Product version id + * @return a list with all the status record found that matches the criteria + */ + List findAllInProgress(final String vspId, final String vspVersionId); + + /** + * Finds the latest upload status record for the Vendor Software Product id and its version id. + * + * @param vspId the Vendor Software Product id + * @param vspVersionId the Vendor Software Product version id + * @return the latest upload status record that matches the criteria + */ + Optional findLatest(final String vspId, final String vspVersionId); + +} diff --git a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatus.java b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatus.java new file mode 100644 index 0000000000..f5d9de36bd --- /dev/null +++ b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatus.java @@ -0,0 +1,42 @@ +/* + * - + * ============LICENSE_START======================================================= + * Copyright (C) 2022 Nordix Foundation. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.openecomp.sdc.vendorsoftwareproduct.dao.type; + +import java.util.List; + +/** + * Represents the status of a Vendor Software Product package upload. + */ +public enum VspUploadStatus { + UPLOADING, + PROCESSING, + SUCCESS, + ERROR; + + public boolean isCompleteStatus() { + return getCompleteStatus().contains(this); + } + + public static List getCompleteStatus() { + return List.of(SUCCESS, ERROR); + } +} diff --git a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatusRecord.java b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatusRecord.java new file mode 100644 index 0000000000..d0ce91cc57 --- /dev/null +++ b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatusRecord.java @@ -0,0 +1,75 @@ +/* + * - + * ============LICENSE_START======================================================= + * Copyright (C) 2022 Nordix Foundation. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.openecomp.sdc.vendorsoftwareproduct.dao.type; + +import com.datastax.driver.mapping.annotations.ClusteringColumn; +import com.datastax.driver.mapping.annotations.Column; +import com.datastax.driver.mapping.annotations.PartitionKey; +import com.datastax.driver.mapping.annotations.Table; +import java.util.Date; +import java.util.UUID; +import lombok.AccessLevel; +import lombok.Data; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +@Data +@NoArgsConstructor +@Table(keyspace = "dox", name = "vsp_upload_status") +public class VspUploadStatusRecord { + + @PartitionKey + @Column(name = "vsp_id") + private String vspId; + + @PartitionKey(value = 1) + @Column(name = "vsp_version_id") + private String vspVersionId; + + @ClusteringColumn + @Column(name = "lock_id") + private UUID lockId; + + @Column(name = "is_complete") + @Getter(AccessLevel.NONE) + @Setter(AccessLevel.NONE) + private boolean isComplete; + + @Column(name = "status") + private VspUploadStatus status; + + @ClusteringColumn(value = 1) + @Column(name = "created") + private Date created; + + @Column(name = "updated") + private Date updated; + + public boolean getIsComplete() { + return isComplete; + } + + public void setIsComplete(boolean complete) { + isComplete = complete; + } +} \ No newline at end of file diff --git a/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/test/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatusTest.java b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/test/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatusTest.java new file mode 100644 index 0000000000..83618e74da --- /dev/null +++ b/openecomp-be/lib/openecomp-sdc-vendor-software-product-lib/openecomp-sdc-vendor-software-product-api/src/test/java/org/openecomp/sdc/vendorsoftwareproduct/dao/type/VspUploadStatusTest.java @@ -0,0 +1,48 @@ +/* + * - + * ============LICENSE_START======================================================= + * Copyright (C) 2022 Nordix Foundation. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.openecomp.sdc.vendorsoftwareproduct.dao.type; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.List; +import org.junit.jupiter.api.Test; + +class VspUploadStatusTest { + + @Test + void isCompleteStatus() { + assertTrue(VspUploadStatus.SUCCESS.isCompleteStatus()); + assertTrue(VspUploadStatus.ERROR.isCompleteStatus()); + assertFalse(VspUploadStatus.UPLOADING.isCompleteStatus()); + assertFalse(VspUploadStatus.PROCESSING.isCompleteStatus()); + } + + @Test + void getCompleteStatusTest() { + final List completeStatus = VspUploadStatus.getCompleteStatus(); + assertEquals(2, completeStatus.size()); + assertTrue(completeStatus.contains(VspUploadStatus.SUCCESS)); + assertTrue(completeStatus.contains(VspUploadStatus.ERROR)); + } +} \ No newline at end of file -- cgit 1.2.3-korg