screwdriver-data-schema 22.4.0 → 22.4.2

package/config/base.js

@@ -37,11 +37,14 @@ const SCHEMA_CHILD_PIPELINES = Joi.object()
         startAll: Joi.boolean()
     })
     .unknown(false);
-
+const SCHEMA_SETUP_TEARDOWN_JOB = Job.job.keys({ requires: Joi.forbidden() });
 const SCHEMA_STAGE = Joi.object()
     .keys({
         description: Joi.string(),
-        jobs: Joi.array().items(Job.jobName).min(0)
+        jobs: Joi.array().items(Job.jobName).min(0),
+        setup: SCHEMA_SETUP_TEARDOWN_JOB,
+        teardown: SCHEMA_SETUP_TEARDOWN_JOB,
+        requires: Job.requires
     })
     .unknown(false);
 
@@ -86,6 +89,7 @@ module.exports = {
     cachePerm: SCHEMA_CACHE_PERMUTATION,
     childPipelines: SCHEMA_CHILD_PIPELINES,
     config: SCHEMA_CONFIG,
+    stageSetupTeardownJob: SCHEMA_SETUP_TEARDOWN_JOB,
     stage: SCHEMA_STAGE,
     stages: SCHEMA_STAGES,
     subscribe: SCHEMA_SUBSCRIBE

package/config/job.js

@@ -138,8 +138,14 @@ const SCHEMA_TEMPLATEID = Joi.number()
 const SCHEMA_TRIGGER = sdJoi.string().branchFilter();
 const SCHEMA_INTERNAL_TRIGGER = Joi.string().regex(Regex.INTERNAL_TRIGGER); // ~main, ~jobOne
 const SCHEMA_EXTERNAL_TRIGGER = Joi.string().regex(Regex.EXTERNAL_TRIGGER_ALL).example('~sd@1234:component'); // ~sd@123:main or sd@123:main
+const SCHEMA_STAGE_TRIGGER = Joi.string().regex(Regex.STAGE_TRIGGER); // ~stage@deploy, ~stage@deploy:main
 const SCHEMA_CRON_EXPRESSION = sdCron.string().cron();
-const SCHEMA_REQUIRES_VALUE = Joi.alternatives().try(SCHEMA_INTERNAL_TRIGGER, SCHEMA_JOBNAME, SCHEMA_TRIGGER);
+const SCHEMA_REQUIRES_VALUE = Joi.alternatives().try(
+    SCHEMA_INTERNAL_TRIGGER,
+    SCHEMA_JOBNAME,
+    SCHEMA_TRIGGER,
+    SCHEMA_STAGE_TRIGGER
+);
 const SCHEMA_REQUIRES = Joi.alternatives().try(Joi.array().items(SCHEMA_REQUIRES_VALUE), SCHEMA_REQUIRES_VALUE);
 const SCHEMA_BLOCKEDBY_VALUE = Joi.alternatives().try(
     SCHEMA_INTERNAL_TRIGGER,

package/config/regex.js

@@ -50,7 +50,8 @@ module.exports = {
     INTERNAL_TRIGGER: /^~([\w-]+)$/,
     // Stages can only be named with A-Z,a-z,0-9,-,_
     STAGE_NAME: /^[\w-]+$/,
-
+    // Stage trigger like ~stage@deploy or ~stage@stageName:jobName
+    STAGE_TRIGGER: /^~stage@([\w-]+)(?::([\w-]+))?$/,
     // Don't combine EXTERNAL_TRIGGER and EXTERNAL_TRIGGER_AND for backward compatibility
     // BlockBy does not support EXTERNAL_TRIGGER_AND
     // External trigger like ~sd@123:component (OR case)

package/core/scm.js

@@ -5,7 +5,7 @@ const Regex = require('../config/regex');
 
 const SCHEMA_USER = Joi.object()
     .keys({
-        id: Joi.alternatives(Joi.string(), Joi.number().integer().positive()).allow('').optional(),
+        id: Joi.string().allow('').optional(),
 
         url: Joi.string()
             .uri()

package/migrations/20221003-add_column_setup_teardown_startFrom_to_stage.js

@@ -0,0 +1,52 @@
+/* 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 => {
+            try {
+                await queryInterface.removeColumn(table, 'groupEventId');
+
+                await queryInterface.addColumn(
+                    table,
+                    'setup',
+                    {
+                        type: Sequelize.INTEGER
+                    },
+                    { transaction }
+                );
+                await queryInterface.addColumn(
+                    table,
+                    'teardown',
+                    {
+                        type: Sequelize.INTEGER
+                    },
+                    { transaction }
+                );
+                await queryInterface.addColumn(
+                    table,
+                    'archived',
+                    {
+                        type: Sequelize.BOOLEAN
+                    },
+                    { transaction }
+                );
+                await queryInterface.removeConstraint(table, `${table}_pipeline_id_name_group_event_id_key`, {
+                    transaction
+                });
+
+                await queryInterface.addConstraint(table, {
+                    fields: ['pipelineId', 'name'],
+                    name: `${table}_pipeline_id_name_key`,
+                    type: 'unique',
+                    transaction
+                });
+                // eslint-disable-next-line no-empty
+            } catch (e) {}
+        });
+    }
+};

package/migrations/20230328-initdb-stageBuilds.js

@@ -0,0 +1,56 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}stageBuilds`;
+
+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
+                    },
+                    stageId: {
+                        type: Sequelize.DOUBLE
+                    },
+                    status: {
+                        type: Sequelize.TEXT
+                    },
+                    eventId: {
+                        type: Sequelize.DOUBLE
+                    },
+                    workflowGraph: {
+                        type: Sequelize.TEXT
+                    }
+                },
+                { transaction }
+            );
+
+            await queryInterface.addConstraint(table, {
+                name: `${table}_stage_id_event_id_key`,
+                fields: ['stageId', 'eventId'],
+                type: 'unique',
+                transaction
+            });
+
+            await queryInterface.addIndex(table, {
+                name: `${table}_stage_id`,
+                fields: ['stageId'],
+                transaction
+            });
+
+            await queryInterface.addIndex(table, {
+                name: `${table}_event_id`,
+                fields: ['eventId'],
+                transaction
+            });
+        });
+    }
+};

package/models/banner.js

@@ -26,7 +26,7 @@ const MODEL = {
 
 module.exports = {
     /**
-     * All the available properties of Banners
+     * All the available properties of Banner
      *
      * @property base
      * @type {Joi}
@@ -34,7 +34,7 @@ module.exports = {
     base: Joi.object(MODEL).label('Banner'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Banner
      *
      * @property fields
      * @type {Object}

package/models/build.js

@@ -132,7 +132,7 @@ module.exports = {
     allStatuses: STATUSES,
 
     /**
-     * All the available properties of Job
+     * All the available properties of Build
      *
      * @property fields
      * @type {Object}

package/models/buildCluster.js

@@ -49,7 +49,7 @@ module.exports = {
     base: Joi.object(MODEL).label('BuildCluster'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of BuildCluster
      *
      * @property fields
      * @type {Object}

package/models/collection.js

@@ -47,7 +47,7 @@ module.exports = {
     base: Joi.object(MODEL).label('Collection'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Collection
      *
      * @property fields
      * @type {Object}

package/models/command.js

@@ -37,7 +37,7 @@ module.exports = {
     base: Joi.object(MODEL).label('Command'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Command
      *
      * @property fields
      * @type {Object}

package/models/commandTag.js

@@ -26,7 +26,7 @@ module.exports = {
     base: Joi.object(MODEL).label('CommandTag'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Command Tag
      *
      * @property fields
      * @type {Object}

package/models/event.js

@@ -80,7 +80,7 @@ module.exports = {
     base: Joi.object(MODEL).label('Event'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Event
      *
      * @property fields
      * @type {Object}

package/models/index.js

@@ -10,6 +10,7 @@ const pipeline = require('./pipeline');
 const user = require('./user');
 const secret = require('./secret');
 const stage = require('./stage');
+const stageBuild = require('./stageBuild');
 const template = require('./template');
 const templateTag = require('./templateTag');
 const token = require('./token');
@@ -29,6 +30,7 @@ module.exports = {
     user,
     secret,
     stage,
+    stageBuild,
     template,
     templateTag,
     token,

package/models/pipeline.js

@@ -105,7 +105,7 @@ module.exports = {
     base: Joi.object(MODEL).label('Pipeline'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Pipeline
      *
      * @property fields
      * @type {Object}

package/models/secret.js

@@ -26,7 +26,7 @@ module.exports = {
     base: Joi.object(MODEL).label('Secret'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Secret
      *
      * @property fields
      * @type {Object}

package/models/stage.js

@@ -2,6 +2,7 @@
 
 const Joi = require('joi');
 const Regex = require('../config/regex');
+const mutate = require('../lib/mutate');
 
 const MODEL = {
     id: Joi.number().integer().positive().example(12345),
@@ -10,13 +11,21 @@ const MODEL = {
 
     name: Joi.string().regex(Regex.STAGE_NAME).max(110).description('Name of the Stage').example('deploy'),
 
+    setup: Joi.array()
+        .items(Joi.number().integer().positive().description('Identifier for this job').example(123345))
+        .description('Job IDs in this Stage'),
+
+    teardown: Joi.array()
+        .items(Joi.number().integer().positive().description('Identifier for this job').example(123345))
+        .description('Job IDs in this Stage'),
+
     jobIds: Joi.array()
         .items(Joi.number().integer().positive().description('Identifier for this job').example(123345))
         .description('Job IDs in this Stage'),
 
     description: Joi.string().max(256).description('Description of the Stage').example('Deploys canary jobs'),
 
-    groupEventId: Joi.number().integer().positive().description('Identifier of the group event').example(123345)
+    archived: Joi.boolean().description('Flag if the stage is archived').example(true).default(false)
 };
 
 module.exports = {
@@ -36,13 +45,31 @@ module.exports = {
      */
     fields: MODEL,
 
+    /**
+     * Properties for Stage that will come back during a GET request
+     *
+     * @property get
+     * @type {Joi}
+     */
+    get: Joi.object(
+        mutate(MODEL, ['id', 'pipelineId', 'name', 'jobIds'], ['description', 'setup', 'teardown', 'archived'])
+    ).label('Get Stage metadata'),
+
+    /**
+     * Properties for Stage that will be passed during an UPDATE request
+     *
+     * @property update
+     * @type {Joi}
+     */
+    update: Joi.object(mutate(MODEL, [], ['jobIds', 'description', 'setup', 'teardown'])).label('Update Stage'),
+
     /**
      * List of fields that determine a unique row
      *
      * @property keys
      * @type {Array}
      */
-    keys: ['pipelineId', 'name', 'groupEventId'],
+    keys: ['pipelineId', 'name'],
 
     /**
      * List of all fields in the model
@@ -65,5 +92,5 @@ module.exports = {
      * @property indexes
      * @type {Array}
      */
-    indexes: [{ fields: ['pipelineId'] }, { fields: ['groupEventId'] }]
+    indexes: [{ fields: ['pipelineId'] }]
 };

package/models/stageBuild.js

@@ -0,0 +1,83 @@
+'use strict';
+
+const Joi = require('joi');
+const mutate = require('../lib/mutate');
+const WorkflowGraph = require('../config/workflowGraph');
+const status = require('./build').base.extract('status');
+
+const MODEL = {
+    id: Joi.number().integer().positive().example(12345),
+
+    stageId: Joi.number().integer().positive().description('Stage associated with the Stage build').example(123345),
+
+    eventId: Joi.number().integer().positive().description('Identifier of the event').example(123345),
+
+    workflowGraph: WorkflowGraph.workflowGraph.description('Graph representation of the workflow').example({
+        nodes: [{ name: '~commit' }, { name: 'main' }, { name: 'publish' }],
+        edges: [
+            { src: '~commit', dest: 'main' },
+            { src: 'main', dest: 'publish' }
+        ]
+    }),
+
+    status
+};
+
+module.exports = {
+    /**
+     * All the available properties of StageBuild
+     *
+     * @property base
+     * @type {Joi}
+     */
+    base: Joi.object(MODEL).label('Stage Build'),
+
+    /**
+     * All the available properties of StageBuild
+     *
+     * @property fields
+     * @type {Object}
+     */
+    fields: MODEL,
+
+    /**
+     * Properties for StageBuild that will come back during a GET request
+     *
+     * @property get
+     * @type {Joi}
+     */
+    get: Joi.object(mutate(MODEL, ['id', 'stageId', 'eventId'], ['workflowGraph', 'status'])).label(
+        'Get Stage Build metadata'
+    ),
+
+    /**
+     * List of fields that determine a unique row
+     *
+     * @property keys
+     * @type {Array}
+     */
+    keys: ['stageId', 'eventId'],
+
+    /**
+     * 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: 'stageBuilds',
+
+    /**
+     * List of indexes to create in the datastore
+     *
+     * @property indexes
+     * @type {Array}
+     */
+    indexes: [{ fields: ['stageId'] }, { fields: ['eventId'] }]
+};

package/models/step.js

@@ -34,7 +34,7 @@ module.exports = {
     base: Joi.object(MODEL).label('Step'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Step
      *
      * @property fields
      * @type {Object}

package/models/template.js

@@ -37,7 +37,7 @@ module.exports = {
     base: Joi.object(MODEL).label('Template'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Template
      *
      * @property fields
      * @type {Object}

package/models/templateTag.js

@@ -26,7 +26,7 @@ module.exports = {
     base: Joi.object(MODEL).label('TemplateTag'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Template Tag
      *
      * @property fields
      * @type {Object}

package/models/token.js

@@ -42,7 +42,7 @@ module.exports = {
     base: Joi.object(MODEL).without('userId', 'pipelineId').label('Token'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Token
      *
      * @property fields
      * @type {Object}

package/models/trigger.js

@@ -31,7 +31,7 @@ module.exports = {
     base: Joi.object(MODEL).label('Trigger'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of Trigger
      *
      * @property fields
      * @type {Object}

package/models/user.js

@@ -28,7 +28,7 @@ module.exports = {
     base: Joi.object(MODEL).label('User'),
 
     /**
-     * All the available properties of Job
+     * All the available properties of User
      *
      * @property fields
      * @type {Object}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-data-schema",
-  "version": "22.4.0",
+  "version": "22.4.2",
   "description": "Internal Data Schema of Screwdriver",
   "main": "index.js",
   "scripts": {
@@ -13,7 +13,7 @@
     "url": "git+https://github.com/screwdriver-cd/data-schema.git"
   },
   "homepage": "https://github.com/screwdriver-cd/data-schema",
-  "bugs": "https://github.com/screwdriver-cd/data-schema/issues",
+  "bugs": "https://github.com/screwdriver-cd/screwdriver/issues",
   "keywords": [
     "screwdriver",
     "yahoo"
@@ -39,23 +39,23 @@
     "debug": false
   },
   "devDependencies": {
-    "chai": "^4.3.6",
-    "eslint": "^8.27.0",
+    "chai": "^4.3.7",
+    "eslint": "^8.28.0",
     "eslint-config-screwdriver": "^7.0.0",
     "js-yaml": "^4.1.0",
     "mocha": "^10.1.0",
     "mocha-multi-reporters": "^1.5.1",
     "mocha-sonarqube-reporter": "^1.0.2",
     "mysql2": "^1.7.0",
-    "npx": "^10.2.2",
+    "npx": "^3.0.0",
     "nyc": "^15.1.0",
     "pg": "^7.18.2",
-    "sequelize": "^6.25.3",
+    "sequelize": "^6.25.8",
     "sequelize-cli": "^6.5.2",
     "sqlite3": "^5.1.2"
   },
   "dependencies": {
-    "cron-parser": "^4.6.0",
+    "cron-parser": "^4.7.0",
     "joi": "^17.7.0"
   }
 }