jenkinsci / generic-webhook-trigger-plugin Goto Github PK

Hi,

currently a generic-webhook trigger invocation returns too much information, as it contains the response of all jobs, whether they're "triggered or not" by the generic webhook. Those "not triggered" jobs include the resolved variables, which doesn't add anything, as they haven't been used because the job hasn't been triggered.

Furthermore, for a given invocation, the resolved variables are always the same for all the pinged jobs, so they could be extracted to their own variable on GenericWebHookRequestReceiver, and returned only once.

Also, as of 1.22 onwards, because of the actual json/xml being contributed as a resolved variable, it also means that the resolved variables content is returned twice, for each job, first one consisting of the sum of each "json/xml leaf" variable, and the other one because of the contributed variable (although I suppose we can manually remove the contributed variable on the pipeline from the triggered jobs).

Why is this a problem? We're using gitea's webhooks to trigger some jobs on jenkins and because all of this, we're beginning to have some webhook responses which are more than 65K characters, which is the maximum allowed by the column which stores the webhook response, so Gitea doesn't store the response, doesn't swallow the unexpected error and doesn't update their appropiate tbale's row, so the webhook remains as not sent, so, on the next webhook call, the webhook is called again, and again, etc. This has become more pressing when we updated to latest version of the plugin, which doubled the output's response.

I understand we've most probably hit a bug on the gitea side, but it would be nice to be able to control the amount of information returned by the generic-webhook-trigger-plugin, or at least to have not returning duplicated info. I can prepare a PR for the latter if needed, as I'm not really sure how to the former could be accomplished..

br,
juan pablo

I wanna receive all request body including null value for matching secret key

i tried below code for getting request body that payload

properties([
            pipelineTriggers([
                [$class: 'GenericTrigger',
                     genericVariables: [
                             [expressionType: 'JSONPath', key: 'body', value: '$'],
                             [expressionType: 'JSONPath', key: 'reference', value: '$.ref'],
                             [expressionType: 'JSONPath', key: 'referenceType', value: '$.ref_type']
                     ],
                     genericHeaderVariables: [
                             [key: 'X-GitHub-Event', regexpFilter: ''],
                             [key: 'X-Hub-Signature', regexpFilter: '']
                     ],

                     regexpFilterText: '',
                     regexpFilterExpression: ''
                ]
            ])
    ])

...


def payLoad = "${env.body}"

echo "${payLoad}'

result is not including null value

The expected value contains null, but does not match the X-path-signature value.

How to get request body including null value

cf) The null values ​​are homepage and mirror-url

Since 1.24 data.triggerResults returns queue info - and it's great, but if my Jenkins job is already in progress it would be cool also get queue status pending, started otherwise.

https://issues.jenkins-ci.org/projects/INFRA/issues/INFRA-1097

Let's assume that we have:

• jenkins-test-1 repo and we have jenkins-test-1 job
• jenkins-test-2 repo and we have jenkins-test-2 job

