@quadnix/octo 0.0.2 → 0.0.3

package/test/models/model.e2e-spec.ts

@@ -1,366 +0,0 @@
-import {
-  App,
-  Deployment,
-  Environment,
-  Execution,
-  Image,
-  Pipeline,
-  Region,
-  Server,
-  Service,
-  Support,
-  UnknownModel,
-} from '../../src/index.js';
-import { TestAnchor, TestOverlay } from '../helpers/test-classes.js';
-
-describe('Model E2E Test', () => {
-  describe('common functions', () => {
-    const app = new App('test');
-    const image = new Image('image', '0.0.1', {
-      dockerfilePath: '/Dockerfile',
-    });
-    const pipeline = new Pipeline('testPipeline');
-    const region = new Region('region-1');
-    const server = new Server('backend', image);
-    const service = new Service('testService');
-    const support = new Support('nginx', 'nginx');
-    const deployment = new Deployment('nginx@v1');
-    const environment = new Environment('qa');
-    const execution = new Execution(deployment, environment, image);
-
-    app.addImage(image);
-    app.addPipeline(pipeline);
-    app.addRegion(region);
-    app.addServer(server);
-    app.addService(service);
-    app.addSupport(support);
-    support.addDeployment(deployment);
-    region.addEnvironment(environment);
-
-    const testCases: {
-      model: UnknownModel;
-      synth?: any;
-    }[] = [
-      {
-        model: app,
-      },
-      {
-        model: deployment,
-      },
-      {
-        model: environment,
-      },
-      {
-        model: execution,
-      },
-      {
-        model: image,
-      },
-      {
-        model: pipeline,
-      },
-      {
-        model: region,
-      },
-      {
-        model: server,
-      },
-      {
-        model: service,
-      },
-      {
-        model: support,
-      },
-    ];
-
-    describe.each(testCases)('Test $model.MODEL_NAME', (data) => {
-      it('getAncestors()', () => {
-        expect(data.model.getAncestors().map((m) => m.getContext())).toMatchSnapshot();
-      });
-
-      it('getBoundaryMembers()', () => {
-        expect(data.model.getBoundaryMembers().map((m) => m.getContext())).toMatchSnapshot();
-      });
-
-      it('getChildren()', () => {
-        expect(Object.keys(data.model.getChildren())).toMatchSnapshot();
-      });
-
-      it('getContext()', () => {
-        expect(data.model.getContext()).toMatchSnapshot();
-      });
-
-      it('getParents()', () => {
-        expect(Object.keys(data.model.getParents())).toMatchSnapshot();
-      });
-
-      it('synth()', () => {
-        if (data.model.MODEL_NAME === 'service') {
-          expect(() => {
-            data.model.synth();
-          }).toThrowErrorMatchingSnapshot();
-        } else {
-          expect(data.model.synth()).toMatchSnapshot();
-        }
-      });
-    });
-  });
-
-  describe('getAncestors()', () => {
-    it('should include region as ancestor of service when a dependency exists between them', () => {
-      const app = new App('app');
-      const region = new Region('region');
-      app.addRegion(region);
-      const service = new Service('service');
-      app.addService(service);
-
-      service.addRelationship('serviceId', region, 'regionId');
-
-      expect(service.getAncestors().map((m) => m.getContext())).toMatchSnapshot();
-    });
-
-    it('should not include service as ancestor of region when a dependency exists between them', () => {
-      const app = new App('app');
-      const region = new Region('region');
-      app.addRegion(region);
-      const service = new Service('service');
-      app.addService(service);
-
-      service.addRelationship('serviceId', region, 'regionId');
-
-      expect(region.getAncestors().map((m) => m.getContext())).toMatchSnapshot();
-    });
-
-    it('should include parent of parent as ancestors', () => {
-      const app = new App('app');
-      const region = new Region('region-0');
-      app.addRegion(region);
-      const environment = new Environment('env-0');
-      region.addEnvironment(environment);
-
-      expect(environment.getAncestors().map((m) => m.getContext())).toMatchSnapshot();
-    });
-  });
-
-  describe('getBoundaryMembers()', () => {
-    it('should include the common model to the boundary in literal sense', () => {
-      const app0 = new App('test-app');
-      const region0 = new Region('region-0');
-      const region1 = new Region('region-1');
-      const environment0 = new Environment('qa');
-
-      app0.addRegion(region0);
-      app0.addRegion(region1);
-      region0.addEnvironment(environment0);
-      region1.addEnvironment(environment0);
-
-      expect(region0.getBoundaryMembers().map((m) => m.getContext())).toMatchSnapshot();
-    });
-
-    it('should not include server in region boundary', () => {
-      const app0 = new App('test-app');
-      const image0 = new Image('image', '0.0.1', {
-        dockerfilePath: '/Dockerfile',
-      });
-      const region0 = new Region('region-0');
-      app0.addImage(image0);
-      app0.addRegion(region0);
-
-      // Just adding a server won't correlate to region. Create an execution in order to correlate.
-      const server0 = new Server('server-0', image0);
-      app0.addServer(server0);
-
-      expect(region0.getBoundaryMembers().map((m) => m.getContext())).toMatchSnapshot();
-    });
-
-    it('should include server in region boundary after an execution is added', () => {
-      const app0 = new App('test-app');
-      const image0 = new Image('test', 'test', { dockerfilePath: 'Dockerfile' });
-      app0.addImage(image0);
-      const region0 = new Region('region-0');
-      app0.addRegion(region0);
-      const environment0 = new Environment('env-0');
-      region0.addEnvironment(environment0);
-      const server0 = new Server('server-0', image0);
-      app0.addServer(server0);
-      const deployment0 = new Deployment('deployment-0');
-      server0.addDeployment(deployment0);
-      new Execution(deployment0, environment0, image0);
-
-      expect(region0.getBoundaryMembers().map((m) => m.getContext())).toMatchSnapshot();
-    });
-
-    it('should include region in server boundary after an execution is added', () => {
-      const app0 = new App('test-app');
-      const image0 = new Image('test', 'test', { dockerfilePath: 'Dockerfile' });
-      app0.addImage(image0);
-      const region0 = new Region('region-0');
-      app0.addRegion(region0);
-      const environment0 = new Environment('env-0');
-      region0.addEnvironment(environment0);
-      const server0 = new Server('server-0', image0);
-      app0.addServer(server0);
-      const deployment0 = new Deployment('deployment-0');
-      server0.addDeployment(deployment0);
-      new Execution(deployment0, environment0, image0);
-
-      expect(server0.getBoundaryMembers().map((m) => m.getContext())).toMatchSnapshot();
-    });
-
-    it('should include service in region boundary when a dependency exists between them', () => {
-      const app = new App('app');
-      const region = new Region('region');
-      app.addRegion(region);
-      const service = new Service('service');
-      app.addService(service);
-
-      service.addRelationship('serviceId', region, 'regionId');
-
-      expect(region.getBoundaryMembers().map((m) => m.getContext())).toMatchInlineSnapshot(`
-        [
-          "region=region,app=app",
-          "app=app",
-          "service=service,app=app",
-        ]
-      `);
-    });
-
-    it('should not include shared image with multiple boundaries', () => {
-      const app = new App('app');
-      const image = new Image('imageName', 'imageTag', {
-        dockerfilePath: 'path/to/Dockerfile',
-      });
-      app.addImage(image);
-      const region1 = new Region('region-1');
-      app.addRegion(region1);
-      const region2 = new Region('region-2');
-      app.addRegion(region2);
-
-      region1.addRelationship('regionId', image, 'imageId');
-      region2.addRelationship('regionId', image, 'imageId');
-
-      expect(region1.getBoundaryMembers().map((m) => m.getContext())).toMatchInlineSnapshot(`
-        [
-          "region=region-1,app=app",
-          "image=imageName:imageTag,app=app",
-          "app=app",
-        ]
-      `);
-    });
-
-    it('should not include overlays in boundary', () => {
-      const app = new App('app');
-      const anchor = new TestAnchor('test-anchor', app);
-      const overlay = new TestOverlay('test-overlay', {}, [anchor]);
-
-      expect(overlay.getBoundaryMembers().map((m) => m.getContext())).toMatchInlineSnapshot(`[]`);
-      expect(app.getBoundaryMembers().map((m) => m.getContext())).toMatchInlineSnapshot(`
-        [
-          "app=app",
-        ]
-      `);
-    });
-
-    describe('Circular Dependencies', () => {
-      it('should throw error on one level of circular dependency', () => {
-        const app0 = new App('test-app');
-        const region0 = new Region('region-0');
-
-        expect(() => {
-          app0.addRegion(region0);
-          region0.addChild('regionId', app0, 'name');
-          app0.getBoundaryMembers();
-        }).toThrowErrorMatchingInlineSnapshot(`"Found circular dependencies!"`);
-      });
-
-      it('should throw error on two levels of circular dependency', () => {
-        const app0 = new App('test-app');
-        const region0 = new Region('region-0');
-        const environment0 = new Environment('qa');
-
-        expect(() => {
-          app0.addRegion(region0);
-          region0.addEnvironment(environment0);
-          environment0.addChild('environmentName', app0, 'name');
-          app0.getBoundaryMembers();
-        }).toThrowErrorMatchingInlineSnapshot(`"Found circular dependencies!"`);
-      });
-    });
-  });
-
-  describe('remove()', () => {
-    it('should throw error when model being a parent cannot be removed', () => {
-      const app = new App('app');
-      const region = new Region('region');
-      app.addRegion(region);
-
-      expect(() => {
-        app.remove(true);
-      }).toThrowErrorMatchingInlineSnapshot(`"Cannot remove model until dependent models exist!"`);
-    });
-
-    it('should throw error when model having a direct relationship cannot be removed', () => {
-      const app = new App('app');
-      const image = new Image('image', 'tag', { dockerfilePath: '/Dockerfile' });
-      app.addImage(image);
-      const server = new Server('server', image);
-      app.addServer(server);
-
-      expect(() => {
-        server.remove();
-      }).toThrowErrorMatchingInlineSnapshot(`"Cannot remove model until dependent models exist!"`);
-    });
-
-    it('should be able to remove leaf model', () => {
-      const app = new App('app');
-      const region = new Region('region');
-      app.addRegion(region);
-
-      expect(app.getChild('region', [{ key: 'regionId', value: 'region' }])).not.toBe(undefined);
-      region.remove();
-      expect(app.getChild('region', [{ key: 'regionId', value: 'region' }])).toBe(undefined);
-    });
-
-    it('should be able to remove leaf model with a direct relationship', () => {
-      const app = new App('app');
-      const image = new Image('image', 'tag', { dockerfilePath: '/Dockerfile' });
-      app.addImage(image);
-      const server = new Server('server', image);
-      app.addServer(server);
-
-      // Image cannot be removed until server is removed.
-      expect(() => {
-        image.remove();
-      }).toThrowErrorMatchingInlineSnapshot(`"Cannot remove model until dependent models exist!"`);
-
-      // Remove server.
-      server.remove(true);
-
-      // Remove image.
-      image.remove();
-      expect(app.getChild('image', [{ key: 'imageTag', value: 'tag' }])).toBe(undefined);
-    });
-  });
-
-  describe('removeRelationship()', () => {
-    it('should be able to remove relationship', () => {
-      const app = new App('app');
-      const region = new Region('region');
-      app.addRegion(region);
-      const image = new Image('image', 'tag', { dockerfilePath: '/Dockerfile' });
-      app.addImage(image);
-      image.addRelationship('imageId', region, 'regionId');
-
-      // Image cannot be removed since it has a relationship with region.
-      expect(() => {
-        image.remove();
-      }).toThrowErrorMatchingInlineSnapshot(`"Cannot remove model until dependent models exist!"`);
-
-      image.removeRelationship(region);
-
-      // Remove image.
-      image.remove();
-      expect(app.getChild('image', [{ key: 'imageTag', value: 'tag' }])).toBe(undefined);
-    });
-  });
-});

package/tsconfig.build.json

@@ -1,4 +0,0 @@
-{
-  "exclude": ["**/*spec.ts", ".eslintrc.cjs", "coverage", "dist", "node_modules", "test"],
-  "extends": "./tsconfig.json"
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": "./",
-    "outDir": "./dist"
-  },
-  "exclude": ["coverage", "dist", "node_modules"],
-  "extends": "../../tsconfig.json",
-  "include": [".eslintrc.cjs", "**/*.json", "**/*.ts"]
-}