Skip to content

Replace RestartableJenkinsExtension with JenkinsRule#restart #146

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
mtughan merged 1 commit into from
Feb 19, 2025
Merged

Replace RestartableJenkinsExtension with JenkinsRule#restart #146

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
208 changes: 101 additions & 107 deletions src/test/java/org/jenkinsci/plugins/scriptler/builder/ScriptlerBuilderWithRestartTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,15 @@
import org.htmlunit.xml.XmlPage;
import org.jenkinsci.plugins.scriptler.ScriptlerManagementHelper;
import org.jenkinsci.plugins.scriptler.config.Parameter;
import org.jenkinsci.plugins.scriptler.testharness.RestartableJenkinsExtension;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.jvnet.hudson.test.JenkinsRule;
import org.jvnet.hudson.test.RestartableJenkinsRule;
import org.jvnet.hudson.test.junit.jupiter.WithJenkins;

/**
* Warning: a user without RUN_SCRIPT can currently only clone an existing builder INSIDE a project.
* You can search CLONE_NOTE inside this test to see the cases
*/
@ExtendWith(RestartableJenkinsExtension.class)
@WithJenkins
class ScriptlerBuilderWithRestartTest {
private static final String SCRIPT_CONTENTS = "print 'Hello World!'";
private static final String SCRIPT_USABLE_1 = "script_usable_1.groovy";
Expand All @@ -62,98 +60,95 @@ class ScriptlerBuilderWithRestartTest {
private static final String SCRIPT_NOT_USABLE = "not_usable.groovy";

@Test
void configRoundTrip(RestartableJenkinsRule rule) {
rule.then(r -> {
r.jenkins.setCrumbIssuer(null);

ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_1, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_2, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_3, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_4, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_NOT_USABLE, SCRIPT_CONTENTS, false);

FreeStyleProject project = r.createFreeStyleProject("test");

try (JenkinsRule.WebClient wc = r.createWebClient()) {

WebRequest request =
new WebRequest(new URL(r.getURL() + project.getShortUrl() + "configSubmit"), HttpMethod.POST);

final String projectName = project.getName();
request.setRequestParameters(List.of(new NameValuePair(
"json",
JSONObject.fromObject(Map.of(
"name",
projectName,
"builder",
Map.of(
"kind",
ScriptlerBuilder.class.getName(),
"builderId",
"",
"scriptlerScriptId",
SCRIPT_USABLE_1,
"propagateParams",
true,
"defineParams",
Map.of(
"parameters",
List.of(
Map.of("name", "param1", "value", "value1"),
Map.of("name", "param2", "value", "value2"))))))
.toString())));
HtmlPage page = wc.getPage(request);
r.assertGoodStatus(page);

ScriptlerBuilder scriptlerBuilder = project.getBuildersList().get(ScriptlerBuilder.class);
assertNotNull(scriptlerBuilder);
assertNotNull(scriptlerBuilder.getBuilderId());
assertEquals(SCRIPT_USABLE_1, scriptlerBuilder.getScriptId());
assertTrue(scriptlerBuilder.isPropagateParams());
assertIterableEquals(
List.of(new Parameter("param1", "value1"), new Parameter("param2", "value2")),
scriptlerBuilder.getParametersList());
}
});

rule.then(r -> {
FreeStyleProject p = r.jenkins.getItemByFullName("test", FreeStyleProject.class);

ScriptlerBuilder scriptlerBuilder =
Objects.requireNonNull(p).getBuildersList().get(ScriptlerBuilder.class);
void configRoundTrip(JenkinsRule r) throws Throwable {
r.jenkins.setCrumbIssuer(null);

ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_1, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_2, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_3, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_4, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_NOT_USABLE, SCRIPT_CONTENTS, false);

FreeStyleProject project = r.createFreeStyleProject("test");

try (JenkinsRule.WebClient wc = r.createWebClient()) {

WebRequest request =
new WebRequest(new URL(r.getURL() + project.getShortUrl() + "configSubmit"), HttpMethod.POST);

final String projectName = project.getName();
request.setRequestParameters(List.of(new NameValuePair(
"json",
JSONObject.fromObject(Map.of(
"name",
projectName,
"builder",
Map.of(
"kind",
ScriptlerBuilder.class.getName(),
"builderId",
"",
"scriptlerScriptId",
SCRIPT_USABLE_1,
"propagateParams",
true,
"defineParams",
Map.of(
"parameters",
List.of(
Map.of("name", "param1", "value", "value1"),
Map.of("name", "param2", "value", "value2"))))))
.toString())));
HtmlPage page = wc.getPage(request);
r.assertGoodStatus(page);

ScriptlerBuilder scriptlerBuilder = project.getBuildersList().get(ScriptlerBuilder.class);
assertNotNull(scriptlerBuilder);
assertNotNull(scriptlerBuilder.getBuilderId());
assertEquals(SCRIPT_USABLE_1, scriptlerBuilder.getScriptId());
assertTrue(scriptlerBuilder.isPropagateParams());
assertIterableEquals(
List.of(new Parameter("param1", "value1"), new Parameter("param2", "value2")),
scriptlerBuilder.getParametersList());
});
}

r.restart();

FreeStyleProject p = r.jenkins.getItemByFullName("test", FreeStyleProject.class);

ScriptlerBuilder scriptlerBuilder =
Objects.requireNonNull(p).getBuildersList().get(ScriptlerBuilder.class);
assertNotNull(scriptlerBuilder);
assertNotNull(scriptlerBuilder.getBuilderId());
assertEquals(SCRIPT_USABLE_1, scriptlerBuilder.getScriptId());
assertTrue(scriptlerBuilder.isPropagateParams());
assertIterableEquals(
List.of(new Parameter("param1", "value1"), new Parameter("param2", "value2")),
scriptlerBuilder.getParametersList());
}

@Test
void configRoundTripConfigXml(RestartableJenkinsRule rule) {
rule.then(r -> {
r.jenkins.setCrumbIssuer(null);
void configRoundTripConfigXml(JenkinsRule r) throws Throwable {
r.jenkins.setCrumbIssuer(null);

ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_1, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_2, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_3, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_4, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_NOT_USABLE, SCRIPT_CONTENTS, false);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_1, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_2, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_3, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_USABLE_4, SCRIPT_CONTENTS, true);
ScriptlerManagementHelper.saveScript(SCRIPT_NOT_USABLE, SCRIPT_CONTENTS, false);

FreeStyleProject project = r.createFreeStyleProject("test");
FreeStyleProject project = r.createFreeStyleProject("test");

try (JenkinsRule.WebClient wc = r.createWebClient()) {
try (JenkinsRule.WebClient wc = r.createWebClient()) {

XmlPage xmlPage = wc.goToXml(project.getShortUrl() + "config.xml");
r.assertGoodStatus(xmlPage);
String xml = xmlPage.getWebResponse().getContentAsString();
XmlPage xmlPage = wc.goToXml(project.getShortUrl() + "config.xml");
r.assertGoodStatus(xmlPage);
String xml = xmlPage.getWebResponse().getContentAsString();

String modifiedXml = xml.replace(
"<builders/>",
String.format(
"""
String modifiedXml = xml.replace(
"<builders/>",
String.format(
"""
<builders>
<org.jenkinsci.plugins.scriptler.builder.ScriptlerBuilder>
<builderId></builderId>
Expand All @@ -171,39 +166,38 @@ void configRoundTripConfigXml(RestartableJenkinsRule rule) {
</parameters>
</org.jenkinsci.plugins.scriptler.builder.ScriptlerBuilder>
</builders>""",
SCRIPT_USABLE_1));

WebRequest request = new WebRequest(new URL(project.getAbsoluteUrl() + "config.xml"), HttpMethod.POST);
request.setRequestBody(modifiedXml);
request.setEncodingType(null);
HtmlPage page = wc.getPage(request);
r.assertGoodStatus(page);

project = r.jenkins.getItemByFullName(project.getFullName(), FreeStyleProject.class);
ScriptlerBuilder scriptlerBuilder =
Objects.requireNonNull(project).getBuildersList().get(ScriptlerBuilder.class);
assertNotNull(scriptlerBuilder);
assertEquals("", scriptlerBuilder.getBuilderId());
assertEquals(SCRIPT_USABLE_1, scriptlerBuilder.getScriptId());
assertTrue(scriptlerBuilder.isPropagateParams());
assertIterableEquals(
List.of(new Parameter("param1", "value1"), new Parameter("param2", "value2")),
scriptlerBuilder.getParametersList());
}
});

rule.then(r -> {
FreeStyleProject p = r.jenkins.getItemByFullName("test", FreeStyleProject.class);
SCRIPT_USABLE_1));

WebRequest request = new WebRequest(new URL(project.getAbsoluteUrl() + "config.xml"), HttpMethod.POST);
request.setRequestBody(modifiedXml);
request.setEncodingType(null);
HtmlPage page = wc.getPage(request);
r.assertGoodStatus(page);

project = r.jenkins.getItemByFullName(project.getFullName(), FreeStyleProject.class);
ScriptlerBuilder scriptlerBuilder =
Objects.requireNonNull(p).getBuildersList().get(ScriptlerBuilder.class);
Objects.requireNonNull(project).getBuildersList().get(ScriptlerBuilder.class);
assertNotNull(scriptlerBuilder);
assertNotNull(scriptlerBuilder.getBuilderId());
assertEquals("", scriptlerBuilder.getBuilderId());
assertEquals(SCRIPT_USABLE_1, scriptlerBuilder.getScriptId());
assertTrue(scriptlerBuilder.isPropagateParams());
assertIterableEquals(
List.of(new Parameter("param1", "value1"), new Parameter("param2", "value2")),
scriptlerBuilder.getParametersList());
});
}

r.restart();

FreeStyleProject p = r.jenkins.getItemByFullName("test", FreeStyleProject.class);

ScriptlerBuilder scriptlerBuilder =
Objects.requireNonNull(p).getBuildersList().get(ScriptlerBuilder.class);
assertNotNull(scriptlerBuilder);
assertNotNull(scriptlerBuilder.getBuilderId());
assertEquals(SCRIPT_USABLE_1, scriptlerBuilder.getScriptId());
assertTrue(scriptlerBuilder.isPropagateParams());
assertIterableEquals(
List.of(new Parameter("param1", "value1"), new Parameter("param2", "value2")),
scriptlerBuilder.getParametersList());
}
}
54 changes: 0 additions & 54 deletions src/test/java/org/jenkinsci/plugins/scriptler/testharness/RestartableJenkinsExtension.java
View file
Open in desktop

This file was deleted.