BI-181 - Failure to locate properties file during initialization

Jay Denebeim · Jay Denebeim · commit 43275d80a8c8 · 2014-07-22T17:53:10.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@
 build-info.ipr
 build-info.iws
 atlassian-*.xml
+/.nb-gradle/private/
diff --git a/build-info-api/src/main/java/org/jfrog/build/api/BuildInfoConfigProperties.java b/build-info-api/src/main/java/org/jfrog/build/api/BuildInfoConfigProperties.java
@@ -41,4 +41,9 @@ public interface BuildInfoConfigProperties {
 
     String ENV_VARS_EXCLUDE_PATTERNS = "envVarsExcludePatterns";
     String PROP_ENV_VARS_EXCLUDE_PATTERNS = BUILD_INFO_CONFIG_PREFIX + ENV_VARS_EXCLUDE_PATTERNS;
+
+    /**
+     * Secondary environment variable to hold the properties file name
+     */
+    String ENV_BUILDINFO_PROPFILE = "BUILDINFO_PROPFILE";
 }
diff --git a/build-info-client/src/main/java/org/jfrog/build/client/ArtifactoryClientConfiguration.java b/build-info-client/src/main/java/org/jfrog/build/client/ArtifactoryClientConfiguration.java
@@ -92,6 +92,10 @@ public Map<String, String> getAllRootConfig() {
         return rootConfig.props;
     }
 
