screwdriver-executor-base - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "screwdriver-executor-base",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Base class defining the interface for executor implementations",
@@ -21,3 +21,3 @@ "main": "index.js",
   "license": "BSD-3-Clause",
-  "author": "Dao Lam <[e-mail]>",
+  "author": "Dao Lam <[e-mail]>",
   "contributors": [
@@ -42,2 +42,2 @@ "Dao Lam <[e-mail]>",
   "dependencies": {}
-}
+}

README.md

@@ -12,2 +12,29 @@ # executor base
 
+## Extending
+```js
+class MyExecutor extends Executor {
+    // Implement the interface
+    start(config, callback) {
+        if (config.buildId) {
+            // do stuff here...
+            return callback(null);
+        }
+
+        return process.nextTick(() => {
+            callback(new Error('Error starting executor'));
+        });
+    }
+}
+
+const executor = new MyExecutor({});
+executor.start({
+    buildId: '4b8d9b530d2e5e297b4f470d5b0a6e1310d29c5e',
+    jobId: '50dc14f719cdc2c9cb1fb0e49dd2acc4cf6189a0',
+    pipelineId: 'ccc49349d3cffbd12ea9e3d41521480b4aa5de5f',
+    container: 'node:4',
+    scmUrl: '[e-mail]:screwdriver-cd/data-model.git#master'
+}, (err) => {
+    // do something...
+});
+```
 ## Testing
@@ -14,0 +41,0 @@

test/index.test.js

 'use strict';
 const assert = require('chai').assert;
+const Executor = require('../index');
 
 describe('index test', () => {
-    it('fails', () => {
-        assert.isTrue(false);
+    let instance;
+
+    beforeEach(() => {
+        instance = new Executor({ foo: 'bar' });
     });
+
+    afterEach(() => {
+        instance = null;
+    });
+
+    it('can create a Executor base class', () => {
+        assert.instanceOf(instance, Executor);
+    });
+
+    it('has methods that need to be extended', () => {
+        assert.throws(instance.start, Error, 'not implemented');
+        assert.throws(instance.stop, Error, 'not implemented');
+    });
+
+    it('can be extended', (done) => {
+        class Foo extends Executor {
+            get(id, callback) {
+                if (id > 0) {
+                    return callback(null, { id });
+                }
+
+                return process.nextTick(() => {
+                    callback(new Error('invalid id'));
+                });
+            }
+        }
+
+        const bar = new Foo({ foo: 'bar' });
+
+        assert.instanceOf(bar, Executor);
+        bar.get(1, (err, data) => {
+            assert.isNull(err);
+            assert.equal(data.id, 1);
+            done();
+        });
+    });
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9384

increased by49.38%

Lines of code

82

increased by1071.43%

Number of lines in readme file

59

increased by84.38%

No dependency changes