catalog-model: tweak Template beta2 schema + add tests

packages/catalog-model/src/kinds/TemplateEntityV1beta2.test.ts

@@ -0,0 +1,109 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  TemplateEntityV1beta2,
+  templateEntityV1beta2Validator as validator,
+} from './TemplateEntityV1beta2';
+
+describe('templateEntityV1beta2Validator', () => {
+  let entity: TemplateEntityV1beta2;
+
+  beforeEach(() => {
+    entity = {
+      apiVersion: 'backstage.io/v1beta2',
+      kind: 'Template',
+      metadata: {
+        name: 'test',
+      },
+      spec: {
+        type: 'website',
+        parameters: {
+          required: ['storePath', 'owner'],
+          properties: {
+            owner: {
+              type: 'string',
+              title: 'Owner',
+              description: 'Who is going to own this component',
+            },
+            storePath: {
+              type: 'string',
+              title: 'Store path',
+              description: 'GitHub store path in org/repo format',
+            },
+          },
+        },
+        steps: [
+          {
+            id: 'fetch',
+            name: 'Fetch',
+            action: 'fetch:plan',
+            parameters: {
+              url: './template',
+            },
+          },
+        ],
+        output: {
+          fetchUrl: '{{ steps.fetch.output.targetUrl }}',
+        },
+      },
+    };
+  });
+
+  it('happy path: accepts valid data', async () => {
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('ignores unknown apiVersion', async () => {
+    (entity as any).apiVersion = 'backstage.io/v1beta0';
+    await expect(validator.check(entity)).resolves.toBe(false);
+  });
+
+  it('ignores unknown kind', async () => {
+    (entity as any).kind = 'Wizard';
+    await expect(validator.check(entity)).resolves.toBe(false);
+  });
+
+  it('rejects missing type', async () => {
+    delete (entity as any).spec.type;
+    await expect(validator.check(entity)).rejects.toThrow(/type/);
+  });
+
+  it('accepts any other type', async () => {
+    (entity as any).spec.type = 'hallo';
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('accepts missing parameters', async () => {
+    delete (entity as any).spec.parameters;
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('accepts missing outputs', async () => {
+    delete (entity as any).spec.outputs;
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('rejects empty type', async () => {
+    (entity as any).spec.type = '';
+    await expect(validator.check(entity)).rejects.toThrow(/type/);
+  });
+
+  it('rejects missing steps', async () => {
+    delete (entity as any).spec.steps;
+    await expect(validator.check(entity)).rejects.toThrow(/steps/);
+  });
+});

packages/catalog-model/src/kinds/TemplateEntityV1beta2.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import type { Entity } from '../entity/Entity';
+import type { Entity, EntityMeta } from '../entity/Entity';
 import schema from '../schema/kinds/Template.v1beta2.schema.json';
 import entitySchema from '../schema/Entity.schema.json';
 import entityMetaSchema from '../schema/EntityMeta.schema.json';
@@ -28,6 +28,9 @@ const KIND = 'Template' as const;
 export interface TemplateEntityV1beta2 extends Entity {
   apiVersion: typeof API_VERSION[number];
   kind: typeof KIND;
+  metadata: EntityMeta & {
+    title?: string;
+  };
   spec: {
     type: string;
     parameters?: JsonObject | JsonObject[];

packages/catalog-model/src/schema/kinds/Template.v1beta2.schema.json

@@ -29,6 +29,27 @@
               "description": "Description of the component"
             }
           }
+        },
+        "steps": [
+          {
+            "id": "fetch",
+            "name": "Fetch",
+            "action": "fetch:plain",
+            "parameters": {
+              "url": "./template"
+            }
+          },
+          {
+            "id": "publish",
+            "name": "Publish to GitHub",
+            "action": "publish:github",
+            "parameters": {
+              "repoUrl": "{{ parameters.repoUrl }}"
+            }
+          }
+        ],
+        "output": {
+          "catalogInfoUrl": "{{ steps.publish.output.catalogInfoUrl }}"
         }
       }
     }
@@ -52,7 +73,7 @@
           "properties": {
             "title": {
               "type": "string",
-              "description": "The nice display name for the template. This field is required as is used to reference the template to the user instead of the metadata.name field.",
+              "description": "The nice display name for the template.",
               "examples": ["React SSR Template"],
               "minLength": 1
             }
@@ -89,7 +110,7 @@
               "description": "A list of steps to execute.",
               "items": {
                 "type": "object",
-                "description": "The JSONSchema describing a template The ID of the step, which can be used to refer to its outputs.",
+                "description": "A description of the step to execute.",
                 "required": ["id", "name", "action"],
                 "properties": {
                   "id": {