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

Add support for regex pattern in folders #41

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Add support for regex pattern in folders #41

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
4ddcf07
Add support for regex pattern in folders
rskupnik Jun 22, 2017
a3ea8d1
Improve the implementation
rskupnik Jul 10, 2017
4ec1ab8
Add @Restricted annotation and protect jobPattern with @CheckForNull
rskupnik Jul 10, 2017
7ee4bb7
Fix a logic error when checking for null jobPattern
rskupnik Jul 10, 2017
67020ee
Merge branch 'master' into regex-folders
MarkEWaite Nov 28, 2021
8670d0c
Fix spotbugs warning for possible NPE
MarkEWaite Nov 28, 2021
9a2aea9
Merge branch 'master' into regex-folders
MarkEWaite Apr 15, 2023
b150b21
Remove redundant null check
MarkEWaite Apr 15, 2023
4ed7cfc
Merge branch 'master' into regex-folders
MarkEWaite Apr 15, 2023
ed3313e
Use spotbugs CheckForNull, format source
MarkEWaite Apr 15, 2023
1151f98
Fix merge error
MarkEWaite Apr 15, 2023
35ce6b2
Merge branch 'master' into regex-folders
MarkEWaite Jul 28, 2023
7d3d3f4
Merge branch 'master' into regex-folders
MarkEWaite Jun 21, 2024
d2c87b5
Remove unused logger
MarkEWaite Jun 21, 2024
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
75 changes: 74 additions & 1 deletion ...ain/java/jenkins/advancedqueue/jobinclusion/strategy/FolderBasedJobInclusionStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,30 @@
import hudson.util.ListBoxModel;

import java.util.List;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;

import jenkins.advancedqueue.DecisionLogger;
import jenkins.advancedqueue.jobinclusion.JobInclusionStrategy;
import jenkins.model.Jenkins;

import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;

import com.cloudbees.hudson.plugins.folder.Folder;

import javax.annotation.CheckForNull;