And both of the repos have webhook (http://username:password@jenkins_url/generic-webhook-trigger/invoke) configured.
This is triggering both the jenkins jobs jenkins-test-1 & jenkins-test-2

Is this possible to trigger only one of them (for example by passing a GET parameter with job name)?

When I'm trying to invoke an endpoint without user:token, just by using ?token=xxxx the build is triggered but getting the error:

{
    "status": "ok",
    "data": {
        "triggerResults": {
            "jenkins-test": "Exception occurred, full stack trace in Jenkins server log. Thrown in: org.jenkinsci.plugins.gwt.GenericTriggerResults:21"
        }
    }
}

P.S. If I provide a wrong token the given response has right error message.

I am trying to set a dynamic filter based on the repo and the job name (we use same Jenkinsfile in all the repos) with following settings:

regexpFilterText: '$repo',
regexpFilterExpression: '/${env.JOB_NAME}.split("/")[1]/g'

The $repo is correctly set to the repo name e.g. template-service and I want to match it with the repo name in the job e.g. ORG/template-service/master. Even with this filter, the webhook is triggering all the jobs. I tried changing '${env.JOB_NAME}' to 'env.JOB_NAME' but that does not work either. Is it possible to use environment variables in regexpFilterExpression? Why is this filter triggering all the jobs?

It seems this plugin is not working with pipelines.

In the Jenkinsfile I've this properties are configured:
properties([buildDiscarder(logRotator(artifactDaysToKeepStr: '', artifactNumToKeepStr: '', daysToKeepStr: '', numToKeepStr: '5')), pipelineTriggers([[$class: 'GenericTrigger', regexpFilterExpression: '', regexpFilterText: '']])])

I've just scanned your source-code and I think a function for PipelineTriggers is missing.

Hi,

I have been using your plugin and I used it on my personal jenkins server which works great and does exactly what I need it to do, However in my work we only have Jenkins 2.0.. is there a version of the plugin that will support this? I have 1.20 installed and it doesnt recognize the input with job DSL api creation through groovy

Thanks
Carl

Hello!
When I use this plugin，And I want to specify a specific branch! But I don't know how to set up!

Generic Webhook Trigger |  
  | Post content parameters |
  | Header parameters |
  | Request parameters |
Optional filter
  | Expression |  
  | Text |  

Can you write any document to help us? Thanks!

i.e., unit test reproducing the issue (adapted from VariablesResolverHeaderTest):

  @Test
  public void testHeaderResolvesCanBeReused() throws Exception {
    String postContent = null;

    List<GenericVariable> genericVariables = newArrayList();

    Map<String, String[]> parameterMap = new HashMap<>();
    List<GenericRequestVariable> genericRequestVariables = new ArrayList<>();

    Map<String, Enumeration<String>> headers = new HashMap<>();
    headers.put("someparam", enumeration("some value"));

    List<GenericHeaderVariable> genericHeaderVariables = new ArrayList<>();
    genericHeaderVariables.add(new GenericHeaderVariable("someparam", null));
    Map<String, String> variables =
            new VariablesResolver(
                    headers,
                    parameterMap,
                    postContent,
                    genericVariables,
                    genericRequestVariables,
                    genericHeaderVariables)
                .getVariables();

        assertThat(variables) //
            .containsEntry("someparam", "some value") //
            .hasSize(2);

    variables =
            new VariablesResolver(
                    headers,
                    parameterMap,
                    postContent,
                    genericVariables,
                    genericRequestVariables,
                    genericHeaderVariables)
                .getVariables();

        assertThat(variables) //  --> this one fails, variables is empty here
            .containsEntry("someparam", "some value") //
            .hasSize(2);
  }

  private Enumeration<String> enumeration(final String... string) {
    return new Enumeration<String>() {
      private int i = 0;

      @Override
      public String nextElement() {
        return string[i++];
      }

      @Override
      public boolean hasMoreElements() {
        return i < string.length;
      }
    };
  }

As title says, header variables cannot be reused through several webhook triggered jobs. This is because at RequestHeaderResolver#L30 and onwards, the Enumeration is first readed and consumed to set the header variable for the first job. When the second job arrives to the same code, it obtains the same Enumeration consumed on the first run, so headerEnumeration.hasMoreElements() returns false and doesn't set the header variable.

Suggested approachs to fix this:

• Convert the Enumeration to a List, work with it, and then create a new Enumeration from this List and put it back on the incomingHeaders variable (PR with this approach following shortly, as there is far less code modified)
• On GenericWebHookRequestReceiver, store the headers as Map <String, List<String>> instead of Map <String, Enumeration<String>>. Propagate this change throughout the plugin

Needed JSON header as it is without flattening the content of JSON.

Hi,

Currently, if a JSONPath expression selects a node rather than a leaf, then no matter what, it gets converted to a String. This is because on VariableResolver#addPostContentParameters, the call to the filter methods uses a toString on the resolved variable (which, in JSONPath can also be a map, if the expression resolves to a node instead of a leaf)

For large pipelines, which use a lot of JSONPath params, it would be nice to have one or two variables representing JSONPath nodes, instead of having one variable for each needed value (as a side effect, this would also allow to access the whole webhook payload). F.ex, inside the pipeline is really easy to do something like

"""
Dear email template,
<a href="$sender.email">$sender.full_name"</a> has come to known blablabla
"""

and it's much more manageable if the job has only one or a couple of JSONPath params rather than 10 or 12.

It seems that to achieve this only requires a couple of changes on VariableResolver:

1. on VariableResolver#L62, the call to filter should be changed to:

map.put(gv.getKey() + "_" + i, filter(o, gv.getRegexpFilter()));

2. replace the filter method with:

private Object filter(Object string, String regexpFilter) {
    if( string instanceof String ) {
        if (string == null || regexpFilter == null || regexpFilter.isEmpty()) {
          return string;
        }
        return string.replaceAll(regexpFilter, "");
    } else {
        LOGGER.info( "NOT filtering " + string )
        return object;
    }
}

As noted above, the ability to filter values on the parameter would be lost for nodes, although that functionality wouldn't be really useful for them anyway.

WDYT?

thanks,
juan pablo

I am trying to access request header variable, X-GitHub-Event, but is always coming up as null. Here is the snippet of my code to extract 'event' variable from header but is not working:

properties([
pipelineTriggers([
[$class: 'GenericTrigger',
genericVariables: [
[expressionType: 'JSONPath', key: 'owner', value: '$.repository.owner.login'],
[expressionType: 'JSONPath', key: 'repo', value: '$.repository.name'],
[expressionType: 'JSONPath', key: 'username', value: '$.sender.login']
],
genericHeaderVariables: [
[key: 'event', regexpFilter: '/X-GitHubEvent:(.*)/g']
],
regexpFilterText: '',
regexpFilterExpression: ''
]
])
])

If i use the webplugin with an Optional filter this option is allways positive.
If the value does match the expression the build is trigert.

But i like to be able to state under witch condition i like to skip the build.
Say if user is 'build' i like to skip the build. Any other user is fine.

How do i accomplish this ?

Updating from 1.27 to 1.28 when the webhooks are accessed they throw a NullPointerException:

java.lang.NullPointerException
	at jenkins.plugins.slack.webhook.WebhookEndpoint.getUrlName(WebhookEndpoint.java:51)
	at jenkins.model.Jenkins.getUnprotectedRootActions(Jenkins.java:4674)
	at jenkins.model.Jenkins.isSubjectToMandatoryReadPermissionCheck(Jenkins.java:4646)
	at jenkins.model.Jenkins.getTarget(Jenkins.java:4624)
	at org.kohsuke.stapler.Stapler.tryInvoke(Stapler.java:674)
	at org.kohsuke.stapler.Stapler.invoke(Stapler.java:845)
	at org.kohsuke.stapler.Stapler.invoke(Stapler.java:649)
	at org.kohsuke.stapler.Stapler.service(Stapler.java:238)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:790)
	at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:841)
	at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1650)
	at hudson.util.PluginServletFilter$1.doFilter(PluginServletFilter.java:154)
	at hudson.util.PluginServletFilter.doFilter(PluginServletFilter.java:157)
	at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1637)
	at hudson.security.csrf.CrumbFilter.doFilter(CrumbFilter.java:105)
	at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1637)
	at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:84)
	at hudson.security.UnwrapSecurityExceptionFilter.doFilter(UnwrapSecurityExceptionFilter.java:51)
	at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:87)
	at jenkins.security.ExceptionTranslationFilter.doFilter(ExceptionTranslationFilter.java:117)
	at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:87)
	at org.acegisecurity.providers.anonymous.AnonymousProcessingFilter.doFilter(AnonymousProcessingFilter.java:125)
	at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:87)
	at org.acegisecurity.ui.rememberme.RememberMeProcessingFilter.doFilter(RememberMeProcessingFilter.java:135)
	at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:87)
	at org.acegisecurity.ui.AbstractProcessingFilter.doFilter(AbstractProcessingFilter.java:271)
	at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:87)
	at jenkins.security.BasicHeaderProcessor.doFilter(BasicHeaderProcessor.java:93)
	at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:87)
	at org.acegisecurity.context.HttpSessionContextIntegrationFilter.doFilter(HttpSessionContextIntegrationFilter.java:249)
	at hudson.security.HttpSessionContextIntegrationFilter2.doFilter(HttpSessionContextIntegrationFilter2.java:67)
	at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:87)
	at hudson.security.ChainedServletFilter.doFilter(ChainedServletFilter.java:90)
	at hudson.security.HudsonFilter.doFilter(HudsonFilter.java:171)
	at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1637)
	at org.kohsuke.stapler.compression.CompressionFilter.doFilter(CompressionFilter.java:49)
	at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1637)
	at hudson.util.CharacterEncodingFilter.doFilter(CharacterEncodingFilter.java:82)
	at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1637)
	at org.kohsuke.stapler.DiagnosticThreadNameFilter.doFilter(DiagnosticThreadNameFilter.java:30)
	at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1637)
	at org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:533)
	at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:143)
	at org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:524)
	at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:132)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:190)
	at org.eclipse.jetty.server.session.SessionHandler.doHandle(SessionHandler.java:1595)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:188)
	at org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1253)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:168)
	at org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:473)
	at org.eclipse.jetty.server.session.SessionHandler.doScope(SessionHandler.java:1564)
	at org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:166)
	at org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1155)
	at org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:141)
	at org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:132)
	at org.eclipse.jetty.server.Server.handle(Server.java:564)
	at org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:317)
	at org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:251)
	at org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:279)
	at org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:110)
	at org.eclipse.jetty.io.ChannelEndPoint$2.run(ChannelEndPoint.java:124)
	at org.eclipse.jetty.util.thread.Invocable.invokePreferred(Invocable.java:128)
	at org.eclipse.jetty.util.thread.Invocable$InvocableExecutor.invoke(Invocable.java:222)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.doProduce(EatWhatYouKill.java:294)
	at org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.run(EatWhatYouKill.java:199)
	at winstone.BoundedExecutorService$1.run(BoundedExecutorService.java:77)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	at java.lang.Thread.run(Thread.java:748)

