screwdriver-api 7.0.32 → 7.0.34

package/bin/server

@@ -254,14 +254,14 @@ datastore.setup(datastoreConfig.ddlSyncEnabled).then(() =>
         commandFactory,
         commandTagFactory,
         templateFactory,
+        pipelineTemplateFactory,
+        pipelineTemplateVersionFactory,
         templateTagFactory,
         pipelineFactory,
         jobFactory,
         userFactory,
         buildFactory,
         buildClusterFactory,
-        pipelineTemplateFactory,
-        pipelineTemplateVersionFactory,
         stepFactory,
         bannerFactory,
         secretFactory,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "7.0.32",
+  "version": "7.0.34",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {

package/plugins/pipelines/README.md

@@ -208,3 +208,84 @@ handler: async (request, h) => {
     // ...
 }
 ```
+
+#### Pipeline Templates
+##### Get all pipeline templates
+
+`GET /pipeline/templates`
+
+Can use additional options for sorting, pagination and count:
+`GET /pipeline/templates?sort=ascending&sortBy=name&page=1&count=50`
+
+##### Get all versions for a pipeline template
+
+`GET /pipeline/templates/{namespace}/{name}/versions`
+
+Can use additional options for sorting, pagination and count:
+`GET /pipeline/templates/{namespace}/{name}/versions?sort=ascending&page=1&count=50`
+
+##### Create a pipeline template
+Creating a template will store the template meta (`name`, `namespace`, `maintainer`, `latestVersion`, `trustedSinceVersion`, `pipelineId`) and template version (`description`, `version`, `config`, `createTime`, `templateId`)  into the datastore.
+
+`version` will be auto-bumped. For example, if `mypipelinetemplate@1.0.0` already exists and the version passed in is `1.0.0`, the newly created template will be version `1.0.1`.
+
+
+`POST /pipeline/template`
+###### Arguments
+
+'name', 'namespace', 'version', 'description', 'maintainer', 'config'
+
+* `name` - Name of the template
+* `namespace` - Namespace of the template
+* `version` - Version of the template
+* `description` - Description of the template
+* `maintainer` - Maintainer of the template
+* `config` - Config of the template. This field is an object that includes `steps`, `image`, and optional `secrets`, `environments`. Similar to what's inside the `pipeline`
+
+Example payload:
+```json
+{
+    "name": "example-template",
+    "namespace": "my-namespace",
+    "version": "1.3.1",
+    "description": "An example template",
+    "maintainer": "example@gmail.com",
+    "config": {
+        "steps": [{
+            "echo": "echo hello"
+        }]
+    }
+}
+```
+
+##### Validate a pipeline template
+Validate a pipeline template and return a JSON containing the boolean property ‘valid’ indicating if the template is valid or not
+
+`POST /pipeline/template/validate`
+
+###### Arguments
+
+'name', 'namespace', 'version', 'description', 'maintainer', 'config'
+
+* `name` - Name of the template
+* `namespace` - Namespace of the template
+* `version` - Version of the template
+* `description` - Description of the template
+* `maintainer` - Maintainer of the template
+* `config` - Config of the template. This field is an object that includes `steps`, `image`, and optional `secrets`, `environments`. Similar to what's inside the `pipeline`
+
+Example payload:
+```json
+{
+    "name": "example-template",
+    "namespace": "my-namespace",
+    "version": "1.3.1",
+    "description": "An example template",
+    "maintainer": "example@gmail.com",
+    "config": {
+        "steps": [{
+            "echo": "echo hello"
+        }]
+    }
+}
+```

package/plugins/pipelines/index.js

@@ -31,6 +31,8 @@ const deleteCache = require('./caches/delete');
 const openPrRoute = require('./openPr');
 const createTemplate = require('./templates/create');
 const validateTemplate = require('./templates/validate');
+const listTemplates = require('./templates/list');
+const listTemplateVersions = require('./templates/listVersions');
 
 /**
  * Pipeline API Plugin
@@ -199,7 +201,9 @@ const pipelinesPlugin = {
             deleteCache(),
             openPrRoute(),
             createTemplate(),
-            validateTemplate()
+            validateTemplate(),
+            listTemplates(),
+            listTemplateVersions()
         ]);
     }
 };

package/plugins/pipelines/templates/list.js

@@ -0,0 +1,55 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const schema = require('screwdriver-data-schema');
+const joi = require('joi');
+const listSchema = joi.array().items(schema.models.templateMeta.get).label('List of pipeline templates');
+const listCountSchema = joi
+    .object()
+    .keys({
+        count: joi.number(),
+        rows: listSchema
+    })
+    .label('Pipeline Template Count and List of templates');
+
+module.exports = () => ({
+    method: 'GET',
+    path: '/pipeline/templates',
+    options: {
+        description: 'List all the pipeline templates',
+        notes: 'Returns an array template meta for all the pipeline templates',
+        tags: ['api', 'pipeline', 'template'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', 'build']
+        },
+        handler: async (request, h) => {
+            const { pipelineTemplateFactory } = request.server.app;
+
+            const { page, sort, sortBy, count } = request.query;
+            const config = { sort };
+
+            if (sortBy) {
+                config.sortBy = sortBy;
+            }
+
+            if (page || count) {
+                config.paginate = { page, count };
+            }
+
+            const pipelineTemplates = await pipelineTemplateFactory.list(config);
+
+            if (!pipelineTemplates || pipelineTemplates.length === 0) {
+                throw boom.notFound('Pipeline templates do not exist');
+            }
+
+            return h.response(pipelineTemplates).code(200);
+        },
+        response: {
+            schema: joi.alternatives().try(listSchema, listCountSchema)
+        },
+        validate: {
+            query: schema.api.pagination
+        }
+    }
+});

package/plugins/pipelines/templates/listVersions.js

@@ -0,0 +1,61 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const listSchema = joi
+    .array()
+    .items(schema.models.pipelineTemplateVersions.get)
+    .label('List of versions of a template');
+const nameSchema = schema.models.templateMeta.base.extract('name');
+const namespaceSchema = schema.models.templateMeta.base.extract('namespace');
+
+module.exports = () => ({
+    method: 'GET',
+    path: '/pipeline/templates/{namespace}/{name}/versions',
+    options: {
+        description: 'Get all template versions for a given template name with pagination',
+        notes: 'Returns all template records for a given template name',
+        tags: ['api', 'templates', 'versions'],
+        auth: {
+            strategies: ['token'],
+            scope: ['user', 'build']
+        },
+        handler: async (request, h) => {
+            const { pipelineTemplateVersionFactory } = request.server.app;
+            const config = {
+                params: request.params,
+                sort: request.query.sort
+            };
+
+            if (request.query.page || request.query.count) {
+                config.paginate = {
+                    page: request.query.page,
+                    count: request.query.count
+                };
+            }
+
+            const templates = await pipelineTemplateVersionFactory.list(config);
+
+            if (!templates || templates.length === 0) {
+                throw boom.notFound('Template does not exist');
+            }
+
+            return h.response(templates).code(200);
+        },
+        response: {
+            schema: listSchema
+        },
+        validate: {
+            params: joi.object({
+                namespace: namespaceSchema,
+                name: nameSchema
+            }),
+            query: schema.api.pagination.concat(
+                joi.object({
+                    search: joi.forbidden()
+                })
+            )
+        }
+    }
+});