[JENKINS-50636] Use @DataBoundSetter for optional pipeline params #48
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,7 @@ | |
| import hudson.Extension; | ||
| import hudson.FilePath; | ||
| import hudson.Launcher; | ||
| import hudson.Util; | ||
| import hudson.model.AbstractProject; | ||
| import hudson.model.Run; | ||
| import hudson.model.TaskListener; | ||
|
|
@@ -13,11 +14,13 @@ | |
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.UUID; | ||
| import javax.annotation.CheckForNull; | ||
| import javax.servlet.ServletException; | ||
| import jenkins.tasks.SimpleBuildStep; | ||
| import net.sf.json.JSONObject; | ||
| import org.jenkinsci.Symbol; | ||
| import org.kohsuke.stapler.DataBoundConstructor; | ||
| import org.kohsuke.stapler.DataBoundSetter; | ||
| import org.kohsuke.stapler.QueryParameter; | ||
| import org.kohsuke.stapler.StaplerRequest; | ||
|
|
||
|
|
@@ -34,133 +37,188 @@ | |
| */ | ||
| public class PlotBuilder extends Builder implements SimpleBuildStep { | ||
|
|
||
| // Required fields | ||
| private final String group; | ||
| private final String style; | ||
|
|
||
| // Optional fields | ||
| @CheckForNull | ||
| private String title; | ||
| @CheckForNull | ||
| private String numBuilds; | ||
| @CheckForNull | ||
| private String yaxis; | ||
| @CheckForNull | ||
| private String yaxisMinimum; | ||
| @CheckForNull | ||
| private String yaxisMaximum; | ||
| private boolean useDescr; | ||
| private boolean exclZero; | ||
| private boolean logarithmic; | ||
| private boolean keepRecords; | ||
|
|
||
| // Generated? | ||
| @SuppressWarnings("visibilitymodifier") | ||
| public String csvFileName; | ||
| /** | ||
| * List of data series. | ||
| */ | ||
| @SuppressWarnings("visibilitymodifier") | ||
| public List<CSVSeries> csvSeries; | ||
| @SuppressWarnings("visibilitymodifier") | ||
| public List<PropertiesSeries> propertiesSeries; | ||
| @SuppressWarnings("visibilitymodifier") | ||
| public List<XMLSeries> xmlSeries; | ||
|
|
||
| // Fields in config.jelly must match the parameter names in the "DataBoundConstructor" | ||
| // Similarly, any optional @DataBoundSetter properties must match | ||
| @DataBoundConstructor | ||
| public PlotBuilder(String group, String style, String csvFileName) { | ||
| this.group = group; | ||
| this.style = style; | ||
| this.csvFileName = csvFileName; | ||
| } | ||
|
|
||
| public String getGroup() { | ||
| return group; | ||
| } | ||
|
|
||
| public String getStyle() { | ||
| return style; | ||
| } | ||
|
|
||
| @CheckForNull | ||
| public String getTitle() { | ||
| return title; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public final void setTitle(@CheckForNull String title) { | ||
| this.title = Util.fixEmptyAndTrim(title); | ||
| } | ||
|
|
||
| @CheckForNull | ||
| public String getNumBuilds() { | ||
| return numBuilds; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public final void setNumBuilds(@CheckForNull String numBuilds) { | ||
| this.numBuilds = Util.fixEmptyAndTrim(numBuilds); | ||
| } | ||
|
|
||
| @CheckForNull | ||
| public String getYaxis() { | ||
| return yaxis; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public final void setYaxis(@CheckForNull String yaxis) { | ||
| this.yaxis = Util.fixEmptyAndTrim(yaxis); | ||
| } | ||
|
|
||
| public boolean getUseDescr() { | ||
| return useDescr; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public void setUseDescr(boolean useDescr) { | ||
| this.useDescr = useDescr; | ||
| } | ||
|
|
||
| public boolean getExclZero() { | ||
| return exclZero; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public void setExclZero(boolean exclZero) { | ||
| this.exclZero = exclZero; | ||
| } | ||
|
|
||
| public boolean getLogarithmic() { | ||
| return logarithmic; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public void setLogarithmic(boolean logarithmic) { | ||
| this.logarithmic = logarithmic; | ||
| } | ||
|
|
||
| public boolean getKeepRecords() { | ||
| return keepRecords; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public void setKeepRecords(boolean keepRecords) { | ||
| this.keepRecords = keepRecords; | ||
| } | ||
|
|
||
| @CheckForNull | ||
| public String getYaxisMinimum() { | ||
| return yaxisMinimum; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public final void setYaxisMinimum(@CheckForNull String yaxisMinimum) { | ||
| this.yaxisMinimum = Util.fixEmptyAndTrim(yaxisMinimum); | ||
| } | ||
|
|
||
| @CheckForNull | ||
| public String getYaxisMaximum() { | ||
| return yaxisMaximum; | ||
| } | ||
|
|
||
|
There was a problem hiding this comment. Verified that this one was actually never called from outside. Should be safe to remove. There was a problem hiding this comment. I'm not super happy with the removal of this, as it splits the pipeline and freestyle jobs further from each other. I tried taking parts of the freestyle config.jelly, unfortunately it's not just simple replacement. I'm not familiar enough with freestyle jobs to say why that is. |
||
| @DataBoundSetter | ||
| public final void setYaxisMaximum(@CheckForNull String yaxisMaximum) { | ||
| this.yaxisMaximum = Util.fixEmptyAndTrim(yaxisMaximum); | ||
| } | ||
|
|
||
| public List<CSVSeries> getCsvSeries() { | ||
| return csvSeries; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public void setCsvSeries(List<CSVSeries> csvSeries) { | ||
| this.csvSeries = csvSeries; | ||
| } | ||
|
|
||
| public List<PropertiesSeries> getPropertiesSeries() { | ||
| return propertiesSeries; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public void setPropertiesSeries(List<PropertiesSeries> propertiesSeries) { | ||
| this.propertiesSeries = propertiesSeries; | ||
| } | ||
|
|
||
| public List<XMLSeries> getXmlSeries() { | ||
| return xmlSeries; | ||
| } | ||
|
|
||
| @DataBoundSetter | ||
| public void setXmlSeries(List<XMLSeries> xmlSeries) { | ||
| this.xmlSeries = xmlSeries; | ||
| } | ||
|
|
||
| @Override | ||
| public void perform(Run<?, ?> build, FilePath workspace, Launcher launcher, | ||
| TaskListener listener) { | ||
| List<Plot> plots = new ArrayList<>(); | ||
| Plot plot = new Plot(title, yaxis, group, numBuilds, csvFileName, style, | ||
| useDescr, keepRecords, exclZero, logarithmic, | ||
| yaxisMinimum, yaxisMaximum); | ||
|
|
||
| List<Series> series = new ArrayList<>(); | ||
| if (csvSeries != null) { | ||
| series.addAll(csvSeries); | ||
| } | ||
| if (xmlSeries != null) { | ||
| series.addAll(xmlSeries); | ||
| } | ||
| if (propertiesSeries != null) { | ||
| series.addAll(propertiesSeries); | ||
| } | ||
|
|
||
| plot.series = series; | ||
| plot.addBuild(build, listener.getLogger(), workspace); | ||
| plots.add(plot); | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably this field should be moved to the top where other
Required fieldsare located.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one is a little odd, since it's not directly specified by the user with the snippet generator. I'm assuming it's generated here through reflection when the step is created.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to move, your assumption is correct. Maybe, in this case, explanation comment from where it comes will be better than
Generate?.