I'm using Generic Webhook Trigger Plugin 1.8. I'm not granting read access to anonymous user in Jenkins Global Security Matrix-based security. I have only one job with "Generic Webhook Trigger" enabled.

When I tested with curl http://user:[email protected]:8080/generic-webhook-trigger/invoke, it triggered the job. But when I tested from Bitbucket using the same url in Post Webhook, it didn't, and I got "Did not find any jobs to trigger!" in the log.

Relatedly, I enabled "Trigger builds remotely" in my Jenkins job, set a simple token, and added that to Bitbucket (.../invoke?token=mytoken), but that didn't help the issue above. Also, when tested with curl, any token value (or none at all) would trigger the job.

Trigger only if variable resolves to a specific value.

Usa case is to trigger only when object_kind is merge_request.

{"object_kind":"merge_request","user":{"name":"Administrator","username":"root","avatar_url":"http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80\u0026d=identicon"},"project":{"name":"violations-test","description":"","web_url":"http://a3dffa263a40/root/violations-test","avatar_url":null,"git_ssh_url":"git@a3dffa263a40:root/violations-test.git","git_http_url":"http://a3dffa263a40/root/violations-test.git","namespace":"root","visibility_level":20,"path_with_namespace":"root/violations-test","default_branch":"feature/addingcrap","homepage":"http://a3dffa263a40/root/violations-test","url":"git@a3dffa263a40:root/violations-test.git","ssh_url":"git@a3dffa263a40:root/violations-test.git","http_url":"http://a3dffa263a40/root/violations-test.git"},"object_attributes":{"id":1,"target_branch":"master","source_branch":"feature/addingcrap","source_project_id":1,"author_id":1,"assignee_id":null,"title":"some crap","created_at":"2017-02-20 19:54:06 UTC","updated_at":"2017-03-12 21:33:23 UTC","milestone_id":null,"state":"opened","merge_status":"unchecked","target_project_id":1,"iid":1,"description":"","position":0,"locked_at":null,"updated_by_id":null,"merge_error":null,"merge_params":{"force_remove_source_branch":null},"merge_when_build_succeeds":false,"merge_user_id":null,"merge_commit_sha":null,"deleted_at":null,"in_progress_merge_commit_sha":null,"lock_version":null,"time_estimate":0,"source":{"name":"violations-test","description":"","web_url":"http://a3dffa263a40/root/violations-test","avatar_url":null,"git_ssh_url":"git@a3dffa263a40:root/violations-test.git","git_http_url":"http://a3dffa263a40/root/violations-test.git","namespace":"root","visibility_level":20,"path_with_namespace":"root/violations-test","default_branch":"feature/addingcrap","homepage":"http://a3dffa263a40/root/violations-test","url":"git@a3dffa263a40:root/violations-test.git","ssh_url":"git@a3dffa263a40:root/violations-test.git","http_url":"http://a3dffa263a40/root/violations-test.git"},"target":{"name":"violations-test","description":"","web_url":"http://a3dffa263a40/root/violations-test","avatar_url":null,"git_ssh_url":"git@a3dffa263a40:root/violations-test.git","git_http_url":"http://a3dffa263a40/root/violations-test.git","namespace":"root","visibility_level":20,"path_with_namespace":"root/violations-test","default_branch":"feature/addingcrap","homepage":"http://a3dffa263a40/root/violations-test","url":"git@a3dffa263a40:root/violations-test.git","ssh_url":"git@a3dffa263a40:root/violations-test.git","http_url":"http://a3dffa263a40/root/violations-test.git"},"last_commit":{"id":"a7b8f8669a8cda51c3fc64ac20e3c32f8442a8c3","message":"asd\n","timestamp":"2017-03-12T22:33:19+01:00","url":"http://a3dffa263a40/root/violations-test/commit/a7b8f8669a8cda51c3fc64ac20e3c32f8442a8c3","author":{"name":"Tomas Bjerre","email":"[email protected]"}},"work_in_progress":false,"url":"http://a3dffa263a40/root/violations-test/merge_requests/1","action":"update","oldrev":"a17426aa8eacda851e3855f183ee244f5fd3a5c1"},"repository":{"name":"violations-test","url":"git@a3dffa263a40:root/violations-test.git","description":"","homepage":"http://a3dffa263a40/root/violations-test"}}

