fix: Add filter to pipelines/id/jobs for pr jobs only (#3078)

Author: tkyi

plugins/pipelines/README.md

@@ -115,7 +115,13 @@ When `latest=true` and `groupEventId` is set, only latest builds in a pipeline b
 #### Get all jobs (including pull requests jobs)
 `archived` is optional and has a default value of `false`, which makes the endpoint not return archived jobs (e.g. closed pull requests)
 
-`GET /pipelines/{id}/jobs?archived={boolean}`
+Arguments:
+
+* `archived` - Optional and has a default value of `false`, which makes the endpoint not return archived jobs (e.g. closed pull requests)
+* `type` - Optional and can be set to `pr` or `pipeline` to only return PR jobs or non-PR jobs
+* `jobName` - Optional and can be set to only return only a single job
+
+`GET /pipelines/{id}/jobs?archived={boolean}&type={type}&jobName={jobName}`
 
 #### Get Pipeline Admin
 `GET /pipelines/{id}/admin`

plugins/pipelines/listJobs.js

@@ -6,6 +6,7 @@ const schema = require('screwdriver-data-schema');
 const jobListSchema = joi.array().items(schema.models.job.get).label('List of jobs');
 const jobNameSchema = schema.models.job.base.extract('name');
 const pipelineIdSchema = schema.models.pipeline.base.extract('id');
+const JOB_PR_PATTERN = `PR-%:%`;
 
 module.exports = () => ({
     method: 'GET',
@@ -21,7 +22,7 @@ module.exports = () => ({
 
         handler: async (request, h) => {
             const { pipelineFactory } = request.server.app;
-            const { page, count, jobName } = request.query;
+            const { page, count, jobName, type } = request.query;
 
             return pipelineFactory
                 .get(request.params.id)
@@ -36,6 +37,20 @@ module.exports = () => ({
                         }
                     };
 
+                    if (type) {
+                        config.search = {
+                            field: 'name',
+                            // Do a search for PR-%:% in job name
+                            // See https://www.w3schools.com/sql/sql_like.asp for syntax
+                            keyword: JOB_PR_PATTERN
+                        };
+
+                        if (type === 'pipeline') {
+                            // Do a search for job name without PR-%:% pattern
+                            // See https://www.w3schools.com/sql/sql_not.asp for syntax
+                            config.search.inverse = true;
+                        }
+                    }
                     if (jobName) {
                         config.params.name = jobName;
                     }
@@ -59,6 +74,7 @@ module.exports = () => ({
             }),
             query: schema.api.pagination.concat(
                 joi.object({
+                    type: joi.string().valid('', 'pr', 'pipeline').label('Job type filter (pr or pipeline)').optional(),
                     archived: joi.boolean().truthy('true').falsy('false').default(false),
                     jobName: jobNameSchema,
                     search: joi.forbidden(), // we don't support search for Pipeline list jobs

test/plugins/pipelines.test.js

@@ -931,7 +931,7 @@ describe('pipeline plugin test', () => {
             }));
 
         it('returns 200 for getting jobs with jobNames', () => {
-            options.url = `/pipelines/${id}/jobs?jobName=deploy`;
+            options.url = `/pipelines/${id}/jobs?jobName=deploy&type=`;
 
             return server.inject(options).then(reply => {
                 assert.equal(reply.statusCode, 200);
@@ -945,6 +945,36 @@ describe('pipeline plugin test', () => {
             });
         });
 
+        it('returns 200 for getting jobs with pr type', () => {
+            options.url = `/pipelines/${id}/jobs?type=pr`;
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 200);
+                assert.calledWith(pipelineMock.getJobs, {
+                    params: {
+                        archived: false
+                    },
+                    search: { field: 'name', keyword: 'PR-%:%' }
+                });
+                assert.deepEqual(reply.result, testJobs);
+            });
+        });
+
+        it('returns 200 for getting jobs with pipeline type', () => {
+            options.url = `/pipelines/${id}/jobs?type=pipeline`;
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 200);
+                assert.calledWith(pipelineMock.getJobs, {
+                    params: {
+                        archived: false
+                    },
+                    search: { field: 'name', keyword: 'PR-%:%', inverse: true }
+                });
+                assert.deepEqual(reply.result, testJobs);
+            });
+        });
+
         it('returns 400 for wrong query format', () => {
             pipelineFactoryMock.get.resolves(null);
             options.url = `/pipelines/${id}/jobs?archived=blah`;