feat(periodicBuilds): Implement boilerplate startPeriodic() and stopPeriodic() (#39)

feat(periodicBuilds): Implement boilerplate startPeriodic() and stopPeriodic()

Author: Pranav Ravichandran

index.js

@@ -69,6 +69,34 @@ class Executor {
         throw new Error('Not implemented');
     }
 
+    /**
+      * Starts a new periodic build in an executor
+      * @method _startPeriodic
+      * @param {Object} config               Configuration
+      * @return {Promise}
+      */
+    startPeriodic(config) {
+        return this._startPeriodic(config);
+    }
+
+    async _startPeriodic() {
+        throw new Error('Not implemented');
+    }
+
+    /**
+     * Stops a previously scheduled periodic build in an executor
+     * @async  _stopPeriodic
+     * @param  {Object}  config        Configuration
+     * @return {Promise}
+     */
+    stopPeriodic(config) {
+        return this._stopPeriodic(config);
+    }
+
+    async _stopPeriodic() {
+        throw new Error('Not implemented');
+    }
+
     /**
      * Get the status of a build
      * @method status

test/index.test.js

@@ -22,6 +22,8 @@ describe('index test', () => {
                 executor: {
                     start: Joi.object().required(),
                     stop: Joi.object().required(),
+                    startPeriodic: Joi.object().required(),
+                    stopPeriodic: Joi.object().required(),
                     status: Joi.object().required()
                 }
             }
@@ -92,6 +94,26 @@ describe('index test', () => {
             })
     ));
 
+    it('startPeriodic returns an error when not overridden', () => (
+        instance.startPeriodic({})
+            .then(() => {
+                throw new Error('Oh no');
+            }, (err) => {
+                assert.isOk(err, 'err is null');
+                assert.equal(err.message, 'Not implemented');
+            })
+    ));
+
+    it('stopPeriodic returns an error when not overridden', () => (
+        instance.stopPeriodic({})
+            .then(() => {
+                throw new Error('Oh no');
+            }, (err) => {
+                assert.isOk(err, 'error is null');
+                assert.equal(err.message, 'Not implemented');
+            })
+    ));
+
     it('status returns an error when not overridden', () => (
         instance.status({})
             .then(() => {