Skip to content

Do not suggest passphraseVariable: '', usernameVariable: '' in snippet generator #144

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

Merged
merged 2 commits into from
Jul 12, 2021
Merged

Do not suggest passphraseVariable: '', usernameVariable: '' in snippet generator #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c36a486
Rename `SSHUserPrivateKeyTest` to `SSHUserPrivateKeyBindingTest` to m…
jglick Jul 12, 2021
86269f1
Do not suggest `passphraseVariable: , usernameVariable: ` in snippet …
jglick Jul 12, 2021
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
9 changes: 5 additions & 4 deletions src/main/java/org/jenkinsci/plugins/credentialsbinding/impl/SSHUserPrivateKeyBinding.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import hudson.Extension;
import hudson.FilePath;
import hudson.Launcher;
import hudson.Util;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.util.Secret;
Expand All @@ -53,8 +54,8 @@ public class SSHUserPrivateKeyBinding extends MultiBinding<SSHUserPrivateKey> {
}

@DataBoundSetter
public void setUsernameVariable(@Nonnull final String usernameVariable) {
this.usernameVariable = usernameVariable;
public void setUsernameVariable(@CheckForNull String usernameVariable) {
this.usernameVariable = Util.fixEmptyAndTrim(usernameVariable);
}

@CheckForNull
Expand All @@ -63,8 +64,8 @@ public String getUsernameVariable() {
}

@DataBoundSetter
public void setPassphraseVariable(@Nonnull final String passphraseVariable) {
this.passphraseVariable = passphraseVariable;
public void setPassphraseVariable(@CheckForNull String passphraseVariable) {
this.passphraseVariable = Util.fixEmptyAndTrim(passphraseVariable);
}

@CheckForNull
Expand Down
2 changes: 2 additions & 0 deletions src/test/java/org/jenkinsci/plugins/credentialsbinding/impl/CertificateMultiBindingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ public void setUp() throws IOException {
}
}

// TODO configRoundtrip to test form, null hygiene on @DataBoundSetter

@Test
public void basics() throws Exception {
String alias = "androiddebugkey";
Expand Down
28 changes: 15 additions & 13 deletions ...lsbinding/impl/SSHUserPrivateKeyTest.java → ...ng/impl/SSHUserPrivateKeyBindingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import hudson.util.Secret;
import org.jenkinsci.plugins.credentialsbinding.MultiBinding;
import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
import org.jenkinsci.plugins.workflow.cps.SnippetizerTester;
import org.jenkinsci.plugins.workflow.job.WorkflowJob;
import org.jenkinsci.plugins.workflow.job.WorkflowRun;
import org.jenkinsci.plugins.workflow.steps.StepConfigTester;
Expand All @@ -51,7 +52,7 @@
import org.junit.ClassRule;
import org.jvnet.hudson.test.BuildWatcher;

public class SSHUserPrivateKeyTest {
public class SSHUserPrivateKeyBindingTest {

@Rule public RestartableJenkinsRule story = new RestartableJenkinsRule();
@ClassRule public static BuildWatcher bw = new BuildWatcher();
Expand Down Expand Up @@ -119,21 +120,22 @@ public CredentialsScope getScope() {
}

@Test public void configRoundTrip() throws Exception {
story.addStep(new Statement() {
@Override public void evaluate() throws Throwable {
SSHUserPrivateKey c = new DummyPrivateKey("creds", "bob", "secret", "the-key");
CredentialsProvider.lookupStores(story.j.jenkins).iterator().next().addCredentials(Domain.global(), c);
SSHUserPrivateKeyBinding binding = new SSHUserPrivateKeyBinding("keyFile", "creds");
binding.setPassphraseVariable("passphrase");
binding.setUsernameVariable("user");
BindingStep s = new StepConfigTester(story.j).configRoundTrip(new BindingStep(
Collections.<MultiBinding>singletonList(binding)));
story.j.assertEqualDataBoundBeans(s.getBindings(), Collections.singletonList(binding));
}
story.then(r -> {
SnippetizerTester st = new SnippetizerTester(r);
SSHUserPrivateKey c = new DummyPrivateKey("creds", "bob", "secret", "the-key");
CredentialsProvider.lookupStores(story.j.jenkins).iterator().next().addCredentials(Domain.global(), c);
SSHUserPrivateKeyBinding binding = new SSHUserPrivateKeyBinding("keyFile", "creds");
BindingStep s = new StepConfigTester(story.j).configRoundTrip(new BindingStep(Collections.<MultiBinding>singletonList(binding)));
st.assertRoundTrip(s, "withCredentials([sshUserPrivateKey(credentialsId: 'creds', keyFileVariable: 'keyFile')]) {\n // some block\n}");
r.assertEqualDataBoundBeans(s.getBindings(), Collections.singletonList(binding));
binding.setPassphraseVariable("passphrase");
binding.setUsernameVariable("user");
s = new StepConfigTester(story.j).configRoundTrip(new BindingStep(Collections.<MultiBinding>singletonList(binding)));
st.assertRoundTrip(s, "withCredentials([sshUserPrivateKey(credentialsId: 'creds', keyFileVariable: 'keyFile', passphraseVariable: 'passphrase', usernameVariable: 'user')]) {\n // some block\n}");
r.assertEqualDataBoundBeans(s.getBindings(), Collections.singletonList(binding));
});
}


@Test public void basics() throws Exception {
final String credentialsId = "creds";
final String username = "bob";
Expand Down