screwdriver-data-schema 21.26.2 → 21.27.0

package/config/settings.js

@@ -2,6 +2,11 @@
 
 const Joi = require('joi');
 
+const SCHEMA_TIMESTAMP_FORMAT = Joi.string()
+    .valid('UTC', 'LOCAL_TIMEZONE', 'HUMAN_READABLE')
+    .optional()
+    .default('HUMAN_READABLE')
+    .description('User preferred timestamp');
 const SCHEMA_DISPLAY_JOB_NAME_LENGTH = Joi.number()
     .integer()
     .min(20)
@@ -46,7 +51,8 @@ const SCHEMA_USER_SETTINGS = Joi.object()
         /\d/,
         Joi.object().keys({
             displayJobNameLength: SCHEMA_DISPLAY_JOB_NAME_LENGTH,
-            showPRJobs: Joi.boolean()
+            showPRJobs: Joi.boolean(),
+            timestampFormat: SCHEMA_TIMESTAMP_FORMAT
         })
     )
     .unknown();

package/config/template.js

@@ -3,7 +3,6 @@
 const Joi = require('joi');
 const Job = require('./job');
 const Regex = require('./regex');
-const Parameters = require('./parameters');
 
 const TEMPLATE_NAMESPACE = Joi.string()
     .regex(Regex.TEMPLATE_NAMESPACE)
@@ -62,8 +61,6 @@ const TEMPLATE_IMAGES = Joi.object()
     })
     .min(1);
 
-const SCHEMA_JOB_PARAMETERS = Parameters.parameters.optional();
-
 const SCHEMA_TEMPLATE = Joi.object().keys({
     namespace: TEMPLATE_NAMESPACE,
     name: TEMPLATE_NAME.required(),
@@ -74,8 +71,7 @@ const SCHEMA_TEMPLATE = Joi.object().keys({
         .required()
         .or('image', 'template')
         .or('steps', 'template'),
-    images: TEMPLATE_IMAGES,
-    parameters: SCHEMA_JOB_PARAMETERS
+    images: TEMPLATE_IMAGES
 });
 
 /**
@@ -93,6 +89,5 @@ module.exports = {
     maintainer: TEMPLATE_MAINTAINER,
     config: Job.templateJob,
     configNoDupSteps: Job.jobNoDupSteps,
-    images: TEMPLATE_IMAGES,
-    parameters: SCHEMA_JOB_PARAMETERS
+    images: TEMPLATE_IMAGES
 };

package/migrations/20220607152947-add_column_state_to_pipeline.js

@@ -0,0 +1,23 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}pipelines`;
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.sequelize.transaction(async transaction => {
+            await queryInterface.addColumn(
+                table,
+                'state',
+                {
+                    type: Sequelize.STRING(10),
+                    defaultValue: 'ACTIVE',
+                    allowNull: false
+                },
+                { transaction }
+            );
+        });
+    }
+};

package/migrations/20220728171252-remove_column_parameters_from_templates.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}templates`;
+
+module.exports = {
+    // eslint-disable-next-line no-unused-vars
+    up: async (queryInterface, Sequelize) => {
+        try {
+            await queryInterface.removeColumn(table, 'parameters');
+            // eslint-disable-next-line no-empty
+        } catch (e) {}
+    }
+};

package/models/pipeline.js

@@ -10,6 +10,8 @@ const WorkflowGraph = require('../config/workflowGraph');
 const Parameters = require('../config/parameters');
 const mutate = require('../lib/mutate');
 
+const STATES = ['ACTIVE', 'INACTIVE'];
+
 const CREATE_MODEL = {
     checkoutUrl: Joi.string()
         .regex(Regex.CHECKOUT_URL)
@@ -85,6 +87,13 @@ const MODEL = {
 
     settings: Settings.pipelineSettings,
 
+    state: Joi.string()
+        .valid(...STATES)
+        .max(10)
+        .description('Current state of the pipeline')
+        .example('ACTIVE')
+        .default('ACTIVE'),
+
     subscribedScmUrlsWithActions: Joi.array()
         .items(
             Joi.object().keys({
@@ -123,7 +132,7 @@ module.exports = {
     get: Joi.object(
         mutate(
             MODEL,
-            ['id', 'scmUri', 'scmContext', 'createTime', 'admins'],
+            ['id', 'scmUri', 'scmContext', 'createTime', 'admins', 'state'],
             [
                 'workflowGraph',
                 'scmRepo',
@@ -175,6 +184,14 @@ module.exports = {
      */
     allKeys: Object.keys(MODEL),
 
+    /**
+     * All the available states of Pipeline
+     *
+     * @property allStates
+     * @type {Array}
+     */
+    allStates: STATES,
+
     /**
      * Tablename to be used in the datastore
      *

package/models/template.js

@@ -32,8 +32,7 @@ const MODEL = {
         .description('When this template was created')
         .example('2038-01-19T03:14:08.131Z'),
     trusted: Joi.boolean().description('Mark whether template is trusted'),
-    latest: Joi.boolean().description('Whether this is latest version'),
-    parameters: Template.parameters
+    latest: Joi.boolean().description('Whether this is latest version')
 };
 
 const CREATE_MODEL = { ...MODEL, config: Template.configNoDupSteps };
@@ -65,7 +64,7 @@ module.exports = {
         mutate(
             MODEL,
             ['id', 'labels', 'name', 'version', 'description', 'maintainer', 'pipelineId'],
-            ['config', 'namespace', 'images', 'createTime', 'trusted', 'latest', 'parameters']
+            ['config', 'namespace', 'images', 'createTime', 'trusted', 'latest']
         )
     ).label('Get Template'),
 
@@ -79,7 +78,7 @@ module.exports = {
         mutate(
             CREATE_MODEL,
             ['config', 'name', 'version', 'description', 'maintainer'],
-            ['labels', 'namespace', 'images', 'parameters']
+            ['labels', 'namespace', 'images']
         )
     ).label('Create Template'),
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-data-schema",
-  "version": "21.26.2",
+  "version": "21.27.0",
   "description": "Internal Data Schema of Screwdriver",
   "main": "index.js",
   "scripts": {