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