Currently, if token supplied, the implementation uses that token to authenticate. And that will make the job visible for that request. But! The job might be visible without authentication or the invoke may use something like http://user:pass@jenkins/ and be authenticated without the token...

I'm considering changing the behavior so that if a token is configured in the job, then the job will only trigger if that token is supplied. Even if the invoke has enough credentials to see the job without supplying the token.

The problem with the current implementation is that someone can accidentally trigger a lot of jobs if invoking the plugin with credentials that makes a lot of jobs visible.

Would it be possible to add multiple optional filters so that the plugin could prevent builds for multiple scenarios? The same way we could add multiple post content parameters?

• Specific Events
• Specific users
• The combination of both, I want to prevent builds on commits made by User X and to prevent builds when a Tag event is sent
  This would allow fine grain situations on when to trigger a legitimate build.

Apr 29, 2017 8:36:42 AM org.jenkinsci.plugins.gwt.GenericWebHookRequestReceiver doInvoke
INFO: Did not find any jobs to trigger! The user invoking /generic-webhook-trigger/invoke must have read permission to any jobs that should be triggered.

I use postman request everything is ok,but gitlab webhook error.
What is the problem , thanks.

I am trying to use this awesome plugin to get the non modified received body. so that I can send the paylaod as it is to a kafka using curl.
using Post content parameters - variale PAY_LOAD giving the modified information.

How can I access the actual payload which gets printed under GenericWebhookEnvironmentContributor
Received: ?

Please help!

