Skip to content
Permalink
Browse files
[JENKINS-25735] [JENKINS-41995] - Create more tests
  • Loading branch information
oleg-nenashev committed Mar 16, 2017
1 parent d3d8c23 commit 3d57fab2af5d3016e9bfd19eacca60095f744811
@@ -24,12 +24,12 @@

package com.michelin.cio.hudson.plugins.maskpasswords;

import com.google.common.annotations.VisibleForTesting;
import com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper.VarPasswordPair;
import com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper.VarMaskRegex;
import hudson.ExtensionList;
import hudson.XmlFile;
import hudson.cli.CLICommand;
import hudson.model.Hudson;
import hudson.model.ParameterDefinition;
import hudson.model.ParameterDefinition.ParameterDescriptor;
import hudson.model.ParameterValue;
@@ -52,6 +52,8 @@
import jenkins.model.Jenkins;
import net.sf.json.JSONObject;
import org.apache.commons.lang.StringUtils;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.StaplerRequest;

/**
@@ -116,11 +118,7 @@ public class MaskPasswordsConfig {

public MaskPasswordsConfig() {
maskPasswordsParamDefClasses = new LinkedHashSet<String>();

// default values for the first time the config is created
addMaskedPasswordParameterDefinition(hudson.model.PasswordParameterDefinition.class.getName());
addMaskedPasswordParameterDefinition(com.michelin.cio.hudson.plugins.passwordparam.PasswordParameterDefinition.class.getName());
globalVarEnableGlobally = false;
reset();
}

/**
@@ -172,6 +170,20 @@ public void setGlobalVarEnabledGlobally(boolean state) {
globalVarEnableGlobally = state;
}

/**
* Resets configuration to the default state.
*/
@Restricted(NoExternalUse.class)
@VisibleForTesting
public final synchronized void reset() {
// Wipe the data
clear();

// default values for the first time the config is created
addMaskedPasswordParameterDefinition(hudson.model.PasswordParameterDefinition.class.getName());
addMaskedPasswordParameterDefinition(com.michelin.cio.hudson.plugins.passwordparam.PasswordParameterDefinition.class.getName());
}

