feat(2669): Add endpoint to get pipeline stages (#2717)

Author: tkyi

README.md

@@ -52,14 +52,14 @@ Three (3) options for executor:
  - Nomad (`nomad`)
 
 Three (3) options for SCM:
- - Github (`github`)
- - Gitlab (`gitlab`)
+ - GitHub (`github`)
+ - GitLab (`gitlab`)
  - Bitbucket (`bitbucket`)
 
 ### Prerequisites
 To use Screwdriver, you will need the following prerequisites:
 
-- Node v8.0.0 or higher
+- Node v12.0.0 or higher
 - [Kubernetes][kubectl] or [Docker][docker]
 
 ### From Source

package.json

@@ -79,15 +79,15 @@
     "@hapi/inert": "^6.0.4",
     "@hapi/vision": "^6.1.0",
     "@promster/hapi": "^6.1.0",
-    "async": "^3.2.2",
+    "async": "^3.2.4",
     "badge-maker": "^3.3.1",
     "config": "^1.31.0",
     "date-fns": "^1.30.1",
     "dayjs": "^1.10.7",
     "hapi-auth-bearer-token": "^8.0.0",
     "hapi-auth-jwt2": "^10.2.0",
     "hapi-rate-limit": "^5.0.1",
-    "hapi-swagger": "^14.2.4",
+    "hapi-swagger": "^14.5.4",
     "ioredis": "^4.28.0",
     "joi": "^17.4.2",
     "js-yaml": "^3.14.1",
@@ -114,14 +114,14 @@
     "screwdriver-executor-queue": "^3.1.2",
     "screwdriver-executor-router": "^2.3.0",
     "screwdriver-logger": "^1.1.0",
-    "screwdriver-models": "^28.11.0",
+    "screwdriver-models": "^28.16.1",
     "screwdriver-notifications-email": "^2.2.0",
     "screwdriver-notifications-slack": "^3.2.1",
     "screwdriver-request": "^1.0.3",
     "screwdriver-scm-base": "^7.3.0",
     "screwdriver-scm-bitbucket": "^4.5.1",
-    "screwdriver-scm-github": "^11.6.3",
-    "screwdriver-scm-gitlab": "^2.7.2",
+    "screwdriver-scm-github": "^11.10.0",
+    "screwdriver-scm-gitlab": "^2.10.0",
     "screwdriver-scm-router": "^6.3.0",
     "screwdriver-template-validator": "^5.2.0",
     "screwdriver-workflow-parser": "^3.2.1",
@@ -153,7 +153,7 @@
     "mocha-sonarqube-reporter": "^1.0.2",
     "mockery": "^2.0.0",
     "mz": "^2.6.0",
-    "nock": "^13.2.1",
+    "nock": "^13.2.7",
     "node-plantuml": "^0.5.0",
     "npm-auto-version": "^1.0.0",
     "nyc": "^15.0.0",

plugins/pipelines/index.js

@@ -12,6 +12,7 @@ const listRoute = require('./list');
 const badgeRoute = require('./badge');
 const jobBadgeRoute = require('./jobBadge');
 const listJobsRoute = require('./listJobs');
+const listStagesRoute = require('./listStages');
 const listTriggersRoute = require('./listTriggers');
 const listSecretsRoute = require('./listSecrets');
 const listEventsRoute = require('./listEvents');
@@ -177,6 +178,7 @@ const pipelinesPlugin = {
             badgeRoute({ statusColor }),
             jobBadgeRoute({ statusColor }),
             listJobsRoute(),
+            listStagesRoute(),
             listTriggersRoute(),
             listSecretsRoute(),
             listEventsRoute(),

plugins/pipelines/listStages.js

@@ -0,0 +1,59 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const pipelineIdSchema = schema.models.pipeline.base.extract('id');
+const stageListSchema = joi
+    .array()
+    .items(schema.models.stage.base)
+    .label('List of stages');
+
+module.exports = () => ({
+    method: 'GET',
+    path: '/pipelines/{id}/stages',
+    options: {
+        description: 'Get all stages for a given pipeline',
+        notes: 'Returns all stages for a given pipeline',
+        tags: ['api', 'pipelines', 'stages'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', 'build', 'pipeline']
+        },
+
+        handler: async (request, h) => {
+            const { pipelineFactory, stageFactory } = request.server.app;
+            const pipelineId = request.params.id;
+
+            return pipelineFactory
+                .get(pipelineId)
+                .then(pipeline => {
+                    if (!pipeline) {
+                        throw boom.notFound('Pipeline does not exist');
+                    }
+
+                    const config = {
+                        params: { pipelineId }
+                    };
+
+                    if (request.query.state) {
+                        config.params.state = request.query.state;
+                    }
+
+                    return stageFactory.list(config);
+                })
+                .then(stages => h.response(stages.map(s => s.toJson())))
+                .catch(err => {
+                    throw err;
+                });
+        },
+        response: {
+            schema: stageListSchema
+        },
+        validate: {
+            params: joi.object({
+                id: pipelineIdSchema
+            })
+        }
+    }
+});

plugins/pipelines/listTriggers.js

@@ -20,9 +20,9 @@ module.exports = () => ({
     method: 'GET',
     path: '/pipelines/{id}/triggers',
     options: {
-        description: 'Get all jobs for a given pipeline',
-        notes: 'Returns all jobs for a given pipeline',
-        tags: ['api', 'pipelines', 'jobs'],
+        description: 'Get all triggers for a given pipeline',
+        notes: 'Returns all triggers for a given pipeline',
+        tags: ['api', 'pipelines', 'triggers'],
         auth: {
             strategies: ['token'],
             scope: ['user', 'build', 'pipeline']

test/plugins/data/stages.json

@@ -0,0 +1,20 @@
+[
+    {
+        "pipelineId": 12345,
+        "name": "setup",
+        "jobIds": [1, 2, 3, 4],
+        "state": "ACTIVE"
+    },
+    {
+        "pipelineId": 12345,
+        "name": "deploy",
+        "jobIds": [5, 6, 7],
+        "state": "ACTIVE"
+    },
+    {
+        "pipelineId": 12345,
+        "name": "test",
+        "jobIds": [],
+        "state": "ARCHIVED"
+    }
+]

test/plugins/pipelines.test.js

@@ -13,6 +13,7 @@ const testCollection = require('./data/collection.json');
 const gitlabTestPipelines = require('./data/pipelinesFromGitlab.json');
 const testJob = require('./data/job.json');
 const testJobs = require('./data/jobs.json');
+const testStages = require('./data/stages.json');
 const testTriggers = require('./data/triggers.json');
 const testBuild = require('./data/buildWithSteps.json');
 const testBuilds = require('./data/builds.json').slice(0, 2);
@@ -137,6 +138,22 @@ const getSecretsMocks = secrets => {
     return decorateJobMock(secrets);
 };
 
+const decorateStageMock = stage => {
+    const mock = hoek.clone(stage);
+
+    mock.toJson = sinon.stub().returns(stage);
+
+    return mock;
+};
+
+const getStagesMocks = stages => {
+    if (Array.isArray(stages)) {
+        return stages.map(decorateStageMock);
+    }
+
+    return decorateStageMock(stages);
+};
+
 const getUserMock = user => {
     const mock = hoek.clone(user);
 
@@ -170,6 +187,7 @@ describe('pipeline plugin test', () => {
     let tokenFactoryMock;
     let bannerFactoryMock;
     let jobFactoryMock;
+    let stageFactoryMock;
     let triggerFactoryMock;
     let secretFactoryMock;
     let bannerMock;
@@ -223,6 +241,9 @@ describe('pipeline plugin test', () => {
             create: sinon.stub().resolves(null),
             list: sinon.stub().resolves(null)
         };
+        stageFactoryMock = {
+            list: sinon.stub()
+        };
         tokenFactoryMock = {
             get: sinon.stub(),
             create: sinon.stub()
@@ -261,6 +282,7 @@ describe('pipeline plugin test', () => {
         server.app = {
             eventFactory: eventFactoryMock,
             jobFactory: jobFactoryMock,
+            stageFactory: stageFactoryMock,
             triggerFactory: triggerFactoryMock,
             pipelineFactory: pipelineFactoryMock,
             userFactory: userFactoryMock,
@@ -915,6 +937,76 @@ describe('pipeline plugin test', () => {
         });
     });
 
+    describe('GET /pipelines/{id}/stages', () => {
+        const id = 123;
+        let options;
+        let pipelineMock;
+        let stagesMocks;
+
+        beforeEach(() => {
+            options = {
+                method: 'GET',
+                url: `/pipelines/${id}/stages`
+            };
+            pipelineMock = getPipelineMocks(testPipeline);
+            stagesMocks = getStagesMocks(testStages);
+            stageFactoryMock.list.resolves(stagesMocks);
+            pipelineFactoryMock.get.resolves(pipelineMock);
+        });
+
+        it('returns 200 for getting stages', () =>
+            server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 200);
+                assert.calledWith(stageFactoryMock.list, {
+                    params: {
+                        pipelineId: id
+                    }
+                });
+                assert.deepEqual(reply.result, testStages);
+            }));
+
+        it('returns 200 for getting stages with state passed in as query param', () => {
+            options.url = `/pipelines/${id}/stages?state=ARCHIVED`;
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 200);
+                assert.calledWith(stageFactoryMock.list, {
+                    params: {
+                        pipelineId: id,
+                        state: 'ARCHIVED'
+                    }
+                });
+                assert.deepEqual(reply.result, testStages);
+            });
+        });
+
+        it('returns 400 for passing in string as pipeline id', () => {
+            const stringId = 'test';
+
+            options.url = `/pipelines/${stringId}/stages`;
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 400);
+            });
+        });
+
+        it('returns 404 for updating a pipeline that does not exist', () => {
+            pipelineFactoryMock.get.resolves(null);
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 404);
+            });
+        });
+
+        it('returns 500 when the datastore returns an error', () => {
+            pipelineFactoryMock.get.rejects(new Error('icantdothatdave'));
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 500);
+            });
+        });
+    });
+
     describe('GET /pipelines/{id}/triggers', () => {
         const id = 123;
         let options;