/**
* @author Magnus Sandberg
* @since 3.0
*/
public class FolderBasedJobInclusionStrategy extends JobInclusionStrategy {

private final static Logger LOGGER = Logger.getLogger(FolderBasedJobInclusionStrategy.class.getName());

@Extension(optional = true)
static public class FolderBasedJobInclusionStrategyDescriptor extends
AbstractJobInclusionStrategyDescriptor<FolderBasedJobInclusionStrategy> {
Expand All @@ -62,9 +71,33 @@ public ListBoxModel getListFolderItems() {

};

@Restricted(NoExternalUse.class)
static public class JobPattern {
Copy link
Member

Choose a reason for hiding this comment

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

If you want to create a new class, make it describable and use optionalProperty. OTOH I am not sure it is required in this case

Copy link
Author

Choose a reason for hiding this comment

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

Is it needed? I've been looking at how it's implemented in ViewBasedJobInclusionStrategy and it doesn't seem to be required there.

Copy link
Member

Choose a reason for hiding this comment

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

In the new implementation I still do not see much reason to have the class in the current state

Copy link
Member

Choose a reason for hiding this comment

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

I've been looking at how it's implemented in ViewBasedJobInclusionStrategy and it doesn't seem to be required there.

Well, I was not an author of that :( I rather suggest a proper design from the Jenkins standpoint. The current implementation is rather a hack based on the JSON structure presumptions. It should work, but I am not sure if we can guarantee compatibility of it in the Jenkins core

If you want to keep the class as is, mark it as @Restricted(NoExternalUse.class) to prevent the external usage. But it will also require the constructor modification then.

Copy link
Author

Choose a reason for hiding this comment

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

I've tried to make it work with a normal String instead of the JobPattern but to no avail, it seems like I'm missing something obvious here, probably due to my low understanding of the ecosystem. I had to go with the @Restricted route. I'm not sure what constructor modifications you mean, though.

Copy link
Member

Choose a reason for hiding this comment

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

OK. I will probably just create a pull request on the top of your changes

private String jobPattern;

@DataBoundConstructor
public JobPattern(String jobPattern) {
this.jobPattern = jobPattern;
}

}

private String folderName;

private boolean useJobFilter = false;
Copy link
Member

Choose a reason for hiding this comment

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

Actually there is no need to keep and persist this flag. jobPattern != null should be enough


private String jobPattern;
private transient Pattern compiledPattern;

@DataBoundConstructor
public FolderBasedJobInclusionStrategy(String folderName, JobPattern jobFilter) {
Copy link
Member

Choose a reason for hiding this comment

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

It breaks the binary compatibility. The original constructor should be retained

Copy link
Author

Choose a reason for hiding this comment

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

I'm not overly familiar with Jenkins' ecosystem (yet) - is it enough to retain the original constructor without the @DataBoundConstructor ?

Copy link
Member

Choose a reason for hiding this comment

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

yes, it is

this.folderName = folderName;
this.useJobFilter = (jobFilter != null);
if (this.useJobFilter) {
this.jobPattern = jobFilter.jobPattern;
Copy link
Member

Choose a reason for hiding this comment

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

Empty pattern from config will override the default value. I would rather make the field nullable, get rid of the default, add @CheckForNull annotation to getter methods. Once the value is null, you can just skip regex check to get a better performance

}
}

public FolderBasedJobInclusionStrategy(String folderName) {
this.folderName = folderName;
}
Expand All @@ -73,8 +106,48 @@ public String getFolderName() {
return folderName;
}

public boolean isUseJobFilter() {
return useJobFilter;
}

@CheckForNull
public String getJobPattern() {
return jobPattern;
}

@CheckForNull
private Pattern getCompiledPattern() throws PatternSyntaxException {
if (jobPattern == null)
return null;

if (compiledPattern == null)
compiledPattern = Pattern.compile(jobPattern);
Copy link
Member

Choose a reason for hiding this comment

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

Handle PatternSyntaxException somehow? Or at least add it to throws. If you follow the nullable field advice, it will need an additional check here as well


return compiledPattern;
}

@Override
public boolean contains(DecisionLogger decisionLogger, Job<?, ?> job) {
return job.getFullName().startsWith(folderName);
if (job.getFullName().startsWith(folderName)) {
if (!isUseJobFilter() || getJobPattern() == null || getCompiledPattern() == null) {
decisionLogger.addDecisionLog(2, "Not using filter ...");
return true;
} else {
decisionLogger.addDecisionLog(2, "Using filter ...");
try {
if (getCompiledPattern().matcher(job.getName()).matches()) {
decisionLogger.addDecisionLog(3, "Job is matching the filter ...");
return true;
} else {
decisionLogger.addDecisionLog(3, "Job is not matching the filter ...");
return false;
}
} catch (PatternSyntaxException e) {
decisionLogger.addDecisionLog(3, "Filter has syntax error");
return false;
}
}
}
return false;
}
}
5 changes: 5 additions & 0 deletions .../jenkins/advancedqueue/jobinclusion/strategy/FolderBasedJobInclusionStrategy/config.jelly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
<j:forEach var="folder" items="${descriptor.listFolderItems}">
<f:option value="${folder.value}" selected="${folder.value==instance.folderName}">${folder.name}</f:option>
</j:forEach>
<f:optionalBlock name="jobFilter" checked="${instance.useJobFilter}" title="Use a regular expression to only include a subset of the included Jobs">
<f:entry title="Regular Expression">
<f:textbox name="jobPattern" field="jobPattern" value="${instance.jobPattern}" />
Copy link
Member

Choose a reason for hiding this comment

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

help file is missing

Copy link
Member

Choose a reason for hiding this comment

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

fixed now

</f:entry>
</f:optionalBlock>
</select>
</f:entry>
</j:jelly>
3 changes: 3 additions & 0 deletions .../advancedqueue/jobinclusion/strategy/FolderBasedJobInclusionStrategy/help-jobPattern.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<div>
The regex pattern to be used to filter jobs inside the folder.
</div>