org.kuali.common.util.maven.MavenUtils Maven / Gradle / Ivy
/**
* Copyright 2010-2013 The Kuali Foundation
*
* Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
*
* 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.kuali.common.util.maven;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Properties;
import org.apache.commons.lang3.StringUtils;
import org.kuali.common.util.CollectionUtils;
import org.kuali.common.util.Project;
import org.kuali.common.util.ProjectUtils;
import org.kuali.common.util.PropertyUtils;
import org.kuali.common.util.property.PropertiesContext;
import org.kuali.common.util.property.processor.ProjectProcessor;
import org.kuali.common.util.property.processor.PropertyProcessor;
import org.kuali.common.util.property.processor.VersionProcessor;
import org.kuali.common.util.spring.PropertySourceUtils;
import org.kuali.common.util.spring.SpringUtils;
import org.kuali.common.util.spring.service.SpringContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.env.Environment;
import org.springframework.core.env.PropertySource;
/**
* Maven utilities that don't depend on Maven libraries
*/
public class MavenUtils {
private static final Logger logger = LoggerFactory.getLogger(MavenUtils.class);
public static final String POM = "pom";
public static final String PROJECT_VERSION_KEY = "project.version";
public static final String PROJECT_ENCODING_KEY = "project.encoding";
public static SpringContext getMavenizedSpringContext(Class propertySourceConfig) {
return getMavenizedSpringContext(null, propertySourceConfig);
}
/**
* Return a SpringContext that resolves placeholders using the single PropertySource
registered with propertySourceConfig
*/
public static SpringContext getMavenizedSpringContext(Properties mavenProperties, Class propertySourceConfig) {
// This PropertySource object is backed by a set of properties that has been
// 1 - fully resolved
// 2 - contains all properties needed by Spring
// 3 - contains system/environment properties where system/env properties override loaded properties
PropertySource source = SpringUtils.getSinglePropertySource(propertySourceConfig, MavenConstants.PROPERTIES_BEAN_NAME, mavenProperties);
return PropertySourceUtils.getSinglePropertySourceContext(source);
}
/**
* Add organization, group, and path properties and tokenize the version number adding properties for each token along with a boolean property indicating if this is a SNAPSHOT
* build
*/
public static void augmentProjectProperties(Properties mavenProperties) {
// Setup some processors
List processors = new ArrayList();
// Add some organization, group, and path properties
processors.add(new ProjectProcessor());
// Tokenize the version number and add properties for each token (major/minor/incremental)
// Also add a boolean property indicating if this is a SNAPSHOT build
processors.add(new VersionProcessor(Arrays.asList(PROJECT_VERSION_KEY), true));
// Process default Maven properties and add in our custom properties
PropertyUtils.process(mavenProperties, processors);
// Finish preparing the properties using the encoding from the project
String encoding = PropertyUtils.getRequiredResolvedProperty(mavenProperties, PROJECT_ENCODING_KEY);
PropertyUtils.prepareContextProperties(mavenProperties, encoding);
}
@Deprecated
public static org.kuali.common.util.property.ProjectProperties getMavenProjectProperties(Properties mavenProperties) {
Project project = ProjectUtils.getProject(mavenProperties);
PropertiesContext pc = new PropertiesContext();
pc.setProperties(mavenProperties);
org.kuali.common.util.property.ProjectProperties pp = new org.kuali.common.util.property.ProjectProperties();
pp.setProject(project);
pp.setPropertiesContext(pc);
return pp;
}
protected static List getList(Properties properties, String key) {
String csv = properties.getProperty(key);
List list = new ArrayList();
list.addAll(CollectionUtils.getTrimmedListFromCSV(csv));
return list;
}
protected static List getList(Environment env, Properties properties, String key) {
String csv = env.getProperty(key);
List list = new ArrayList();
list.addAll(CollectionUtils.getTrimmedListFromCSV(csv));
list.addAll(getList(properties, key));
return list;
}
/**
* Always return false if forceMojoExecution
is true, otherwise return true only if skip
is true or packaging
is pom.
*/
public static final boolean skip(boolean forceMojoExecution, boolean skip, String packaging) {
if (forceMojoExecution) {
logger.info("Forced mojo execution");
return false;
}
if (skip) {
logger.info("Skipping mojo execution");
return true;
}
if (StringUtils.equalsIgnoreCase(packaging, POM)) {
logger.info("Skipping mojo execution for project with packaging type '{}'", POM);
return true;
} else {
return false;
}
}
}