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.

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

Jump to bottom

[JENKINS-34983] - Add pipeline support #12

Merged
merged 15 commits into from
Jun 15, 2018
Merged

[JENKINS-34983] - Add pipeline support #12

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
118ceb7
Add pipeline support
Jun 9, 2018
8a3753a
Update POM version
Jun 13, 2018
dcaeee1
textFinder => findText (per review feedback)
Jun 13, 2018
ad508d1
Add automated test on agent
Jun 13, 2018
fc58b29
TaskListener => RemoteOutputStream (per review feedback)
Jun 13, 2018
563aaa3
Add Jenkinsfile for https://ci.jenkins.io/job/Plugins/
Jun 13, 2018
5906137
Set up testing against the 1.121.x branch for discovering compatibili…
Jun 13, 2018
73c6bb1
Bump minimum Jenkins version to 1.651
basil Jun 15, 2018
1bf70f4
Downgrade minimum Jenkins version to 1.650
basil Jun 15, 2018
4f4eb26
Fix FindBugs warnings
basil Jun 15, 2018
1ff8ffd
Attempt to fix tests on Windows
basil Jun 15, 2018
3b31863
Remove getters
basil Jun 15, 2018
4c89b0c
Attempt to fix tests on Windows (again)
basil Jun 15, 2018
410dc7e
Another try at fixing tests on Windows
basil Jun 15, 2018
54f6a0c
Another try at fixing tests on Windows
basil Jun 15, 2018
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
43 changes: 40 additions & 3 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,19 @@
<parent>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>plugin</artifactId>
<version>1.480</version>
<version>3.4</version>
Copy link
Member

Choose a reason for hiding this comment

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

3.14 now

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, 3.15 now ;-)

<relativePath />
</parent>

<artifactId>text-finder</artifactId>
<packaging>hpi</packaging>
<version>1.11-SNAPSHOT</version>
<name>Jenkins TextFinder plugin</name>
<url>http://wiki.jenkins-ci.org/display/JENKINS/Text-finder+Plugin</url>
<properties>
<jenkins.version>1.642.1</jenkins.version>
<java.level>7</java.level>
</properties>

<developers>
<developer>
Expand All @@ -28,17 +33,49 @@
<url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
</scm>

<dependencies>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>structs</artifactId>
<version>1.3</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-basic-steps</artifactId>
<version>2.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-cps</artifactId>
<version>2.10</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-durable-task-step</artifactId>
<version>2.4</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-job</artifactId>
<version>2.4</version>
<scope>test</scope>
</dependency>
</dependencies>

<repositories>
<repository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
<url>https://repo.jenkins-ci.org/public/</url>
</repository>
</repositories>

<pluginRepositories>
<pluginRepository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
<url>https://repo.jenkins-ci.org/public/</url>
</pluginRepository>
</pluginRepositories>
</project>
Expand Down
210 changes: 141 additions & 69 deletions src/main/java/hudson/plugins/textfinder/TextFinderPublisher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
package hudson.plugins.textfinder;

import hudson.FilePath.FileCallable;
import hudson.FilePath;
import hudson.Launcher;
import hudson.Util;
import hudson.Extension;
import static hudson.Util.fixEmpty;
import hudson.model.AbstractBuild;
import hudson.model.AbstractProject;
import hudson.model.BuildListener;
import hudson.model.Result;
import hudson.remoting.RemoteOutputStream;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.remoting.VirtualChannel;
import hudson.tasks.BuildStepDescriptor;
import hudson.tasks.BuildStepMonitor;
import hudson.tasks.Publisher;
import hudson.tasks.Recorder;
import hudson.util.FormValidation;
import jenkins.MasterToSlaveFileCallable;
import jenkins.tasks.SimpleBuildStep;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.types.FileSet;
import org.apache.commons.io.IOUtils;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.DataBoundSetter;
import org.kohsuke.stapler.QueryParameter;

