/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.ambari.server.checks;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.ambari.server.AmbariException;
import org.apache.ambari.server.controller.PrereqCheckRequest;
import org.apache.ambari.server.orm.entities.RepositoryVersionEntity;
import org.apache.ambari.server.state.Cluster;
import org.apache.ambari.server.state.Clusters;
import org.apache.ambari.server.state.Config;
import org.apache.ambari.server.state.ConfigHelper;
import org.apache.ambari.server.state.DesiredConfig;
import org.apache.ambari.server.state.stack.PrereqCheckStatus;
import org.apache.ambari.server.state.stack.PrerequisiteCheck;
import org.apache.ambari.server.state.stack.upgrade.UpgradeType;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
/**
* Checks for properties that contain hardcoded CURRENT hdp version string.
* Presence of such properties usually means that some paths are hardcoded to
* point to concrete version of HDP, instead of pointing to current symlink.
* That is a potential problem when doing stack update.
*/
@Singleton
@UpgradeCheck(
order = 98.0f,
required = { UpgradeType.ROLLING, UpgradeType.NON_ROLLING, UpgradeType.HOST_ORDERED })
public class HardcodedStackVersionPropertiesCheck extends AbstractCheckDescriptor {
@Inject
private Provider<Clusters> m_clusters;
@Inject
private Provider<ConfigHelper> m_config_helper_provider;
public HardcodedStackVersionPropertiesCheck() {
super(CheckDescription.HARDCODED_STACK_VERSION_PROPERTIES_CHECK);
}
@Override
public void perform(PrerequisiteCheck prerequisiteCheck, PrereqCheckRequest request)
throws AmbariException {
String stackName = request.getTargetStackId().getStackName();
RepositoryVersionEntity rve = repositoryVersionDaoProvider.get().
findByStackNameAndVersion(stackName, request.getRepositoryVersion());
Cluster cluster = m_clusters.get().getCluster(request.getClusterName());
String currentHdpVersion = cluster.getCurrentClusterVersion().getRepositoryVersion().getVersion();
Map<String, DesiredConfig> desiredConfigs = cluster.getDesiredConfigs();
Set<String> failures = new HashSet<>();
Pattern searchPattern = getHardcodeSearchPattern(currentHdpVersion);
for (Entry<String, DesiredConfig> configEntry : desiredConfigs.entrySet()) {
String configType = configEntry.getKey();
DesiredConfig desiredConfig = configEntry.getValue();
final Config config = cluster.getConfig(configType, desiredConfig.getTag());
Map<String, String> properties = config.getProperties();
for (Entry<String, String> property : properties.entrySet()) {
if (stringContainsVersionHardcode(property.getValue(), searchPattern)) {
failures.add(String.format(" %s/%s",
configType, property.getKey()));
}
}
if (failures.size() > 0) {
prerequisiteCheck.setStatus(PrereqCheckStatus.WARNING);
String failReason = getFailReason(prerequisiteCheck, request);
prerequisiteCheck.setFailReason(String.format(failReason, currentHdpVersion));
prerequisiteCheck.setFailedOn(new LinkedHashSet<>(failures));
} else {
prerequisiteCheck.setStatus(PrereqCheckStatus.PASS);
}
}
}
/**
* Returns pattern that looks for hdp version hardcoded occurences, except
* those that start with "-Dhdp.version=" string
* @param hdpVersion hdp version to search for
* @return compiled pattern
*/
public static Pattern getHardcodeSearchPattern(String hdpVersion) {
// Only things like -Dhdp.version=2.3.4.0-1234 are allowed at hardcode
return Pattern.compile("(?<!-Dhdp\\.version=)" + hdpVersion.replace(".", "\\."));
}
/**
* Looks for search pattern in string
* @param string string to look into
* @param searchPattern compiled regex
* @return true if string contains pattern
*/
public static boolean stringContainsVersionHardcode(String string, Pattern searchPattern) {
Matcher matcher = searchPattern.matcher(string);
return matcher.find();
}
}