gerrit.onap Code Review - sdc.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 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 import org.openecomp.core.utilities.CommonMethods;
  24 import org.openecomp.core.utilities.file.FileUtils;
  25 import org.openecomp.core.utilities.json.JsonUtil;
  26 import org.openecomp.sdc.common.errors.Messages;
  27 import org.openecomp.sdc.common.session.SessionContextProviderFactory;
  28 import org.openecomp.sdc.datatypes.error.ErrorLevel;
  29 import org.openecomp.sdc.datatypes.model.ItemType;
  30 import org.openecomp.sdc.healing.api.HealingManager;
  31 import org.openecomp.sdc.healing.dao.HealingDao;
  32 import org.openecomp.sdc.healing.interfaces.Healer;
  33 import org.openecomp.sdc.healing.types.HealCode;
  34 import org.openecomp.sdc.healing.types.HealerType;
  35 import org.openecomp.sdc.logging.types.LoggerConstants;
  36 import org.openecomp.sdc.logging.types.LoggerErrorCode;
  37 import org.openecomp.sdc.logging.types.LoggerErrorDescription;
  38 import org.openecomp.sdc.logging.types.LoggerTragetServiceName;
  39 import org.openecomp.sdc.versioning.VersioningManager;
  40 import org.openecomp.sdc.versioning.dao.types.Version;
  41 import org.openecomp.sdc.versioning.dao.types.VersionStatus;
  42 import org.openecomp.sdc.versioning.types.VersionCreationMethod;
  43
  44 import java.lang.reflect.InvocationTargetException;
  45 import java.util.ArrayList;
  46 import java.util.Collection;
  47 import java.util.List;
  48 import java.util.Map;
  49 import java.util.Objects;
  50 import java.util.Optional;
  51 import java.util.stream.Collectors;
  52
  53 /**
  54  * Created by Talio on 11/29/2016.
  55  */
  56 public class HealingManagerImpl implements HealingManager {
  57
  58   private static final String HEALERS_BY_ENTITY_TYPE_FILE = "entityHealingConfiguration.json";
  59   private static final String HEALING_USER_SUFFIX = "_healer";
  60   private static final String PUBLIC_USER = "public";
  61
  62   private HealingDao healingDao;
  63   private VersioningManager versioningManager;
  64
  65   public HealingManagerImpl(VersioningManager versioningManager, HealingDao healingDao) {
  66     this.versioningManager = versioningManager;
  67     this.healingDao = healingDao;
  68   }
  69
  70   @Override
  71   public Optional<Version> healItemVersion(String itemId, Version version, ItemType itemType,
  72                                            boolean force) {
  73     String user = getUser();
  74     if (force || isPrivateHealingNeededByFlag(itemId, version.getId(), user)) {
  75       version = versioningManager.get(itemId, version);
  76       Version origVersion = version;
  77       if (version.getStatus() == VersionStatus.Certified) {
  78         Optional<Version> newVersion = createNewVersion(itemId, version);
  79         if (!newVersion.isPresent()) {
  80           // do NOT turn off flag here (in thought of saving version calculate performance next
  81           // time) because maybe next time the next version will be available (due to deletion of
  82           // the taken one)
  83           return Optional.empty();
  84         }
  85         version = newVersion.get();
  86       }
  87
  88       doHeal(itemId, version, origVersion, itemType, user, force);
  89       return Optional.of(version);
  90     }
  91     return Optional.empty();
  92   }
  93
  94   private void doHeal(String itemId, Version version, Version origVersion,
  95                       ItemType itemType, String user, boolean force) {
  96     Optional<String> privateFailureMessages =
  97         healPrivate(itemId, version, origVersion, getItemHealers(itemType), user);
  98
  99     Optional<String> publicFailureMessages =
 100         force || origVersion.getStatus() == VersionStatus.Certified ||
 101             isPublicHealingNeededByFlag(itemId, origVersion.getId())
 102             ? healPublic(itemId, version, origVersion, getItemHealers(itemType), user)
 103             : Optional.empty();
 104
 105     if (privateFailureMessages.isPresent() || publicFailureMessages.isPresent()) {
 106       throw new RuntimeException(
 107           publicFailureMessages.orElse("") + " " + privateFailureMessages.orElse(""));
 108     }
 109   }
 110
 111   private Optional<String> healPrivate(String itemId, Version version, Version origVersion,
 112                                        Map<String, Map<String, String>> itemHealers, String user) {
 113     if (origVersion.getStatus() != VersionStatus.Certified) {
 114       itemHealers.remove(HealerType.structure.name());
 115     }
 116
 117     Optional<String> privateHealingFailureMessages = executeHealers(itemId, version, itemHealers);
 118     markAsHealed(itemId, origVersion.getId(), user);
 119     return privateHealingFailureMessages;
 120   }
 121
 122   private Optional<String> healPublic(String itemId, Version version, Version origVersion,
 123                                       Map<String, Map<String, String>> itemHealers, String user) {
 124     Optional<String> healingFailureMessages = origVersion.getStatus() == VersionStatus.Certified
 125         ? Optional.empty()
 126         : healPublic(itemId, version, itemHealers, user);
 127
 128     markAsHealed(itemId, origVersion.getId(), PUBLIC_USER);
 129     return healingFailureMessages;
 130   }
 131
 132   private Optional<String> healPublic(String itemId, Version version,
 133                                       Map<String, Map<String, String>> itemHealers, String user) {
 134     SessionContextProviderFactory.getInstance().createInterface()
 135         .create(user + HEALING_USER_SUFFIX);
 136
 137     versioningManager.sync(itemId, version);
 138
 139     Optional<String> healingFailureMessages = executeHealers(itemId, version, itemHealers);
 140     Version publicVersion = versioningManager.get(itemId, version);
 141
 142     if (Objects.nonNull(publicVersion.getState()) && publicVersion.getState().isDirty()) {
 143       versioningManager.publish(itemId, version, "Healing vsp");
 144     }
 145
 146     SessionContextProviderFactory.getInstance().createInterface().create(user);
 147     return healingFailureMessages;
 148   }
 149
 150   private Optional<Version> createNewVersion(String itemId, Version version) {
 151     Version newVersion = new Version();
 152     newVersion.setBaseId(version.getId());
 153     try {
 154       return Optional.of(versioningManager.create(itemId, newVersion, VersionCreationMethod.major));
 155     } catch (Exception e) {
 156       return Optional.empty();
 157     }
 158   }
 159
 160   @Override
 161   public Object heal(String itemId, Version version, HealerType healerType, HealCode code,
 162                      ItemType itemType) {
 163     String healerClassName = getItemHealers(itemType).get(healerType.name()).get(code.name());
 164     ArrayList<String> healingFailureMessages = new ArrayList<>();
 165
 166     Object result = executeHealer(itemId, version, healerClassName, healingFailureMessages);
 167
 168     if (!healingFailureMessages.isEmpty()) {
 169       throw new RuntimeException(CommonMethods.listToSeparatedString(healingFailureMessages, '\n'));
 170     }
 171     return result;
 172   }
 173
 174   private Optional<String> executeHealers(String itemId, Version version,
 175                                           Map<String, Map<String, String>> itemHealers) {
 176     List<String> healers = itemHealers.values().stream()
 177         .map(Map::values)
 178         .flatMap(Collection::stream)
 179         .collect(Collectors.toList());
 180
 181     List<String> healingFailureMessages = new ArrayList<>();
 182     for (String implClassName : healers) {
 183       executeHealer(itemId, version, implClassName, healingFailureMessages);
 184     }
 185
 186     return healingFailureMessages.isEmpty()
 187         ? Optional.empty()
 188         : Optional.of(CommonMethods.listToSeparatedString(healingFailureMessages, '\n'));
 189   }
 190
 191
 192   private Object executeHealer(String itemId, Version version, String healerClassName,
 193                                List<String> healingFailureMessages) {
 194     Healer healer;
 195     try {
 196       healer = getHealerImplInstance(healerClassName);
 197     } catch (Exception e) {
 198       healingFailureMessages
 199           .add(String.format(Messages.CANT_LOAD_HEALING_CLASS.getErrorMessage(),
 200               healerClassName));
 201       return null;
 202     }
 203
 204     try {
 205       return healer.heal(itemId, version);
 206     } catch (Exception e) {
 207       healingFailureMessages.add(e.getMessage() + " ,healer name :" + healerClassName);
 208     }
 209     return null;
 210   }
 211
 212   private boolean isPrivateHealingNeededByFlag(String itemId, String version, String user) {
 213     Optional<Boolean> userHealingFlag = getHealingFlag(itemId, version, user);
 214     return userHealingFlag.isPresent()
 215         ? userHealingFlag.get()
 216         : isPublicHealingNeededByFlag(itemId, version);
 217   }
 218
 219   private boolean isPublicHealingNeededByFlag(String itemId, String versionId) {
 220     Optional<Boolean> publicHealingFlag = getHealingFlag(itemId, versionId, PUBLIC_USER);
 221     return publicHealingFlag.isPresent() && publicHealingFlag.get();
 222   }
 223
 224   private Optional<Boolean> getHealingFlag(String itemId, String version, String user) {
 225     return healingDao.getItemHealingFlag(user, itemId, version);
 226   }
 227
 228   private void markAsHealed(String itemId, String versionId, String user) {
 229     healingDao.setItemHealingFlag(false, user, itemId, versionId);
 230   }
 231
 232   private Map<String, Map<String, String>> getItemHealers(ItemType itemType) {
 233     // TODO: 11/29/2017 create objects to hold this configuration +
 234     // load once from the json file and use the relevant healers (by itemType, healerType) as needed.
 235     Map healingConfig = FileUtils
 236         .readViaInputStream(HEALERS_BY_ENTITY_TYPE_FILE,
 237             stream -> JsonUtil.json2Object(stream, Map.class));
 238     return (Map<String, Map<String, String>>) healingConfig.get(itemType.name());
 239   }
 240
 241   private Healer getHealerImplInstance(String implClassName)
 242       throws InstantiationException, IllegalAccessException, InvocationTargetException,
 243       NoSuchMethodException, ClassNotFoundException {
 244     return (Healer) Class.forName(implClassName).getConstructor().newInstance();
 245   }
 246
 247   private String getUser() {
 248     return SessionContextProviderFactory.getInstance().createInterface().get().getUser()
 249         .getUserId();
 250   }
 251 }