screwdriver-data-schema 21.8.2 → 21.10.1

package/api/validator.js

@@ -33,6 +33,8 @@ const SCHEMA_JOB_PERMUTATION = Joi.object()
         freezeWindows: Job.freezeWindows,
         image: Job.image,
         order: Job.order,
+        parameters: Job.parameters,
+        provider: Job.provider,
         requires: Job.requires,
         secrets: Job.secrets,
         settings: Job.settings,
@@ -62,7 +64,7 @@ const SCHEMA_OUTPUT = Joi.object()
         jobs: SCHEMA_JOBS,
         childPipelines: Base.childPipelines,
         workflowGraph: WorkflowGraph.workflowGraph,
-        parameters: Parameters.parameters,
+        parameters: Parameters.parameters.default({}),
         warnMessages: Joi.array().optional(),
         subscribe: Base.subscribe
     })

package/config/base.js

@@ -60,7 +60,7 @@ const SCHEMA_CONFIG = Joi.object()
         cache: SCHEMA_CACHE,
         childPipelines: SCHEMA_CHILD_PIPELINES,
         subscribe: SCHEMA_SUBSCRIBE,
-        parameters: Parameters.parameters
+        parameters: Parameters.parameters.default({})
     })
     .unknown(false);
 

package/config/job.js

@@ -4,6 +4,8 @@ const Joi = require('joi');
 const Annotations = require('./annotations');
 const Regex = require('./regex');
 const sdCron = require('./cronExpression');
+const Parameters = require('./parameters');
+const Provider = require('./provider');
 
 const SPECIFIC_BRANCH_POS = 4;
 
@@ -166,6 +168,8 @@ const SCHEMA_SOURCEPATH = Joi.string()
     .optional();
 const SCHEMA_SOURCEPATHS = Joi.alternatives().try(Joi.array().items(SCHEMA_SOURCEPATH), SCHEMA_SOURCEPATH);
 const SCHEMA_CACHE = Joi.boolean().optional();
