screwdriver-api 5.0.0 → 5.0.2

package/bin/server

@@ -44,6 +44,9 @@ ecosystem.api = httpdConfig.uri;
 
 const release = config.get('release');
 
+// Logging config
+const log = config.get('log');
+
 // Notification config
 const notificationConfig = config.get('notifications');
 
@@ -261,6 +264,7 @@ datastore.setup(datastoreConfig.ddlSyncEnabled).then(() =>
             scm
         },
         release,
+        log,
         validator: {
             externalJoin: true,
             notificationsValidationErr

package/config/custom-environment-variables.yaml

@@ -468,6 +468,16 @@ release:
   __name: RELEASE_ENVIRONMENT_VARIABLES
   __format: json
 
+# Logging preferences
+log:
+  audit:
+    # set true to enable audit logs for all API calls
+    enabled: LOG_AUDIT_ENABLED
+    # add target scope tokens(pipeline, build, temporal, admin, guest, user)
+    scope:
+      __name: LOG_AUDIT_SCOPE
+      __format: json
+
 build:
   environment:
     __name: CLUSTER_ENVIRONMENT_VARIABLES

package/config/default.yaml

@@ -339,6 +339,13 @@ release:
     headerName: release
     headerValue: stable
 
+# Logging preferences
+log:
+  audit:
+    # set true to enable audit logs for all API calls
+    enabled: false
+    # add target scope tokens(pipeline, build, temporal, admin, guest, user)
+    scope: []
 
 # default cluster environment variables to inject into builds
 build:

package/lib/server.js

@@ -160,6 +160,34 @@ module.exports = async config => {
         // Write prettier errors
         server.ext('onPreResponse', prettyPrintErrors);
 
+        // Audit log
+        if (config.log && config.log.audit.enabled) {
+            server.ext('onCredentials', (request, h) => {
+                const { username, scope, pipelineId } = request.auth.credentials;
+                const validScope = config.log.audit.scope.filter(s => scope.includes(s));
+
+                if (Array.isArray(validScope) && validScope.length > 0) {
+                    let context;
+
+                    if (validScope.includes('admin')) {
+                        context = `Admin ${username}`;
+                    } else if (validScope.includes('user')) {
+                        context = `User ${username}`;
+                    } else if (validScope.includes('build') || validScope.includes('temporal')) {
+                        context = `Build ${username}`;
+                    } else if (validScope.includes('pipeline')) {
+                        context = `Pipeline ${pipelineId}`;
+                    } else {
+                        context = `Guest ${username}`;
+                    }
+
+                    logger.info(`[Login] ${context} ${request.method} ${request.path}`);
+                }
+
+                return h.continue;
+            });
+        }
+
         // Register events for notifications plugin
         server.event(['build_status', 'job_status']);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {
@@ -83,13 +83,13 @@
     "badge-maker": "^3.3.1",
     "config": "^1.31.0",
     "date-fns": "^1.30.1",
-    "dayjs": "^1.11.4",
+    "dayjs": "^1.11.6",
     "hapi-auth-bearer-token": "^8.0.0",
     "hapi-auth-jwt2": "^10.2.0",
     "hapi-rate-limit": "^5.0.1",
     "hapi-swagger": "^14.5.5",
     "ioredis": "^5.2.3",
-    "joi": "^17.4.2",
+    "joi": "^17.7.0",
     "js-yaml": "^3.14.1",
     "jsonwebtoken": "^8.5.1",
     "license-checker": "^17.0.0",
@@ -98,14 +98,14 @@
     "node-env-file": "^0.1.8",
     "prom-client": "^12.0.0",
     "redlock": "^4.1.0",
-    "screwdriver-artifact-bookend": "^1.2.0",
+    "screwdriver-artifact-bookend": "^1.4.0",
     "screwdriver-build-bookend": "^3.0.0",
-    "screwdriver-cache-bookend": "^2.0.2",
+    "screwdriver-cache-bookend": "^2.1.0",
     "screwdriver-command-validator": "^2.1.0",
-    "screwdriver-config-parser": "^7.6.0",
-    "screwdriver-coverage-bookend": "^1.0.3",
-    "screwdriver-coverage-sonar": "^3.4.0",
-    "screwdriver-data-schema": "^21.28.1",
+    "screwdriver-config-parser": "^7.6.1",
+    "screwdriver-coverage-bookend": "^1.1.0",
+    "screwdriver-coverage-sonar": "^3.4.1",
+    "screwdriver-data-schema": "^21.28.4",
     "screwdriver-datastore-sequelize": "^7.2.7",
     "screwdriver-executor-base": "^8.4.0",
     "screwdriver-executor-docker": "^5.0.1",
@@ -113,19 +113,19 @@
     "screwdriver-executor-k8s-vm": "^4.3.2",
     "screwdriver-executor-queue": "^3.1.2",
     "screwdriver-executor-router": "^2.3.0",
-    "screwdriver-logger": "^1.1.0",
-    "screwdriver-models": "^28.18.1",
+    "screwdriver-logger": "^1.2.0",
+    "screwdriver-models": "^28.20.0",
     "screwdriver-notifications-email": "^2.3.1",
     "screwdriver-notifications-slack": "^3.3.0",
     "screwdriver-request": "^1.0.3",
     "screwdriver-scm-base": "^7.3.0",
     "screwdriver-scm-bitbucket": "^4.5.1",
-    "screwdriver-scm-github": "^11.10.0",
+    "screwdriver-scm-github": "^11.10.3",
     "screwdriver-scm-gitlab": "^2.10.0",
     "screwdriver-scm-router": "^6.3.0",
     "screwdriver-template-validator": "^5.2.0",
     "screwdriver-workflow-parser": "^3.2.1",
-    "sqlite3": "^5.0.11",
+    "sqlite3": "^5.1.2",
     "stream": "0.0.2",
     "tinytim": "^0.1.1",
     "uuid": "^8.3.2",

package/plugins/logging.js

@@ -25,7 +25,12 @@ const loggingPlugin = {
                             args: [{ error: '*', log: '*', response: '*', request: '*' }]
                         },
                         {
-                            module: '@hapi/good-console'
+                            module: '@hapi/good-console',
+                            args: [
+                                {
+                                    color: false
+                                }
+                            ]
                         },
                         suppressAPITokens,
                         'stdout'

package/plugins/pipelines/README.md

@@ -33,6 +33,10 @@ server.register({
 
 `GET /pipelines?page={pageNumber}&count={countNumber}&configPipelineId={configPipelineId}&search={search}`
 
+Need to have array format for `ids` to only return pipelines with matching ids
+`GET /pipelines?search={search}&ids[]=12345&ids[]=55555`
+
+
 #### Get single pipeline
 
 `GET /pipelines/{id}`

package/plugins/pipelines/list.js

@@ -7,6 +7,11 @@ const listSchema = joi
     .array()
     .items(schema.models.pipeline.get)
     .label('List of Pipelines');
+const pipelineIdsSchema = joi
+    .alternatives()
+    .try(joi.array().items(idSchema), idSchema)
+    .required();
+const IDS_KEY = 'ids[]';
 
 module.exports = () => ({
     method: 'GET',
@@ -21,30 +26,40 @@ module.exports = () => ({
         },
 
         handler: async (request, h) => {
-            const factory = request.server.app.pipelineFactory;
-            const scmContexts = factory.scm.getScmContexts();
+            const { pipelineFactory } = request.server.app;
+            const { sort, configPipelineId, sortBy, search, page, count } = request.query;
+            const scmContexts = pipelineFactory.scm.getScmContexts();
             let pipelineArray = [];
 
             scmContexts.forEach(scmContext => {
                 const config = {
                     params: { scmContext },
-                    sort: request.query.sort
+                    sort
                 };
 
-                if (request.query.configPipelineId) {
-                    config.params.configPipelineId = request.query.configPipelineId;
+                // Only return specific pipelines
+                if (request.query[IDS_KEY]) {
+                    const ids = request.query[IDS_KEY];
+
+                    config.params.id = Array.isArray(ids)
+                        ? ids.map(pipelineId => parseInt(pipelineId, 10))
+                        : [parseInt(ids, 10)];
+                }
+
+                if (configPipelineId) {
+                    config.params.configPipelineId = configPipelineId;
                 }
 
-                if (request.query.sortBy) {
-                    config.sortBy = request.query.sortBy;
+                if (sortBy) {
+                    config.sortBy = sortBy;
                 }
 
-                if (request.query.search) {
+                if (search) {
                     config.search = {
                         field: 'name',
                         // Do a fuzzy search for name: screwdriver-cd/ui
                         // See https://www.w3schools.com/sql/sql_like.asp for syntax
-                        keyword: `%${request.query.search}%`
+                        keyword: `%${search}%`
                     };
                 } else {
                     // default list all to 50 max count, according to schema.api.pagination
@@ -54,17 +69,17 @@ module.exports = () => ({
                     };
                 }
 
-                if (request.query.page) {
+                if (page) {
                     config.paginate = config.paginate || {};
-                    config.paginate.page = request.query.page;
+                    config.paginate.page = page;
                 }
 
-                if (request.query.count) {
+                if (count) {
                     config.paginate = config.paginate || {};
-                    config.paginate.count = request.query.count;
+                    config.paginate.count = count;
                 }
 
-                const pipelines = factory.list(config);
+                const pipelines = pipelineFactory.list(config);
 
                 pipelineArray = pipelineArray.concat(pipelines);
             });
@@ -76,7 +91,7 @@ module.exports = () => ({
                     let adminDetails;
 
                     if (scmContext) {
-                        const scmDisplayName = factory.scm.getDisplayName({ scmContext });
+                        const scmDisplayName = pipelineFactory.scm.getDisplayName({ scmContext });
 
                         adminDetails = request.server.plugins.banners.screwdriverAdminDetails(username, scmDisplayName);
                     }
@@ -86,10 +101,11 @@ module.exports = () => ({
                     }
 
                     return allPipelines.filter(pipeline => {
-                        const setToPublic = pipeline.settings && pipeline.settings.public;
-                        const privatePipeline = pipeline.scmRepo && pipeline.scmRepo.private;
+                        const { settings, scmRepo, admins } = pipeline;
+                        const setToPublic = settings && settings.public;
+                        const privatePipeline = scmRepo && scmRepo.private;
 
-                        return !privatePipeline || setToPublic || pipeline.admins[username];
+                        return !privatePipeline || setToPublic || admins[username];
                     });
                 })
                 .then(allPipelines => h.response(allPipelines.map(p => p.toJson())))
@@ -103,7 +119,8 @@ module.exports = () => ({
         validate: {
             query: schema.api.pagination.concat(
                 joi.object({
-                    configPipelineId: idSchema
+                    configPipelineId: idSchema,
+                    'ids[]': pipelineIdsSchema.optional()
                 })
             )
         }