gerrit.onap Code Review - sdc.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdc.healing.impl;
  22
  23
  24 import org.openecomp.core.utilities.CommonMethods;
  25 import org.openecomp.core.utilities.file.FileUtils;
  26 import org.openecomp.core.utilities.json.JsonUtil;
  27 import org.openecomp.sdc.common.errors.CoreException;
  28 import org.openecomp.sdc.common.errors.ErrorCategory;
  29 import org.openecomp.sdc.common.errors.ErrorCode;
  30 import org.openecomp.sdc.common.errors.Messages;
  31 import org.openecomp.sdc.common.session.SessionContextProviderFactory;
  32 import org.openecomp.sdc.datatypes.model.ItemType;
  33 import org.openecomp.sdc.healing.api.HealingManager;
  34 import org.openecomp.sdc.healing.dao.HealingDao;
  35 import org.openecomp.sdc.healing.interfaces.Healer;
  36 import org.openecomp.sdc.healing.types.HealerType;
  37 import org.openecomp.sdc.versioning.VersioningManager;
  38 import org.openecomp.sdc.versioning.dao.types.Version;
  39 import org.openecomp.sdc.versioning.dao.types.VersionStatus;
  40 import org.openecomp.sdc.versioning.types.VersionCreationMethod;
  41
  42 import java.util.Collection;
  43 import java.util.Collections;
  44 import java.util.LinkedList;
  45 import java.util.List;
  46 import java.util.Map;
  47 import java.util.Objects;
  48 import java.util.Optional;
  49 import java.util.stream.Collectors;
  50 import java.util.stream.Stream;
  51
  52 public class HealingManagerImpl implements HealingManager {
  53
  54   private static final String HEALERS_BY_ENTITY_TYPE_FILE = "entityHealingConfiguration.json";
  55   private static final String HEALING_USER_SUFFIX = "_healer";
  56   private static final String PUBLIC_USER = "public";
  57
  58   private HealingDao healingDao;
  59   private VersioningManager versioningManager;
  60
  61   public HealingManagerImpl(VersioningManager versioningManager, HealingDao healingDao) {
  62     this.versioningManager = versioningManager;
  63     this.healingDao = healingDao;
  64   }
  65
  66   @Override
  67   public Optional<Version> healItemVersion(final String itemId, final Version version,
  68                                            final ItemType itemType, final boolean force) {
  69     String user = getUser();
  70     populateVersionInfo(itemId, version);
  71
  72     if (!isHealingNeeded(itemId, version, force, user)) {
  73       return Optional.empty();
  74     }
  75
  76     Map<String, Collection<String>> healersByType = getItemHealers(itemType);
  77     List<String> failureMessages = new LinkedList<>();
  78     List<Healer> structureHealersToRun =
  79         getHealersToRun(healersByType.get(HealerType.structure.name()), itemId, version,
  80             failureMessages);
  81     List<Healer> dataHealersToRun =
  82         getHealersToRun(healersByType.get(HealerType.data.name()), itemId, version,
  83             failureMessages);
  84
  85     if (structureHealersToRun.isEmpty() && dataHealersToRun.isEmpty()) {
  86       markAsHealed(itemId, version.getId(), user);
  87       markAsHealed(itemId, version.getId(), PUBLIC_USER);
  88       return Optional.empty();
  89     }
  90
  91     Optional<Version> healVersion = getHealVersion(itemId, version);
  92     if (!healVersion.isPresent()) {
  93       // do NOT turn off flag here (in thought of saving version calculate performance next
  94       // time) because maybe next time the next version will be available (due to deletion of
  95       // the taken one)
  96       return Optional.empty();
  97     }
  98
  99     failureMessages.addAll(
 100         doHeal(itemId, healVersion.get(), version, structureHealersToRun, dataHealersToRun, user,
 101             force));
 102     handleFailures(failureMessages);
 103
 104     return healVersion;
 105   }
 106
 107   private void populateVersionInfo(String itemId, Version version) {
 108     if (version.getStatus() != null) {
 109       return;
 110     }
 111
 112     Version retrievedVersion = versioningManager.get(itemId, version);
 113     version.setStatus(retrievedVersion.getStatus());
 114     version.setBaseId(retrievedVersion.getBaseId());
 115   }
 116
 117   private boolean isHealingNeeded(String itemId, Version version, boolean force, String user) {
 118     return force || isHealingFlagOn(itemId, version.getId(), user)
 119         .orElse(isHealingFlagOn(itemId, version.getId(), PUBLIC_USER)
 120             .orElse(version.getStatus() == VersionStatus.Draft && version.getBaseId() != null &&
 121                 isHealingFlagOn(itemId, version.getBaseId(), user)
 122                     .orElse(isHealingFlagOn(itemId, version.getBaseId(), PUBLIC_USER)
 123                         .orElse(false))));
 124   }
 125
 126   private Optional<Version> getHealVersion(String itemId, Version version) {
 127     return version.getStatus() == VersionStatus.Certified
 128         ? createNewVersion(itemId, version.getId())
 129         : Optional.of(version);
 130   }
 131
 132   private Optional<Version> createNewVersion(String itemId, String versionId) {
 133     Version newVersion = new Version();
 134     newVersion.setBaseId(versionId);
 135     newVersion.setDescription("Version is created by healing process");
 136     try {
 137       return Optional.of(versioningManager.create(itemId, newVersion, VersionCreationMethod.major));
 138     } catch (Exception e) {
 139       return Optional.empty();
 140     }
 141   }
 142
 143   private List<String> doHeal(String itemId, Version version, Version origVersion,
 144                               List<Healer> structureHealersToRun,
 145                               List<Healer> dataHealersToRun, String user,
 146                               boolean force) {
 147     boolean publicFlagOn = isHealingFlagOn(itemId, origVersion.getId(), PUBLIC_USER)
 148         .orElse(origVersion.getBaseId() != null &&
 149             isHealingFlagOn(itemId, origVersion.getBaseId(), PUBLIC_USER).orElse(false));
 150
 151     List<String> failureMessages =
 152         force || origVersion.getStatus() == VersionStatus.Certified || publicFlagOn
 153             ? healPublic(itemId, version, origVersion, structureHealersToRun, dataHealersToRun,
 154             user)
 155             : new LinkedList<>();
 156
 157     failureMessages.addAll(
 158         healPrivate(itemId, version, origVersion, structureHealersToRun, dataHealersToRun, user));
 159
 160     return failureMessages;
 161   }
 162
 163   private List<String> healPrivate(String itemId, Version version, Version origVersion,
 164                                    List<Healer> structureHealersToRun,
 165                                    List<Healer> dataHealersToRun, String user) {
 166     List<String> failureMessages;
 167     if (origVersion.getStatus() == VersionStatus.Certified) {
 168       failureMessages = executeHealers(itemId, version,
 169           Stream.concat(structureHealersToRun.stream(), dataHealersToRun.stream())
 170               .collect(Collectors.toList()));
 171     } else {
 172       if (structureHealersToRun.isEmpty()) {
 173         failureMessages = executeHealers(itemId, version, dataHealersToRun);
 174       } else {
 175         versioningManager.forceSync(itemId, version);
 176         failureMessages = new LinkedList<>();
 177       }
 178     }
 179     markAsHealed(itemId, origVersion.getId(), user);
 180     return failureMessages;
 181   }
 182
 183   private List<String> healPublic(String itemId, Version version, Version origVersion,
 184                                   List<Healer> structureHealersToRun,
 185                                   List<Healer> dataHealersToRun, String user) {
 186     List<String> failureMessages = origVersion.getStatus() == VersionStatus.Certified
 187         ? new LinkedList<>()
 188         : healPublic(itemId, version,
 189             Stream.concat(structureHealersToRun.stream(), dataHealersToRun.stream())
 190                 .collect(Collectors.toList()), user);
 191
 192     markAsHealed(itemId, origVersion.getId(), PUBLIC_USER);
 193     return failureMessages;
 194   }
 195
 196   private List<String> healPublic(String itemId, Version version, List<Healer> healers,
 197                                   String user) {
 198     String tenant = SessionContextProviderFactory.getInstance().createInterface().get().getTenant();
 199     SessionContextProviderFactory.getInstance().createInterface()
 200         .create(user + HEALING_USER_SUFFIX, tenant);
 201
 202     versioningManager.forceSync(itemId, version);
 203
 204     List<String> failureMessages = executeHealers(itemId, version, healers);
 205     Version publicVersion = versioningManager.get(itemId, version);
 206
 207     if (Objects.nonNull(publicVersion.getState()) && publicVersion.getState().isDirty()) {
 208       versioningManager.publish(itemId, version, "Healing vsp");
 209     }
 210
 211     SessionContextProviderFactory.getInstance().createInterface().create(user, tenant);
 212     return failureMessages;
 213   }
 214
 215   private List<String> executeHealers(String itemId, Version version, List<Healer> healers) {
 216     List<String> failureMessages = new LinkedList<>();
 217     for (Healer healer : healers) {
 218       try {
 219         healer.heal(itemId, version);
 220       } catch (Exception e) {
 221         failureMessages.add(
 222             String.format("Failure in healer %s: %s", healer.getClass().getName(), e.getMessage()));
 223       }
 224     }
 225
 226     return failureMessages;
 227   }
 228
 229   private Optional<Boolean> isHealingFlagOn(String itemId, String version, String user) {
 230     return healingDao.getItemHealingFlag(user, itemId, version);
 231   }
 232
 233   private void markAsHealed(String itemId, String versionId, String user) {
 234     healingDao.setItemHealingFlag(false, user, itemId, versionId);
 235   }
 236
 237   private void handleFailures(List<String> failureMessages) {
 238     if (!failureMessages.isEmpty()) {
 239       throw new CoreException(new ErrorCode.ErrorCodeBuilder()
 240           .withCategory(ErrorCategory.APPLICATION)
 241           .withMessage(CommonMethods.listToSeparatedString(failureMessages, '\n')).build());
 242     }
 243   }
 244
 245   private List<Healer> getHealersToRun(Collection<String> healersClassNames, String itemId,
 246                                        Version version, List<String> failureMessages) {
 247     return healersClassNames == null
 248         ? Collections.emptyList()
 249         : healersClassNames.stream()
 250             .map(healerClassName -> getHealerInstance(healerClassName, failureMessages))
 251             .filter(Optional::isPresent)
 252             .map(Optional::get)
 253             .filter(healer -> healer.isHealingNeeded(itemId, version))
 254             .collect(Collectors.toList());
 255   }
 256
 257   private Optional<Healer> getHealerInstance(String healerClassName, List<String> failureMessages) {
 258     try {
 259       return Optional.of((Healer) Class.forName(healerClassName).getConstructor().newInstance());
 260     } catch (Exception e) {
 261       failureMessages
 262           .add(String.format(Messages.CANT_LOAD_HEALING_CLASS.getErrorMessage(), healerClassName));
 263       return Optional.empty();
 264     }
 265   }
 266
 267   private Map<String, Collection<String>> getItemHealers(ItemType itemType) {
 268     Map healingConfig = FileUtils
 269         .readViaInputStream(HEALERS_BY_ENTITY_TYPE_FILE,
 270             stream -> JsonUtil.json2Object(stream, Map.class));
 271     return (Map<String, Collection<String>>) healingConfig
 272         .getOrDefault(itemType.name(), Collections.emptyMap());
 273   }
 274
 275   private String getUser() {
 276     return SessionContextProviderFactory.getInstance().createInterface().get().getUser()
 277         .getUserId();
 278   }
 279 }