feat(465): support notification plugins

d2lam · d2lam · commit 2661d06e9fba · 2017-03-02T18:40:57.000-08:00
diff --git a/bin/server b/bin/server
@@ -23,6 +23,9 @@ const ecosystem = config.get('ecosystem');
 
 ecosystem.api = httpdConfig.uri;
 
+// Notification config
+const notificationConfig = config.get('notifications');
+
 // Setup Datastore
 const datastoreConfig = config.get('datastore');
 const DatastorePlugin = require(`screwdriver-datastore-${datastoreConfig.plugin}`);
@@ -92,6 +95,7 @@ datastore.setup()
         httpd: httpdConfig,
         auth: authConfig,
         webhooks: webhooksConfig,
+        notifications: notificationConfig,
         ecosystem,
         pipelineFactory,
         jobFactory,
diff --git a/config/custom-environment-variables.yaml b/config/custom-environment-variables.yaml
@@ -129,6 +129,10 @@ bookends:
         __name: BOOKENDS_TEARDOWN
         __format: json
 
+notifications:
+    __name: NOTIFICATIONS
+    __format: json
+
 ecosystem:
     # URL for the User Interface
     ui: ECOSYSTEM_UI
diff --git a/config/default.yaml b/config/default.yaml
@@ -143,6 +143,12 @@ bookends:
     teardown:
         - screwdriver-artifact-bookend
 
+notifications:
+    # Email notification when build finishes
+    # email:
+    #     host: email-host
+    #     port: email-port
+    #     from: email-address-to-send-from
 ecosystem:
     # Externally routable URL for the User Interface
     ui: https://cd.screwdriver.cd
diff --git a/lib/registerPlugins.js b/lib/registerPlugins.js
@@ -71,5 +71,16 @@ module.exports = (server, config) => (
 
             return resolve();
         });
+    }).then(() => {
+        // Register notification plugins
+        const notificationConfig = config.notifications || {};
+
+        return Object.keys(notificationConfig).forEach((plugin) => {
+            const Plugin = require(`screwdriver-notifications-${plugin}`);
+            const notificationPlugin = new Plugin(
+                notificationConfig[plugin], server, 'build_status');
+
+            notificationPlugin.notify();
+        });
     })