Groovy code:
pipelineTriggers([[ $class: 'GenericTrigger', genericVariables: [ // Bitbucket EventPayloads: https://confluence.atlassian.com/bitbucket/event-payloads-740262817.html#EventPayloads-Push [key: 'EVENT_REPOSITORY_NAME', value: '$.repository.full_name', expressionType: 'JSONPath'], [key: 'EVENT_PUSH_TYPE', value: '$.push.changes[0].new.type', expressionType: 'JSONPath'], [key: 'BRANCH_OR_TAG', value: '$.push.changes[0].new.name', expressionType: 'JSONPath'], ], genericRequestVariables: [ [key: 'WAR_PROFILE', regexpFilter: ''], [key: 'EXEC_DEPLOY', regexpFilter: ''], [key: 'UPDATEBUILD', regexpFilter: ''], ], regexpFilterText: '$EVENT_PUSH_TYPE', regexpFilterExpression: 'tag' ]

Response Body:
{ "status": "ok", "data": { "triggerResults": { "pipeline-webhook-test": "Exception occurred, full stack trace in Jenkins server log. Thrown in: org.jenkinsci.plugins.gwt.GenericTriggerResults:21", } } }

Jenkins Log:
java.lang.NullPointerException at org.jenkinsci.plugins.gwt.GenericTriggerResults.<init>(GenericTriggerResults.java:21) at org.jenkinsci.plugins.gwt.GenericTrigger.trigger(GenericTrigger.java:118) at org.jenkinsci.plugins.gwt.GenericWebHookRequestReceiver.doInvoke(GenericWebHookRequestReceiver.java:87) at org.jenkinsci.plugins.gwt.GenericWebHookRequestReceiver.doInvoke(GenericWebHookRequestReceiver.java:56) at java.lang.invoke.MethodHandle.invokeWithArguments(MethodHandle.java:627) at org.kohsuke.stapler.Function$MethodFunction.invoke(Function.java:343) at org.kohsuke.stapler.Function.bindAndInvoke(Function.java:184) at org.kohsuke.stapler.Function.bindAndInvokeAndServeResponse(Function.java:117) at org.kohsuke.stapler.MetaClass$1.doDispatch(MetaClass.java:129) at org.kohsuke.stapler.NameBasedDispatcher.dispatch(NameBasedDispatcher.java:58) at org.kohsuke.stapler.Stapler.tryInvoke(Stapler.java:715) at org.kohsuke.stapler.Stapler.invoke(Stapler.java:845) at org.kohsuke.stapler.MetaClass$10.dispatch(MetaClass.java:374) at org.kohsuke.stapler.Stapler.tryInvoke(Stapler.java:715) at org.kohsuke.stapler.Stapler.invoke(Stapler.java:845) at org.kohsuke.stapler.Stapler.invoke(Stapler.java:649) at org.kohsuke.stapler.Stapler.service(Stapler.java:238) at javax.servlet.http.HttpServlet.service(HttpServlet.java:790) at org.eclipse.jetty.servlet.ServletHolder.handle(ServletHolder.java:841) at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1650) at hudson.util.PluginServletFilter$1.doFilter(PluginServletFilter.java:135) at hudson.plugins.greenballs.GreenBallFilter.doFilter(GreenBallFilter.java:59) at hudson.util.PluginServletFilter$1.doFilter(PluginServletFilter.java:132) at hudson.util.PluginServletFilter.doFilter(PluginServletFilter.java:138) at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1637) at org.jenkinsci.plugins.gwt.GenericWebHookRequestReceiver.process(GenericWebHookRequestReceiver.java:125) at hudson.security.csrf.CrumbFilter.doFilter(CrumbFilter.java:58) at org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1637) at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:84) at hudson.security.UnwrapSecurityExceptionFilter.doFilter(UnwrapSecurityExceptionFilter.java:51) at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:87) at jenkins.security.ExceptionTranslationFilter.doFilter(ExceptionTranslationFilter.java:117) at hudson.security.ChainedServletFilter$1.doFilter(ChainedServletFilter.java:87) at

For some reason when i try to pass a token param to use the token auth it is being ignored and i get the following error:

{"status":"ok","data":{"triggerResults":{"ANY":"Did not find any jobs to trigger! The user invoking /generic-webhook-trigger/invoke must have read permission to any jobs that should be triggered. You may try adding http://user:passw@url... or configuring and passing an authentication token like ...trigger/invoke?token=TOKENHERE"}}}

Can anyone please advise on whether they experience the same or its just my jenkins instance?

How should I configure generic-webhook-trigger-plugin to avoid showing

Generic Cause
GenericWebhookEnvironmentContributor Received:
{
  // my request data here, I would like to hide it
}

When you build using a token (i.e. JENKINS_URL/job/my_job/build?token=sometoken&cause=The+Cause) the build lists the cause as "Started by remote host 127.0.0.1 with note: The Cause"

When you trigger a build via a webhook (i.e. JENKINS_URL/generic-webhook-trigger/invoke?token=sometoken&cause=The+Cause) the cause is always "Generic Cause"

Is it possible to pass the cause parameter through so it can be shown with the build as the reason the build was triggered?

Thank you

So, this example is shown for users who are using a Pipeline.
`
node {
properties([
pipelineTriggers([
[$class: 'GenericTrigger',
genericVariables: [
[expressionType: 'JSONPath', key: 'variable1', value: 'expression1'],
[expressionType: 'JSONPath', key: 'variable2', value: 'expression2']
],
regexpFilterText: '',
regexpFilterExpression: ''
]
])
])

stage("build") {
sh '''
echo Build
'''
}
}
`

But how can we access variable1, and variable2 from within stage build? It may be a good idea to make the example echo similar to what the Job DSL example had.

