diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStep.java index 14dae35..a274bdd 100644 --- a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStep.java +++ b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStep.java @@ -66,6 +66,15 @@ public void setColor(String color) { } } + /** + * @deprecated replaced by {@link #getStyle()}. + */ + @Deprecated(since = "2.0", forRemoval = true) + public String getColor() { + // translate new field to color + return StringUtils.substringBetween(getStyle(), "color: ", ";"); + } + @Override public StepExecution start(StepContext context) { return new Execution(getId(), getIcon(), getText(), getCssClass(), getStyle(), getLink(), context) { diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStep.java index 1e7a627..d764c8c 100644 --- a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStep.java +++ b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStep.java @@ -85,6 +85,11 @@ public String getFunctionName() { public String getDisplayName() { return "Add a HTML Badge"; } + + @Override + public boolean isAdvanced() { + return true; + } } @Deprecated(since = "2.0", forRemoval = true) diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddShortTextStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddShortTextStep.java index 6f404b2..5f196fe 100644 --- a/src/main/java/com/jenkinsci/plugins/badge/dsl/AddShortTextStep.java +++ b/src/main/java/com/jenkinsci/plugins/badge/dsl/AddShortTextStep.java @@ -121,6 +121,11 @@ public String getFunctionName() { public String getDisplayName() { return "Add Short Text"; } + + @Override + public boolean isAdvanced() { + return true; + } } @Deprecated(since = "2.0", forRemoval = true) diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/CreateSummaryStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/CreateSummaryStep.java index 78b7d62..d893810 100644 --- a/src/main/java/com/jenkinsci/plugins/badge/dsl/CreateSummaryStep.java +++ b/src/main/java/com/jenkinsci/plugins/badge/dsl/CreateSummaryStep.java @@ -95,6 +95,11 @@ public String getFunctionName() { public String getDisplayName() { return "Create Summary"; } + + @Override + public boolean isAdvanced() { + return true; + } } @Deprecated(since = "2.0", forRemoval = true) diff --git a/src/main/java/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStep.java b/src/main/java/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStep.java index 3873dd5..dd05e60 100644 --- a/src/main/java/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStep.java +++ b/src/main/java/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStep.java @@ -76,6 +76,11 @@ public String getFunctionName() { public String getDisplayName() { return "Remove HTML Badges"; } + + @Override + public boolean isAdvanced() { + return true; + } } @Override diff --git a/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStep/help.html b/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStep/help.html new file mode 100644 index 0000000..fa804f8 --- /dev/null +++ b/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStep/help.html @@ -0,0 +1,5 @@ +
+

+ This step has been deprecated and should be replaced by addBadge. +

+
diff --git a/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddShortTextStep/help.html b/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddShortTextStep/help.html new file mode 100644 index 0000000..fa804f8 --- /dev/null +++ b/src/main/resources/com/jenkinsci/plugins/badge/dsl/AddShortTextStep/help.html @@ -0,0 +1,5 @@ +
+

+ This step has been deprecated and should be replaced by addBadge. +

+
diff --git a/src/main/resources/com/jenkinsci/plugins/badge/dsl/CreateSummaryStep/help.html b/src/main/resources/com/jenkinsci/plugins/badge/dsl/CreateSummaryStep/help.html new file mode 100644 index 0000000..2344c24 --- /dev/null +++ b/src/main/resources/com/jenkinsci/plugins/badge/dsl/CreateSummaryStep/help.html @@ -0,0 +1,5 @@ +
+

+ This step has been deprecated and should be replaced by addSummary. +

+
diff --git a/src/main/resources/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStep/help.html b/src/main/resources/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStep/help.html new file mode 100644 index 0000000..5efb14f --- /dev/null +++ b/src/main/resources/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStep/help.html @@ -0,0 +1,5 @@ +
+

+ This step has been deprecated and should be replaced by addBadge and removeBadges. +

+
diff --git a/src/test/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStepTest.java b/src/test/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStepTest.java index 4ea38c8..205f103 100644 --- a/src/test/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStepTest.java +++ b/src/test/java/com/jenkinsci/plugins/badge/dsl/AddBadgeStepTest.java @@ -51,6 +51,19 @@ void defaultConstructor(JenkinsRule r) { assertNull(step.getLink()); } + @Test + @Deprecated(since = "2.0", forRemoval = true) + void color(@SuppressWarnings("unused") JenkinsRule r) { + AddBadgeStep step = (AddBadgeStep) createStep("id", "icon", "text", "cssClass", null, "link"); + assertNull(step.getColor()); + + step.setColor(""); + assertEquals("", step.getColor()); + + step.setColor("style"); + assertEquals("style", step.getColor()); + } + @Test void addInScriptedPipeline(JenkinsRule r) throws Exception { AbstractAddBadgeStep step = createStep( diff --git a/src/test/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStepTest.java b/src/test/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStepTest.java index ea2e132..34bc4b0 100644 --- a/src/test/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStepTest.java +++ b/src/test/java/com/jenkinsci/plugins/badge/dsl/AddHtmlBadgeStepTest.java @@ -25,6 +25,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; import com.jenkinsci.plugins.badge.action.HtmlBadgeAction; import hudson.markup.RawHtmlMarkupFormatter; @@ -62,6 +63,12 @@ void html() { assertEquals(html, step.getHtml()); } + @Test + void deprecated(@SuppressWarnings("unused") JenkinsRule r) { + AddHtmlBadgeStep step = new AddHtmlBadgeStep(null); + assertTrue(step.getDescriptor().isAdvanced()); + } + @Test void addHtmlBadge(JenkinsRule r) throws Exception { String html = UUID.randomUUID().toString(); diff --git a/src/test/java/com/jenkinsci/plugins/badge/dsl/CreateSummaryStepTest.java b/src/test/java/com/jenkinsci/plugins/badge/dsl/CreateSummaryStepTest.java index a55cd1f..f327f66 100644 --- a/src/test/java/com/jenkinsci/plugins/badge/dsl/CreateSummaryStepTest.java +++ b/src/test/java/com/jenkinsci/plugins/badge/dsl/CreateSummaryStepTest.java @@ -73,6 +73,12 @@ void text(@SuppressWarnings("unused") JenkinsRule r) { assertEquals(text, step.getText()); } + @Test + void deprecated(@SuppressWarnings("unused") JenkinsRule r) { + CreateSummaryStep step = new CreateSummaryStep(null); + assertTrue(step.getDescriptor().isAdvanced()); + } + @Test void createSummary_plain(JenkinsRule r) throws Exception { String text = randomUUID().toString(); diff --git a/src/test/java/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStepTest.java b/src/test/java/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStepTest.java index 14359ff..5e6b951 100644 --- a/src/test/java/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStepTest.java +++ b/src/test/java/com/jenkinsci/plugins/badge/dsl/RemoveHtmlBadgesStepTest.java @@ -24,6 +24,7 @@ package com.jenkinsci.plugins.badge.dsl; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; import hudson.model.BuildBadgeAction; import java.util.List; @@ -63,6 +64,12 @@ void removeInvalidId(JenkinsRule r) throws Exception { runRemoveJob(r, addStep, removeStep, 1); } + @Test + void deprecated(@SuppressWarnings("unused") JenkinsRule r) { + RemoveHtmlBadgesStep removeStep = createRemoveStep(null); + assertTrue(removeStep.getDescriptor().isAdvanced()); + } + private static void runRemoveJob( JenkinsRule r, AddHtmlBadgeStep addStep, RemoveHtmlBadgesStep removeStep, int expected) throws Exception { WorkflowJob project = r.jenkins.createProject(WorkflowJob.class, "project"); diff --git a/src/test/java/com/jenkinsci/plugins/badge/dsl/ShortTextStepTest.java b/src/test/java/com/jenkinsci/plugins/badge/dsl/ShortTextStepTest.java index 478f3b2..f2708e5 100644 --- a/src/test/java/com/jenkinsci/plugins/badge/dsl/ShortTextStepTest.java +++ b/src/test/java/com/jenkinsci/plugins/badge/dsl/ShortTextStepTest.java @@ -25,6 +25,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; import com.jenkinsci.plugins.badge.action.BadgeAction; import hudson.model.BuildBadgeAction; @@ -97,6 +98,12 @@ void link(@SuppressWarnings("unused") JenkinsRule r) { assertEquals("https://jenkins.io", step.getLink()); } + @Test + void deprecated(@SuppressWarnings("unused") JenkinsRule r) { + AddShortTextStep step = new AddShortTextStep(null); + assertTrue(step.getDescriptor().isAdvanced()); + } + @Test void addShortText(JenkinsRule r) throws Exception { String text = UUID.randomUUID().toString();