Skip to content

[JENKINS-59777] Allow nested docker.withRegistry() blocks #2 #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PhilippHomann wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[JENKINS-59777] Allow nested docker.withRegistry() blocks #2 #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions src/main/java/org/jenkinsci/plugins/docker/commons/impl/RegistryKeyMaterialFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,26 +75,40 @@ public RegistryKeyMaterialFactory(@NonNull String username, @NonNull String pass
this.dockerExecutable = dockerExecutable;
}

private void generateConfig(String configJson, FilePath destination, Boolean ignoreBlacklist) throws IOException, InterruptedException {
JSONObject json = JSONObject.fromObject(configJson);
if(!ignoreBlacklist) {
for (String property : BLACKLISTED_PROPERTIES) {
Object value = json.remove(property);
if (value != null) {
launcher.getListener().getLogger().println("Removing blacklisted property: " + property);
}
}
}

destination.write(json.toString(), StandardCharsets.UTF_8.name());
}

@Override
public KeyMaterial2 materialize2() throws IOException, InterruptedException {
FilePath dockerConfig = createSecretsDirectory();

// read the existing docker config file, which might hold some important settings (e.b. proxies)
String envConfig = this.env.get("DOCKER_CONFIG", null);
FilePath configJsonPath = FilePath.getHomeDirectory(this.launcher.getChannel()).child(".docker").child(DOCKER_CONFIG_FILENAME);
Boolean isHomeConfig = true;
if (envConfig != null) {
launcher.getListener().getLogger().println("Using the existing docker config file from environment.");
configJsonPath = new FilePath(this.launcher.getChannel(), envConfig).child(DOCKER_CONFIG_FILENAME);
isHomeConfig = false;
}

if (configJsonPath.exists()) {
String configJson = configJsonPath.readToString();
if (StringUtils.isNotBlank(configJson)) {
launcher.getListener().getLogger().println("Using the existing docker config file.");

JSONObject json = JSONObject.fromObject(configJson);
for (String property : BLACKLISTED_PROPERTIES) {
Object value = json.remove(property);
if (value != null) {
launcher.getListener().getLogger().println("Removing blacklisted property: " + property);
}
if (isHomeConfig) {
launcher.getListener().getLogger().println("Using the existing docker config file from home directory.");
}

dockerConfig.child(DOCKER_CONFIG_FILENAME).write(json.toString(), StandardCharsets.UTF_8.name());
this.generateConfig(configJson, dockerConfig.child(DOCKER_CONFIG_FILENAME), !isHomeConfig);
}
}

Expand Down
91 changes: 59 additions & 32 deletions src/test/java/org/jenkinsci/plugins/docker/commons/impl/RegistryKeyMaterialFactoryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,41 +69,41 @@ public class RegistryKeyMaterialFactoryTest {

private KeyMaterialFactory factory;

@Before
public void setup() throws Exception {
// fake launcher for the docker login invocation
FakeLauncher faker = new FakeLauncher() {
@Override
public Proc onLaunch(final ProcStarter p) throws IOException {
return new FinishedProc(0);
}
};

PretendSlave slave = j.createPretendSlave(faker);
// VirtualChannel channel = slave.getChannel();
// FreeStyleProject project = j.createFreeStyleProject();

TaskListener listener = TaskListener.NULL;
Launcher launcher = slave.createLauncher(listener);
launcher = new Launcher.DecoratedLauncher(launcher) {
@Override
public VirtualChannel getChannel() {
return new LocalChannel(null) {
@Override
public <V, T extends Throwable> V call(final Callable<V, T> callable) throws T {
// ugly as hell, but we need a way to mock fetching the home directory
return (V) new FilePath(tempFolder.getRoot());
}
private KeyMaterialFactory getFactory(EnvVars env) throws Exception {
// fake launcher for the docker login invocation
FakeLauncher faker = new FakeLauncher() {
@Override
public Proc onLaunch(final ProcStarter p) throws IOException {
return new FinishedProc(0);
}
};
}
};

URL endpoint = new DockerRegistryEndpoint(null, null).getEffectiveUrl();
EnvVars env = new EnvVars();
String dockerExecutable = DockerTool.getExecutable(null, null, listener, env);
PretendSlave slave = j.createPretendSlave(faker);
TaskListener listener = TaskListener.NULL;
Launcher launcher = slave.createLauncher(listener);
launcher = new Launcher.DecoratedLauncher(launcher) {
@Override
public VirtualChannel getChannel() {
return new LocalChannel(null) {
@Override
public <V, T extends Throwable> V call(final Callable<V, T> callable) throws T {
// ugly as hell, but we need a way to mock fetching the home directory
return (V) new FilePath(tempFolder.getRoot());
}
};
}
};

URL endpoint = new DockerRegistryEndpoint(null, null).getEffectiveUrl();
String dockerExecutable = DockerTool.getExecutable(null, null, listener, env);

return new RegistryKeyMaterialFactory("username", "password", endpoint, launcher, env, listener,
dockerExecutable).contextualize(new KeyMaterialContext(new FilePath(tempFolder.newFolder())));
}

factory = new RegistryKeyMaterialFactory("username", "password", endpoint, launcher, env, listener,
dockerExecutable).contextualize(new KeyMaterialContext(new FilePath(tempFolder.newFolder())));
@Before
public void setup() throws Exception {
factory = getFactory(new EnvVars());
}

@Test
Expand Down Expand Up @@ -233,4 +233,31 @@ public void materialize_userConfigFileWithCredStoreAndHttpHeaders_createdWithHea
assertEquals("{\"HttpHeaders\":{\"User-Agent\":\"Docker-Client\"}}", FileUtils.readFileToString(jsonFile, Charset.defaultCharset()));
}

@Test
public void materialize_envConfigFile() throws Exception {
EnvVars env = new EnvVars();
env.put("DOCKER_CONFIG", new File(tempFolder.getRoot(), ".custom-docker").getPath());
factory = getFactory(env);

// arrange
File cfgFile = new File(new File(tempFolder.getRoot(), ".custom-docker"), "config.json");
FileUtils.write(cfgFile, "{\"auths\": { \"localhost:5001\": { \"auth\": \"whatever\", \"email\": \"\"} }}", Charset.defaultCharset());

// act
KeyMaterial2 material = factory.materialize2();

// assert
String dockerCfgFolderPath = material.env().get("DOCKER_CONFIG");
assertNotNull(dockerCfgFolderPath);

File dockerCfgFolder = new File(dockerCfgFolderPath);
assertTrue(dockerCfgFolder.exists());

String[] files = dockerCfgFolder.list();
assertThat(files, arrayContaining("config.json"));

File jsonFile = new File(dockerCfgFolder, "config.json");
assertEquals("{\"auths\":{\"localhost:5001\":{\"auth\":\"whatever\",\"email\":\"\"}}}", FileUtils.readFileToString(jsonFile, Charset.defaultCharset()));
}

}