Skip to content

Commit

Permalink
[FIXED JENKINS-42888] [FIXED JENKINS-44480] show argument description…
Browse files Browse the repository at this point in the history 
… for selected script
  • Loading branch information
@imod
imod committed Aug 4, 2017
1 parent 1e09603 commit 895fe84
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 50 deletions.
6 changes: 6 additions & 0 deletions README.md
View file
Expand Up @@ -4,3 +4,9 @@ managed-scripts-plugin
Jenkins plugin which allows the central configuration of scripts, these scripts can be reused as build steps in every job.

see the [wiki](https://wiki.jenkins-ci.org/display/JENKINS/Managed+Script+Plugin) for more details

#### builds are currently executed on:

* [jenkins ci, azure - blueocean](https://ci.jenkins.io/blue/organizations/jenkins/Plugins%2Fmanaged-scripts-plugin/)


7 changes: 3 additions & 4 deletions src/main/java/org/jenkinsci/plugins/managedscripts/PowerShellBuildStep.java
View file
Expand Up @@ -181,8 +181,7 @@ public String getDisplayName() {
* @param configId the config id to get the arguments description for
* @return the description
*/
@JavaScriptMethod
public String getArgsDescription(@AncestorInPath ItemGroup context, String configId) {
private String getArgsDescription(@AncestorInPath ItemGroup context, String configId) {
final PowerShellConfig config = ConfigFiles.getByIdOrNull(context, configId);
if (config != null) {
if (config.args != null && !config.args.isEmpty()) {
Expand All @@ -200,7 +199,7 @@ public String getArgsDescription(@AncestorInPath ItemGroup context, String confi
return "No arguments required";
}
}
return "please select a script!";
return "please select a valid script!";
}

@JavaScriptMethod
Expand All @@ -221,7 +220,7 @@ public List<Arg> getArgs(@AncestorInPath ItemGroup context, String configId) {
public FormValidation doCheckBuildStepId(@AncestorInPath ItemGroup context, @QueryParameter String buildStepId) {
final PowerShellConfig config = ConfigFiles.getByIdOrNull(context, buildStepId);
if (config != null) {
return FormValidation.ok();
return FormValidation.ok(getArgsDescription(context, buildStepId));
} else {
return FormValidation.error("you must select a valid powershell file");
}
Expand Down
27 changes: 10 additions & 17 deletions src/main/java/org/jenkinsci/plugins/managedscripts/ScriptBuildStep.java
View file
@@ -1,35 +1,30 @@
package org.jenkinsci.plugins.managedscripts;

import hudson.EnvVars;
import hudson.Extension;
import hudson.FilePath;
import hudson.Launcher;
import hudson.Util;
import hudson.*;
import hudson.model.*;
import hudson.tasks.BuildStepDescriptor;
import hudson.tasks.Builder;
import hudson.tasks.Shell;
import hudson.util.ArgumentListBuilder;
import hudson.util.FormValidation;

import java.io.IOException;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;

import hudson.util.ListBoxModel;
import jenkins.model.Jenkins;

import org.jenkinsci.lib.configprovider.model.Config;
import org.jenkinsci.plugins.configfiles.ConfigFiles;
import org.jenkinsci.plugins.managedscripts.ScriptConfig.Arg;
import org.jenkinsci.plugins.managedscripts.ScriptConfig.ScriptConfigProvider;
import org.jenkinsci.plugins.tokenmacro.TokenMacro;
import org.kohsuke.stapler.AncestorInPath;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.bind.JavaScriptMethod;

import java.io.IOException;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
* LibraryBuildStep {@link Builder}.
* <p>
Expand Down Expand Up @@ -256,15 +251,13 @@ public int compare(Config o1, Config o2) {
}



/**
* gets the argument description to be displayed on the screen when selecting a config in the dropdown
*
* @param configId the config id to get the arguments description for
* @return the description
*/
@JavaScriptMethod
public String getArgsDescription(@AncestorInPath ItemGroup context, String configId) {
private String getArgsDescription(@AncestorInPath ItemGroup context, String configId) {
final ScriptConfig config = ConfigFiles.getByIdOrNull(context, configId);
if (config != null) {
if (config.args != null && !config.args.isEmpty()) {
Expand All @@ -282,7 +275,7 @@ public String getArgsDescription(@AncestorInPath ItemGroup context, String confi
return "No arguments required";
}
}
return "please select a script!";
return "please select a valid script!";
}

@JavaScriptMethod
Expand All @@ -304,7 +297,7 @@ public List<Arg> getArgs(@AncestorInPath ItemGroup context, String configId) {
public FormValidation doCheckBuildStepId(@AncestorInPath ItemGroup context, @QueryParameter String buildStepId) {
final ScriptConfig config = ConfigFiles.getByIdOrNull(context, buildStepId);
if (config != null) {
return FormValidation.ok();
return FormValidation.ok(getArgsDescription(context, buildStepId));
} else {
return FormValidation.error("you must select a valid script");
}
Expand Down
7 changes: 3 additions & 4 deletions src/main/java/org/jenkinsci/plugins/managedscripts/WinBatchBuildStep.java
View file
Expand Up @@ -201,8 +201,7 @@ public int compare(Config o1, Config o2) {
* @param configId the config id to get the arguments description for
* @return the description
*/
@JavaScriptMethod
public String getArgsDescription(@AncestorInPath ItemGroup context, String configId) {
private String getArgsDescription(@AncestorInPath ItemGroup context, String configId) {
final WinBatchConfig config = ConfigFiles.getByIdOrNull(context, configId);
if (config != null) {
if (config.args != null && !config.args.isEmpty()) {
Expand All @@ -220,7 +219,7 @@ public String getArgsDescription(@AncestorInPath ItemGroup context, String confi
return "No arguments required";
}
}
return "please select a script!";
return "please select a valid script!";
}

@JavaScriptMethod
Expand All @@ -238,7 +237,7 @@ public List<Arg> getArgs(@AncestorInPath ItemGroup context, String configId) {
public FormValidation doCheckBuildStepId(@AncestorInPath ItemGroup context, @QueryParameter String buildStepId) {
final WinBatchConfig config = ConfigFiles.getByIdOrNull(context, buildStepId);
if (config != null) {
return FormValidation.ok();
return FormValidation.ok(getArgsDescription(context, buildStepId));
} else {
return FormValidation.error("you must select a valid batch file");
}
Expand Down
25 changes: 0 additions & 25 deletions src/main/webapp/js/managed-scripts.js
View file
@@ -1,29 +1,4 @@

function ms_descArguments(referenceTag, desc){
var all = new Array();
all = document.getElementsByName('buildStepId');
for(var i = 0; i < all.length; i++) {
if(referenceTag == all.item(i)){
var descriptionTag = document.getElementsByName('argumentDescription').item(i);
descriptionTag.innerHTML = desc;
}
}
}

function ms_showParams(referenceTag, scriptId){
desc.getArgsDescription(scriptId, function(t) {
ms_descArguments(referenceTag, t.responseObject());
});
ms_getArgs(referenceTag,scriptId);
}

function ms_getArgs(referenceTag, scriptId){
desc.getArgs(scriptId,function(t){
referenceTag.args = JSON.parse(t.responseText);
ms_labelArgs(referenceTag);
});
}

function ms_labelArgs(referenceTag)
{
var all = new Array();
Expand Down

0 comments on commit 895fe84

Please sign in to comment.