Merge pull request #4033 from SDA-SE/feat/make-system-and-domains-real

Implement systems, domains and resources

packages/catalog-model/examples/all-domains.yaml

@@ -0,0 +1,9 @@
+apiVersion: backstage.io/v1alpha1
+kind: Location
+metadata:
+  name: example-domains
+  description: A collection of all Backstage example domains
+spec:
+  targets:
+    - ./domains/artists-domain.yaml
+    - ./domains/playback-domain.yaml

packages/catalog-model/examples/all-resources.yaml

@@ -0,0 +1,8 @@
+apiVersion: backstage.io/v1alpha1
+kind: Location
+metadata:
+  name: example-resources
+  description: A collection of all Backstage example resources
+spec:
+  targets:
+    - ./resources/artists-db-resource.yaml

packages/catalog-model/examples/all-systems.yaml

@@ -0,0 +1,10 @@
+apiVersion: backstage.io/v1alpha1
+kind: Location
+metadata:
+  name: example-systems
+  description: A collection of all Backstage example systems
+spec:
+  targets:
+    - ./systems/artist-engagement-portal-system.yaml
+    - ./systems/audio-playback-system.yaml
+    - ./systems/podcast-system.yaml

packages/catalog-model/examples/components/artist-lookup-component.yaml

@@ -10,3 +10,4 @@ spec:
   type: service
   lifecycle: experimental
   owner: team-a
+  system: artist-engagement-portal

packages/catalog-model/examples/components/playback-lib-component.yaml

@@ -7,3 +7,4 @@ spec:
   type: library
   lifecycle: experimental
   owner: team-c
+  system: audio-playback

packages/catalog-model/examples/components/playback-order-component.yaml

@@ -10,3 +10,4 @@ spec:
   type: service
   lifecycle: production
   owner: user:guest
+  system: audio-playback

packages/catalog-model/examples/components/podcast-api-component.yaml

@@ -9,3 +9,4 @@ spec:
   type: service
   lifecycle: experimental
   owner: team-b
+  system: podcast

packages/catalog-model/examples/components/queue-proxy-component.yaml

@@ -10,3 +10,4 @@ spec:
   type: website
   lifecycle: production
   owner: team-b
+  system: podcast

packages/catalog-model/examples/components/shuffle-api-component.yaml

@@ -9,3 +9,4 @@ spec:
   type: service
   lifecycle: production
   owner: user:guest
+  system: audio-playback

packages/catalog-model/examples/components/www-artist-component.yaml

@@ -7,3 +7,4 @@ spec:
   type: website
   lifecycle: production
   owner: team-a
+  system: artist-engagement-portal

packages/catalog-model/examples/domains/artists-domain.yaml

@@ -0,0 +1,7 @@
+apiVersion: backstage.io/v1alpha1
+kind: Domain
+metadata:
+  name: artists
+  description: Everything related to artists
+spec:
+  owner: team-a

packages/catalog-model/examples/domains/playback-domain.yaml

@@ -0,0 +1,7 @@
+apiVersion: backstage.io/v1alpha1
+kind: Domain
+metadata:
+  name: playback
+  description: Everything related to audio playback
+spec:
+  owner: user:frank.tiernan

packages/catalog-model/examples/resources/artists-db-resource.yaml

@@ -0,0 +1,9 @@
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: artists-db
+  description: Stores artist details
+spec:
+  type: database
+  owner: team-a
+  system: artist-engagement-portal

packages/catalog-model/examples/systems/artist-engagement-portal-system.yaml

@@ -0,0 +1,10 @@
+apiVersion: backstage.io/v1alpha1
+kind: System
+metadata:
+  name: artist-engagement-portal
+  description: Everything related to artists
+  tags:
+    - portal
+spec:
+  owner: team-a
+  domain: artists

packages/catalog-model/examples/systems/audio-playback-system.yaml

@@ -0,0 +1,8 @@
+apiVersion: backstage.io/v1alpha1
+kind: System
+metadata:
+  name: audio-playback
+  description: Audio playback system
+spec:
+  owner: team-c
+  domain: playback

packages/catalog-model/examples/systems/podcast-system.yaml

@@ -0,0 +1,8 @@
+apiVersion: backstage.io/v1alpha1
+kind: System
+metadata:
+  name: podcast
+  description: Podcast playback
+spec:
+  owner: team-b
+  domain: playback

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