I'm trying to get the repository name from a github webhook POST. The payload looks like this (truncated for clarity):

{
  "repository": {
    "name": "foo"
  }
}

And I've tested at https://jsonpath.curiousconcept.com/ that $.repository.name correctly parses for the respository name.

However, the jenkins job is continually failing to add the variable. When I look at the logs I see the following message:

Dec 20, 2017 1:06:01 PM INFO org.jenkinsci.plugins.gwt.resolvers.PostContentParameterResolver resolve
Unable to resolve repository_name

My configuration looks correct to me:

I am running Jenkins 2.89.2
And generic-webhook-trigger-plugin 1.20

it would be useful to also set variables from request headers, f.ex.,

• Gogs' webhooks are capable of sending a custom header, secret, which can be used at jenkins' side to see if the request cames from that webhook (is legit), or not
• also Gogs' webhooks send the event that triggered the webhook on a request header. Different events produce different payloads

On the UI side, as headers and request parameters would be treated essentially the same, maybe the current request parameter variable field could be reused? that is, if the variable isn't found as a request parameter, then look for it on the request headers? Or maybe is better to clearly separate one from another?

Our SCM tool is sending PR events to trigger our builds but the default parameters that we set get ignored and are not present in the environment.

1. Create Pipeline Job
2. Check "This project is parameterized"
3. Add dummy parameter
4. setup generic webhook trigger with your repo
5. Manually build project - pass: dummy parameter is present
6. Trigger the job with a commit - fail: dummy parameter is not present

Workaround:
Define all parameters in generic webhook trigger section... this means we have to define everything twice

The XMLFlattener only allows access to Element nodes and not Attribute nodes.

e.g.
Element nodes successfully work with an XPATH of /element
<element>value</element>

Attribute nodes do no work with an XPATH of /attribute[@name='key']/@value
<attribute name='key' value='value' />

I've tried a fix for this by modifying isXmlLeafNode() to check for either ELEMENT_NODE or ATTRIBUTE_NODE which resolved the problem I had.

return node != null && (node.getNodeType() == Node.ELEMENT_NODE || node.getNodeType() == Node.ATTRIBUTE_NODE) && node.getChildNodes().getLength() == 1 && node.getFirstChild().getNodeType() == Node.TEXT_NODE;

I have a classic scenario, I have a pipeline that commits changes into github with a service account, obviously I am on an infinite loop scenario, is there a way to filter out commits from specific users and avoid this infinite loop?

Thank you

Hi, thanks for your work with the plugin, it is great!

I'd like to suggest adding the defaultValue attribute to GenericVariables, as the example below:

genericVariables: [ [expressionType: 'JSONPath', key: 'VAR', value: '$.node', defaultValue: 'some_value']

I would like to add some logic by concatenating strings/variables in Optional filter text field.

For example:

• concatenate string w/ variable $FILTER_VAR'customstring'
• concatenate variables $FILTER_VAR$ANOTHER_VAR

Is it possible or I can workaround this?

Most headers include a - character in its name (i.e., content-type), which gets published on the pipeline as content-type, which isn't a valid groovy name.

PR following, replacing "-" with "_" on header variable names (maybe it should be done for request params too?)

I have a single Jenkins instance hosting multiple jobs, which build different repos. I noticed a post message from one repo would trigger unrelated jobs. I understand that there is only one webhook url, but shouldn't Jenkins do some internal matching to trigger only the job that is relevant? For example, with the GitHub Plugin, I didn't see unrelated job being triggered. But that is not the case with the Generic Webhook Trigger Plugin.

Is it by design, or am I missing something?

If this is how it was designed, can we have multiple "Optional Filters", or can we have "positive" "Parameter Filter"? (I understand we can extract the source repo as a parameter, but the regex can only remove the match, not retain the match; I could use the "Optional Fitler" for matching the repo, but I am already using it to match a tag).

This is an awesome plugin. Thank you for the great work!

After updating to v1.15, our webhook that used to work no longer works. Jenkins logs spits out:

INFO: Did not find any jobs to trigger! The user invoking /generic-webhook-trigger/invoke must have read permission to any jobs that should be triggered.

The webhook looks like this:

https://jenkins_user:[email protected]/generic-webhook-trigger/invoke

After rolling back to v1.14, everything works again.

The plugin works great. Let say I have 5 jobs using this plugin. Instead of triggering all the jobs can I control based on the event /payload I receive?

Also, does this plugin execution can handle huge list of events fired ( example: 100 in a min) ?

If the plugin does not lose the received payload during heavy load, can I see the pending requests in Jenkins/ Plugin configuration?

Once again thanks

Thanks a ton for this project..

I will dive deeper, but after a couple hours I wanted to file an issue with a simplified test case.

I am able to get Request Parameters parsed into the Text for the Optional Filter, but it seems like the HTTP header variable isn't getting interprolated.

For example, webhook configuration like this:

But a curl like
curl -v -H 'TESTHEADER: testValue' https://example.com/generic-webhook-trigger/invoke?token= GABE

Returns a json response without the parameter substution.

I re-configured it with Request Parameter and it gets replaced and matched as expected.

I'm actually trying to match X-GitHub-Event: pull_request in my Optional Filter, but I whittled it down to a simple header without dashes for this test.

I'll go looking at the test code next, and maybe even go grab a JDK to possibly help. But i wanted to check if anything seemed out of sorts to others too.

Thanks again for the project!

Migrating to an AWS Jenkins I ran into the following problem:

node {
    properties([
        pipelineTriggers([
            [$class: 'GenericTrigger', 
                genericVariables: [
                    [expressionType: 'JSONPath', key: 'reference', value: '$.ref'],
                    [expressionType: 'JSONPath', key: 'before', value: '$.before'],
                    [expressionType: 'JSONPath', key: 'after', value: '$.after'],
                    [expressionType: 'JSONPath', key: 'repository', value: '$.repository.full_name']
                ],
                genericRequestVariables: [],
                genericHeaderVariables: []
            ]
        ])
    ])
    
    stage("run") 
        echo $reference
    }
}