-);
+  );
diff --git a/lib/server.js b/lib/server.js
@@ -93,6 +93,9 @@ module.exports = (config) => {
     // Write prettier errors
     server.ext('onPreResponse', prettyPrintErrors);
 
+    // Register build_status event for notifications plugin
+    server.event('build_status');
+
     // Register plugins
     return registrationMan(server, config)
         .then(() => {
diff --git a/package.json b/package.json
@@ -76,12 +76,13 @@
     "requestretry": "^1.12.0",
     "screwdriver-artifact-bookend": "^1.0.1",
     "screwdriver-build-bookend": "^2.0.1",
-    "screwdriver-config-parser": "^3.1.0",
-    "screwdriver-data-schema": "^16.0.1",
+    "screwdriver-config-parser": "^3.3.0",
+    "screwdriver-data-schema": "^16.1.1",
     "screwdriver-datastore-sequelize": "^2.0.0",
     "screwdriver-executor-docker": "^2.0.0",
     "screwdriver-executor-k8s": "^10.0.0",
     "screwdriver-models": "^21.2.0",
+    "screwdriver-notifications-email": "^1.0.3",
     "screwdriver-scm-bitbucket": "^2.6.0",
     "screwdriver-scm-github": "^4.6.0",
     "tinytim": "^0.1.1",
diff --git a/plugins/builds/update.js b/plugins/builds/update.js
@@ -17,7 +17,7 @@ module.exports = () => ({
             scope: ['user', 'build']
         },
         handler: (request, reply) => {
-            const factory = request.server.app.buildFactory;
+            const buildFactory = request.server.app.buildFactory;
             const id = request.params.id;
             const desiredStatus = request.payload.status;
             const jobFactory = request.server.app.jobFactory;
@@ -29,7 +29,7 @@ module.exports = () => ({
                 throw boom.forbidden(`Credential only valid for ${username}`);
             }
 
-            return factory.get(id)
+            return buildFactory.get(id)
                 .then((build) => {
                     if (!build) {
                         throw boom.notFound(`Build ${id} does not exist`);
@@ -67,13 +67,22 @@ module.exports = () => ({
                     // Everyone is able to update the status
                     build.status = desiredStatus;
 
-                    // Guard against triggering non-successful builds
-                    if (desiredStatus !== 'SUCCESS') {
-                        return build.update();
-                    }
-
                     // Only trigger next build on success
                     return build.job.then(job => job.pipeline.then((pipeline) => {
+                        request.server.emit('build_status', {
+                            settings: job.permutations[0].settings,
+                            status: build.status,
+                            pipelineName: pipeline.scmRepo.name,
+                            jobName: job.name,
+                            buildId: build.id,
+                            buildLink: `${buildFactory.uiUri}/builds/${id}`
+                        });
+
+                        // Guard against triggering non-successful builds
+                        if (desiredStatus !== 'SUCCESS') {
+                            return null;
+                        }
+
                         const workflow = pipeline.workflow;
 
                         // No workflow to follow
@@ -100,7 +109,7 @@ module.exports = () => ({
                             pipelineId: pipeline.id
                         }).then((nextJobToTrigger) => {
                             if (nextJobToTrigger.state === 'ENABLED') {
-                                return factory.create({
+                                return buildFactory.create({
                                     jobId: nextJobToTrigger.id,
                                     sha: build.sha,
                                     parentBuildId: id,
diff --git a/test/lib/registerPlugins.test.js b/test/lib/registerPlugins.test.js
@@ -101,6 +101,38 @@ describe('Register Unit Test Case', () => {
         });
     });
 
+    it('registered notifications plugins', () => {
+        serverMock.register.callsArgAsync(2);
+
+        const newConfig = {
+            notifications: {
+                email: {
+                    foo: 'abc'
+                },
+                slack: {
+                    baz: 'def'
+                }
+            }
+        };
+
+        const notificationPlugins = [
+            'screwdriver-notifications-email',
+            'screwdriver-notifications-slack'
+        ];
+
+        notificationPlugins.forEach((plugin) => {
+            mocks[plugin] = sinon.stub();
+            mocks[plugin].prototype.notify = sinon.stub();
+            mockery.registerMock(plugin, mocks[plugin]);
+        });
+
+        return main(serverMock, newConfig).then(() =>
+            notificationPlugins.forEach(plugin =>
+                Assert.called(mocks[plugin].prototype.notify)
+            )
+        );
+    });
+
     it('bubbles failures up', () => {
         serverMock.register.callsArgWithAsync(2, new Error('failure loading'));
 
diff --git a/test/plugins/builds.test.js b/test/plugins/builds.test.js
@@ -110,6 +110,7 @@ describe('build plugin test', () => {
         }));
         server.auth.strategy('token', 'custom');
         server.auth.strategy('session', 'custom');
+        server.event('build_status');
 
         secretMock = {
             register: (s, o, next) => {
@@ -181,7 +182,15 @@ describe('build plugin test', () => {
 
     describe('PUT /builds/{id}', () => {
         const id = 12345;
+        const pipelineId = 123;
+        const scmUri = 'github.com:12345:branchName';
+        const scmRepo = {
+            branch: 'master',
+            name: 'screwdriver-cd/screwdriver',
+            url: 'https://github.com/screwdriver-cd/screwdriver/tree/branchName'
+        };
         let buildMock;
+        let pipelineMock;
 
         beforeEach(() => {
             testBuild.status = 'QUEUED';
@@ -193,6 +202,62 @@ describe('build plugin test', () => {
 
             buildFactoryMock.get.resolves(buildMock);
             buildMock.update.resolves(buildMock);
+
+            pipelineMock = {
+                id: pipelineId,
+                scmUri,
+                scmRepo,
+                sync: sinon.stub().resolves()
+            };
+        });
+
+        it('emits event buid_status', () => {
+            const jobMock = {
+                id: 1234,
+                name: 'main',
+                pipelineId,
+                permutations: [{
+                    settings: {
+                        email: 'foo@bar.com'
+                    }
+                }]
+            };
+
+            jobMock.pipeline = sinon.stub().resolves(pipelineMock)();
+            buildMock.job = sinon.stub().resolves(jobMock)();
+            buildMock.settings = {
+                email: 'foo@bar.com'
+            };
+
+            buildFactoryMock.get.resolves(buildMock);
+            buildFactoryMock.uiUri = 'http://foo.bar';
+
+            const options = {
+                method: 'PUT',
+                url: `/builds/${id}`,
+                payload: {
+                    status: 'ABORTED'
+                },
+                credentials: {
+                    scope: ['user']
+                }
+            };
+
+            server.emit = sinon.stub().resolves(null);
+
+            return server.inject(options).then((reply) => {
+                assert.calledWith(server.emit, 'build_status', {
+                    buildId: 12345,
+                    buildLink: 'http://foo.bar/builds/12345',
+                    jobName: 'main',
+                    pipelineName: 'screwdriver-cd/screwdriver',
+                    settings: {
+                        email: 'foo@bar.com'
+                    },
+                    status: 'ABORTED'
+                });
+                assert.equal(reply.statusCode, 200);
+            });
         });
 
         it('returns 404 for updating a build that does not exist', () => {
@@ -235,6 +300,22 @@ describe('build plugin test', () => {
 
         describe('user token', () => {
             it('returns 200 for updating a build that exists', () => {
+                const jobMock = {
+                    id: 1234,
+                    name: 'main',
+                    pipelineId,
+                    permutations: [{
+                        settings: {
+                            email: 'foo@bar.com'
+                        }
+                    }]
+                };
+
+                jobMock.pipeline = sinon.stub().resolves(pipelineMock)();
+                buildMock.job = sinon.stub().resolves(jobMock)();
+
+                buildFactoryMock.get.resolves(buildMock);
+
                 const expected = hoek.applyToDefaults(testBuild, { status: 'ABORTED' });
                 const options = {
                     method: 'PUT',
@@ -250,9 +331,9 @@ describe('build plugin test', () => {
                 buildMock.toJson.returns(expected);
 
                 return server.inject(options).then((reply) => {
-                    assert.equal(reply.statusCode, 200);
                     assert.deepEqual(reply.result, expected);
                     assert.calledWith(buildFactoryMock.get, id);
+                    assert.equal(reply.statusCode, 200);
                 });
             });
 
@@ -296,23 +377,18 @@ describe('build plugin test', () => {
 
         describe('build token', () => {
             const jobId = 1234;
-            const pipelineId = 123;
             const publishJobId = 1235;
-            const scmUri = 'github.com:12345:branchName';
 
             let jobMock;
-            let pipelineMock;
 
             beforeEach(() => {
                 jobMock = {
                     id: jobId,
                     name: 'main',
-                    pipelineId
-                };
-                pipelineMock = {
-                    id: pipelineId,
-                    scmUri,
-                    sync: sinon.stub().resolves()
+                    pipelineId,
+                    permutations: [{
+                        settings: {}
+                    }]
                 };
 
                 jobMock.pipeline = sinon.stub().resolves(pipelineMock)();
diff --git a/test/plugins/data/validator.output.json b/test/plugins/data/validator.output.json
@@ -21,7 +21,8 @@
                 "environment": {
                     "NODE_VERSION": "4"
                 },
-                "secrets": []
+                "secrets": [],
+                "settings": {}
             },
             {
                 "image": "node:6",
@@ -43,7 +44,8 @@
                 "environment": {
                     "NODE_VERSION": "6"
                 },
-                "secrets": []
+                "secrets": [],
+                "settings": {}
             }
         ],
         "publish": [
@@ -56,7 +58,8 @@
                     }
                 ],
                 "environment": {},
-                "secrets": []
+                "secrets": [],
+                "settings": {}
             }
         ]
     },

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@`
`21`	`21`	`"environment": {`
`22`	`22`	`"NODE_VERSION": "4"`
`23`	`23`	`},`
`24`		`- "secrets": []`
	`24`	`+ "secrets": [],`
	`25`	`+ "settings": {}`
`25`	`26`	`},`
`26`	`27`	`{`
`27`	`28`	`"image": "node:6",`
`@@ -43,7 +44,8 @@`
`43`	`44`	`"environment": {`
`44`	`45`	`"NODE_VERSION": "6"`
`45`	`46`	`},`
`46`		`- "secrets": []`
	`47`	`+ "secrets": [],`
	`48`	`+ "settings": {}`
`47`	`49`	`}`
`48`	`50`	`],`
`49`	`51`	`"publish": [`
`@@ -56,7 +58,8 @@`
`56`	`58`	`}`
`57`	`59`	`],`
`58`	`60`	`"environment": {},`
`59`		`- "secrets": []`
	`61`	`+ "secrets": [],`
	`62`	`+ "settings": {}`
`60`	`63`	`}`
`61`	`64`	`]`
`62`	`65`	`},`