gerrit.onap Code Review - sdc/sdc-workflow-designer.git/blob

   1 /*
   2  * Copyright © 2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.onap.sdc.workflow.services.impl;
  18
  19 import static org.onap.sdc.workflow.persistence.types.WorkflowVersionState.CERTIFIED;
  20
  21 import com.amdocs.zusammen.datatypes.response.ErrorCode;
  22 import java.io.IOException;
  23 import java.io.InputStream;
  24 import java.util.Collection;
  25 import java.util.HashSet;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Optional;
  29 import java.util.Set;
  30 import java.util.function.Function;
  31 import java.util.stream.Collectors;
  32 import org.onap.sdc.workflow.persistence.ArtifactRepository;
  33 import org.onap.sdc.workflow.persistence.ParameterRepository;
  34 import org.onap.sdc.workflow.persistence.types.ArtifactEntity;
  35 import org.onap.sdc.workflow.persistence.types.ParameterEntity;
  36 import org.onap.sdc.workflow.persistence.types.ParameterRole;
  37 import org.onap.sdc.workflow.persistence.types.WorkflowVersion;
  38 import org.onap.sdc.workflow.persistence.types.WorkflowVersionState;
  39 import org.onap.sdc.workflow.services.WorkflowVersionManager;
  40 import org.onap.sdc.workflow.services.exceptions.EntityNotFoundException;
  41 import org.onap.sdc.workflow.services.exceptions.InvalidArtifactException;
  42 import org.onap.sdc.workflow.services.exceptions.VersionCreationException;
  43 import org.onap.sdc.workflow.services.exceptions.VersionModificationException;
  44 import org.onap.sdc.workflow.services.exceptions.VersionStateModificationException;
  45 import org.onap.sdc.workflow.services.impl.mappers.VersionMapper;
  46 import org.onap.sdc.workflow.services.impl.mappers.VersionStateMapper;
  47 import org.openecomp.sdc.common.errors.SdcRuntimeException;
  48 import org.openecomp.sdc.logging.api.Logger;
  49 import org.openecomp.sdc.logging.api.LoggerFactory;
  50 import org.openecomp.sdc.versioning.VersioningManager;
  51 import org.openecomp.sdc.versioning.dao.types.Version;
  52 import org.openecomp.sdc.versioning.dao.types.VersionStatus;
  53 import org.openecomp.sdc.versioning.types.VersionCreationMethod;
  54 import org.springframework.beans.factory.annotation.Autowired;
  55 import org.springframework.stereotype.Service;
  56 import org.springframework.util.StringUtils;
  57 import org.springframework.web.multipart.MultipartFile;
  58
  59 @Service("workflowVersionManager")
  60 public class WorkflowVersionManagerImpl implements WorkflowVersionManager {
  61
  62     private static final String VERSION_NOT_EXIST_MSG = "version with id '%s' does not exist for workflow with id '%s'";
  63     private final VersioningManager versioningManager;
  64     private final ArtifactRepository artifactRepository;
  65     private final ParameterRepository parameterRepository;
  66     private final VersionMapper versionMapper;
  67     private final VersionStateMapper versionStateMapper;
  68     private static final Logger LOGGER = LoggerFactory.getLogger(WorkflowVersionManagerImpl.class);
  69
  70     @Autowired
  71     public WorkflowVersionManagerImpl(VersioningManager versioningManager, ArtifactRepository artifactRepository,
  72             VersionMapper versionMapper, VersionStateMapper versionStateMapper,
  73             ParameterRepository parameterRepository) {
  74         this.versioningManager = versioningManager;
  75         this.artifactRepository = artifactRepository;
  76         this.parameterRepository = parameterRepository;
  77         this.versionMapper = versionMapper;
  78         this.versionStateMapper = versionStateMapper;
  79     }
  80
  81     @Override
  82     public Collection<WorkflowVersion> list(String workflowId, Set<WorkflowVersionState> stateFilter) {
  83         Set<VersionStatus> versionStatusFilter =
  84                 stateFilter == null ? null :
  85                         stateFilter.stream().map(versionStateMapper::workflowVersionStateToVersionStatus)
  86                                            .collect(Collectors.toSet());
  87
  88         return versioningManager.list(workflowId).stream()
  89                                 .filter(version -> versionStatusFilter == null || versionStatusFilter.contains(
  90                                         version.getStatus()))
  91                                 .map(versionMapper::versionToWorkflowVersion)
  92                                 .peek(workflowVersion -> loadAndAddParameters(workflowId, workflowVersion))
  93                                 .collect(Collectors.toList());
  94     }
  95
  96     @Override
  97     public WorkflowVersion get(String workflowId, String versionId) {
  98         WorkflowVersion workflowVersion = versionMapper.versionToWorkflowVersion(getVersion(workflowId, versionId));
  99         loadAndAddParameters(workflowId, workflowVersion);
 100         workflowVersion.setHasArtifact(artifactRepository.isExist(workflowId,versionId));
 101         return workflowVersion;
 102     }
 103
 104     @Override
 105     public WorkflowVersion create(String workflowId, String baseVersionId, WorkflowVersion workflowVersion) {
 106         List<Version> versions = versioningManager.list(workflowId);
 107
 108         if (baseVersionId != null) {
 109             if (!workflowVersion.getInputs().isEmpty() || !workflowVersion.getOutputs().isEmpty()) {
 110                 throw new VersionCreationException(workflowId, baseVersionId, "Inputs/Outputs should not be supplied");
 111             }
 112             validateVersionExistAndCertified(workflowId, versions, baseVersionId);
 113         } else if (!versions.isEmpty()) {
 114             throw new VersionCreationException(workflowId);
 115         }
 116
 117         Version version = new Version();
 118         version.setDescription(workflowVersion.getDescription());
 119         version.setBaseId(baseVersionId);
 120         Version createdVersion = versioningManager.create(workflowId, version, VersionCreationMethod.major);
 121
 122         if (versions.isEmpty()) { // only for first version
 123             artifactRepository.createStructure(workflowId, createdVersion.getId());
 124             parameterRepository.createStructure(workflowId, createdVersion.getId());
 125             updateParameters(workflowId, createdVersion.getId(), workflowVersion.getInputs(), workflowVersion.getOutputs());
 126             versioningManager.publish(workflowId, createdVersion, "Add initial data");
 127         }
 128
 129         return get(workflowId, createdVersion.getId());
 130     }
 131
 132     @Override
 133     public void update(String workflowId, WorkflowVersion workflowVersion) {
 134         Version retrievedVersion = getVersion(workflowId, workflowVersion.getId());
 135         if (CERTIFIED.equals(versionStateMapper.versionStatusToWorkflowVersionState(retrievedVersion.getStatus()))) {
 136             throw new VersionModificationException(workflowId, workflowVersion.getId());
 137         }
 138
 139         Version version = versionMapper.workflowVersionToVersion(workflowVersion);
 140         version.setName(retrievedVersion.getName());
 141         version.setStatus(retrievedVersion.getStatus());
 142
 143         updateParameters(workflowId, version.getId(), workflowVersion.getInputs(), workflowVersion.getOutputs());
 144
 145         versioningManager.updateVersion(workflowId, version);
 146
 147         Version updatedVersion = versioningManager.get(workflowId, version);
 148         if(updatedVersion.getState().isDirty()) {
 149             versioningManager.publish(workflowId, version, "Update version");
 150         }
 151     }
 152
 153
 154     @Override
 155     public WorkflowVersionState getState(String workflowId, String versionId) {
 156         return versionStateMapper.versionStatusToWorkflowVersionState(getVersion(workflowId, versionId).getStatus());
 157     }
 158
 159     @Override
 160     public void updateState(String workflowId, String versionId, WorkflowVersionState state) {
 161         WorkflowVersionState retrievedState =
 162                 versionStateMapper.versionStatusToWorkflowVersionState(getVersion(workflowId, versionId).getStatus());
 163
 164         if (state == CERTIFIED) {
 165             try {
 166                 versioningManager.submit(workflowId, new Version(versionId),
 167                         String.format("Update version state to %s", state.name()));
 168             } catch (Exception e) {
 169                 throw new VersionStateModificationException(workflowId, versionId, retrievedState, state);
 170             }
 171         } else {
 172             throw new VersionStateModificationException(workflowId, versionId, retrievedState, state);
 173         }
 174     }
 175
 176     @Override
 177     public void uploadArtifact(String workflowId, String versionId, MultipartFile artifact) {
 178         Version retrievedVersion = getVersion(workflowId, versionId);
 179         if (CERTIFIED.equals(versionStateMapper.versionStatusToWorkflowVersionState(retrievedVersion.getStatus()))) {
 180             throw new VersionModificationException(workflowId, versionId);
 181         }
 182
 183         try (InputStream artifactData = artifact.getInputStream()) {
 184             ArtifactEntity artifactEntity =
 185                     new ArtifactEntity(StringUtils.cleanPath(artifact.getOriginalFilename()), artifactData);
 186             artifactRepository.update(workflowId, versionId, artifactEntity);
 187             versioningManager.publish(workflowId, new Version(versionId), "Update Artifact");
 188
 189         } catch (IOException e) {
 190             LOGGER.error(String.format("Upload Artifact failed for workflow id %s and version id %s",
 191                     workflowId, versionId),e);
 192             throw new InvalidArtifactException(e.getMessage());
 193         }
 194     }
 195
 196     @Override
 197     public ArtifactEntity getArtifact(String workflowId, String versionId) {
 198         getVersion(workflowId, versionId);
 199         Optional<ArtifactEntity> artifactOptional = artifactRepository.get(workflowId, versionId);
 200         if (!artifactOptional.isPresent()) {
 201             LOGGER.error(String.format("Workflow Version Artifact was not found for workflow id %s and version id %s",
 202                     workflowId, versionId));
 203             throw new EntityNotFoundException(
 204                     String.format("Artifact for workflow id %S version id %S was not found", workflowId, versionId));
 205         }
 206         return artifactOptional.get();
 207     }
 208
 209     @Override
 210     public void deleteArtifact(String workflowId, String versionId) {
 211         WorkflowVersion retrievedVersion = get(workflowId, versionId);
 212         if (CERTIFIED.equals(retrievedVersion.getState())) {
 213             LOGGER.error(String.format(
 214                     "Workflow Version is certified and can not be edited.Workflow id %s and version id %s", workflowId,
 215                     versionId));
 216             throw new VersionModificationException(workflowId, versionId);
 217         }
 218
 219         artifactRepository.delete(workflowId, versionId);
 220         versioningManager.publish(workflowId, new Version(versionId), "Delete Artifact");
 221     }
 222
 223     private void validateVersionExistAndCertified(String workflowId, List<Version> versions, String versionId) {
 224         Version baseVersion = findVersion(versions, versionId).orElseThrow(
 225                 () -> new EntityNotFoundException(String.format(VERSION_NOT_EXIST_MSG, versionId, workflowId)));
 226
 227         if (CERTIFIED != versionStateMapper.versionStatusToWorkflowVersionState(baseVersion.getStatus())) {
 228             throw new VersionCreationException(workflowId, versionId, "base version must be CERTIFIED");
 229         }
 230     }
 231
 232     private Version getVersion(String workflowId, String versionId) {
 233         try {
 234             Version version = versioningManager.get(workflowId, new Version(versionId));
 235             if (version == null) {
 236                 throw new EntityNotFoundException(String.format(VERSION_NOT_EXIST_MSG, versionId, workflowId));
 237             }
 238             return version;
 239         } catch (Exception e) {
 240             LOGGER.error(String.format(
 241                     "Workflow Version was not found.Workflow id %s and version id %s", workflowId,
 242                     versionId),e);
 243             throw new EntityNotFoundException(String.format(VERSION_NOT_EXIST_MSG, versionId, workflowId));
 244         }
 245     }
 246
 247     private void updateParameters(String workflowId, String versionId, Collection<ParameterEntity> inputs,
 248             Collection<ParameterEntity> outputs) {
 249         updateVersionParameters(workflowId, versionId, ParameterRole.INPUT, inputs);
 250         updateVersionParameters(workflowId, versionId, ParameterRole.OUTPUT, outputs);
 251     }
 252
 253     private void updateVersionParameters(String workflowId, String versionId, ParameterRole role,
 254             Collection<ParameterEntity> parameters) {
 255
 256         Collection<ParameterEntity> retrievedParams = parameterRepository.list(workflowId, versionId, role);
 257         Map<String, ParameterEntity> retrievedParamsByName =
 258                 retrievedParams.stream().collect(Collectors.toMap(ParameterEntity::getName, Function.identity()));
 259
 260         Set<String> namesOfParamsToKeep = new HashSet<>();
 261         for (ParameterEntity parameter : parameters) {
 262
 263             ParameterEntity retrievedParam = retrievedParamsByName.get(parameter.getName());
 264             if (retrievedParam == null) {
 265                 parameterRepository.create(workflowId, versionId, role, parameter);
 266             } else {
 267                 parameterRepository.update(workflowId, versionId, role, parameter);
 268                 namesOfParamsToKeep.add(parameter.getName());
 269             }
 270         }
 271
 272         retrievedParams.stream().filter(retrievedParam -> !namesOfParamsToKeep.contains(retrievedParam.getName()))
 273                        .forEach(retrievedParam -> parameterRepository
 274                                                           .delete(workflowId, versionId, retrievedParam.getId()));
 275     }
 276
 277     private void loadAndAddParameters(String workflowId, WorkflowVersion workflowVersion) {
 278         workflowVersion.setInputs(parameterRepository.list(workflowId, workflowVersion.getId(), ParameterRole.INPUT));
 279         workflowVersion.setOutputs(parameterRepository.list(workflowId, workflowVersion.getId(), ParameterRole.OUTPUT));
 280     }
 281
 282     private static Optional<Version> findVersion(List<Version> versions, String versionId) {
 283         return versions.stream().filter(version -> versionId.equals(version.getId())).findFirst();
 284     }
 285
 286 }