screwdriver-api 7.0.25 → 7.0.26

package/bin/server

@@ -229,6 +229,16 @@ const buildClusterFactory = Models.BuildClusterFactory.getInstance({
     datastoreRO,
     scm
 });
+const pipelineTemplateFactory = Models.PipelineTemplateFactory.getInstance({
+    datastore,
+    datastoreRO,
+    scm
+});
+const pipelineTemplateVersionFactory = Models.PipelineTemplateVersionFactory.getInstance({
+    datastore,
+    datastoreRO,
+    scm
+});
 
 // @TODO run setup for SCM and Executor
 // datastoreConfig.ddlSync => sync datastore schema (ddl) via api (default: true)
@@ -250,6 +260,8 @@ datastore.setup(datastoreConfig.ddlSyncEnabled).then(() =>
         userFactory,
         buildFactory,
         buildClusterFactory,
+        pipelineTemplateFactory,
+        pipelineTemplateVersionFactory,
         stepFactory,
         bannerFactory,
         secretFactory,

package/lib/server.js

@@ -126,6 +126,11 @@ module.exports = async config => {
             commandTagFactory: config.commandTagFactory,
             templateFactory: config.templateFactory,
             templateTagFactory: config.templateTagFactory,
+            pipelineTemplateFactory: config.pipelineTemplateFactory,
+            pipelineTemplateVersionFactory: config.pipelineTemplateVersionFactory,
+            templateMetaFactory: config.templateMetaFactory,
+            jobTemplateTagFactory: config.jobTemplateTagFactory,
+            pipelineTemplateTagFactory: config.pipelineTemplateTagFactory,
             stageFactory: config.stageFactory,
             stageBuildFactory: config.stageBuildFactory,
             triggerFactory: config.triggerFactory,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "7.0.25",
+  "version": "7.0.26",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {
@@ -123,7 +123,7 @@
     "screwdriver-scm-github": "^12.1.1",
     "screwdriver-scm-gitlab": "^3.1.0",
     "screwdriver-scm-router": "^7.0.0",
-    "screwdriver-template-validator": "^6.0.0",
+    "screwdriver-template-validator": "^7.0.0",
     "screwdriver-workflow-parser": "^4.1.1",
     "sqlite3": "^5.1.4",
     "stream": "0.0.2",

package/plugins/pipelines/index.js

@@ -29,6 +29,8 @@ const latestCommitEvent = require('./latestCommitEvent');
 const getAdmin = require('./admins/get');
 const deleteCache = require('./caches/delete');
 const openPrRoute = require('./openPr');
+const createTemplate = require('./templates/create');
+const validateTemplate = require('./templates/validate');
 
 /**
  * Pipeline API Plugin
@@ -195,7 +197,9 @@ const pipelinesPlugin = {
             latestCommitEvent(),
             getAdmin(),
             deleteCache(),
-            openPrRoute()
+            openPrRoute(),
+            createTemplate(),
+            validateTemplate()
         ]);
     }
 };

package/plugins/pipelines/templates/create.js

@@ -0,0 +1,61 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const schema = require('screwdriver-data-schema');
+const validator = require('screwdriver-template-validator').parsePipelineTemplate;
+const templateSchema = schema.api.templateValidator;
+
+module.exports = () => ({
+    method: 'POST',
+    path: '/pipeline/template',
+    options: {
+        description: 'Create a new pipeline template',
+        notes: 'Create a specific pipeline template',
+        tags: ['api', 'pipelineTemplate'],
+        auth: {
+            strategies: ['token'],
+            scope: ['build']
+        },
+
+        handler: async (request, h) => {
+            const { pipelineTemplateVersionFactory, pipelineTemplateFactory } = request.server.app;
+
+            const config = await validator(request.payload.yaml);
+
+            if (config.errors.length > 0) {
+                throw boom.badRequest(`Template has invalid format: ${config.errors.length} error(s).`, config.errors);
+            }
+
+            const pipelineTemplate = await pipelineTemplateFactory.get({
+                name: config.template.name,
+                namespace: config.template.namespace
+            });
+
+            const { isPR, pipelineId } = request.auth.credentials;
+
+            // If template name exists, but this build's pipelineId is not the same as template's pipelineId
+            // Then this build does not have permission to publish
+            if (isPR || (pipelineTemplate && pipelineId !== pipelineTemplate.pipelineId)) {
+                throw boom.forbidden('Not allowed to publish this template');
+            }
+
+            const template = await pipelineTemplateVersionFactory.create(
+                {
+                    ...config.template,
+                    pipelineId
+                },
+                pipelineTemplateFactory
+            );
+
+            const location = new URL(
+                `${request.path}/${template.id}`,
+                `${request.server.info.protocol}://${request.headers.host}`
+            ).toString();
+
+            return h.response(template.toJson()).header('Location', location).code(201);
+        },
+        validate: {
+            payload: templateSchema.input
+        }
+    }
+});

package/plugins/pipelines/templates/validate.js

@@ -0,0 +1,38 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const schema = require('screwdriver-data-schema');
+const templateSchema = schema.api.templateValidator;
+const pipelineValidator = require('screwdriver-template-validator').parsePipelineTemplate;
+
+module.exports = () => ({
+    method: 'POST',
+    path: '/pipeline/template/validate',
+    options: {
+        description: 'Validate a given sd-template.yaml',
+        notes: 'returns the parsed config, validation errors, or both',
+        tags: ['api', 'validation', 'yaml'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', 'pipeline']
+        },
+
+        handler: async (request, h) => {
+            try {
+                const { yaml: templateString } = request.payload;
+
+                const result = await pipelineValidator(templateString);
+
+                return h.response(result);
+            } catch (err) {
+                throw boom.badRequest(err.toString());
+            }
+        },
+        validate: {
+            payload: templateSchema.input
+        },
+        response: {
+            schema: templateSchema.output
+        }
+    }
+});

package/plugins/template-validator.js

@@ -3,7 +3,7 @@
 const boom = require('@hapi/boom');
 const schema = require('screwdriver-data-schema');
 const templateSchema = schema.api.templateValidator;
-const validator = require('screwdriver-template-validator');
+const validator = require('screwdriver-template-validator').parseJobTemplate;
 
 /**
  * Hapi Template Validator Plugin

package/plugins/templates/create.js

@@ -3,7 +3,7 @@
 const urlLib = require('url');
 const boom = require('@hapi/boom');
 const schema = require('screwdriver-data-schema');
-const validator = require('screwdriver-template-validator');
+const validator = require('screwdriver-template-validator').parseJobTemplate;
 const templateSchema = schema.api.templateValidator;
 const hoek = require('@hapi/hoek');