Skip to content

Commit

Permalink
[JENKINS-42262] Add a one more EnvVars parameter to ConfigFileManager…
Browse files Browse the repository at this point in the history 
… because a build step could define additional variables used in the config file which otherwise could not be obtained by Token.expandAll() with the usual method Run.getEnvironment(TaskListener)
  • Loading branch information
@nfalco79
nfalco79 committed Apr 15, 2017
1 parent 04fc069 commit d93eee5
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 30 deletions.
1 change: 1 addition & 0 deletions src/main/java/org/jenkinsci/lib/configprovider/ConfigProvider.java
View file
Expand Up @@ -209,6 +209,7 @@ public void save(Config config) {
* @throws IOException in case an exception occurs when providing the content or other needed files
* @since 2.16
*/
@CheckForNull
public String supplyContent(@NonNull Config configFile, Run<?, ?> build, FilePath workDir, TaskListener listener, @NonNull List<String> tempFiles) throws IOException {
return configFile.content;
}
Expand Down
5 changes: 2 additions & 3 deletions src/main/java/org/jenkinsci/lib/configprovider/model/Config.java
View file
Expand Up @@ -31,7 +31,6 @@ of this software and associated documentation files (the "Software"), to deal
import org.kohsuke.stapler.DataBoundSetter;

import java.io.Serializable;
import java.util.logging.Logger;

/**
* Represents a particular configuration file and its content.
Expand All @@ -40,10 +39,9 @@ of this software and associated documentation files (the "Software"), to deal
*
* @author domi
*/
@SuppressWarnings("serial")
public class Config implements Serializable, Describable<Config> {

private static final Logger LOGGER = Logger.getLogger(Config.class.getName());

/**
* a unique id along all providers!
*/
Expand Down Expand Up @@ -105,6 +103,7 @@ public Config(@NonNull String id, String name, String comment, String content, @
*
* @return never null.
*/
@Override
public ConfigProvider getDescriptor() {
return (ConfigProvider) Jenkins.getActiveInstance().getDescriptorOrDie(this.getClass());
}
Expand Down
61 changes: 35 additions & 26 deletions src/main/java/org/jenkinsci/lib/configprovider/model/ConfigFileManager.java
View file
Expand Up @@ -23,26 +23,27 @@ of this software and associated documentation files (the "Software"), to deal
*/
package org.jenkinsci.lib.configprovider.model;

import hudson.AbortException;
import hudson.FilePath;
import hudson.model.*;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.apache.commons.lang.StringUtils;
import org.jenkinsci.lib.configprovider.ConfigProvider;
import org.jenkinsci.lib.configprovider.model.Config;
import org.jenkinsci.plugins.configfiles.ConfigFiles;
import org.jenkinsci.plugins.configfiles.buildwrapper.Messages;
import org.jenkinsci.plugins.tokenmacro.MacroEvaluationException;
import org.jenkinsci.plugins.tokenmacro.TokenMacro;

import edu.umd.cs.findbugs.annotations.Nullable;
import hudson.AbortException;
import hudson.EnvVars;
import hudson.FilePath;
import hudson.Util;
import hudson.model.Build;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.slaves.WorkspaceList;

public class ConfigFileManager {
Expand All @@ -61,7 +62,9 @@ public static FilePath tempDir(FilePath ws) {
/**
* Provisions (publishes) the given file to the workspace.
*
* @param managedFile the file to be provisioned
* @param configFile the file to be provisioned
* @param env enhanced environment to use in the variable substitution
* @param build a build being run
* @param workspace target workspace
* @param listener the listener
* @param tempFiles temp files created by this method, these files should be deleted by the caller
Expand All @@ -70,31 +73,31 @@ public static FilePath tempDir(FilePath ws) {
* @throws InterruptedException
* @throws AbortException config file has not been found
*/
public static FilePath provisionConfigFile(ConfigFile managedFile, Run<?, ?> build, FilePath workspace, TaskListener listener, List<String> tempFiles) throws IOException, InterruptedException {
Config configFile = ConfigFiles.getByIdOrNull(build, managedFile.getFileId());
public static FilePath provisionConfigFile(ConfigFile configFile, @Nullable EnvVars env, Run<?, ?> build, FilePath workspace, TaskListener listener, List<String> tempFiles) throws IOException, InterruptedException {
Config config = ConfigFiles.getByIdOrNull(build, configFile.getFileId());

if (configFile == null) {
String message = "not able to provide the file " + managedFile + ", can't be resolved by any provider - maybe it got deleted by an administrator?";
if (config == null) {
String message = "not able to provide the file " + configFile + ", can't be resolved by any provider - maybe it got deleted by an administrator?";
listener.getLogger().println(message);
throw new AbortException(message);
}

FilePath workDir = tempDir(workspace);
workDir.mkdirs();

boolean createTempFile = StringUtils.isBlank(managedFile.getTargetLocation());
boolean createTempFile = StringUtils.isBlank(configFile.getTargetLocation());

FilePath target;
if (createTempFile) {
target = workDir.createTempFile("config", "tmp");
} else {

String expandedTargetLocation = managedFile.getTargetLocation();
String expandedTargetLocation = configFile.getTargetLocation();
try {
expandedTargetLocation = TokenMacro.expandAll(build, workspace, listener, managedFile.getTargetLocation());
expandedTargetLocation = TokenMacro.expandAll(build, workspace, listener, configFile.getTargetLocation());
} catch (MacroEvaluationException e) {
listener.getLogger().println("[ERROR] failed to expand variables in target location '" + managedFile.getTargetLocation() + "' : " + e.getMessage());
expandedTargetLocation = managedFile.getTargetLocation();
listener.getLogger().println("[ERROR] failed to expand variables in target location '" + configFile.getTargetLocation() + "' : " + e.getMessage());
expandedTargetLocation = configFile.getTargetLocation();
}

// Should treat given path as the actual filename unless it has a trailing slash (implying a
Expand All @@ -103,25 +106,31 @@ public static FilePath provisionConfigFile(ConfigFile managedFile, Run<?, ?> bui
String immediateFileName = expandedTargetLocation.substring(expandedTargetLocation.lastIndexOf("/") + 1);

if (immediateFileName.length() == 0 || (target.exists() && target.isDirectory())) {
target = new FilePath(target, configFile.name.replace(" ", "_"));
target = new FilePath(target, config.name.replace(" ", "_"));
}
}

ConfigProvider provider = configFile.getDescriptor();
String fileContent = provider.supplyContent(configFile, build, workDir, listener, tempFiles);
ConfigProvider provider = config.getDescriptor();
String fileContent = provider.supplyContent(config, build, workDir, listener, tempFiles);

if (managedFile.isReplaceTokens()) {
if (configFile.isReplaceTokens()) {
try {
fileContent = TokenMacro.expandAll(build, workspace, listener, fileContent);
if (env != null) {
fileContent = Util.replaceMacro(fileContent, env);
}
} catch (MacroEvaluationException e) {
listener.getLogger().println("[ERROR] failed to expand variables in content of " + configFile.name + " - " + e.getMessage());
listener.getLogger().println("[ERROR] failed to expand variables in content of " + config.name + " - " + e.getMessage());
}
}

LOGGER.log(Level.FINE, "Create file {0} for configuration {1} mapped as {2}", new Object[]{target.getRemote(), configFile, managedFile});
listener.getLogger().println(Messages.console_output(configFile.name, target.toURI()));
ByteArrayInputStream bs = new ByteArrayInputStream(fileContent.getBytes("UTF-8"));
target.copyFrom(bs);
LOGGER.log(Level.FINE, "Create file {0} for configuration {1} mapped as {2}", new Object[]{target.getRemote(), config, configFile});
listener.getLogger().println(Messages.console_output(config.name, target.toURI()));
// check if empty file
if (fileContent != null) {
ByteArrayInputStream bs = new ByteArrayInputStream(fileContent.getBytes("UTF-8"));
target.copyFrom(bs);
}
target.chmod(0640);

return target;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/jenkinsci/plugins/configfiles/buildwrapper/ManagedFileUtil.java
View file
Expand Up @@ -54,7 +54,7 @@ public static Map<ManagedFile, FilePath> provisionConfigFiles(List<ManagedFile>
listener.getLogger().println("provisioning config files...");

for (ManagedFile managedFile : managedFiles) {
FilePath target = ConfigFileManager.provisionConfigFile(managedFile, build, workspace, listener, tempFiles);
FilePath target = ConfigFileManager.provisionConfigFile(managedFile, null, build, workspace, listener, tempFiles);
file2Path.put(managedFile, target);
}

Expand Down

0 comments on commit d93eee5

Please sign in to comment.