@@ -70,6 +70,7 @@ components:
       items:
         $ref: "#/components/schemas/Pet"
 `,
+        system: 'system',
       },
     };
   });
@@ -152,4 +153,19 @@ components:
     (entity as any).spec.definition = '';
     await expect(validator.check(entity)).rejects.toThrow(/definition/);
   });
+
+  it('accepts missing system', async () => {
+    delete (entity as any).spec.system;
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('rejects wrong system', async () => {
+    (entity as any).spec.system = 7;
+    await expect(validator.check(entity)).rejects.toThrow(/system/);
+  });
+
+  it('rejects empty system', async () => {
+    (entity as any).spec.system = '';
+    await expect(validator.check(entity)).rejects.toThrow(/system/);
+  });
 });

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

@@ -30,6 +30,7 @@ const schema = yup.object<Partial<ApiEntityV1alpha1>>({
       lifecycle: yup.string().required().min(1),
       owner: yup.string().required().min(1),
       definition: yup.string().required().min(1),
+      system: yup.string().notRequired().min(1),
     })
     .required(),
 });
@@ -42,6 +43,7 @@ export interface ApiEntityV1alpha1 extends Entity {
     lifecycle: string;
     owner: string;
     definition: string;
+    system?: string;
   };
 }
 

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

@@ -36,6 +36,7 @@ describe('ComponentV1alpha1Validator', () => {
         subcomponentOf: 'monolith',
         providesApis: ['api-0'],
         consumesApis: ['api-0'],
+        system: 'system',
       },
     };
   });
@@ -158,4 +159,19 @@ describe('ComponentV1alpha1Validator', () => {
     (entity as any).spec.consumesApis = [];
     await expect(validator.check(entity)).resolves.toBe(true);
   });
+
+  it('accepts missing system', async () => {
+    delete (entity as any).spec.system;
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('rejects wrong system', async () => {
+    (entity as any).spec.system = 7;
+    await expect(validator.check(entity)).rejects.toThrow(/system/);
+  });
+
+  it('rejects empty system', async () => {
+    (entity as any).spec.system = '';
+    await expect(validator.check(entity)).rejects.toThrow(/system/);
+  });
 });

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

@@ -32,6 +32,7 @@ const schema = yup.object<Partial<ComponentEntityV1alpha1>>({
       subcomponentOf: yup.string().notRequired().min(1),
       providesApis: yup.array(yup.string().required()).notRequired(),
       consumesApis: yup.array(yup.string().required()).notRequired(),
+      system: yup.string().notRequired().min(1),
     })
     .required(),
 });
@@ -46,6 +47,7 @@ export interface ComponentEntityV1alpha1 extends Entity {
     subcomponentOf?: string;
     providesApis?: string[];
     consumesApis?: string[];
+    system?: string;
   };
 }
 

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

@@ -0,0 +1,71 @@
+/*
+ * 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 {
+  DomainEntityV1alpha1,
+  domainEntityV1alpha1Validator as validator,
+} from './DomainEntityV1alpha1';
+
+describe('DomainV1alpha1Validator', () => {
+  let entity: DomainEntityV1alpha1;
+
+  beforeEach(() => {
+    entity = {
+      apiVersion: 'backstage.io/v1alpha1',
+      kind: 'Domain',
+      metadata: {
+        name: 'test',
+      },
+      spec: {
+        owner: 'me',
+      },
+    };
+  });
+
+  it('happy path: accepts valid data', async () => {
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('silently accepts v1beta1 as well', async () => {
+    (entity as any).apiVersion = 'backstage.io/v1beta1';
+    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 owner', async () => {
+    delete (entity as any).spec.owner;
+    await expect(validator.check(entity)).rejects.toThrow(/owner/);
+  });
+
+  it('rejects wrong owner', async () => {
+    (entity as any).spec.owner = 7;
+    await expect(validator.check(entity)).rejects.toThrow(/owner/);
+  });
+
+  it('rejects empty owner', async () => {
+    (entity as any).spec.owner = '';
+    await expect(validator.check(entity)).rejects.toThrow(/owner/);
+  });
+});

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

@@ -0,0 +1,46 @@
+/*
+ * 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 * as yup from 'yup';
+import type { Entity } from '../entity/Entity';
+import { schemaValidator } from './util';
+
+const API_VERSION = ['backstage.io/v1alpha1', 'backstage.io/v1beta1'] as const;
+const KIND = 'Domain' as const;
+
+const schema = yup.object<Partial<DomainEntityV1alpha1>>({
+  apiVersion: yup.string().required().oneOf(API_VERSION),
+  kind: yup.string().required().equals([KIND]),
+  spec: yup
+    .object({
+      owner: yup.string().required().min(1),
+    })
+    .required(),
+});
+
+export interface DomainEntityV1alpha1 extends Entity {
+  apiVersion: typeof API_VERSION[number];
+  kind: typeof KIND;
+  spec: {
+    owner: string;
+  };
+}
+
+export const domainEntityV1alpha1Validator = schemaValidator(
+  KIND,
+  API_VERSION,
+  schema,
+);

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

@@ -0,0 +1,103 @@
+/*
+ * 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 {
+  ResourceEntityV1alpha1,
+  resourceEntityV1alpha1Validator as validator,
+} from './ResourceEntityV1alpha1';
+
+describe('ResourceV1alpha1Validator', () => {
+  let entity: ResourceEntityV1alpha1;
+
+  beforeEach(() => {
+    entity = {
+      apiVersion: 'backstage.io/v1alpha1',
+      kind: 'Resource',
+      metadata: {
+        name: 'test',
+      },
+      spec: {
+        type: 'database',
+        owner: 'me',
+        system: 'system',
+      },
+    };
+  });
+
+  it('happy path: accepts valid data', async () => {
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('silently accepts v1beta1 as well', async () => {
+    (entity as any).apiVersion = 'backstage.io/v1beta1';
+    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('rejects wrong type', async () => {
+    (entity as any).spec.type = 7;
+    await expect(validator.check(entity)).rejects.toThrow(/type/);
+  });
+
+  it('rejects empty type', async () => {
+    (entity as any).spec.type = '';
+    await expect(validator.check(entity)).rejects.toThrow(/type/);
+  });
+
+  it('rejects missing owner', async () => {
+    delete (entity as any).spec.owner;
+    await expect(validator.check(entity)).rejects.toThrow(/owner/);
+  });
+
+  it('rejects wrong owner', async () => {
+    (entity as any).spec.owner = 7;
+    await expect(validator.check(entity)).rejects.toThrow(/owner/);
+  });
+
+  it('rejects empty owner', async () => {
+    (entity as any).spec.owner = '';
+    await expect(validator.check(entity)).rejects.toThrow(/owner/);
+  });
+
+  it('accepts missing system', async () => {
+    delete (entity as any).spec.system;
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('rejects wrong system', async () => {
+    (entity as any).spec.system = 7;
+    await expect(validator.check(entity)).rejects.toThrow(/system/);
+  });
+
+  it('rejects empty system', async () => {
+    (entity as any).spec.system = '';
+    await expect(validator.check(entity)).rejects.toThrow(/system/);
+  });
+});

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

@@ -0,0 +1,50 @@
+/*
+ * 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 * as yup from 'yup';
+import type { Entity } from '../entity/Entity';
+import { schemaValidator } from './util';
+
+const API_VERSION = ['backstage.io/v1alpha1', 'backstage.io/v1beta1'] as const;
+const KIND = 'Resource' as const;
+
+const schema = yup.object<Partial<ResourceEntityV1alpha1>>({
+  apiVersion: yup.string().required().oneOf(API_VERSION),
+  kind: yup.string().required().equals([KIND]),
+  spec: yup
+    .object({
+      type: yup.string().required().min(1),
+      owner: yup.string().required().min(1),
+      system: yup.string().notRequired().min(1),
+    })
+    .required(),
+});
+
+export interface ResourceEntityV1alpha1 extends Entity {
+  apiVersion: typeof API_VERSION[number];
+  kind: typeof KIND;
+  spec: {
+    type: string;
+    owner: string;
+    system?: string;
+  };
+}
+
+export const resourceEntityV1alpha1Validator = schemaValidator(
+  KIND,
+  API_VERSION,
+  schema,
+);

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

@@ -0,0 +1,87 @@
+/*
+ * 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 {
+  SystemEntityV1alpha1,
+  systemEntityV1alpha1Validator as validator,
+} from './SystemEntityV1alpha1';
+
+describe('SystemV1alpha1Validator', () => {
+  let entity: SystemEntityV1alpha1;
+
+  beforeEach(() => {
+    entity = {
+      apiVersion: 'backstage.io/v1alpha1',
+      kind: 'System',
+      metadata: {
+        name: 'test',
+      },
+      spec: {
+        owner: 'me',
+        domain: 'domain',
+      },
+    };
+  });
+
+  it('happy path: accepts valid data', async () => {
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('silently accepts v1beta1 as well', async () => {
+    (entity as any).apiVersion = 'backstage.io/v1beta1';
+    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 owner', async () => {
+    delete (entity as any).spec.owner;
+    await expect(validator.check(entity)).rejects.toThrow(/owner/);
+  });
+
+  it('rejects wrong owner', async () => {
+    (entity as any).spec.owner = 7;
+    await expect(validator.check(entity)).rejects.toThrow(/owner/);
+  });
+
+  it('rejects empty owner', async () => {
+    (entity as any).spec.owner = '';
+    await expect(validator.check(entity)).rejects.toThrow(/owner/);
+  });
+
+  it('accepts missing domain', async () => {
+    delete (entity as any).spec.domain;
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('rejects wrong domain', async () => {
+    (entity as any).spec.domain = 7;
+    await expect(validator.check(entity)).rejects.toThrow(/domain/);
+  });
+
+  it('rejects empty domain', async () => {
+    (entity as any).spec.domain = '';
+    await expect(validator.check(entity)).rejects.toThrow(/domain/);
+  });
+});

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

@@ -0,0 +1,48 @@
+/*
+ * 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 * as yup from 'yup';
+import type { Entity } from '../entity/Entity';
+import { schemaValidator } from './util';
+
+const API_VERSION = ['backstage.io/v1alpha1', 'backstage.io/v1beta1'] as const;
+const KIND = 'System' as const;
+
+const schema = yup.object<Partial<SystemEntityV1alpha1>>({
+  apiVersion: yup.string().required().oneOf(API_VERSION),
+  kind: yup.string().required().equals([KIND]),
+  spec: yup
+    .object({
+      owner: yup.string().required().min(1),
+      domain: yup.string().notRequired().min(1),
+    })
+    .required(),
+});
+
+export interface SystemEntityV1alpha1 extends Entity {
+  apiVersion: typeof API_VERSION[number];
+  kind: typeof KIND;
+  spec: {
+    owner: string;
+    domain?: string;
+  };
+}
+
+export const systemEntityV1alpha1Validator = schemaValidator(
+  KIND,
+  API_VERSION,
+  schema,
+);

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

@@ -26,6 +26,11 @@ export type {
   ComponentEntityV1alpha1 as ComponentEntity,
   ComponentEntityV1alpha1,
 } from './ComponentEntityV1alpha1';
+export { domainEntityV1alpha1Validator } from './DomainEntityV1alpha1';
+export type {
+  DomainEntityV1alpha1 as DomainEntity,
+  DomainEntityV1alpha1,
+} from './DomainEntityV1alpha1';
 export { groupEntityV1alpha1Validator } from './GroupEntityV1alpha1';
 export type {
   GroupEntityV1alpha1 as GroupEntity,
@@ -37,6 +42,16 @@ export type {
   LocationEntityV1alpha1,
 } from './LocationEntityV1alpha1';
 export * from './relations';
+export { resourceEntityV1alpha1Validator } from './ResourceEntityV1alpha1';
+export type {
+  ResourceEntityV1alpha1 as ResourceEntity,
+  ResourceEntityV1alpha1,
+} from './ResourceEntityV1alpha1';
+export { systemEntityV1alpha1Validator } from './SystemEntityV1alpha1';
+export type {
+  SystemEntityV1alpha1 as SystemEntity,
+  SystemEntityV1alpha1,
+} from './SystemEntityV1alpha1';
 export { templateEntityV1alpha1Validator } from './TemplateEntityV1alpha1';
 export type {
   TemplateEntityV1alpha1 as TemplateEntity,

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

@@ -30,7 +30,7 @@ export const RELATION_OWNED_BY = 'ownedBy';
 export const RELATION_OWNER_OF = 'ownerOf';
 
 /**
- * A relation with an API entity, typically from a component or system
+ * A relation with an API entity, typically from a component
  */
 export const RELATION_CONSUMES_API = 'consumesApi';
 export const RELATION_API_CONSUMED_BY = 'apiConsumedBy';