+    public Log getLog() {
+        return root.getLog();
+    }
+
     public void persistToPropertiesFile() {
         if (StringUtils.isEmpty(getPropertiesFile())) {
             return;
diff --git a/build-info-client/src/main/java/org/jfrog/build/client/PrefixPropertyHandler.java b/build-info-client/src/main/java/org/jfrog/build/client/PrefixPropertyHandler.java
@@ -28,6 +28,10 @@ private PrefixPropertyHandler(Log log, Map<String, String> props, String prefix)
         this.prefix = prefix;
     }
 
+    public Log getLog() {
+        return log;
+    }
+
     public String getPrefix() {
         return prefix;
     }
diff --git a/build-info-extractor-gradle/src/main/groovy/org/jfrog/gradle/plugin/artifactory/extractor/GradleArtifactoryClientConfigUpdater.java b/build-info-extractor-gradle/src/main/groovy/org/jfrog/gradle/plugin/artifactory/extractor/GradleArtifactoryClientConfigUpdater.java
@@ -16,8 +16,6 @@
 
 package org.jfrog.gradle.plugin.artifactory.extractor;
 
-import com.google.common.base.Predicate;
-import com.google.common.collect.Maps;
 import org.apache.commons.lang.StringUtils;
 import org.gradle.StartParameter;
 import org.gradle.api.Project;
@@ -26,7 +24,6 @@
 import org.jfrog.build.client.ArtifactoryClientConfiguration;
 import org.jfrog.build.extractor.BuildInfoExtractorUtils;
 
-import javax.annotation.Nullable;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
@@ -64,7 +61,7 @@ public static void update(ArtifactoryClientConfiguration config, Project project
         props.putAll(BuildInfoExtractorUtils.filterStringEntries(startProps));
 
         // Then System properties
-        Properties mergedProps = BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(props);
+        Properties mergedProps = BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(props, config.info.getLog());
         // Then special buildInfo properties
         Properties buildInfoProperties =
                 BuildInfoExtractorUtils.filterDynamicProperties(mergedProps, BUILD_INFO_PROP_PREDICATE);
diff --git a/build-info-extractor-gradle/src/main/groovy/org/jfrog/gradle/plugin/artifactory/extractor/GradleBuildInfoExtractor.java b/build-info-extractor-gradle/src/main/groovy/org/jfrog/gradle/plugin/artifactory/extractor/GradleBuildInfoExtractor.java
@@ -216,7 +216,7 @@ public Build extract(Project rootProject) {
         if (clientConf.isIncludeEnvVars()) {
             Properties envProperties = new Properties();
             envProperties.putAll(clientConf.getAllProperties());
-            envProperties = BuildInfoExtractorUtils.getEnvProperties(envProperties);
+            envProperties = BuildInfoExtractorUtils.getEnvProperties(envProperties, clientConf.getLog());
             for (Map.Entry<Object, Object> envProp : envProperties.entrySet()) {
                 bib.addProperty(envProp.getKey(), envProp.getValue());
             }
@@ -291,6 +291,7 @@ public Artifact apply(GradleDeployDetails from) {
         }));
         return artifacts;
     }
+
     private List<Dependency> calculateDependencies(Project project) throws Exception {
         Set<Configuration> configurationSet = project.getConfigurations();
         List<Dependency> dependencies = newArrayList();
@@ -360,10 +361,10 @@ public IncludeExcludePredicate(Project project, IncludeExcludePatterns patterns,
         }
 
         public boolean apply(@Nullable GradleDeployDetails input) {
-            if(include){
+            if (include) {
                 return input.getProject().equals(project) && !PatternMatcher.pathConflicts(input.getDeployDetails().getArtifactPath(), patterns);
-            }else{
-                return input.getProject().equals(project) &&  PatternMatcher.pathConflicts(input.getDeployDetails().getArtifactPath(), patterns);
+            } else {
+                return input.getProject().equals(project) && PatternMatcher.pathConflicts(input.getDeployDetails().getArtifactPath(), patterns);
             }
         }
     }
diff --git a/build-info-extractor-ivy/src/main/java/org/jfrog/build/extractor/listener/ArtifactoryBuildListener.java b/build-info-extractor-ivy/src/main/java/org/jfrog/build/extractor/listener/ArtifactoryBuildListener.java
@@ -64,7 +64,7 @@ private void assertInitialized(BuildEvent event) {
     private Properties getMergedEnvAndSystemProps() {
         Properties props = new Properties();
         props.putAll(System.getenv());
-        return BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(props);
+        return BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(props, buildInfoLog);
     }
 
     public IvyBuildInfoLog getBuildInfoLog(BuildEvent event) {
@@ -327,7 +327,7 @@ private void doDeploy(BuildEvent event) {
         if (clientConf.isIncludeEnvVars()) {
             Properties envProperties = new Properties();
             envProperties.putAll(clientConf.getAllProperties());
-            envProperties = BuildInfoExtractorUtils.getEnvProperties(envProperties);
+            envProperties = BuildInfoExtractorUtils.getEnvProperties(envProperties, clientConf.getLog());
             for (Map.Entry<Object, Object> envProp : envProperties.entrySet()) {
                 builder.addProperty(envProp.getKey(), envProp.getValue());
             }
diff --git a/build-info-extractor-maven3/src/main/java/org/jfrog/build/extractor/maven/BuildInfoRecorder.java b/build-info-extractor-maven3/src/main/java/org/jfrog/build/extractor/maven/BuildInfoRecorder.java
@@ -103,8 +103,7 @@ public void projectDiscoveryStarted(ExecutionEvent event) {
 
     @Override
     public void sessionStarted(ExecutionEvent event) {
-        try
-        {
+        try {
             logger.info("Initializing Artifactory Build-Info Recording");
             buildInfoBuilder = buildInfoModelPropertyResolver.resolveProperties(event, conf);
             deployableArtifactBuilderMap = Maps.newHashMap();
@@ -119,12 +118,10 @@ public void sessionStarted(ExecutionEvent event) {
             if (wrappedListener != null) {
                 wrappedListener.sessionStarted(event);
             }
-        }
-        catch ( Throwable t )
-        {
+        } catch (Throwable t) {
             String message = getClass().getName() + ".sessionStarted() listener has failed: ";
-            logger.error( message, t );
-            throw new RuntimeException( message, t );
+            logger.error(message, t);
+            throw new RuntimeException(message, t);
         }
     }
 
@@ -135,20 +132,17 @@ public void sessionEnded(ExecutionEvent event) {
             if (build != null) {
                 File basedir = event.getSession().getTopLevelProject().getBasedir();
                 conf.persistToPropertiesFile();
-                buildDeploymentHelper.deploy(build, conf, deployableArtifactBuilderMap, projectHasTestFailures,basedir);
+                buildDeploymentHelper.deploy(build, conf, deployableArtifactBuilderMap, projectHasTestFailures, basedir);
             }
             deployableArtifactBuilderMap.clear();
             if (wrappedListener != null) {
                 wrappedListener.sessionEnded(event);
             }
-        }
-        catch ( Throwable t )
-        {
+        } catch (Throwable t) {
             String message = getClass().getName() + ".sessionEnded() listener has failed: ";
-            logger.error( message, t );
-            throw new RuntimeException( message, t );
-        }
-        finally {
+            logger.error(message, t);
+            throw new RuntimeException(message, t);
+        } finally {
             String propertyFilePath = System.getenv(BuildInfoConfigProperties.PROP_PROPS_FILE);
             if (StringUtils.isNotBlank(propertyFilePath)) {
                 File file = new File(propertyFilePath);
@@ -454,9 +448,9 @@ private void addArtifactsToCurrentModule(MavenProject project, ModuleBuilder mod
             String groupId = moduleArtifact.getGroupId();
             String deploymentPath = getDeploymentPath(groupId, artifactId, artifactVersion, artifactClassifier, artifactExtension);
             // If excludeArtifactsFromBuild and the PatternMatcher found conflict, add the excluded artifact to the excluded artifact set.
-            if(excludeArtifactsFromBuild && PatternMatcher.pathConflicts(deploymentPath,patterns)){
+            if (excludeArtifactsFromBuild && PatternMatcher.pathConflicts(deploymentPath, patterns)) {
                 module.addExcludedArtifact(artifact);
-            }else{
+            } else {
                 module.addArtifact(artifact);
             }
             if (isPublishArtifacts(artifactFile)) {
@@ -476,9 +470,9 @@ private void addArtifactsToCurrentModule(MavenProject project, ModuleBuilder mod
                         artifactBuilder.name(pomFileName);
                         org.jfrog.build.api.Artifact pomArtifact = artifactBuilder.build();
                         deploymentPath = getDeploymentPath(groupId, artifactId, artifactVersion, artifactClassifier, "pom");
-                        if(excludeArtifactsFromBuild && PatternMatcher.pathConflicts(deploymentPath,patterns)){
+                        if (excludeArtifactsFromBuild && PatternMatcher.pathConflicts(deploymentPath, patterns)) {
                             module.addExcludedArtifact(pomArtifact);
-                        }else{
+                        } else {
                             module.addArtifact(pomArtifact);
                         }
                         if (isPublishArtifacts(pomFile)) {
@@ -528,7 +522,7 @@ private void addDeployableArtifact(org.jfrog.build.api.Artifact artifact, File a
     /**
      * @param deployPath the full path string to extract the repo from
      * @return Return the target deployment repository. Either the releases repository (default) or snapshots if defined
-     *         and the deployed file is a snapshot.
+     * and the deployed file is a snapshot.
      */
     public String getTargetRepository(String deployPath) {
         String snapshotsRepository = conf.publisher.getSnapshotRepoKey();
@@ -604,7 +598,7 @@ public Build extract(ExecutionEvent event) {
             if (conf.isIncludeEnvVars()) {
                 Properties envProperties = new Properties();
                 envProperties.putAll(conf.getAllProperties());
-                envProperties = BuildInfoExtractorUtils.getEnvProperties(envProperties);
+                envProperties = BuildInfoExtractorUtils.getEnvProperties(envProperties, conf.getLog());
                 for (Map.Entry<Object, Object> envProp : envProperties.entrySet()) {
                     buildInfoBuilder.addProperty(envProp.getKey(), envProp.getValue());
                 }
diff --git a/build-info-extractor-maven3/src/main/java/org/jfrog/build/extractor/maven/BuildInfoRecorderLifecycleParticipant.java b/build-info-extractor-maven3/src/main/java/org/jfrog/build/extractor/maven/BuildInfoRecorderLifecycleParticipant.java
@@ -74,8 +74,9 @@ private ArtifactoryClientConfiguration getConfiguration(MavenSession session) {
         allMavenProps.putAll(session.getSystemProperties());
         allMavenProps.putAll(session.getUserProperties());
 
-        Properties allProps = BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(allMavenProps);
-        internalConfiguration = new ArtifactoryClientConfiguration(new Maven3BuildInfoLogger(logger));
+        Maven3BuildInfoLogger log = new Maven3BuildInfoLogger(logger);
+        Properties allProps = BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(allMavenProps, log);
+        internalConfiguration = new ArtifactoryClientConfiguration(log);
         internalConfiguration.fillFromProperties(allProps);
         return internalConfiguration;
     }
diff --git a/build-info-extractor-maven3/src/main/java/org/jfrog/build/extractor/maven/resolver/ResolutionHelper.java b/build-info-extractor-maven3/src/main/java/org/jfrog/build/extractor/maven/resolver/ResolutionHelper.java
@@ -28,8 +28,9 @@ public void resolve(Properties allMavenProps, Logger logger) {
             return;
         }
 
-        Properties allProps = BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(allMavenProps);
-        internalConfiguration = new ArtifactoryClientConfiguration(new Maven3BuildInfoLogger(logger));
+        Maven3BuildInfoLogger log = new Maven3BuildInfoLogger(logger);
+        Properties allProps = BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(allMavenProps, log);
+        internalConfiguration = new ArtifactoryClientConfiguration(log);
         internalConfiguration.fillFromProperties(allProps);
     }
 
diff --git a/build-info-extractor/src/main/java/org/jfrog/build/extractor/BuildInfoExtractorUtils.java b/build-info-extractor/src/main/java/org/jfrog/build/extractor/BuildInfoExtractorUtils.java
@@ -32,16 +32,12 @@
 import org.jfrog.build.api.Build;
 import org.jfrog.build.api.BuildInfoConfigProperties;
 import org.jfrog.build.api.BuildInfoProperties;
+import org.jfrog.build.api.util.Log;
 import org.jfrog.build.client.ClientProperties;
 import org.jfrog.build.client.IncludeExcludePatterns;
 import org.jfrog.build.client.PatternMatcher;
 
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.StringReader;
-import java.io.StringWriter;
+import java.io.*;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Properties;
@@ -65,9 +61,9 @@ public abstract class BuildInfoExtractorUtils {
     public static final Predicate<Object> MATRIX_PARAM_PREDICATE =
             new PrefixPredicate(ClientProperties.PROP_DEPLOY_PARAM_PROP_PREFIX);
 
-    public static Properties mergePropertiesWithSystemAndPropertyFile(Properties existingProps) {
+    public static Properties mergePropertiesWithSystemAndPropertyFile(Properties existingProps, Log log) {
         Properties props = new Properties();
-        String propertiesFilePath = getAdditionalPropertiesFile(existingProps);
+        String propertiesFilePath = getAdditionalPropertiesFile(existingProps, log);
         if (StringUtils.isNotBlank(propertiesFilePath)) {
             File propertiesFile = new File(propertiesFilePath);
             InputStream inputStream = null;
@@ -115,7 +111,7 @@ public static Properties stripPrefixFromProperties(Properties source, String pre
         return props;
     }
 
-    public static Properties getEnvProperties(Properties startProps) {
+    public static Properties getEnvProperties(Properties startProps, Log log) {
         IncludeExcludePatterns patterns = new IncludeExcludePatterns(
                 startProps.getProperty(BuildInfoConfigProperties.PROP_ENV_VARS_INCLUDE_PATTERNS),
                 startProps.getProperty(BuildInfoConfigProperties.PROP_ENV_VARS_EXCLUDE_PATTERNS));
@@ -151,7 +147,7 @@ public static Properties getEnvProperties(Properties startProps) {
         }
 
         // TODO: [by FSI] Test if this is needed! Since start props are used now
-        String propertiesFilePath = getAdditionalPropertiesFile(startProps);
+        String propertiesFilePath = getAdditionalPropertiesFile(startProps, log);
         if (StringUtils.isNotBlank(propertiesFilePath)) {
             File propertiesFile = new File(propertiesFilePath);
             InputStream inputStream = null;
@@ -215,17 +211,40 @@ public static void saveBuildInfoToFile(Build build, File toFile) throws IOExcept
         Files.write(buildInfoJson, toFile, Charsets.UTF_8);
     }
 
-    private static String getAdditionalPropertiesFile(Properties additionalProps) {
+    private static String getAdditionalPropertiesFile(Properties additionalProps, Log log) {
         String key = BuildInfoConfigProperties.PROP_PROPS_FILE;
         String propertiesFilePath = System.getProperty(key);
+        String propFoundPath = "";
         if (StringUtils.isBlank(propertiesFilePath) && additionalProps != null) {
             propertiesFilePath = additionalProps.getProperty(key);
+            propFoundPath = "additionalProps.getProperty";
+        }
+        if (StringUtils.isBlank(propertiesFilePath)) {
+            // Jenkins prefixes these variables with "env." so let's try that
+            propertiesFilePath = additionalProps.getProperty("env." + key);
             if (StringUtils.isBlank(propertiesFilePath)) {
-                // Jenkins prefixes these variables with "env." so let's try that
-                propertiesFilePath = additionalProps.getProperty("env." + key);
-                if (StringUtils.isBlank(propertiesFilePath)) {
-                    propertiesFilePath = System.getenv(key);
-                }
+                propertiesFilePath = System.getenv(key);
+                propFoundPath = StringUtils.isBlank(propertiesFilePath) ? "" : "System.getenv";
+            } else {
+                propFoundPath = "additionalProps.getProperty(\"env.\" + key)";
+            }
+        }
+        if (StringUtils.isBlank(propertiesFilePath)) {
+            // Jenkins prefixes these variables with "env." so let's try that
+            key = BuildInfoConfigProperties.ENV_BUILDINFO_PROPFILE;
+            propertiesFilePath = additionalProps.getProperty("env." + key);
+            if (StringUtils.isBlank(propertiesFilePath)) {
+                propertiesFilePath = System.getenv(key);
+                propFoundPath = StringUtils.isBlank(propertiesFilePath) ? "" : " second System.getenv";
+            } else {
+                propFoundPath = "additionalProps.getProperty(\"env.\" + key)";
+            }
+        }
+        if (log != null) {
+            if (StringUtils.isBlank(propFoundPath)) {
+                log.warn("[buildinfo] Properties file path was not found, this build will probably fail");
+            } else {
+                log.debug("[buildinfo] Properties file " + propertiesFilePath + " retrieved from " + propFoundPath);
             }
         }
         return propertiesFilePath;
diff --git a/build-info-extractor/src/test/java/org/jfrog/build/extractor/BuildInfoExtractorSupportTest.java b/build-info-extractor/src/test/java/org/jfrog/build/extractor/BuildInfoExtractorSupportTest.java

Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,9 @@ public interface BuildInfoConfigProperties {`
`41`	`41`
`42`	`42`	`String ENV_VARS_EXCLUDE_PATTERNS = "envVarsExcludePatterns";`
`43`	`43`	`String PROP_ENV_VARS_EXCLUDE_PATTERNS = BUILD_INFO_CONFIG_PREFIX + ENV_VARS_EXCLUDE_PATTERNS;`
	`44`	`+`
	`45`	`+ /**`
	`46`	`+ * Secondary environment variable to hold the properties file name`
	`47`	`+ */`
	`48`	`+ String ENV_BUILDINFO_PROPFILE = "BUILDINFO_PROPFILE";`
`44`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,10 @@ private PrefixPropertyHandler(Log log, Map<String, String> props, String prefix)`
`28`	`28`	`this.prefix = prefix;`
`29`	`29`	`}`
`30`	`30`
	`31`	`+ public Log getLog() {`
	`32`	`+ return log;`
	`33`	`+ }`
	`34`	`+`
`31`	`35`	`public String getPrefix() {`
`32`	`36`	`return prefix;`
`33`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ public Build extract(Project rootProject) {`
`216`	`216`	`if (clientConf.isIncludeEnvVars()) {`
`217`	`217`	`Properties envProperties = new Properties();`
`218`	`218`	`envProperties.putAll(clientConf.getAllProperties());`
`219`		`- envProperties = BuildInfoExtractorUtils.getEnvProperties(envProperties);`
	`219`	`+ envProperties = BuildInfoExtractorUtils.getEnvProperties(envProperties, clientConf.getLog());`
`220`	`220`	`for (Map.Entry<Object, Object> envProp : envProperties.entrySet()) {`
`221`	`221`	`bib.addProperty(envProp.getKey(), envProp.getValue());`
`222`	`222`	`}`
`@@ -291,6 +291,7 @@ public Artifact apply(GradleDeployDetails from) {`
`291`	`291`	`}));`
`292`	`292`	`return artifacts;`
`293`	`293`	`}`
	`294`	`+`
`294`	`295`	`private List<Dependency> calculateDependencies(Project project) throws Exception {`
`295`	`296`	`Set<Configuration> configurationSet = project.getConfigurations();`
`296`	`297`	`List<Dependency> dependencies = newArrayList();`
`@@ -360,10 +361,10 @@ public IncludeExcludePredicate(Project project, IncludeExcludePatterns patterns,`
`360`	`361`	`}`
`361`	`362`
`362`	`363`	`public boolean apply(@Nullable GradleDeployDetails input) {`
`363`		`- if(include){`
	`364`	`+ if (include) {`
`364`	`365`	`return input.getProject().equals(project) && !PatternMatcher.pathConflicts(input.getDeployDetails().getArtifactPath(), patterns);`
`365`		`- }else{`
`366`		`- return input.getProject().equals(project) && PatternMatcher.pathConflicts(input.getDeployDetails().getArtifactPath(), patterns);`
	`366`	`+ } else {`
	`367`	`+ return input.getProject().equals(project) && PatternMatcher.pathConflicts(input.getDeployDetails().getArtifactPath(), patterns);`
`367`	`368`	`}`
`368`	`369`	`}`
`369`	`370`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,8 +28,9 @@ public void resolve(Properties allMavenProps, Logger logger) {`
`28`	`28`	`return;`
`29`	`29`	`}`
`30`	`30`
`31`		`- Properties allProps = BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(allMavenProps);`
`32`		`- internalConfiguration = new ArtifactoryClientConfiguration(new Maven3BuildInfoLogger(logger));`
	`31`	`+ Maven3BuildInfoLogger log = new Maven3BuildInfoLogger(logger);`
	`32`	`+ Properties allProps = BuildInfoExtractorUtils.mergePropertiesWithSystemAndPropertyFile(allMavenProps, log);`
	`33`	`+ internalConfiguration = new ArtifactoryClientConfiguration(log);`
`33`	`34`	`internalConfiguration.fillFromProperties(allProps);`
`34`	`35`	`}`
`35`	`36`