screwdriver-api 7.0.260 → 7.0.262

package/design/sd-build-cluster-selection.md

@@ -0,0 +1,82 @@
+### Build Cluster Selection
+
+##### On pipeline creation
+
+```mermaid
+graph TD
+
+  A(Start) -->|Create| B[Pipeline Create]
+  B -->|Sync| C[Pipeline Sync]
+  C -->|Fetch Config| D[Get Config]
+
+  subgraph GH
+    E1@{ shape: lean-r, label: "SD YAML" }
+  end
+  E1 --> D
+
+  D --> E{Pipeline-level build cluster annotation?}
+  E -->|Yes| F[Store annotation]
+  E -->|No| F1[Get pipeline annotation]
+
+  subgraph Database
+    F1
+    F
+  end
+
+  F1 --> H{Pipeline has build cluster annotation?}
+  H -->|Yes| I[Use annotation] --> F
+  H -->|No| J[Derive build cluster] --> F
+  F --> Z@{ shape: stadium, label: "End" }
+
+  subgraph buildCluster Table in DB
+    K@{ shape: lean-r, label: "group" }
+    L@{ shape: lean-r, label: "weight" }
+  end
+
+  K --> J
+  L --> J
+
+  click B "https://github.com/screwdriver-cd/screwdriver/blob/master/plugins/pipelines/create.js"
+  click C "https://github.com/screwdriver-cd/screwdriver/blob/5a74c24e232a95a12d28e0ae7c4c3a5b25e6f872/plugins/pipelines/create.js#L104"
+  click D "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/pipeline.js#L1009-L1021"
+  click I "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/pipeline.js#L1018-L1020"
+  click J "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/helper.js#L229-L293"
+
+```
+
+##### On build creation
+
+```mermaid
+graph TD
+
+  A(Start) --> B[Build Create]
+  B --> C[Get build cluster]
+  subgraph input
+  D@{ shape: lean-r, label: "Job permutations" }
+  E@{ shape: lean-r, label: "Pipeline annotations" }
+  F@{ shape: lean-r, label: "Job provider" }
+  end
+  D --> C
+  E --> C
+  F --> C
+  C --> G{Is provider present?}
+  G -->|Yes| H[Derive build cluster based on provider]
+  H --> Z@{ shape: stadium, label: "Done" }
+  G -->|No| I{Is job annotation present?}
+  I --> |Yes| J[Use the build cluster from job annotation]
+  J --> Z
+  I --> |No| K{Is pipeline annotation present?}
+  K --> |Yes| L[Use the build cluster from pipeline annotation]
+  K --> |No| M[Derive randomly]
+  L --> Z
+  M --> Z
+
+  click C "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/buildFactory.js#L221-L226"
+  click D "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/buildFactory.js#L213"
+  click E "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/buildFactory.js#L214"
+  click F "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/buildFactory.js#L215-L219"
+  click H "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/helper.js#L245-L248"
+  click J "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/helper.js#L235-L237"
+  click L "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/helper.js#L239-L241"
+  click M "https://github.com/screwdriver-cd/models/blob/7eac5d79e11620793ab8936cf6e06971a2c04eea/lib/helper.js#L259-L265"
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "7.0.260",
+  "version": "7.0.262",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {

package/plugins/pipelines/index.js

@@ -43,6 +43,7 @@ const removeTemplateRoute = require('./templates/remove');
 const removeTemplateTagRoute = require('./templates/removeTag');
 const removeTemplateVersionRoute = require('./templates/removeVersion');
 const updateTrustedRoute = require('./templates/updateTrusted');
+const updateBuildCluster = require('./updateBuildCluster');
 
 /**
  * Pipeline API Plugin
@@ -276,7 +277,8 @@ const pipelinesPlugin = {
             removeTemplateRoute(),
             removeTemplateTagRoute(),
             removeTemplateVersionRoute(),
-            updateTrustedRoute()
+            updateTrustedRoute(),
+            updateBuildCluster()
         ]);
     }
 };

package/plugins/pipelines/updateBuildCluster.js

@@ -0,0 +1,102 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const logger = require('screwdriver-logger');
+const idSchema = schema.models.pipeline.base.extract('id');
+
+module.exports = () => ({
+    method: 'PUT',
+    path: '/pipelines/{id}/buildCluster',
+    options: {
+        description: 'Update the buildCluster of a pipeline',
+        notes: 'Update the buildCluster of a specific pipeline',
+        tags: ['api', 'pipelines'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', '!guest']
+        },
+        handler: async (request, h) => {
+            const buildClusterAnnotation = 'screwdriver.cd/buildCluster';
+            const { payload } = request;
+
+            // payload should have buildCluster annotation
+            if (!payload[buildClusterAnnotation]) {
+                throw boom.badRequest(`Payload must contain ${buildClusterAnnotation}`);
+            }
+
+            const { pipelineFactory, bannerFactory, buildClusterFactory } = request.server.app;
+            const { scmContext, username, scmUserId } = request.auth.credentials;
+
+            // only SD cluster admins can update the buildCluster
+            const scmDisplayName = bannerFactory.scm.getDisplayName({ scmContext });
+            const adminDetails = request.server.plugins.banners.screwdriverAdminDetails(
+                username,
+                scmDisplayName,
+                scmUserId
+            );
+
+            if (!adminDetails.isAdmin) {
+                throw boom.forbidden(
+                    `User ${username} does not have Screwdriver administrative privileges to update the buildCluster`
+                );
+            }
+
+            const { id } = request.params;
+            const pipeline = await pipelineFactory.get({ id });
+            // check if pipeline exists
+
+            if (!pipeline) {
+                throw boom.notFound(`Pipeline ${id} does not exist`);
+            }
+
+            const pipelineConfig = await pipeline.getConfiguration({});
+            // check if pipeline has buildCluster annotation
+
+            if (pipelineConfig.annotations && pipelineConfig.annotations[buildClusterAnnotation]) {
+                const scmUrl = pipeline.scmRepo.url;
+
+                throw boom.conflict(
+                    `Pipeline ${id} already has a buildCluster annotation set in the YAML configuration: check ${scmUrl}`
+                );
+            }
+
+            // ensure that the buildCluster is a valid cluster
+            const buildClusterName = payload[buildClusterAnnotation];
+            const buildCluster = await buildClusterFactory.get({ name: buildClusterName, scmContext });
+
+            if (!buildCluster) {
+                throw boom.badRequest(`Build cluster ${buildClusterName} does not exist`);
+            }
+
+            // ensure that the buildCluster is active
+            if (!buildCluster.isActive) {
+                throw boom.badRequest(`Build cluster ${buildClusterName} is not active`);
+            }
+
+            // update pipeline with buildCluster annotation
+            if (!pipeline.annotations) {
+                pipeline.annotations = {};
+            }
+            pipeline.annotations[buildClusterAnnotation] = buildClusterName;
+            try {
+                const result = await pipeline.update();
+
+                logger.info(
+                    `[Audit] user ${username} updates ${buildClusterAnnotation} for pipelineID:${id} to ${buildClusterName}.`
+                );
+
+                return h.response(result.toJson()).code(200);
+            } catch (err) {
+                logger.error(`Failed to update ${buildClusterAnnotation} for pipeline ${id}: ${err.message}`);
+                throw boom.internal(`Failed to update ${buildClusterAnnotation} for pipeline ${id}`);
+            }
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema
+            })
+        }
+    }
+});