screwdriver-executor-base - npm Package Compare versions

Comparing version 7.4.0 to 7.5.0

index.js

@@ -169,6 +169,38 @@ 'use strict';
     async _cleanUp() {
-        // no-op in case no implemented in extenders
+        // no-op in case not implemented in extenders
     }
 
     /**
+     * Adds information to the timeout queue
+     * @method status
+     * @param  {Object} config               Configuration object
+     * @param  {String} config.buildId       Unique ID for a build
+     * @param  {String} config.startTime     Start time fo build
+     * @param  {String} config.buildStatus     Status of build
+     * @return {Promise}
+     */
+    startTimer(config) {
+        return this._startTimer(config);
+    }
+
+    async _startTimer() {
+        // no-op in case not implemented in extenders
+    }
+
+    /**
+     * Removes information from the timeout queue
+     * @method status
+     * @param  {Object} config               Configuration object
+     * @param  {String} config.buildId       Unique ID for a build
+     * @return {Promise}
+     */
+    stopTimer(config) {
+        return this._stopTimer(config);
+    }
+
+    async _stopTimer() {
+        // no-op in case not implemented in extenders
+    }
+
+    /**
      * Return statistics on the executor
@@ -175,0 +207,0 @@ * @method stats

package.json

 {
   "name": "screwdriver-executor-base",
-  "version": "7.4.0",
+  "version": "7.5.0",
   "description": "Base class defining the interface for executor implementations",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -97,3 +97,33 @@ # Executor Base
 
+#### StartTimer
+##### Required Parameters
+| Parameter        | Type  |  Description |
+| :-------------   | :---- | :-------------|
+| config        | Object | Configuration Object |
+| config.annotations | Object | Optional key/value object |
+| config.buildStatus | String | The status of the  build |
+| config.buildId | String | The unique ID for a build |
+| config.startTime | String | ISO start time of the build |
+| config.jobId | String | job id of the build |
+##### Expected Outcome
+The StartTimer function is expected to add buildId as key and timeout config value to timeout queue
+Default is no-op
 
+##### Expected Return
+A Promise that resolves or rejects.
+
+#### StopTimer
+##### Required Parameters
+| Parameter        | Type  |  Description |
+| :-------------   | :---- | :-------------|
+| config        | Object | Configuration Object |
+| config.buildId | String | The unique ID for a build |
+##### Expected Outcome
+The StopTimer function is expected to remove key/value buildId from timeout queue
+Default is no-op
+
+##### Expected Return
+A Promise that resolves or rejects.
+
+
 ## Extending
@@ -100,0 +130,0 @@ To make use of the validation function for start and stop, you need to

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

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

Improved metrics

Total package byte prevSize

15607

increased by14.82%

Lines of code

203

increased by16%

Number of lines in readme file

180

increased by20%

No dependency changes