Skip to content

Handle dorment login configuration in RundeckClientManager #53

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
norrs wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Handle dorment login configuration in RundeckClientManager #53

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
3068252
Test for either using token or username/password
norrs Mar 2, 2023
bd56943
Validate both username and password has value
norrs Mar 2, 2023
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
5 changes: 5 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@
<version>1.16</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>subversion</artifactId>
Expand Down
23 changes: 21 additions & 2 deletions src/main/java/org/jenkinsci/plugins/rundeck/client/RundeckClientManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package org.jenkinsci.plugins.rundeck.client;

import com.google.common.annotations.VisibleForTesting;
import hudson.AbortException;
import okhttp3.ResponseBody;
import org.jenkinsci.plugins.rundeck.RundeckInstance;
import org.rundeck.client.RundeckClient;
import org.rundeck.client.RundeckClient.Builder;
import org.rundeck.client.api.RundeckApi;
import org.rundeck.client.api.model.*;
import org.rundeck.client.api.model.scheduler.ScheduledJobItem;
Expand All @@ -23,6 +25,8 @@ public class RundeckClientManager implements RundeckManager {
private RundeckInstance rundeckInstance;
private Client<RundeckApi> client;

private Builder<RundeckApi> clientBuilder;

public RundeckClientManager() {
}

Expand All @@ -31,6 +35,20 @@ public RundeckClientManager(RundeckInstance rundeckInstance) {
buildClient();
}


private Builder<RundeckApi> createRundeckClientBuilder() {
if (clientBuilder != null) {
return clientBuilder;
} else {
return RundeckClient.builder();
}
}

@VisibleForTesting
protected void setRundeckClientBuilder(Builder<RundeckApi> builder) {
clientBuilder = builder;
}

public RundeckInstance getRundeckInstance() {
return rundeckInstance;
}
Expand All @@ -49,12 +67,13 @@ public void setClient(Client<RundeckApi> client) {

public void buildClient(){
if(client == null){
RundeckClient.Builder builder = RundeckClient.builder().baseUrl(rundeckInstance.getUrl());
RundeckClient.Builder builder = createRundeckClientBuilder().baseUrl(rundeckInstance.getUrl());

if(rundeckInstance.getToken()!=null && !rundeckInstance.getToken().getPlainText().isEmpty()){
builder.tokenAuth(rundeckInstance.getToken().getPlainText());
}
if(rundeckInstance.getLogin() != null && rundeckInstance.getPassword()!=null){
if (rundeckInstance.getLogin() != null && rundeckInstance.getPassword() != null
&& !rundeckInstance.getPassword().getPlainText().isEmpty()) {
builder.passwordAuth(rundeckInstance.getLogin(),rundeckInstance.getPassword().getPlainText() );
}

Expand Down
39 changes: 39 additions & 0 deletions src/test/java/org/jenkinsci/plugins/rundeck/client/RundeckClientManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package org.jenkinsci.plugins.rundeck.client;

import static org.mockito.Mockito.anyString;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import hudson.util.Secret;
import org.jenkinsci.plugins.rundeck.RundeckInstance;
import org.junit.Test;
import org.rundeck.client.RundeckClient;
import org.rundeck.client.RundeckClient.Builder;
import org.rundeck.client.api.RundeckApi;

public class RundeckClientManagerTest {

@Test
public void usingTokenDoesNotTryToSetUsernameAndPasswordCredentialsMethodWhenEarlierLoginInformationIsFoundInConfiguration() {

Builder<RundeckApi> clientBuilderSpy = spy(RundeckClient.builder());

RundeckInstance rundeckInstanceMock = mock(RundeckInstance.class);
when(rundeckInstanceMock.getUrl()).thenReturn("http://localhost:4044");

when(rundeckInstanceMock.getToken()).thenReturn(Secret.fromString("aToken"));
when(rundeckInstanceMock.getTokenPlainText()).thenReturn("aToken");
when(rundeckInstanceMock.getLogin()).thenReturn("bad_data_from_plugin_data_somehow");
when(rundeckInstanceMock.getPassword()).thenReturn(Secret.fromString(""));
when(rundeckInstanceMock.getPasswordPlainText()).thenReturn("");

RundeckClientManager rundeckClientManager = new RundeckClientManager(rundeckInstanceMock);
rundeckClientManager.setRundeckClientBuilder(clientBuilderSpy);
rundeckClientManager.buildClient();

verify(clientBuilderSpy, never()).passwordAuth(anyString(), anyString());

}
}