Skip to content
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.

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

Implement Describable from Script, not AbstractScript #406

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@
import java.util.LinkedList;
import java.util.List;

import org.biouno.unochoice.model.AbstractScript;
import org.biouno.unochoice.model.Script;

import hudson.model.Descriptor;
import hudson.model.ParameterDefinition.ParameterDescriptor;
@@ -40,8 +40,8 @@
*/
public class UnoChoiceParameterDescriptor extends ParameterDescriptor {

public List<Descriptor<? extends AbstractScript>> getApplicableResultSeekers() {
return new LinkedList<>(AbstractScript.all());
public List<Descriptor<? extends Script>> getApplicableResultSeekers() {
return new LinkedList<>(Script.all());
}

}
22 changes: 8 additions & 14 deletions src/main/java/org/biouno/unochoice/model/AbstractScript.java
Original file line number Diff line number Diff line change
@@ -24,8 +24,6 @@

package org.biouno.unochoice.model;

import hudson.DescriptorExtensionList;
import hudson.model.Describable;
import hudson.model.Descriptor;
import jenkins.model.Jenkins;

@@ -35,31 +33,27 @@
* @author Bruno P. Kinoshita
* @since 0.23
*/
public abstract class AbstractScript implements Script, Describable<AbstractScript> {
public abstract class AbstractScript implements Script {

/*
* Serial UID.
*/
private static final long serialVersionUID = 4027103576278802323L;

// TODO could be pulled up into Script (default method);

Check warning on line 43 in src/main/java/org/biouno/unochoice/model/AbstractScript.java

ci.jenkins.io / Open Tasks Scanner

TODO

NORMAL: could be pulled up into Script (default method);
// in fact this intermediate type could probably be deleted
// (assuming there is no Java serialization outside of Remoting,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Serial form compatibility for types used in Remoting is irrelevant, since the agent always runs the same bytecode as the controller.)

// since such a change would break the stream class description;
// XStream should not care about that)
@Override
@SuppressWarnings("unchecked")
public Descriptor<AbstractScript> getDescriptor() {
public Descriptor<Script> getDescriptor() {
final Jenkins instance = Jenkins.getInstanceOrNull();
Descriptor<AbstractScript> descriptor = null;
Descriptor<Script> descriptor = null;
if (instance != null) {
descriptor = instance.getDescriptor(getClass());
}
return descriptor;
}

public static DescriptorExtensionList<AbstractScript, ScriptDescriptor> all() {
final Jenkins instance = Jenkins.getInstanceOrNull();
DescriptorExtensionList<AbstractScript, ScriptDescriptor> all = null;
if (instance != null) {
all = instance.getDescriptorList(AbstractScript.class);
}
return all;
}

}
14 changes: 13 additions & 1 deletion src/main/java/org/biouno/unochoice/model/Script.java
Original file line number Diff line number Diff line change
@@ -24,16 +24,19 @@

package org.biouno.unochoice.model;

import hudson.DescriptorExtensionList;
import hudson.model.Describable;
import java.io.Serializable;
import java.util.Map;
import jenkins.model.Jenkins;

/**
* Interface for scripts.
*
* @author Bruno P. Kinoshita
* @since 0.23
*/
public interface Script extends Serializable {
public interface Script extends Serializable, Describable<Script> {

/**
* Evaluates the script.
@@ -50,4 +53,13 @@
*/
Object eval(Map<String, String> parameters);

static DescriptorExtensionList<Script, ScriptDescriptor> all() {
final Jenkins instance = Jenkins.getInstanceOrNull();
DescriptorExtensionList<Script, ScriptDescriptor> all = null;
if (instance != null) {

Check warning on line 59 in src/main/java/org/biouno/unochoice/model/Script.java

ci.jenkins.io / Code Coverage

Partially covered line

Line 59 is only partially covered, one branch is missing
all = instance.getDescriptorList(Script.class);
}
return all;
}

}
Original file line number Diff line number Diff line change
@@ -32,6 +32,6 @@
* @author Bruno P. Kinoshita
* @since 0.23
*/
public abstract class ScriptDescriptor extends Descriptor<AbstractScript> {
public abstract class ScriptDescriptor extends Descriptor<Script> {

}