+const SCHEMA_PARAMETERS = Parameters.parameters.optional();
+const SCHEMA_PROVIDER = Provider.provider.optional();
 const SCHEMA_JOB = Joi.object()
     .keys({
         annotations: Annotations.annotations,
@@ -177,6 +181,8 @@ const SCHEMA_JOB = Joi.object()
         image: SCHEMA_IMAGE,
         matrix: SCHEMA_MATRIX,
         order: SCHEMA_ORDER,
+        parameters: SCHEMA_PARAMETERS,
+        provider: SCHEMA_PROVIDER,
         requires: SCHEMA_REQUIRES,
         secrets: SCHEMA_SECRETS,
         settings: SCHEMA_SETTINGS,
@@ -211,6 +217,8 @@ module.exports = {
     jobNoDupSteps: SCHEMA_JOB_NO_DUP_STEPS,
     matrix: SCHEMA_MATRIX,
     order: SCHEMA_ORDER,
+    parameters: SCHEMA_PARAMETERS,
+    provider: SCHEMA_PROVIDER,
     requires: SCHEMA_REQUIRES,
     requiresValue: SCHEMA_REQUIRES_VALUE,
     secret: SCHEMA_SECRET,

package/config/parameters.js

@@ -12,16 +12,14 @@ const SCHEMA_PARAMETERS_OBJECT = Joi.object({
     'object.unknown': 'only supports string or key: {{#label}} pair as values'
 });
 
-const SCHEMA_PARAMETERS = Joi.object()
-    .pattern(
-        Joi.any(),
-        Joi.alternatives().try(
-            SCHEMA_PARAMETERS_STRING,
-            Joi.array().items(SCHEMA_PARAMETERS_STRING),
-            SCHEMA_PARAMETERS_OBJECT
-        )
+const SCHEMA_PARAMETERS = Joi.object().pattern(
+    Joi.any(),
+    Joi.alternatives().try(
+        SCHEMA_PARAMETERS_STRING,
+        Joi.array().items(SCHEMA_PARAMETERS_STRING),
+        SCHEMA_PARAMETERS_OBJECT
     )
-    .default({});
+);
 
 module.exports = {
     parameters: SCHEMA_PARAMETERS

package/config/provider.js

@@ -0,0 +1,78 @@
+'use strict';
+
+const Joi = require('joi');
+const Regex = require('./regex');
+
+const SCHEMA_VPC_OBJECT = Joi.object({
+    vpcId: Joi.string()
+        .regex(Regex.VPC_ID)
+        .max(128)
+        .description('VPC ID')
+        .example('vpc-1a2b3c4d')
+        .required(),
+    securityGroupIds: Joi.array()
+        .items(
+            Joi.string()
+                .regex(Regex.SECURITY_GROUP_ID)
+                .max(128)
+                .description('Security group ID')
+                .example('sg-51530134')
+        )
+        .min(1)
+        .label('List of security group IDs')
+        .required(),
+    subnetIds: Joi.array()
+        .items(
+            Joi.string()
+                .regex(Regex.SUBNET_ID)
+                .max(128)
+                .description('Subnet ID')
+                .example('subnet-01234567890abcdef')
+        )
+        .min(1)
+        .label('List of subnet IDs')
+        .required()
+});
+
+const SCHEMA_PROVIDER = Joi.object().keys({
+    name: Joi.string()
+        .valid('aws')
+        .max(64)
+        .description('Provider name')
+        .example('aws'),
+    region: Joi.string()
+        .regex(Regex.REGION)
+        .max(64)
+        .description('Region')
+        .example('us-west-2'),
+    accountId: Joi.alternatives()
+        .try(
+            Joi.string()
+                .regex(Regex.ACCOUNT_ID)
+                .max(12),
+            Joi.number()
+                .integer()
+                .min(12)
+        )
+        .description('Account ID')
+        .example('123456789012'),
+    vpc: SCHEMA_VPC_OBJECT.optional(),
+    role: Joi.string()
+        .regex(Regex.ROLE_ARN)
+        .max(512)
+        .description('Role ARN')
+        .example('arn:aws:iam::123456789012:role/aws-service-role/amazonaws.com/AWSServiceRole'),
+    executor: Joi.string()
+        .valid('sls', 'eks')
+        .max(64)
+        .description('Executor name')
+        .example('eks'),
+    clusterName: Joi.string()
+        .max(128)
+        .description('Cluster name')
+        .example('sd-build-eks')
+});
+
+module.exports = {
+    provider: SCHEMA_PROVIDER
+};

package/config/regex.js

@@ -96,5 +96,18 @@ module.exports = {
     // Image aliases can only contain A-Z,a-z,0-9,-,_
     IMAGE_ALIAS: /^[\w-]+$/,
     // Valid Events for webhook
-    WEBHOOK_EVENT: /^~([\w-]+)$/
+    WEBHOOK_EVENT: /^~([\w-]+)$/,
+    // Provider region. e.g. us-west-1, ap-northeast-2
+    REGION: /^(us(-gov)?|ap|ca|cn|eu|sa|me)-(central|(north|south)?(east|west)?)-\d$/,
+    // Provider account ID. Can be A-Z,a-z,0-9,_,-
+    // https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html
+    ACCOUNT_ID: /^[0-9]{12}$/,
+    // Provider VPC ID. Can be vpc-xxxxxx, with A-Z,a-z,0-9,_
+    VPC_ID: /^vpc-[\w]+$/,
+    // Provider Security group ID. Can be sg-xxxxxx, with A-Z,a-z,0-9,_
+    SECURITY_GROUP_ID: /^sg-[\w]+$/,
+    // Provider Subnet ID. Can be subnet-xxxxxx, with A-Z,a-z,0-9,_
+    SUBNET_ID: /^subnet-[\w]+$/,
+    // Provider Role. Can be arn:aws:iam::xxxxxx:role/some-role
+    ROLE_ARN: /^arn:aws:iam::\d{12}:role\/.+/
 };

package/migrations/20211004-update_trigger_length-triggers.js

@@ -0,0 +1,17 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}triggers`;
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.sequelize.transaction(async transaction => {
+            await queryInterface.changeColumn(table, 'src', Sequelize.STRING(128), { transaction });
+        });
+        await queryInterface.sequelize.transaction(async transaction => {
+            await queryInterface.changeColumn(table, 'dest', Sequelize.STRING(128), { transaction });
+        });
+    }
+};

package/models/pipeline.js

@@ -81,7 +81,7 @@ const MODEL = {
     // in order to convert the `prChain` to `chainPR`.
     prChain: Base.prChain.description('Configuration of chainPR'),
 
-    parameters: Parameters.parameters,
+    parameters: Parameters.parameters.default({}),
 
     settings: Settings.pipelineSettings,
 

package/models/trigger.js

@@ -13,10 +13,10 @@ const MODEL = {
         .try(
             Joi.string()
                 .regex(Regex.EXTERNAL_TRIGGER)
-                .max(64),
+                .max(128),
             Joi.string()
                 .regex(Regex.EXTERNAL_TRIGGER_AND)
-                .max(64)
+                .max(128)
         )
         .example('~sd@1234:component'),
 
@@ -24,10 +24,10 @@ const MODEL = {
         .try(
             Joi.string()
                 .regex(Regex.EXTERNAL_TRIGGER)
-                .max(64),
+                .max(128),
             Joi.string()
                 .regex(Regex.EXTERNAL_TRIGGER_AND)
-                .max(64)
+                .max(128)
         )
         .example('~sd@5678:test')
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-data-schema",
-  "version": "21.8.2",
+  "version": "21.10.1",
   "description": "Internal Data Schema of Screwdriver",
   "main": "index.js",
   "scripts": {
@@ -40,7 +40,7 @@
   },
   "devDependencies": {
     "chai": "^4.2.0",
-    "eslint": "^7.5.0",
+    "eslint": "^7.32.0",
     "eslint-config-screwdriver": "^5.0.1",
     "js-yaml": "^3.14.1",
     "mocha": "^8.4.0",
@@ -55,6 +55,6 @@
   },
   "dependencies": {
     "cron-parser": "^2.18.0",
-    "joi": "^17.4.0"
+    "joi": "^17.4.2"
   }
 }

package/plugins/executor.js

@@ -26,6 +26,7 @@ const buildSchemaObj = {
     jobName,
     jobState,
     jobArchived,
+    provider: Job.provider,
     annotations: Annotations.annotations,
     blockedBy: Joi.array().items(jobId),
     freezeWindows: Job.freezeWindows,
@@ -61,7 +62,8 @@ const SCHEMA_STOP = Joi.object()
         buildClusterName: models.buildCluster.base.extract('name'),
         jobId,
         token: Joi.string().label('Build JWT'),
-        pipelineId
+        pipelineId,
+        provider: Job.provider
     })
     .required();
 const SCHEMA_STATUS = Joi.object()
@@ -69,7 +71,8 @@ const SCHEMA_STATUS = Joi.object()
         buildId,
         token: Joi.string().label('Build JWT'),
         pipelineId,
-        jobId
+        jobId,
+        provider: Job.provider
     })
     .required();
 const SCHEMA_VERIFY = Joi.object()