Skip to content
Permalink
Browse files
Merge pull request #43 from jglick/NoTriggerBranchProperty-JENKINS-32396
[JENKINS-32396] Option to suppress automatic SCM trigger
  • Loading branch information
jglick committed May 23, 2016
2 parents 0400b7d + 2713a10 commit b02297b7ba5c01d40403540badb40b6087ff2394
23 pom.xml
@@ -113,6 +113,29 @@
<version>1.24</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>git</artifactId>
<version>2.4.4</version>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpcore</artifactId>
</exclusion>
<exclusion>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency> <!-- TODO for GitSampleRepoRule; should this be pushed up into scm-api, or git, or jenkins-test-harness? -->
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-scm-step</artifactId>
<version>2.0</version>
<classifier>tests</classifier>
<scope>test</scope>
</dependency>
</dependencies>

</project>
@@ -42,7 +42,7 @@
}

/**
* @inheritDoc
* {@inheritDoc}
*/
@Override
public void onAddedTo(Run build) {
@@ -53,7 +53,7 @@ public void onAddedTo(Run build) {
}

/**
* @inheritDoc
* {@inheritDoc}
*/
@Override
public void onLoad(Run<?,?> build) {
@@ -76,7 +76,7 @@ public String getIndexingUrl() {
}

/**
* @inheritDoc
* {@inheritDoc}
*/
@Override
public String getShortDescription() {
@@ -82,7 +82,7 @@ public ProjectDecorator decorator(Class clazz) {
if (Util.isOverridden(BranchProperty.class, getClass(), "decorator", Class.class) && AbstractProject.class.isAssignableFrom(clazz)) {
return decorator(clazz);
} else {
throw new AbstractMethodError("you must implement jobDecorator");
throw new AbstractMethodError("you must implement jobDecorator in " + getClass());
}
}

@@ -0,0 +1,92 @@
/*
* The MIT License
*
* Copyright 2016 CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/

package jenkins.branch;

import hudson.Extension;
import hudson.model.Action;
import hudson.model.Cause;
import hudson.model.CauseAction;
import hudson.model.Job;
import hudson.model.Queue;
import hudson.model.Run;
import java.util.List;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;

/**
* Suppresses builds due to {@link BranchIndexingCause}.
*/
@Restricted(NoExternalUse.class)
public class NoTriggerBranchProperty extends BranchProperty {

@DataBoundConstructor
public NoTriggerBranchProperty() {}

@Override
public <P extends Job<P, B>, B extends Run<P, B>> JobDecorator<P, B> jobDecorator(Class<P> clazz) {
return null;
}

@Extension
public static class DescriptorImpl extends BranchPropertyDescriptor {

@Override
public String getDisplayName() {
return Messages.NoTriggerBranchProperty_suppress_automatic_scm_triggering();
}

}

@Extension
public static class Dispatcher extends Queue.QueueDecisionHandler {

@SuppressWarnings({"unchecked", "rawtypes"}) // untypable
@Override
public boolean shouldSchedule(Queue.Task p, List<Action> actions) {
for (Action action : actions) {
if (action instanceof CauseAction) {
for (Cause c : ((CauseAction) action).getCauses()) {
if (c instanceof BranchIndexingCause) {
if (p instanceof Job) {
Job j = (Job) p;
if (j.getParent() instanceof MultiBranchProject) {
for (BranchProperty prop : ((MultiBranchProject) j.getParent()).getProjectFactory().getBranch(j).getProperties()) {
if (prop instanceof NoTriggerBranchProperty) {
return false;
}
}
}
}
}
}
}
}
return true;
}

}

}
@@ -0,0 +1,116 @@
/*
* The MIT License
*
* Copyright 2016 CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/

package jenkins.branch;

import com.cloudbees.hudson.plugins.folder.AbstractFolderProperty;
import com.cloudbees.hudson.plugins.folder.AbstractFolderPropertyDescriptor;
import hudson.Extension;
import hudson.model.Action;
import hudson.model.Cause;
import hudson.model.CauseAction;
import hudson.model.Job;
import hudson.model.Queue;
import hudson.util.FormValidation;
import java.util.List;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.QueryParameter;

/**
* Defines {@link NoTriggerBranchProperty} on selected branches.
*/
@Restricted(NoExternalUse.class)
public class NoTriggerOrganizationFolderProperty extends AbstractFolderProperty<OrganizationFolder> {

/** Regexp of branch names to trigger. */
private final String branches;

@DataBoundConstructor
public NoTriggerOrganizationFolderProperty(String branches) {
this.branches = branches;
}

public String getBranches() {
return branches;
}

@Extension
public static class DescriptorImpl extends AbstractFolderPropertyDescriptor {

@Override
public String getDisplayName() {
return Messages.NoTriggerBranchProperty_suppress_automatic_scm_triggering();
}

public FormValidation doCheckBranches(@QueryParameter String value) {
try {
Pattern.compile(value);
return FormValidation.ok();
} catch (PatternSyntaxException x) {
return FormValidation.error(x.getMessage());
}
}

}

@Extension
public static class Dispatcher extends Queue.QueueDecisionHandler {

@SuppressWarnings({"unchecked", "rawtypes"}) // untypable
@Override
public boolean shouldSchedule(Queue.Task p, List<Action> actions) {
for (Action action : actions) {
if (action instanceof CauseAction) {
for (Cause c : ((CauseAction) action).getCauses()) {
if (c instanceof BranchIndexingCause) {
if (p instanceof Job) {
Job j = (Job) p;
if (j.getParent() instanceof MultiBranchProject) {
MultiBranchProject mbp = (MultiBranchProject) j.getParent();
if (mbp.getParent() instanceof OrganizationFolder) {
NoTriggerOrganizationFolderProperty prop = ((OrganizationFolder) mbp.getParent()).getProperties().get(NoTriggerOrganizationFolderProperty.class);
if (prop != null) {
// Not necessarily the same as j.getName(), which may be encoded:
String name = mbp.getProjectFactory().getBranch(j).getName();
if (!name.matches(prop.getBranches())) {
return false;
}
}
}
}
}
}
}
}
}
return true;
}

}

}
@@ -146,7 +146,7 @@ public void addSource(SCMSource source) {
}
List<BranchSource> branchSources = new ArrayList<BranchSource>();
for (SCMSource source : sources) {
// TODO we probably need to define a BranchPropertyStrategyFactory (cf. JENKINS-22242)
// TODO do we want/need a more general BranchPropertyStrategyFactory?
branchSources.add(new BranchSource(source));
}
sources = null; // make sure complete gets called just once
@@ -23,6 +23,7 @@
#
DefaultBranchPropertyStrategy.DisplayName=All branches get the same properties
NamedExceptionsBranchPropertyStrategy.DisplayName=Named branches get different properties
NoTriggerBranchProperty.suppress_automatic_scm_triggering=Suppress automatic SCM triggering
RateLimitBranchProperty.ApproxDaysBetweenBuilds=Approximately {0,choice,1\#a day|1<{0,number,integer} days} between builds
RateLimitBranchProperty.ApproxHoursBetweenBuilds=Approximately {0,choice,1\#an hour|1<{0,number,integer} hours} between builds
RateLimitBranchProperty.ApproxMinsBetweenBuilds=Approximately {0,choice,1\#a minute|1<{0,number,integer} minutes} between builds
@@ -34,4 +35,4 @@ RateLimitBranchProperty.duration.hour=Hour
RateLimitBranchProperty.duration.day=Day
RateLimitBranchProperty.duration.week=Week
RateLimitBranchProperty.duration.month=Month
RateLimitBranchProperty.duration.year=Year
RateLimitBranchProperty.duration.year=Year
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
The MIT License
Copyright 2016 CloudBees, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->

<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core"/>
@@ -0,0 +1,3 @@
<div>
Suppresses the normal SCM commit trigger coming from branch indexing.
</div>
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
The MIT License
Copyright 2016 CloudBees, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->

<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
<f:section title="${%Automatic branch project triggering}">
<f:entry title="${%Branch names to build automatically}" field="branches">
<f:textbox default=".*"/>
</f:entry>
</f:section>
</j:jelly>
@@ -0,0 +1,6 @@
<div>
Allows you to control the SCM commit trigger coming from branch indexing.
Supply a regular expression of branch names, for example <code>(?!release.*).*</code> or <code>PR-\d+</code>.
Matching branches will be triggered automatically.
(You may still build other branches manually or via CLI/REST.)
</div>

0 comments on commit b02297b

Please sign in to comment.