public synchronized void clear() {
maskPasswordsParamDefClasses.clear();
getGlobalVarPasswordPairsList().clear();
@@ -0,0 +1,118 @@
/*
* The MIT License
*
* Copyright (c) 2017 Jenkins contributors.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.michelin.cio.hudson.plugins.integrations;

import com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper;
import com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsConfig;
import hudson.Launcher;
import hudson.model.AbstractBuild;
import hudson.model.BuildListener;
import hudson.model.Cause;
import hudson.model.FreeStyleBuild;
import hudson.model.FreeStyleProject;
import hudson.model.ParameterValue;
import hudson.model.ParametersDefinitionProperty;
import hudson.model.PasswordParameterDefinition;
import hudson.model.PasswordParameterValue;
import hudson.model.Result;
import hudson.util.Secret;
import java.io.IOException;
import java.util.Collections;
import org.junit.Assert;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.jvnet.hudson.test.BuildWatcher;
import org.jvnet.hudson.test.Issue;
import org.jvnet.hudson.test.JenkinsRule;
import org.jvnet.hudson.test.TestBuilder;

/**
* Tests of {@link PasswordParameterValue} and {@link PasswordParameterDefinition}.
* @author bpmarinho
*/
public class CorePasswordParameterTest {

@ClassRule
public static BuildWatcher buildWatcher = new BuildWatcher();

@Rule
public JenkinsRule j = new JenkinsRule();

@Before
public void dropCache() {
MaskPasswordsConfig.getInstance().clear();
}

@Test
public void shouldMaskPasswordParameterClassByDefault() {
Assert.assertTrue( PasswordParameterValue.class + " must be masked by default",
MaskPasswordsConfig.getInstance().isMasked(PasswordParameterValue.class.getName()));
}

@Test
public void shouldMaskPasswordParameterValueByDefault() {
PasswordParameterDefinition d = new PasswordParameterDefinition("FOO", "myPassword", "BAR");
ParameterValue created = d.createValue("hello");

// We pass the non-existent class name in order to ensure that the Value metadata check is enough
Assert.assertTrue( PasswordParameterValue.class + " must be masked by default",
MaskPasswordsConfig.getInstance().isMasked(created, "nonExistent"));
}

@Test
@Issue("JENKINS-41955")
public void passwordParameterShouldBeMaskedInFreestyleProject() throws Exception {
final String clearTextPassword = "myClearTextPassword";
final String logWithClearTextPassword = "printed " + clearTextPassword + " oops";
final String logWithHiddenPassword = "printed ******** oops";

FreeStyleProject project
= j.jenkins.createProject(FreeStyleProject.class, "testPasswordParameter");

PasswordParameterDefinition passwordParameterDefinition
= new hudson.model.PasswordParameterDefinition("Password1", clearTextPassword, null);
ParametersDefinitionProperty parametersDefinitionProperty
= new ParametersDefinitionProperty(passwordParameterDefinition);
project.addProperty(parametersDefinitionProperty);

MaskPasswordsBuildWrapper maskPasswordsBuildWrapper
= new MaskPasswordsBuildWrapper(Collections.<MaskPasswordsBuildWrapper.VarPasswordPair>emptyList());
project.getBuildWrappersList().add(maskPasswordsBuildWrapper);

project.getBuildersList().add(new TestBuilder() {
@Override
public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException {
listener.getLogger().println(logWithClearTextPassword);
build.setResult(Result.SUCCESS);
return true;
}
});

FreeStyleBuild build = j.buildAndAssertSuccess(project);
j.assertLogContains(logWithHiddenPassword, build);
j.assertLogNotContains(logWithClearTextPassword, build);
}
}
@@ -0,0 +1,81 @@
/*
* The MIT License
*
* Copyright (c) 2017 CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.michelin.cio.hudson.plugins.maskpasswords;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.jvnet.hudson.test.JenkinsRule;

/**
* Tests of {@link MaskPasswordsConfig}.
* These tests do not depend on the caching being done in the Jenkins instance.
* @author Oleg Nenashev
*/
public class MaskPasswordConfigTests {

MaskPasswordsConfig config;

// The logic inside needs the classloader
@Rule
public JenkinsRule j = new JenkinsRule();

@Before
public void initConfig() {
config = new MaskPasswordsConfig();
}

@Test
public void shouldConsiderAsMasked_cmchppPasswordParameterValue() {
assertIsMasked(com.michelin.cio.hudson.plugins.passwordparam.PasswordParameterValue.class);
}

@Test
public void shouldConsiderAsMasked_hmPasswordParameterValue() {
assertIsMasked(hudson.model.PasswordParameterValue.class);
}

@Test
public void shouldNotMaskTheBaseClass() {
assertIsNotMasked(hudson.model.ParameterValue.class);
}

@Test
public void shouldNotMaskTheBasicParameterTypes() {
assertIsNotMasked(hudson.model.StringParameterValue.class);
assertIsNotMasked(hudson.model.FileParameterValue.class);
}

private void assertIsMasked(Class<?> clazz) {
config.invalidatePasswordValueClassCaches();
assertTrue("Expected that the class is masked: " + clazz, config.guessIfShouldMask(clazz.getName()));
}

private void assertIsNotMasked(Class<?> clazz) {
config.invalidatePasswordValueClassCaches();
assertFalse("Expected that the class is not masked: " + clazz, config.guessIfShouldMask(clazz.getName()));
}
}
@@ -55,7 +55,7 @@ public class MaskPasswordsURLEncodingTest {

@Before
public void dropCache() {
MaskPasswordsConfig.getInstance().clear();
MaskPasswordsConfig.getInstance().reset();
}

@Test
@@ -66,7 +66,7 @@ public class MaskPasswordsWorkflowTest {

@Before
public void dropCache() {
MaskPasswordsConfig.getInstance().clear();
MaskPasswordsConfig.getInstance().reset();
}

@Test
@@ -33,6 +33,7 @@
import hudson.model.FreeStyleProject;
import hudson.model.ParameterDefinition;
import hudson.model.ParameterValue;
import hudson.model.ParametersAction;
import hudson.model.ParametersDefinitionProperty;
import hudson.model.Result;
import hudson.util.Secret;
@@ -62,7 +63,7 @@ public class PasswordParameterTest {

@Before
public void dropCache() {
MaskPasswordsConfig.getInstance().clear();
MaskPasswordsConfig.getInstance().reset();
}

@Test
@@ -93,8 +94,7 @@ public void passwordParameterShouldBeMaskedInFreestyleProject() throws Exception
FreeStyleProject project
= j.jenkins.createProject(FreeStyleProject.class, "testPasswordParameter");

hudson.model.PasswordParameterDefinition passwordParameterDefinition
= new hudson.model.PasswordParameterDefinition("Password1", clearTextPassword, null);
PasswordParameterDefinition passwordParameterDefinition = new PasswordParameterDefinition("Password1", null);
ParametersDefinitionProperty parametersDefinitionProperty
= new ParametersDefinitionProperty(passwordParameterDefinition);
project.addProperty(parametersDefinitionProperty);
@@ -112,7 +112,9 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
}
});

FreeStyleBuild build = project.scheduleBuild2(0, new Cause.UserIdCause()).get();
FreeStyleBuild build = project.scheduleBuild2(0, new Cause.UserIdCause(),
new ParametersAction(passwordParameterDefinition.createValue(Secret.fromString(clearTextPassword))))
.get();
j.assertBuildStatusSuccess(j.waitForCompletion(build));
j.assertLogContains(logWithHiddenPassword, build);
j.assertLogNotContains(logWithClearTextPassword, build);

0 comments on commit 3d57fab

Please sign in to comment.