4f640dff29012a61959e6f55a32dc24bd4d54cca
[sdc.git] /
1 /*
2  * Copyright © 2016-2017 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.openecomp.sdc.validation.impl.validators.namingconvention;
18
19 import static java.util.Objects.nonNull;
20
21 import java.util.ArrayList;
22 import java.util.Arrays;
23 import java.util.Collection;
24 import java.util.Comparator;
25 import java.util.HashMap;
26 import java.util.LinkedList;
27 import java.util.List;
28 import java.util.Map;
29 import java.util.Objects;
30 import java.util.TreeMap;
31
32 import org.apache.commons.collections4.MapUtils;
33 import org.apache.commons.lang3.tuple.ImmutablePair;
34 import org.apache.commons.lang3.tuple.Pair;
35 import org.openecomp.core.validation.ErrorMessageCode;
36 import org.openecomp.core.validation.errors.ErrorMessagesFormatBuilder;
37 import org.openecomp.core.validation.types.GlobalValidationContext;
38 import org.openecomp.sdc.common.errors.Messages;
39 import org.openecomp.sdc.datatypes.error.ErrorLevel;
40 import org.openecomp.sdc.heat.datatypes.DefinedHeatParameterTypes;
41 import org.openecomp.sdc.heat.datatypes.model.Environment;
42 import org.openecomp.sdc.heat.datatypes.model.HeatOrchestrationTemplate;
43 import org.openecomp.sdc.heat.datatypes.model.HeatResourcesTypes;
44 import org.openecomp.sdc.heat.datatypes.model.Resource;
45 import org.openecomp.sdc.heat.datatypes.model.ResourceReferenceFunctions;
46 import org.openecomp.sdc.heat.services.HeatStructureUtil;
47 import org.openecomp.sdc.validation.ResourceValidator;
48 import org.openecomp.sdc.validation.ValidationContext;
49 import org.openecomp.sdc.validation.type.NamingConventionValidationContext;
50 import org.openecomp.sdc.validation.util.ValidationUtil;
51
52 public class NovaServerNamingConventionGuideLineValidator implements ResourceValidator {
53   private static final String AVAILABILITY_ZONE = "availability_zone";
54   private static final String SERVER = "Server";
55   private static final ErrorMessageCode ERROR_CODE_NNS1 = new ErrorMessageCode("NNS1");
56   private static final ErrorMessageCode ERROR_CODE_NNS2 = new ErrorMessageCode("NNS2");
57   private static final ErrorMessageCode ERROR_CODE_NNS3 = new ErrorMessageCode("NNS3");
58   private static final ErrorMessageCode ERROR_CODE_NNS4 = new ErrorMessageCode("NNS4");
59   private static final ErrorMessageCode ERROR_CODE_NNS5 = new ErrorMessageCode("NNS5");
60   private static final ErrorMessageCode ERROR_CODE_NNS6 = new ErrorMessageCode("NNS6");
61   private static final ErrorMessageCode ERROR_CODE_NNS7 = new ErrorMessageCode("NNS7");
62   private static final ErrorMessageCode ERROR_CODE_NNS8 = new ErrorMessageCode("NNS8");
63   private static final ErrorMessageCode ERROR_CODE_NNS9 = new ErrorMessageCode("NNS9");
64   private static final ErrorMessageCode ERROR_CODE_NNS10 = new ErrorMessageCode("NNS10");
65   private static final ErrorMessageCode ERROR_CODE_NNS11 = new ErrorMessageCode("NNS11");
66   private static final ErrorMessageCode ERROR_CODE_NNS12 = new ErrorMessageCode("NNS12");
67   private static final ErrorMessageCode ERROR_CODE_NNS13 = new ErrorMessageCode("NNS13");
68   private static final ErrorMessageCode ERROR_CODE_NNS14 = new ErrorMessageCode("NNS14");
69
70   @Override
71   public void validate(String fileName, Map.Entry<String, Resource> resourceEntry,
72                        GlobalValidationContext globalContext, ValidationContext validationContext) {
73
74     NamingConventionValidationContext namingConventionValidationContext =
75             (NamingConventionValidationContext)validationContext;
76     validateHeatNovaResource(fileName, namingConventionValidationContext.getEnvFileName(),
77             namingConventionValidationContext.getHeatOrchestrationTemplate(),
78             globalContext);
79   }
80
81   private void validateHeatNovaResource(String fileName, String envFileName,
82                                         HeatOrchestrationTemplate heatOrchestrationTemplate,
83                                         GlobalValidationContext globalContext) {
84     Map<String, String> uniqueResourcePortNetworkRole = new HashMap<>();
85     //if no resources exist return
86     if (MapUtils.isEmpty(heatOrchestrationTemplate.getResources())) {
87       return;
88     }
89
90     heatOrchestrationTemplate
91             .getResources()
92             .entrySet()
93             .stream()
94             .filter(entry -> entry.getValue().getType()
95                     .equals(HeatResourcesTypes.NOVA_SERVER_RESOURCE_TYPE.getHeatResource()))
96             .forEach( entry -> validateNovaServerResourceType(entry.getKey(), fileName, envFileName,
97                     entry, uniqueResourcePortNetworkRole, heatOrchestrationTemplate, globalContext));
98   }
99
100   private void validateNovaServerResourceType(String resourceId, String fileName,
101                                               String envFileName,
102                                               Map.Entry<String, Resource> resourceEntry,
103                                               Map<String, String> uniqueResourcePortNetworkRole,
104                                               HeatOrchestrationTemplate heatOrchestrationTemplate,
105                                               GlobalValidationContext globalContext) {
106     validateNovaServerResourceMetaData(fileName, resourceId,
107             heatOrchestrationTemplate.getResources().get(resourceId), globalContext);
108     validateNovaServerResourceNetworkUniqueRole(fileName, resourceId, uniqueResourcePortNetworkRole,
109             heatOrchestrationTemplate, globalContext);
110     validateAvailabilityZoneName(fileName, resourceEntry, globalContext);
111     validateNovaServerNameImageAndFlavor(fileName, envFileName, resourceEntry, globalContext);
112   }
113
114   @SuppressWarnings("unchecked")
115   private void validateNovaServerResourceMetaData(String fileName, String resourceId,
116                                                   Resource resource,
117                                                   GlobalValidationContext globalValidationContext) {
118     Map<String, Object> novaServerProp = resource.getProperties();
119     Object novaServerPropMetadata;
120     if (MapUtils.isNotEmpty(novaServerProp)) {
121       novaServerPropMetadata = novaServerProp.get("metadata");
122       if (novaServerPropMetadata == null) {
123         globalValidationContext.addMessage(
124                 fileName,
125                 ErrorLevel.WARNING,
126                 ErrorMessagesFormatBuilder
127                         .getErrorWithParameters(
128                                 ERROR_CODE_NNS1, Messages.MISSING_NOVA_SERVER_METADATA.getErrorMessage(),
129                                 resourceId));
130       } else if (novaServerPropMetadata instanceof Map) {
131         TreeMap<String, Object> propertyMap = new TreeMap((Comparator<String>) String::compareToIgnoreCase);
132         propertyMap.putAll((Map) novaServerPropMetadata);
133         if (!propertyMap.containsKey("vf_module_id")) {
134           globalValidationContext.addMessage(
135                   fileName,
136                   ErrorLevel.WARNING,
137                   ErrorMessagesFormatBuilder.getErrorWithParameters(
138                           ERROR_CODE_NNS2, Messages.MISSING_NOVA_SERVER_VF_MODULE_ID.getErrorMessage(),
139                           resourceId));
140         }
141         if (!propertyMap.containsKey("vnf_id")) {
142           globalValidationContext.addMessage(
143                   fileName, ErrorLevel.WARNING,
144                   ErrorMessagesFormatBuilder
145                           .getErrorWithParameters(
146                                   ERROR_CODE_NNS3, Messages.MISSING_NOVA_SERVER_VNF_ID.getErrorMessage(),
147                                   resourceId));
148         }
149       }
150     }
151   }
152
153   private void validateNovaServerResourceNetworkUniqueRole(String fileName, String resourceId,
154                                                            Map<String, String> uniqueResourcePortNetworkRole,
155                                                            HeatOrchestrationTemplate heatOrchestrationTemplate,
156                                                            GlobalValidationContext globalValidationContext) {
157       if (MapUtils.isEmpty(heatOrchestrationTemplate.getResources().get(resourceId).getProperties())) {
158           return;
159       }
160     Object propertyNetworkValue =
161             heatOrchestrationTemplate.getResources().get(resourceId).getProperties().get("networks");
162     if (propertyNetworkValue != null && propertyNetworkValue instanceof List) {
163       List<String> portResourceIdList =
164               getNovaNetworkPortResourceList(fileName, (List) propertyNetworkValue,
165                       globalValidationContext);
166       for (String portResourceId : portResourceIdList) {
167         Resource portResource = heatOrchestrationTemplate.getResources().get(portResourceId);
168
169         if (portResource != null && portResource.getType()
170                 .equals(HeatResourcesTypes.NEUTRON_PORT_RESOURCE_TYPE.getHeatResource())) {
171           validateUniqueResourcePortNetworkRole(fileName, resourceId,
172                   uniqueResourcePortNetworkRole, globalValidationContext,
173                   portResourceId, portResource);
174         }
175       }
176     }
177   }
178
179   private void validateUniqueResourcePortNetworkRole(String fileName, String resourceId,
180                                       Map<String, String> uniqueResourcePortNetworkRole,
181                                       GlobalValidationContext globalValidationContext,
182                                       String portResourceId, Resource portResource) {
183     String role = null;
184     Object network;
185     Map portNetwork =
186             getPortNetwork(fileName, resourceId, portResource, globalValidationContext);
187     if (Objects.nonNull(portNetwork)) {
188       network = portNetwork.get("get_param");
189       if (Objects.nonNull(network)) {
190         if (network instanceof String ){
191           role = getNetworkRole((String)network);
192         }else if (network instanceof List){
193           role = getNetworkRole((String)((List) network).get(0));
194         }
195         if (role != null && uniqueResourcePortNetworkRole.containsKey(role)) {
196           globalValidationContext.addMessage(
197                   fileName,
198                   ErrorLevel.WARNING,
199                   ErrorMessagesFormatBuilder.getErrorWithParameters(
200                           ERROR_CODE_NNS12, Messages.RESOURCE_CONNECTED_TO_TWO_EXTERNAL_NETWORKS_WITH_SAME_ROLE
201                                   .getErrorMessage(), resourceId, role));
202         } else {
203           uniqueResourcePortNetworkRole.put(role, portResourceId);
204         }
205       }
206     }
207   }
208
209   private List<String> getNovaNetworkPortResourceList(String filename, List propertyNetworkValue,
210                                                       GlobalValidationContext globalContext) {
211     globalContext.setMessageCode(ERROR_CODE_NNS14);
212     List<String> portResourceIdList = new ArrayList<>();
213     for (Object propValue : propertyNetworkValue) {
214       Object portPropValue = ((Map) propValue).get("port");
215       Collection<String> portResourceIds = HeatStructureUtil
216               .getReferencedValuesByFunctionName(filename, "get_resource", portPropValue,
217                       globalContext);
218       if (portResourceIds != null) {
219         portResourceIdList.addAll(portResourceIds);
220       }
221     }
222
223     return portResourceIdList;
224   }
225
226   private String getNetworkRole(String network) {
227     if (network == null) {
228       return null;
229     }
230     if (network.contains("_net_id")) {
231       return network.substring(0, network.indexOf("_net_id"));
232     } else if (network.contains("_net_name")) {
233       return network.substring(0, network.indexOf("_net_name"));
234     } else if (network.contains("_net_fqdn")) {
235       return network.substring(0, network.indexOf("_net_fqdn"));
236     }
237     return null;
238   }
239
240   private Map getPortNetwork(String fileName, String resourceId, Resource portResource,
241                              GlobalValidationContext globalValidationContext) {
242     Object portNetwork = portResource.getProperties().get("network_id");
243     if (portNetwork == null) {
244       portNetwork = portResource.getProperties().get("network");
245     }
246     if (!(portNetwork instanceof Map)) {
247       globalValidationContext.addMessage(
248               fileName,
249               ErrorLevel.WARNING,
250               ErrorMessagesFormatBuilder
251                       .getErrorWithParameters(
252                               ERROR_CODE_NNS4, Messages.MISSING_GET_PARAM.getErrorMessage(),
253                               "network or network_id", resourceId));
254       return null;
255     }
256     return (Map) portNetwork;
257   }
258
259   private void validateAvailabilityZoneName(String fileName,
260                                             Map.Entry<String, Resource> resourceEntry,
261                                             GlobalValidationContext globalContext) {
262     String[] regexList = new String[]{"availability_zone_(\\d+)"};
263
264     if (MapUtils.isEmpty(resourceEntry.getValue().getProperties())) {
265       return;
266     }
267
268     Object availabilityZoneMap =  resourceEntry.getValue().getProperties()
269             .get(AVAILABILITY_ZONE);
270
271     if (nonNull(availabilityZoneMap)) {
272       if (availabilityZoneMap instanceof Map) {
273         String availabilityZoneName = ValidationUtil.getWantedNameFromPropertyValueGetParam
274                 (availabilityZoneMap);
275
276           if (availabilityZoneName != null && !ValidationUtil
277                   .evalPattern(availabilityZoneName, regexList)) {
278             globalContext.addMessage(
279                     fileName,
280                     ErrorLevel.WARNING, ErrorMessagesFormatBuilder.getErrorWithParameters(
281                             ERROR_CODE_NNS5, Messages.PARAMETER_NAME_NOT_ALIGNED_WITH_GUIDELINES.getErrorMessage(),
282                             ValidationUtil.getMessagePartAccordingToResourceType(resourceEntry),
283                             "Availability Zone", availabilityZoneName, resourceEntry.getKey()));
284           }
285       } else {
286         globalContext.addMessage(
287                 fileName,
288                 ErrorLevel.WARNING, ErrorMessagesFormatBuilder
289                         .getErrorWithParameters(
290                                 ERROR_CODE_NNS6, Messages.MISSING_GET_PARAM.getErrorMessage(),
291                                 AVAILABILITY_ZONE, resourceEntry.getKey()));
292       }
293     }
294   }
295
296   private void validateNovaServerNameImageAndFlavor(String fileName, String envFileName,
297                                                     Map.Entry<String, Resource> resourceEntry,
298                                                     GlobalValidationContext globalContext) {
299     String novaName =
300             validateNovaServerNamingConvention(fileName, envFileName, resourceEntry, globalContext);
301     Map<String, String> legalNovaNamingConventionMap =
302             validateImageAndFlavorFromNovaServer(fileName, resourceEntry, globalContext);
303
304     if (Objects.nonNull(novaName)) {
305       legalNovaNamingConventionMap.put("name", novaName);
306     }
307
308     if (legalNovaNamingConventionMap.keySet().size() > 1) {
309       validateNovaServerNameImageAndFlavorSync(fileName, resourceEntry,
310               legalNovaNamingConventionMap, globalContext);
311     }
312   }
313
314   private String validateNovaServerNamingConvention(String fileName, String envFileName,
315                                                     Map.Entry<String, Resource> resourceEntry,
316                                                     GlobalValidationContext globalContext) {
317     if (MapUtils.isEmpty(resourceEntry.getValue().getProperties())) {
318       return null;
319     }
320     return checkIfNovaNameByGuidelines(fileName, envFileName, resourceEntry, globalContext);
321   }
322
323   private Map<String, String> validateImageAndFlavorFromNovaServer(String fileName,
324                                                                    Map.Entry<String, Resource> resourceEntry,
325                                                                    GlobalValidationContext globalContext) {
326       Map<String, String> imageAndFlavorLegalNames = new HashMap<>();
327
328     if (MapUtils.isEmpty(resourceEntry.getValue().getProperties())) {
329       return imageAndFlavorLegalNames;
330     }
331
332     Pair<String, String> imagePair = new ImmutablePair<>("image", ".*_image_name");
333     Pair<String, String> flavorPair = new ImmutablePair<>("flavor", ".*_flavor_name");
334     List<Pair<String, String>> imageFlavorPairs = Arrays.asList(imagePair, flavorPair);
335     Map<String, Object> propertiesMap = resourceEntry.getValue().getProperties();
336
337     for (Pair<String, String> imageOrFlavor : imageFlavorPairs) {
338       boolean isErrorInImageOrFlavor =
339               isErrorExistWhenValidatingImageOrFlavorNames(fileName, imageOrFlavor, resourceEntry,
340                       propertiesMap, globalContext);
341       if (!isErrorInImageOrFlavor) {
342         Object nameValue = propertiesMap.get(imageOrFlavor.getKey());
343         String imageOrFlavorName = ValidationUtil.getWantedNameFromPropertyValueGetParam
344                 (nameValue);
345         imageAndFlavorLegalNames.put(imageOrFlavor.getKey(), imageOrFlavorName);
346       }
347     }
348     return imageAndFlavorLegalNames;
349   }
350
351   private String checkIfNovaNameByGuidelines(String fileName, String envFileName,
352                                              Map.Entry<String, Resource> resourceEntry,
353                                              GlobalValidationContext globalContext) {
354     if (MapUtils.isEmpty(resourceEntry.getValue().getProperties())) {
355       return null;
356     }
357     Object novaNameGetParam = getNovaServerName(resourceEntry);
358     String novaName = null;
359     if (nonNull(novaNameGetParam)) {
360       novaName =
361               checkNovaNameGetParamValueMap(fileName, novaNameGetParam, resourceEntry, globalContext);
362       checkIfNovaNameParameterInEnvIsStringOrList(fileName, envFileName, novaName, resourceEntry,
363               globalContext);
364     } else {
365       globalContext.addMessage(
366               fileName,
367               ErrorLevel.WARNING, ErrorMessagesFormatBuilder
368                       .getErrorWithParameters(
369                               ERROR_CODE_NNS7, Messages.MISSING_GET_PARAM.getErrorMessage(),
370                               "nova server name", resourceEntry.getKey()));
371     }
372
373     return novaName;
374   }
375
376   private boolean isErrorExistWhenValidatingImageOrFlavorNames(String fileName,
377                                                                Pair<String, String> propertyNameAndRegex,
378                                                                Map.Entry<String, Resource> resourceEntry,
379                                                                Map<String, Object> propertiesMap,
380                                                                GlobalValidationContext globalContext) {
381     String propertyName = propertyNameAndRegex.getKey();
382     Object nameValue = propertiesMap.get(propertyName);
383     String[] regexList = new String[]{propertyNameAndRegex.getValue()};
384
385
386     if (nonNull(nameValue)) {
387       if (nameValue instanceof Map) {
388         globalContext.setMessageCode(ERROR_CODE_NNS13);
389         if (ValidationUtil.validateMapPropertyValue(fileName, resourceEntry, globalContext,
390                 propertyName,
391                 nameValue, regexList)) {
392           return true;
393         }
394       } else {
395         globalContext.addMessage(
396                 fileName,
397                 ErrorLevel.WARNING, ErrorMessagesFormatBuilder
398                         .getErrorWithParameters(
399                                 ERROR_CODE_NNS8, Messages.MISSING_GET_PARAM.getErrorMessage(),
400                                 propertyName, resourceEntry.getKey()));
401         return true;
402       }
403
404       return false;
405     }
406     return false;
407   }
408
409   private Object getNovaServerName(Map.Entry<String, Resource> resourceEntry) {
410     Object novaServerName = resourceEntry.getValue().getProperties().get("name");
411     Map novaNameMap;
412       if (nonNull(novaServerName) && novaServerName instanceof Map) {
413         novaNameMap = (Map) novaServerName;
414         return novaNameMap.get(ResourceReferenceFunctions.GET_PARAM.getFunction());
415       }
416
417     return null;
418   }
419
420   @SuppressWarnings("unchecked")
421   private String checkNovaNameGetParamValueMap(String fileName, Object getParamValue,
422                                                Map.Entry<String, Resource> resourceEntry,
423                                                GlobalValidationContext globalContext) {
424     if (getParamValue instanceof List) {
425       List<Object> getParamNameList = (List) getParamValue;
426       String[] regexName = new String[]{".*_names"};
427       return isNovaNameAsListLegal(fileName, regexName, getParamNameList, resourceEntry,
428               globalContext);
429     } else if (getParamValue instanceof String) {
430       String[] regexName = new String[]{".*_name_(\\d+)"};
431       return isNovaNameAsStringLegal(fileName, (String) getParamValue, regexName, resourceEntry,
432               globalContext);
433     }
434
435     return null;
436   }
437
438   private void checkIfNovaNameParameterInEnvIsStringOrList(String fileName,
439                                                            String envFileName,
440                                                            String novaServerName,
441                                                            Map.Entry<String, Resource> resourceEntry,
442                                                            GlobalValidationContext globalContext) {
443     if (nonNull(envFileName)) {
444       Environment environment = ValidationUtil.validateEnvContent(envFileName, globalContext);
445
446       if (environment != null && MapUtils.isNotEmpty(environment.getParameters())) {
447         Object novaServerNameEnvValue = environment.getParameters()
448                         .get(novaServerName);
449           if (Objects.nonNull(novaServerNameEnvValue) && !DefinedHeatParameterTypes
450                   .isNovaServerEnvValueIsFromRightType(novaServerNameEnvValue)) {
451             globalContext.addMessage(
452                     fileName,
453                     ErrorLevel.WARNING, ErrorMessagesFormatBuilder.getErrorWithParameters(
454                             ERROR_CODE_NNS9, Messages.PARAMETER_NAME_NOT_ALIGNED_WITH_GUIDELINES.getErrorMessage(),
455                             SERVER, "Name",
456                             novaServerNameEnvValue.toString(), resourceEntry.getKey()));
457           }
458       }
459     }
460   }
461
462   private String isNovaNameAsListLegal(String fileName,
463                                        String[] regexName,
464                                        List<Object> getParamNameList,
465                                        Map.Entry<String, Resource> resourceEntry,
466                                        GlobalValidationContext globalContext) {
467
468     if (getParamNameList.size() != 2 || !ValidationUtil.evalPattern(getParamNameList.get(0),
469             regexName)) {
470       globalContext.addMessage(
471               fileName,
472               ErrorLevel.WARNING,
473               ErrorMessagesFormatBuilder.getErrorWithParameters(
474                       ERROR_CODE_NNS10, Messages.PARAMETER_NAME_NOT_ALIGNED_WITH_GUIDELINES.getErrorMessage(),
475                       SERVER,
476                       "name", getParamNameList.toString(), resourceEntry.getKey()));
477       return null;
478     }
479
480     return (String) getParamNameList.get(0);
481   }
482
483   private String isNovaNameAsStringLegal(String fileName,
484                                          String novaName,
485                                          String[] regexName,
486                                          Map.Entry<String, Resource> resourceEntry,
487                                          GlobalValidationContext globalContext) {
488     if (!ValidationUtil.evalPattern(novaName, regexName)) {
489       globalContext.addMessage(
490               fileName,
491               ErrorLevel.WARNING,
492               ErrorMessagesFormatBuilder.getErrorWithParameters(
493                       ERROR_CODE_NNS10, Messages.PARAMETER_NAME_NOT_ALIGNED_WITH_GUIDELINES.getErrorMessage(),
494                       SERVER,
495                       "name", novaName, resourceEntry.getKey()));
496       return null;
497     }
498     return novaName;
499   }
500
501   private void validateNovaServerNameImageAndFlavorSync(String fileName,
502                                                         Map.Entry<String, Resource> resourceEntry,
503                                                         Map<String, String> legalNovaNamingConventionNames,
504                                                         GlobalValidationContext globalContext) {
505     List<String> vmNames = new LinkedList<>();
506
507     for (Map.Entry<String, String> nameEntry : legalNovaNamingConventionNames.entrySet()) {
508       vmNames.add(getVmName(nameEntry.getValue(), nameEntry.getKey()));
509     }
510
511     vmNames.removeIf(Objects::isNull);
512
513     if (!isVmNameSync(vmNames)) {
514       globalContext.addMessage(
515               fileName,
516               ErrorLevel.WARNING,
517               ErrorMessagesFormatBuilder.getErrorWithParameters(
518                       ERROR_CODE_NNS11, Messages.NOVA_NAME_IMAGE_FLAVOR_NOT_CONSISTENT.getErrorMessage(),
519                       resourceEntry.getKey()));
520     }
521   }
522
523   private String getVmName(String nameToGetVmNameFrom, String stringToGetIndexOf) {
524     int vmIndex =
525             nameToGetVmNameFrom == null ? -1 : nameToGetVmNameFrom.indexOf(stringToGetIndexOf);
526     String vmName = null;
527     if (nameToGetVmNameFrom != null) {
528       vmName = vmIndex < 0 ? null
529               : trimNonAlphaNumericCharactersFromEndOfString(nameToGetVmNameFrom.substring(0, vmIndex));
530     }
531     return vmName;
532   }
533
534   private boolean isVmNameSync(List<String> namesToCompare) {
535     int size = namesToCompare.size();
536     for (int i = 0; i < size - 1; i++) {
537       if (!namesToCompare.get(i).equals(namesToCompare.get(i + 1))) {
538         return false;
539       }
540     }
541     return true;
542   }
543
544   private String trimNonAlphaNumericCharactersFromEndOfString(String toTrim) {
545     int stringSize = toTrim.length();
546     int stringLength = stringSize - 1;
547     String[] regexList = new String[]{"[^a-zA-Z0-9]"};
548
549     while (stringLength >= 0) {
550       if (!ValidationUtil.evalPattern(String.valueOf(toTrim.charAt(stringLength)), regexList)) {
551         break;
552       }
553       stringLength--;
554     }
555
556     return toTrim.substring(0, stringLength + 1);
557   }
558 }