screwdriver-data-schema 21.23.1 → 21.25.1

package/api/validator.js

@@ -39,6 +39,7 @@ const SCHEMA_JOB_PERMUTATION = Joi.object()
         secrets: Job.secrets,
         settings: Job.settings,
         sourcePaths: Job.sourcePaths,
+        stages: Base.stages,
         subscribe: Base.subscribe,
         templateId: Job.templateId
     })
@@ -66,6 +67,7 @@ const SCHEMA_OUTPUT = Joi.object()
         workflowGraph: WorkflowGraph.workflowGraph,
         parameters: Parameters.parameters.default({}),
         warnMessages: Joi.array().optional(),
+        stages: Base.stages.optional(),
         subscribe: Base.subscribe
     })
     .label('Execution information');

package/config/base.js

@@ -42,6 +42,25 @@ const SCHEMA_CHILD_PIPELINES = Joi.object()
     })
     .unknown(false);
 
+const SCHEMA_STAGE = Joi.object()
+    .keys({
+        description: Joi.string(),
+        jobs: Joi.array()
+            .items(Job.jobName)
+            .min(0),
+        color: Joi.string().regex(Regex.STAGE_COLOR)
+    })
+    .unknown(false);
+
+const SCHEMA_STAGES = Joi.object()
+    // Stages can only be named with A-Z,a-z,0-9,-,_
+    // Stages only contain an object with the stages
+    .pattern(Regex.STAGE_NAME, SCHEMA_STAGE)
+    // All others are marked as invalid
+    .unknown(false)
+    // Add documentation
+    .messages({ 'object.unknown': '{{#label}} only supports the following characters A-Z,a-z,0-9,-,_' });
+
 const SCHEMA_SUBSCRIBE = Joi.object().keys({
     scmUrls: Joi.array().items(
         Joi.object().pattern(Regex.CHECKOUT_URL, Joi.array().items(Joi.string().regex(Regex.WEBHOOK_EVENT)))
@@ -59,6 +78,7 @@ const SCHEMA_CONFIG = Joi.object()
         shared: SCHEMA_SHARED,
         cache: SCHEMA_CACHE,
         childPipelines: SCHEMA_CHILD_PIPELINES,
+        stages: SCHEMA_STAGES,
         subscribe: SCHEMA_SUBSCRIBE,
         parameters: Parameters.parameters.default({})
     })
@@ -76,5 +96,7 @@ module.exports = {
     cachePerm: SCHEMA_CACHE_PERMUTATION,
     childPipelines: SCHEMA_CHILD_PIPELINES,
     config: SCHEMA_CONFIG,
+    stage: SCHEMA_STAGE,
+    stages: SCHEMA_STAGES,
     subscribe: SCHEMA_SUBSCRIBE
 };

package/config/regex.js

@@ -47,6 +47,10 @@ module.exports = {
     ALL_JOB_NAME: /^(PR-[0-9]+:)?[\w-@:]+$/,
     // Internal trigger like ~component or ~main
     INTERNAL_TRIGGER: /^~([\w-]+)$/,
+    // Stages can only be named with A-Z,a-z,0-9,-,_
+    STAGE_NAME: /^[\w-]+$/,
+    // Stages can only be named with valid hex CSS color
+    STAGE_COLOR: /^#(?:[0-9a-fA-F]{3}){1,2}$/,
 
     // Don't combine EXTERNAL_TRIGGER and EXTERNAL_TRIGGER_AND for backward compatibility
     // BlockBy does not support EXTERNAL_TRIGGER_AND

package/migrations/20220607-initdb-stages.js

@@ -0,0 +1,56 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}stages`;
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.sequelize.transaction(async transaction => {
+            await queryInterface.createTable(
+                table,
+                {
+                    id: {
+                        allowNull: false,
+                        autoIncrement: true,
+                        primaryKey: true,
+                        type: Sequelize.INTEGER.UNSIGNED
+                    },
+                    pipelineId: {
+                        type: Sequelize.DOUBLE
+                    },
+                    name: {
+                        type: Sequelize.STRING(64)
+                    },
+                    jobIds: {
+                        type: Sequelize.TEXT
+                    },
+                    state: {
+                        type: Sequelize.STRING(10)
+                    },
+                    description: {
+                        type: Sequelize.STRING(256)
+                    },
+                    color: {
+                        type: Sequelize.STRING(10)
+                    }
+                },
+                { transaction }
+            );
+
+            await queryInterface.addConstraint(table, {
+                name: `${table}_pipeline_id_name_key`,
+                fields: ['pipelineId', 'name'],
+                type: 'unique',
+                transaction
+            });
+
+            await queryInterface.addIndex(table, {
+                name: `${table}_pipeline_id`,
+                fields: ['pipelineId'],
+                transaction
+            });
+        });
+    }
+};

package/migrations/20220628180148-remove_pr_jobs_invalid_name.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}jobs`;
+
+module.exports = {
+    // eslint-disable-next-line no-unused-vars
+    async up(queryInterface, Sequelize) {
+        await queryInterface.sequelize.transaction(async transaction => {
+            const dialect = queryInterface.sequelize.getDialect();
+            // sqlite
+            let query = `DELETE FROM "${table}" WHERE "name" LIKE 'PR-%' AND INSTR(name, ':') = 0`;
+
+            if (dialect === 'postgres') {
+                query = `DELETE FROM "${table}" WHERE "name" LIKE 'PR-%' AND POSITION(':' IN "name") = 0`;
+            } else if (dialect === 'mysql') {
+                query = `DELETE FROM \`${table}\` WHERE name LIKE 'PR-%' AND POSITION(':' IN name) = 0`;
+            }
+
+            await queryInterface.sequelize.query(query, { transaction });
+        });
+    }
+};

package/models/index.js

@@ -9,6 +9,7 @@ const job = require('./job');
 const pipeline = require('./pipeline');
 const user = require('./user');
 const secret = require('./secret');
+const stage = require('./stage');
 const template = require('./template');
 const templateTag = require('./templateTag');
 const token = require('./token');
@@ -27,6 +28,7 @@ module.exports = {
     pipeline,
     user,
     secret,
+    stage,
     template,
     templateTag,
     token,

package/models/stage.js

@@ -0,0 +1,102 @@
+'use strict';
+
+const Joi = require('joi');
+const Regex = require('../config/regex');
+
+const MODEL = {
+    id: Joi.number()
+        .integer()
+        .positive()
+        .example(12345),
+
+    pipelineId: Joi.number()
+        .integer()
+        .positive()
+        .description('Pipeline associated with the Stage')
+        .example(123345),
+
+    name: Joi.string()
+        .regex(Regex.STAGE_NAME)
+        .max(110)
+        .description('Name of the Stage')
+        .example('deploy'),
+
+    jobIds: Joi.array()
+        .items(
+            Joi.number()
+                .integer()
+                .positive()
+                .description('Identifier for this job')
+                .example(123345)
+                .optional()
+                .allow(null)
+        )
+        .description('Job IDs in this Stage'),
+
+    state: Joi.string()
+        .valid('ARCHIVED', 'ACTIVE')
+        .max(10)
+        .description('Current state of the Stage')
+        .example('ARCHIVED')
+        .default('ACTIVE'),
+
+    description: Joi.string()
+        .max(256)
+        .description('Description of the Stage')
+        .example('Deploys canary jobs'),
+
+    color: Joi.string()
+        .regex(Regex.STAGE_COLOR)
+        .max(7)
+        .description('Color for the Stage')
+        .example('#FFFF00')
+};
+
+module.exports = {
+    /**
+     * All the available properties of Stage
+     *
+     * @property base
+     * @type {Joi}
+     */
+    base: Joi.object(MODEL).label('Stage'),
+
+    /**
+     * All the available properties of Stage
+     *
+     * @property fields
+     * @type {Object}
+     */
+    fields: MODEL,
+
+    /**
+     * List of fields that determine a unique row
+     *
+     * @property keys
+     * @type {Array}
+     */
+    keys: ['pipelineId', 'name'],
+
+    /**
+     * List of all fields in the model
+     * @property allKeys
+     * @type {Array}
+     */
+    allKeys: Object.keys(MODEL),
+
+    /**
+     * Tablename to be used in the datastore
+     *
+     * @property tableName
+     * @type {String}
+     */
+    tableName: 'stages',
+
+    /**
+     * List of indexes to create in the datastore
+     *
+     * @property indexes
+     * @type {Array}
+     */
+    indexes: [{ fields: ['pipelineId'] }]
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-data-schema",
-  "version": "21.23.1",
+  "version": "21.25.1",
   "description": "Internal Data Schema of Screwdriver",
   "main": "index.js",
   "scripts": {
@@ -50,7 +50,7 @@
     "npx": "^10.2.2",
     "nyc": "^15.0.0",
     "pg": "^7.18.2",
-    "sequelize": "^6.20.1",
+    "sequelize": "^6.21.0",
     "sequelize-cli": "^6.4.1",
     "sqlite3": "^4.2.0"
   },

package/plugins/scm.js

@@ -113,6 +113,8 @@ const ADD_PR_COMMENT = Joi.object()
         token,
         prNum: core.scm.hook.extract('prNum').required(),
         comment: Joi.string().required(),
+        jobName,
+        pipelineId,
         scmContext
     })
     .required();