screwdriver-data-schema 22.5.0 → 22.6.0

package/config/index.js

@@ -6,6 +6,7 @@ const command = require('./command');
 const commandFormat = require('./commandFormat');
 const job = require('./job');
 const parameters = require('./parameters');
+const pipelineTemplate = require('./pipelineTemplate');
 const regex = require('./regex');
 const settings = require('./settings');
 const template = require('./template');
@@ -19,6 +20,7 @@ module.exports = {
     commandFormat,
     job,
     parameters,
+    pipelineTemplate,
     regex,
     settings,
     template,

package/config/pipelineTemplate.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const Joi = require('joi');
+const JobsSchema = require('./base').jobs;
+const Shared = require('./base').shared;
+const Parameters = require('./parameters');
+const Template = require('./template');
+const Regex = require('./regex');
+
+const SCHEMA_CONFIG = Joi.object()
+    .keys({
+        jobs: JobsSchema.required(),
+        shared: Shared,
+        parameters: Parameters.parameters.default({})
+    })
+    .unknown(false);
+
+const SCHEMA_TEMPLATE = Joi.object()
+    .keys({
+        namespace: Template.namespace.required(),
+        name: Joi.string()
+            .regex(Regex.TEMPLATE_NAME_NO_SLASH)
+            .max(64)
+            .description('Name of the template')
+            .example('nodePipeline')
+            .required(),
+        version: Template.version.required(),
+        description: Template.description.required(),
+        maintainer: Template.maintainer.required(),
+        config: SCHEMA_CONFIG.required()
+    })
+    .unknown(false);
+
+/**
+ * The definition of the Template pieces
+ * @type {Object}
+ */
+module.exports = {
+    template: SCHEMA_TEMPLATE,
+    config: SCHEMA_CONFIG
+};

package/migrations/20230727160105-add_column_templateType_to_templateTags.js

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

package/migrations/20230727160440-initdb-pipelineTemplateVersions.js

@@ -0,0 +1,64 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}pipelineTemplateVersions`;
+
+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
+                    },
+                    templateId: {
+                        type: Sequelize.DOUBLE,
+                        allowNull: false
+                    },
+                    description: {
+                        type: Sequelize.STRING(256)
+                    },
+                    version: {
+                        type: Sequelize.STRING(16),
+                        allowNull: false
+                    },
+                    config: {
+                        type: Sequelize.TEXT,
+                        allowNull: false
+                    },
+                    createTime: {
+                        type: Sequelize.STRING(32),
+                        allowNull: false
+                    }
+                },
+                { transaction }
+            );
+
+            await queryInterface.addConstraint(table, {
+                name: `${table}_templateId_version_key`,
+                fields: ['templateId', 'version'],
+                type: 'unique',
+                transaction
+            });
+
+            await queryInterface.addIndex(table, {
+                name: `${table}_templateId`,
+                fields: ['templateId'],
+                transaction
+            });
+
+            await queryInterface.addIndex(table, {
+                name: `${table}_version`,
+                fields: ['version'],
+                transaction
+            });
+        });
+    }
+};

package/migrations/20230727160522-initdb-templateMeta.js

@@ -0,0 +1,79 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}templateMeta`;
+
+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,
+                        allowNull: false
+                    },
+                    namespace: {
+                        type: Sequelize.STRING(64),
+                        allowNull: false
+                    },
+                    name: {
+                        type: Sequelize.STRING(64),
+                        allowNull: false
+                    },
+                    maintainer: {
+                        type: Sequelize.STRING(64),
+                        allowNull: false
+                    },
+                    trustedSinceVersion: {
+                        type: Sequelize.STRING(16)
+                    },
+                    latestVersion: {
+                        type: Sequelize.STRING(16)
+                    },
+                    createTime: {
+                        type: Sequelize.STRING(32),
+                        allowNull: false
+                    },
+                    updateTime: {
+                        type: Sequelize.STRING(32),
+                        allowNull: false
+                    },
+                    templateType: {
+                        type: Sequelize.STRING(16),
+                        allowNull: false
+                    }
+                },
+                { transaction }
+            );
+
+            await queryInterface.addConstraint(table, {
+                name: `${table}_namespace_name_key`,
+                fields: ['name', 'namespace', 'templateType'],
+                type: 'unique',
+                transaction
+            });
+
+            await queryInterface.addIndex(table, {
+                name: `${table}_name`,
+                fields: ['name'],
+                transaction
+            });
+
+            await queryInterface.addIndex(table, {
+                name: `${table}_namespace`,
+                fields: ['namespace'],
+                transaction
+            });
+        });
+    }
+};