on triggering the webhook the build fails with No such property: $reference for class: groovy.lang.Binding:

Generic Cause
[Pipeline] node
Running on Jenkins in /var/lib/jenkins/workspace/_autobuild
[Pipeline] {
[Pipeline] properties
GenericWebhookEnvironmentContributor Received:




Contributing variables:



[Pipeline] stage
GenericWebhookEnvironmentContributor Received:




Contributing variables:



[Pipeline] { (run)
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
groovy.lang.MissingPropertyException: No such property: $reference for class: groovy.lang.Binding
	at groovy.lang.Binding.getVariable(Binding.java:63)
	at org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SandboxInterceptor.onGetProperty(SandboxInterceptor.java:242)
	at org.kohsuke.groovy.sandbox.impl.Checker$6.call(Checker.java:282)
	at org.kohsuke.groovy.sandbox.impl.Checker.checkedGetProperty(Checker.java:286)
	at org.kohsuke.groovy.sandbox.impl.Checker.checkedGetProperty(Checker.java:262)
	at org.kohsuke.groovy.sandbox.impl.Checker.checkedGetProperty(Checker.java:262)
	at com.cloudbees.groovy.cps.sandbox.SandboxInvoker.getProperty(SandboxInvoker.java:29)
	at com.cloudbees.groovy.cps.impl.PropertyAccessBlock.rawGet(PropertyAccessBlock.java:20)
	at WorkflowScript.run(WorkflowScript:27)
	at ___cps.transform___(Native Method)
	at com.cloudbees.groovy.cps.impl.PropertyishBlock$ContinuationImpl.get(PropertyishBlock.java:74)
	at com.cloudbees.groovy.cps.LValueBlock$GetAdapter.receive(LValueBlock.java:30)
	at com.cloudbees.groovy.cps.impl.PropertyishBlock$ContinuationImpl.fixName(PropertyishBlock.java:66)
	at sun.reflect.GeneratedMethodAccessor517.invoke(Unknown Source)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at com.cloudbees.groovy.cps.impl.ContinuationPtr$ContinuationImpl.receive(ContinuationPtr.java:72)
	at com.cloudbees.groovy.cps.impl.ConstantBlock.eval(ConstantBlock.java:21)
	at com.cloudbees.groovy.cps.Next.step(Next.java:83)
	at com.cloudbees.groovy.cps.Continuable$1.call(Continuable.java:174)
	at com.cloudbees.groovy.cps.Continuable$1.call(Continuable.java:163)
	at org.codehaus.groovy.runtime.GroovyCategorySupport$ThreadCategoryInfo.use(GroovyCategorySupport.java:122)
	at org.codehaus.groovy.runtime.GroovyCategorySupport.use(GroovyCategorySupport.java:261)
	at com.cloudbees.groovy.cps.Continuable.run0(Continuable.java:163)
	at org.jenkinsci.plugins.workflow.cps.SandboxContinuable.access$001(SandboxContinuable.java:19)
	at org.jenkinsci.plugins.workflow.cps.SandboxContinuable$1.call(SandboxContinuable.java:35)
	at org.jenkinsci.plugins.workflow.cps.SandboxContinuable$1.call(SandboxContinuable.java:32)
	at org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.GroovySandbox.runInSandbox(GroovySandbox.java:108)
	at org.jenkinsci.plugins.workflow.cps.SandboxContinuable.run0(SandboxContinuable.java:32)
	at org.jenkinsci.plugins.workflow.cps.CpsThread.runNextChunk(CpsThread.java:174)
	at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup.run(CpsThreadGroup.java:330)
	at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup.access$100(CpsThreadGroup.java:82)
	at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup$2.call(CpsThreadGroup.java:242)
	at org.jenkinsci.plugins.workflow.cps.CpsThreadGroup$2.call(CpsThreadGroup.java:230)
	at org.jenkinsci.plugins.workflow.cps.CpsVmExecutorService$2.call(CpsVmExecutorService.java:64)
	at java.util.concurrent.FutureTask.run(FutureTask.java:266)
	at hudson.remoting.SingleLaneExecutorService$1.run(SingleLaneExecutorService.java:112)
	at jenkins.util.ContextResettingExecutorService$1.run(ContextResettingExecutorService.java:28)
	at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)
	at java.util.concurrent.FutureTask.run(FutureTask.java:266)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	at java.lang.Thread.run(Thread.java:748)
Finished: FAILURE

Jenkins ver. 2.73.2
Generic Webhook Trigger PluginTrigger 1.20

Using the example of a GitHub PushEvent (1)

I can create a "Post content parameters" entry as such:

Variable: gitFilesModified
Expression: $.commits[*].modified[*]

And the Environment variable in the run "gitFilesModified_0" is set as expected.

However, if I try to create a variable for all files affected:

Variable: gitFilesAffected
Expression: $.commits[*].modified,added,removed[*]

No environment variables starting with "gitFilesAffected" are created at all.

Testing with jsonpath.com, this doesn't seem to be a problem with the path expression itself.

Cheers
Darren

(1) https://developer.github.com/v3/activity/events/types/#pushevent

If you have 2+ projects on Jenkins and call the URL to invoke, it will build all projects with this plugin enabled. Should be a parameter to set which job to build.

It should be possible to pass token in headers: Authorization : Bearer <token-goes-here> to keep it away from logs and let invoking application know this should be secret (and don't include it in output).

Hi,
I've a private bitbucket repo and want to connect via SSH key. Standard Bitbucket plugin is useless since it only provides auth by password (I don't want to create new Jenkins user at Bb and don't want to use my own credentials).

In both multibranch pipelines I've setted this plugin in same way:

and use webook: http://username:[email protected]:8080/generic-webhook-trigger/invoke

but still have

May 09, 2017 1:59:35 PM org.jenkinsci.plugins.gwt.GenericWebHookRequestReceiver doInvoke
INFO: Did not find any jobs to trigger! The user invoking /generic-webhook-trigger/invoke must have read permission to any jobs that should be triggered.

Jenkins is setted to "everyone can do everything" and disallowed is to read by everyone; Jenkins SSH key is added to project, not Bb account

Tried via Bb webhooks, Postman and cUrl, still same response (no triggered tasks):

{
	"status": "ok",
	"data": {
		"triggerResults": {}
	}
}

Now we get following data back from generic-webhook-trigger-plugin:

{
    "status": "ok",
    "data": {
        "triggerResults": {
            "jenkins-test": "OK"
        }
    }
}

It would be great to be able to configure more information, as example queueId or even more

When I push with curl, I get this error response as html :

Caused by: java.lang.NoSuchMethodError: hudson.util.HttpResponses.okJSON(Ljava/util/Map;)Lorg/kohsuke/stapler/HttpResponse;
        at org.jenkinsci.plugins.gwt.GenericWebHookRequestReceiver.doInvoke(GenericWebHookRequestReceiver.java:96)
        at org.jenkinsci.plugins.gwt.GenericWebHookRequestReceiver.doInvoke(GenericWebHookRequestReceiver.java:57)
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
        at java.lang.reflect.Method.invoke(Method.java:606)
        at org.kohsuke.stapler.Function$InstanceFunction.invoke(Function.java:298)
        at org.kohsuke.stapler.Function.bindAndInvoke(Function.java:161)
        at org.kohsuke.stapler.Function.bindAndInvokeAndServeResponse(Function.java:96)
        at org.kohsuke.stapler.MetaClass$1.doDispatch(MetaClass.java:121)
        at org.kohsuke.stapler.NameBasedDispatcher.dispatch(NameBasedDispatcher.java:53)
        at org.kohsuke.stapler.Stapler.tryInvoke(Stapler.java:746)

Windows 7
maven 3.3
java 7

Thanks in advance.

I have configured the Jenkins job to ignore specific commits from specific user, I am looking that github is triggering twice the same hook with the same payload, when this gets to jenkins, it gets stopped on its tracks the first time but not the second time, leading to a build.

Please note the timestamps for both, they happen within milliseconds.

I have a multibranch project and wanted to create an filter that listens to the github repository name and the branch that is pushed to.
But with the following pipeline - even with some other excape sequences (or without) I can not get it working :(

    properties([
        pipelineTriggers([
            [$class: 'GenericTrigger', 
                genericVariables: [
                    [expressionType: 'JSONPath', key: 'reference', value: '$.ref'],
                    [expressionType: 'JSONPath', key: 'before', value: '$.before'],
                    [expressionType: 'JSONPath', key: 'repository', value: '$.repository.full_name']
                ],
                genericRequestVariables: [
                    [key: 'requestWithNumber', regexpFilter: '[^0-9]'],
                    [key: 'requestWithString', regexpFilter: '']
                ],
                genericHeaderVariables: [
                    [key: 'headerWithNumber', regexpFilter: '[^0-9]'],
                    [key: 'headerWithString', regexpFilter: '']
                ],
                regexpFilterText: '$repository/$reference',
                regexpFilterExpression: 'myGroup\\/myRepo\\/refs\\/heads\\/master'
            ]
        ])
    ])

Would be great if this point would be explained in the documentation :)

It would be nice to have a chance to use this plugin with declarative pipeline under trigger sections.
In my case we have all pipelines written in declarative way except one using generic trigger.