import javax.servlet.ServletException;
Expand All @@ -39,24 +42,20 @@
*
* @author Santiago.PericasGeertsen@sun.com
*/
public class TextFinderPublisher extends Recorder implements Serializable {
public class TextFinderPublisher extends Recorder implements Serializable, SimpleBuildStep {

public final String fileSet;
public String fileSet;
public final String regexp;
public final boolean succeedIfFound;
public final boolean unstableIfFound;
public boolean succeedIfFound;
public boolean unstableIfFound;
/**
* True to also scan the whole console output
*/
public final boolean alsoCheckConsoleOutput;
public boolean alsoCheckConsoleOutput;

@DataBoundConstructor
public TextFinderPublisher(String fileSet, String regexp, boolean succeedIfFound, boolean unstableIfFound, boolean alsoCheckConsoleOutput) {
this.fileSet = Util.fixEmpty(fileSet.trim());
public TextFinderPublisher(String regexp) {
this.regexp = regexp;
this.succeedIfFound = succeedIfFound;
this.unstableIfFound = unstableIfFound;
this.alsoCheckConsoleOutput = alsoCheckConsoleOutput;

// Attempt to compile regular expression
try {
Expand All @@ -66,13 +65,69 @@ public TextFinderPublisher(String fileSet, String regexp, boolean succeedIfFound
}
}

@Deprecated
public TextFinderPublisher(
String fileSet,
String regexp,
boolean succeedIfFound,
boolean unstableIfFound,
boolean alsoCheckConsoleOutput) {
this(regexp);
this.fileSet = Util.fixEmpty(fileSet.trim());
this.succeedIfFound = succeedIfFound;
this.unstableIfFound = unstableIfFound;
this.alsoCheckConsoleOutput = alsoCheckConsoleOutput;
}

public String getRegexp() {
return regexp;
}

public String getFileSet() {
return fileSet;
}

@DataBoundSetter
public void setFileSet(String fileSet) {
this.fileSet = Util.fixEmpty(fileSet.trim());
}

public boolean isSucceedIfFound() {
return succeedIfFound;
}

@DataBoundSetter
public void setSucceedIfFound(boolean succeedIfFound) {
this.succeedIfFound = succeedIfFound;
}

public boolean isUnstableIfFound() {
return unstableIfFound;
}

@DataBoundSetter
public void setUnstableIfFound(boolean unstableIfFound) {
this.unstableIfFound = unstableIfFound;
}

public boolean isAlsoCheckConsoleOutput() {
return alsoCheckConsoleOutput;
}

@DataBoundSetter
public void setAlsoCheckConsoleOutput(boolean alsoCheckConsoleOutput) {
this.alsoCheckConsoleOutput = alsoCheckConsoleOutput;
}

@Override
public BuildStepMonitor getRequiredMonitorService() {
return BuildStepMonitor.NONE;
}

public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException {
findText(build, listener.getLogger());
return true;
@Override
public void perform(Run<?, ?> run, FilePath workspace, Launcher launcher, TaskListener listener)
throws InterruptedException, IOException {
findText(run, workspace, listener);
}

/**
Expand All @@ -81,74 +136,32 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
private static final class AbortException extends RuntimeException {
}

private void findText(AbstractBuild build, PrintStream logger) throws IOException, InterruptedException {
private void findText(Run<?, ?> run, FilePath workspace, TaskListener listener)
throws IOException, InterruptedException {
try {
PrintStream logger = listener.getLogger();
boolean foundText = false;

if(alsoCheckConsoleOutput) {
logger.println("Checking console output");
foundText |= checkFile(build.getLogFile(), compilePattern(logger), logger, true);
foundText |=
checkFile(run.getLogFile(), compilePattern(logger, regexp), logger, true);
} else {
// printing this when checking console output will cause the plugin
// to find this line, which would be pointless.
// doing this only when fileSet!=null to avoid
logger.println("Checking " + regexp);
}

final RemoteOutputStream ros = new RemoteOutputStream(logger);

if(fileSet!=null) {
foundText |= build.getWorkspace().act(new FileCallable<Boolean>() {
public Boolean invoke(File ws, VirtualChannel channel) throws IOException {
PrintStream logger = new PrintStream(ros);

// Collect list of files for searching
FileSet fs = new FileSet();
org.apache.tools.ant.Project p = new org.apache.tools.ant.Project();
fs.setProject(p);
fs.setDir(ws);
fs.setIncludes(fileSet);
DirectoryScanner ds = fs.getDirectoryScanner(p);

// Any files in the final set?
String[] files = ds.getIncludedFiles();
if (files.length == 0) {
logger.println("Jenkins Text Finder: File set '" +
fileSet + "' is empty");
throw new AbortException();
}

Pattern pattern = compilePattern(logger);

boolean foundText = false;

for (String file : files) {
File f = new File(ws, file);

if (!f.exists()) {
logger.println("Jenkins Text Finder: Unable to" +
" find file '" + f + "'");
continue;
}
if (!f.canRead()) {
logger.println("Jenkins Text Finder: Unable to" +
" read from file '" + f + "'");
continue;
}

foundText |= checkFile(f, pattern, logger, false);
}

return foundText;
}
});
foundText |= workspace.act(new FileChecker(listener, fileSet, regexp));
}

if (foundText != succeedIfFound)
build.setResult(unstableIfFound ? Result.UNSTABLE : Result.FAILURE);
run.setResult(unstableIfFound ? Result.UNSTABLE : Result.FAILURE);
} catch (AbortException e) {
// no test file found
build.setResult(Result.UNSTABLE);
run.setResult(Result.UNSTABLE);
}
}

Expand All @@ -159,7 +172,8 @@ public Boolean invoke(File ws, VirtualChannel channel) throws IOException {
* true to return immediately as soon as the first hit is found. this is necessary
* when we are scanning the console output, because otherwise we'll loop forever.
*/
private boolean checkFile(File f, Pattern pattern, PrintStream logger, boolean abortAfterFirstHit) {
private static boolean checkFile(
File f, Pattern pattern, PrintStream logger, boolean abortAfterFirstHit) {
boolean logFilename = true;
boolean foundText = false;
BufferedReader reader=null;
Expand Down Expand Up @@ -189,7 +203,7 @@ private boolean checkFile(File f, Pattern pattern, PrintStream logger, boolean a
return foundText;
}

private Pattern compilePattern(PrintStream logger) {
private static Pattern compilePattern(PrintStream logger, String regexp) {
Pattern pattern;
try {
pattern = Pattern.compile(regexp);
Expand All @@ -201,8 +215,10 @@ private Pattern compilePattern(PrintStream logger) {
return pattern;
}

@Symbol("textFinder")
Copy link
Member

Choose a reason for hiding this comment

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

Maybe findText() to make it look like method. No strong preference

Copy link
Member Author

Choose a reason for hiding this comment

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

I've changed the symbol to findText as you requested.

@Extension
public static final class DescriptorImpl extends BuildStepDescriptor<Publisher> {
@Override
public String getDisplayName() {
return Messages.DisplayName();
}
Expand All @@ -212,6 +228,7 @@ public String getHelpFile() {
return "/plugin/text-finder/help.html";
}

@Override
public boolean isApplicable(Class<? extends AbstractProject> jobType) {
return true;
}
Expand All @@ -233,6 +250,61 @@ public FormValidation doCheckRegexp(@QueryParameter String value) throws IOExcep
}
}

private static class FileChecker extends MasterToSlaveFileCallable<Boolean> {

private final TaskListener listener;
Copy link
Member

Choose a reason for hiding this comment

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

I would recommend to pass RemoteOutputStream there.
TaskListener gets here from API, and there is no guarantee that it will be always serializable over Remoting if somebody uses API

Copy link
Member Author

Choose a reason for hiding this comment

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

I changed {{TaskListener}} to {{RemoteOutputStream}} as you requested.

private final String fileSet;
private final String regexp;

public FileChecker(TaskListener listener, String fileSet, String regexp) {
this.listener = listener;
this.fileSet = fileSet;
this.regexp = regexp;
}

@Override
public Boolean invoke(File ws, VirtualChannel channel) throws IOException {
PrintStream logger = listener.getLogger();

// Collect list of files for searching
FileSet fs = new FileSet();
org.apache.tools.ant.Project p = new org.apache.tools.ant.Project();
fs.setProject(p);
fs.setDir(ws);
fs.setIncludes(fileSet);
DirectoryScanner ds = fs.getDirectoryScanner(p);

// Any files in the final set?
String[] files = ds.getIncludedFiles();
if (files.length == 0) {
logger.println("Jenkins Text Finder: File set '" + fileSet + "' is empty");
throw new AbortException();
}

Pattern pattern = compilePattern(logger, regexp);

boolean foundText = false;

for (String file : files) {
File f = new File(ws, file);

if (!f.exists()) {
logger.println("Jenkins Text Finder: Unable to" + " find file '" + f + "'");
continue;
}
if (!f.canRead()) {
logger.println(
"Jenkins Text Finder: Unable to" + " read from file '" + f + "'");
continue;
}

foundText |= checkFile(f, pattern, logger, false);
}

return foundText;
}
}

private static final long serialVersionUID = 1L;
}

1 change: 1 addition & 0 deletions src/main/resources/hudson/plugins/textfinder/TextFinderPublisher/config.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
<f:entry field="fileSet" title="${%Files}">
<f:textbox/>
Expand Down
Loading