Support pipeline name as param

README.md

@@ -50,6 +50,10 @@ Create or delete a webhook using the configured parameters.
     webhook_token: your-token
     operation: create
     events: [push, pull_request]
+    pipeline: pipeline-name
+    pipeline_instance_vars: {
+        your_instance_var_name: value
+    }
 ```
 
 -	`org`: *Required.* Your github organization.
@@ -60,6 +64,8 @@ Create or delete a webhook using the configured parameters.
     -   `create` to create a new webhook. Updates existing webhook if your configuration differs from remote.
     -   `delete` to delete an existing webhook. Outputs current timestamp on non-existing webhooks.
 -   `events`: *Optional*. An array of [events](https://developer.github.com/webhooks/#events) which will trigger your webhook. Default: `push`
+-	`pipeline`: *Optional.* Defaults to the name of the pipeline executing the task
+-	`pipeline_instance_vars`: *Optional.* Instance vars to append to the webhook url. These help Concourse identify which [instance pipeline](https://concourse-ci.org/resources.html#schema.resource.webhook_token) it should invoke
 
 ## Example
 Include the github-webhook-resource in your pipeline.yml file

bin/out.js

@@ -46,11 +46,11 @@ stdin.on('end', function () {
 });
 
 function buildUrl(source, params) {
-    const instanceVars = buildInstanceVariables();
-    return encodeURI(`${env.ATC_EXTERNAL_URL}/api/v1/teams/${env.BUILD_TEAM_NAME}/pipelines/${env.BUILD_PIPELINE_NAME}/resources/${params.resource_name}/check/webhook?webhook_token=${params.webhook_token}${instanceVars}`);
+    const instanceVars = buildInstanceVariables(params);
+    return encodeURI(`${env.ATC_EXTERNAL_URL}/api/v1/teams/${env.BUILD_TEAM_NAME}/pipelines/${params.pipeline ? params.pipeline : env.BUILD_PIPELINE_NAME}/resources/${params.resource_name}/check/webhook?webhook_token=${params.webhook_token}${instanceVars}`);
 }
 
-function buildInstanceVariables() {
+function buildInstanceVariables(params) {
     let vars = "";
     if (env.BUILD_PIPELINE_INSTANCE_VARS) {
         try {
@@ -62,6 +62,15 @@ function buildInstanceVariables() {
             throw new Error(exception);
         }
     }
+    if ("pipeline_instance_vars" in params && params.pipeline_instance_vars) {
+        try {
+            for (const [key, value] of Object.entries(params.pipeline_instance_vars)) {
+                vars += `&vars.${key}="${value}"`;
+            }
+        } catch(exception) {
+            throw new Error(exception);
+        }
+    }
     return vars;
 }
 
@@ -200,4 +209,4 @@ function log(message) {
     console.error(message);
 }
 
-module.exports = { buildInstanceVariables };
+module.exports = { buildInstanceVariables, buildUrl };

bin/out.test.js

@@ -1,6 +1,6 @@
 const out = require('./out');
 
-describe('buildInstanceVaribles', () => {
+describe('out', () => {
 
     const OLD_ENV = process.env;
 
@@ -13,26 +13,59 @@ describe('buildInstanceVaribles', () => {
         process.env = OLD_ENV;
     });
 
-    it('with unset variables, returns empty string', () => {
-        delete process.env.BUILD_PIPELINE_INSTANCE_VARS;
-        const instanceVar = out.buildInstanceVariables();
-        expect(instanceVar).toEqual('')
-    });
-
-    it('with empty variables, returns empty string', () => {
-        process.env.BUILD_PIPELINE_INSTANCE_VARS = "{}";
-        const instanceVar = out.buildInstanceVariables();
-        expect(instanceVar).toEqual('')
-    });
-
-    it('with bad json, it throws an exception', () => {
-        process.env.BUILD_PIPELINE_INSTANCE_VARS = "{695988";
-        expect(() => out.buildInstanceVariables()).toThrow();
+    describe('buildInstanceVaribles', () => {
+        it('with unset variables, returns empty string', () => {
+            delete process.env.BUILD_PIPELINE_INSTANCE_VARS;
+            const params = {};
+            const instanceVar = out.buildInstanceVariables(params);
+            expect(instanceVar).toEqual('')
+        });
+
+        it('with empty variables, returns empty string', () => {
+            process.env.BUILD_PIPELINE_INSTANCE_VARS = "{}";
+            const params = {pipeline_instance_vars: {}};
+            const instanceVar = out.buildInstanceVariables(params);
+            expect(instanceVar).toEqual('')
+        });
+
+        it('with bad json, it throws an exception', () => {
+            process.env.BUILD_PIPELINE_INSTANCE_VARS = "{695988";
+            const params = {};
+            expect(() => out.buildInstanceVariables(params)).toThrow();
+        });
+
+        it('with valid instance variables, it builds variable string to append to url', () => {
+            process.env.BUILD_PIPELINE_INSTANCE_VARS = '{"name":"John", "age":30, "car":"Toyota"}';
+            const params = {pipeline_instance_vars: {"license": "full"}};
+            const instanceVar = out.buildInstanceVariables(params);
+            expect(instanceVar).toEqual(`&vars.name="John"&vars.age="30"&vars.car="Toyota"&vars.license="full"`)
+        });
     });
 
-    it('with valid instance variables, it builds variable string to append to url', () => {
-        process.env.BUILD_PIPELINE_INSTANCE_VARS = '{"name":"John", "age":30, "car":"Toyota"}';
-        const instanceVar = out.buildInstanceVariables();
-        expect(instanceVar).toEqual(`&vars.name="John"&vars.age="30"&vars.car="Toyota"`)
+    describe('buildUrl', () => {
+        it('defaults to using the current pipeline name', () => {
+            process.env.ATC_EXTERNAL_URL = 'https://example.com';
+            process.env.BUILD_PIPELINE_NAME = 'pipeline';
+            process.env.BUILD_TEAM_NAME = 'team';
+            const params = {
+                resource_name: 'resource',
+                webhook_token: 'token'
+            }
+            const instanceVar = out.buildUrl(null, params);
+            expect(instanceVar).toEqual("https://example.com/api/v1/teams/team/pipelines/pipeline/resources/resource/check/webhook?webhook_token=token")
+        });
+
+        it('prefers the pipeline name from params', () => {
+            process.env.ATC_EXTERNAL_URL = 'https://example.com';
+            process.env.BUILD_PIPELINE_NAME = 'pipeline';
+            process.env.BUILD_TEAM_NAME = 'team';
+            const params = {
+                pipeline: 'another-pipeline',
+                resource_name: 'resource',
+                webhook_token: 'token'
+            }
+            const instanceVar = out.buildUrl(null, params);
+            expect(instanceVar).toEqual("https://example.com/api/v1/teams/team/pipelines/another-pipeline/resources/resource/check/webhook?webhook_token=token")
+        });
     });
 });

bin/validate.js

@@ -46,7 +46,14 @@ const configSchema = {
                     transform: ['trim', 'toEnumCase'],
                     enum: validOperations,
                     errorMessage: { enum: 'must be either create or delete' }
-                }
+                },
+                pipeline:      { 
+                    type: 'string',
+                    transform: ['trim', 'toLowerCase']
+                },
+                pipeline_instance_vars: { 
+                    type: 'object',
+                },
             },
             required: ['org', 'repo', 'resource_name', 'webhook_token', 'operation']
         },

bin/validate.test.js

@@ -117,6 +117,7 @@ describe('validate.input', () => {
             'params.resource_name',
             'params.webhook_token',
             'params.operation',
+            'params.pipeline',
         ];
 
         constrainedFields.forEach(field => {
@@ -155,13 +156,16 @@ describe('validate.input', () => {
                 resource_name: '',
                 webhook_token: '',
                 operation: 'CrEaTe',
-                events: ['pUsH']
+                events: ['pUsH'],
+                pipeline: 'mYPipeline',
+                pipeline_instance_vars: {}
             }
         };
 
         expect(() => validate.config(config)).not.toThrow();
         expect(config.params.operation).toBe('create');
         expect(config.params.events).toEqual(['push']);
+        expect(config.params.pipeline).toBe('mypipeline');
     });
 
     it('trims whitespace', () => {
@@ -176,18 +180,21 @@ describe('validate.input', () => {
                 resource_name: '',
                 webhook_token: '',
                 operation: ' create ',
-                events: [' push ']
+                events: [' push '],
+                pipeline: ' mypipeline ',
+                pipeline_instance_vars: {}
             }
         };
 
         expect(() => validate.config(config)).not.toThrow();
         expect(config.params.operation).toBe('create');
         expect(config.params.events).toEqual(['push']);
+        expect(config.params.pipeline).toBe('mypipeline');
     });
 
     it('checks fields with array constraint', () => {
         const constrainedFields = [
-            'params.events'
+            'params.events',
         ];
 
         constrainedFields.forEach(field => {
@@ -202,7 +209,41 @@ describe('validate.input', () => {
                     resource_name: '',
                     webhook_token: '',
                     operation: 'create',
-                    events: []
+                    events: [],
+                    pipeline: '',
+                    pipeline_instance_vars: {}
+                }
+            };
+
+            expect(() => validate.config(config)).not.toThrow();
+
+            const fieldTree = field.split('.');
+            config[fieldTree[0]][fieldTree[1]] = null;
+
+            expect(() => validate.config(config)).toThrow();
+        });
+    });
+
+    it('checks fields with object constraint', () => {
+        const constrainedFields = [
+            'params.pipeline_instance_vars'
+        ];
+
+        constrainedFields.forEach(field => {
+            const config = {
+                source: {
+                    github_api: '',
+                    github_token: ''
+                },
+                params: {
+                    org: '',
+                    repo: '',
+                    resource_name: '',
+                    webhook_token: '',
+                    operation: 'create',
+                    events: [],
+                    pipeline: '',
+                    pipeline_instance_vars: {}
                 }
             };