package/models/index.js

@@ -7,11 +7,13 @@ const step = require('./step');
 const event = require('./event');
 const job = require('./job');
 const pipeline = require('./pipeline');
+const pipelineTemplateVersions = require('./pipelineTemplateVersions');
 const user = require('./user');
 const secret = require('./secret');
 const stage = require('./stage');
 const stageBuild = require('./stageBuild');
 const template = require('./template');
+const templateMeta = require('./templateMeta');
 const templateTag = require('./templateTag');
 const token = require('./token');
 const trigger = require('./trigger');
@@ -27,11 +29,13 @@ module.exports = {
     event,
     job,
     pipeline,
+    pipelineTemplateVersions,
     user,
     secret,
     stage,
     stageBuild,
     template,
+    templateMeta,
     templateTag,
     token,
     trigger,

package/models/pipelineTemplateVersions.js

@@ -0,0 +1,89 @@
+'use strict';
+
+const Joi = require('joi');
+const mutate = require('../lib/mutate');
+const pipelineTemplateVersions = require('../config/pipelineTemplate');
+const JobTemplateConfig = require('../config/template');
+const templateId = require('./templateMeta').base.extract('id');
+
+const MODEL = {
+    id: Joi.number().integer().positive().description('Identifier of this template').example(123345).required(),
+    templateId,
+    description: pipelineTemplateVersions.template.extract('description'),
+    version: JobTemplateConfig.exactVersion.description('Exact version of the template').required(),
+    config: pipelineTemplateVersions.config,
+    createTime: Joi.string()
+        .isoDate()
+        .max(32)
+        .description('When this template was created')
+        .example('2038-01-19T03:14:08.131Z')
+        .required()
+};
+
+module.exports = {
+    /**
+     * All the available properties of Template
+     *
+     * @property base
+     * @type {Joi}
+     */
+    base: Joi.object(MODEL).label('pipelineTemplateVersions'),
+
+    /**
+     * All the available properties of pipelineTemplateVersions
+     *
+     * @property fields
+     * @type {Object}
+     */
+    fields: MODEL,
+
+    /**
+     * Properties for template that will come back during a GET request
+     *
+     * @property get
+     * @type {Joi}
+     */
+    get: Joi.object(mutate(MODEL, ['id', 'templateId', 'version'], ['description', 'config', 'createTime'])).label(
+        'Get Template'
+    ),
+
+    /**
+     * List of fields that determine a unique row
+     *
+     * @property keys
+     * @type {Array}
+     */
+    keys: ['templateId', 'version'],
+
+    /**
+     * List of all fields in the model
+     * @property allKeys
+     * @type {Array}
+     */
+    allKeys: Object.keys(MODEL),
+
+    /**
+     * Primary column to sort queries by.
+     * This defines queries to optionally sort a query result set by id.
+     * Each range key matches up with an element in the indexes property
+     *
+     * @property rangeKeys
+     * @type {Array}
+     */
+    rangeKeys: ['templateId', 'version'],
+
+    /**
+     * Tablename to be used in the datastore
+     *
+     * @property tableName
+     * @type {String}
+     */
+    tableName: 'pipelineTemplateVersions',
+    /**
+     * List of indexes to create in the datastore
+     *
+     * @property indexes
+     * @type {Array}
+     */
+    indexes: [{ fields: ['templateId'] }, { fields: ['version'] }]
+};

package/models/templateMeta.js

@@ -0,0 +1,113 @@
+'use strict';
+
+const Joi = require('joi');
+const mutate = require('../lib/mutate');
+const pipelineTemplateConfig = require('../config/pipelineTemplate');
+const pipelineId = require('./pipeline').base.extract('id');
+const JobTemplateConfig = require('../config/template');
+
+const TEMPLATE_TYPES = ['JOB', 'PIPELINE'];
+
+const MODEL = {
+    id: Joi.number().integer().positive().description('Identifier of this template').example(123345).required(),
+    pipelineId,
+    namespace: pipelineTemplateConfig.template.extract('namespace'),
+    name: pipelineTemplateConfig.template.extract('name'),
+    maintainer: pipelineTemplateConfig.template.extract('maintainer'),
+    trustedSinceVersion: JobTemplateConfig.exactVersion
+        .description('The version since the template is marked as trusted')
+        .example('1.2.3'),
+    latestVersion: JobTemplateConfig.exactVersion.description('Latest version of the template'),
+    createTime: Joi.string()
+        .isoDate()
+        .max(32)
+        .description('When this template was created')
+        .example('2038-01-19T03:14:08.131Z')
+        .required(),
+    updateTime: Joi.string()
+        .isoDate()
+        .max(32)
+        .description('When this template was updated')
+        .example('2038-01-19T03:14:08.131Z')
+        .required(),
+    templateType: Joi.string()
+        .valid(...TEMPLATE_TYPES)
+        .max(16)
+        .description('Template Type')
+        .example('PIPELINE')
+        .required()
+        .default('JOB')
+};
+
+module.exports = {
+    /**
+     * All the available properties of Template
+     *
+     * @property base
+     * @type {Joi}
+     */
+    base: Joi.object(MODEL).label('templateMeta'),
+
+    /**
+     * All the available properties of TemplateMeta
+     *
+     * @property fields
+     * @type {Object}
+     */
+    fields: MODEL,
+
+    /**
+     * Properties for template that will come back during a GET request
+     *
+     * @property get
+     * @type {Joi}
+     */
+    get: Joi.object(
+        // eslint-disable-next-line no-sparse-arrays
+        mutate(
+            MODEL,
+            ['id', 'pipelineId', 'namespace', 'name', 'maintainer', 'templateType'],
+            ['trustedSinceVersion', 'latestVersion', 'createTime', 'updateTime']
+        )
+    ).label('Get Template'),
+
+    /**
+     * List of fields that determine a unique row
+     *
+     * @property keys
+     * @type {Array}
+     */
+    keys: ['namespace', 'name', 'templateType'],
+
+    /**
+     * List of all fields in the model
+     * @property allKeys
+     * @type {Array}
+     */
+    allKeys: Object.keys(MODEL),
+
+    /**
+     * Primary column to sort queries by.
+     * This defines queries to optionally sort a query result set by id.
+     * Each range key matches up with an element in the indexes property
+     *
+     * @property rangeKeys
+     * @type {Array}
+     */
+    rangeKeys: ['namespace', 'name'],
+
+    /**
+     * Tablename to be used in the datastore
+     *
+     * @property tableName
+     * @type {String}
+     */
+    tableName: 'templateMeta',
+    /**
+     * List of indexes to create in the datastore
+     *
+     * @property indexes
+     * @type {Array}
+     */
+    indexes: [{ fields: ['namespace'] }, { fields: ['name'] }]
+};

package/models/templateTag.js

@@ -3,6 +3,8 @@
 const Joi = require('joi');
 const Template = require('../config/template');
 
+const TEMPLATE_TYPES = ['JOB', 'PIPELINE'];
+
 const MODEL = {
     id: Joi.number().integer().positive().description('Identifier of this template tag').example(123345),
     createTime: Joi.string()
@@ -13,7 +15,14 @@ const MODEL = {
     namespace: Template.namespace,
     name: Joi.string().max(64).description('Template name').example('nodejs/lib'),
     tag: Template.templateTag,
-    version: Template.exactVersion
+    version: Template.exactVersion,
+    templateType: Joi.string()
+        .valid(...TEMPLATE_TYPES)
+        .max(16)
+        .description('Template Type')
+        .example('PIPELINE')
+        .required()
+        .default('JOB')
 };
 
 module.exports = {
@@ -39,7 +48,7 @@ module.exports = {
      * @property keys
      * @type {Array}
      */
-    keys: ['namespace', 'name', 'tag'],
+    keys: ['namespace', 'name', 'tag', 'templateType'],
 
     /**
      * List of all fields in the model

package/package.json

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