patch(feat): octo has a new model - Subnet.

Author: rash805115

packages/octo/src/index.ts

@@ -1,5 +1,5 @@
-export { Anchor } from './decorators/anchor.decorator.js';
 export { Action } from './decorators/action.decorator.js';
+export { Anchor } from './decorators/anchor.decorator.js';
 export { Container } from './decorators/container.js';
 export { EnableHook } from './decorators/enable-hook.decorator.js';
 export { Factory } from './decorators/factory.decorator.js';
@@ -13,26 +13,28 @@ export { Diff, DiffAction } from './functions/diff/diff.js';
 export { DiffUtility } from './functions/diff/diff.utility.js';
 export { DiffMetadata } from './functions/diff/diff-metadata.js';
 
-export { App } from './models/app/app.model.js';
 export { IApp } from './models/app/app.interface.js';
-export { Deployment } from './models/deployment/deployment.model.js';
+export { App } from './models/app/app.model.js';
 export { IDeployment } from './models/deployment/deployment.interface.js';
-export { Environment } from './models/environment/environment.model.js';
+export { Deployment } from './models/deployment/deployment.model.js';
 export { IEnvironment } from './models/environment/environment.interface.js';
-export { Execution } from './models/execution/execution.model.js';
+export { Environment } from './models/environment/environment.model.js';
 export { IExecution } from './models/execution/execution.interface.js';
-export { IImageDockerOptions, Image } from './models/image/image.model.js';
+export { Execution } from './models/execution/execution.model.js';
 export { IImage } from './models/image/image.interface.js';
-export { Pipeline } from './models/pipeline/pipeline.model.js';
+export { IImageDockerOptions, Image } from './models/image/image.model.js';
 export { IPipeline } from './models/pipeline/pipeline.interface.js';
-export { Region } from './models/region/region.model.js';
+export { Pipeline } from './models/pipeline/pipeline.model.js';
 export { IRegion } from './models/region/region.interface.js';
-export { Server } from './models/server/server.model.js';
+export { Region } from './models/region/region.model.js';
 export { IServer } from './models/server/server.interface.js';
-export { Service } from './models/service/service.model.js';
+export { Server } from './models/server/server.model.js';
 export { IService } from './models/service/service.interface.js';
-export { Support } from './models/support/support.model.js';
+export { Service } from './models/service/service.model.js';
+export { ISubnet } from './models/subnet/subnet.interface.js';
+export { Subnet } from './models/subnet/subnet.model.js';
 export { ISupport } from './models/support/support.interface.js';
+export { Support } from './models/support/support.model.js';
 
 export { AModel } from './models/model.abstract.js';
 export { IModel, IModelReference } from './models/model.interface.js';

packages/octo/src/models/region/region.model.ts

@@ -4,6 +4,7 @@ import { UnknownModel } from '../../app.type.js';
 import { Model } from '../../decorators/model.decorator.js';
 import { Environment } from '../environment/environment.model.js';
 import { AModel } from '../model.abstract.js';
+import { Subnet } from '../subnet/subnet.model.js';
 import { IRegion } from './region.interface.js';
 
 @Model()
@@ -14,6 +15,7 @@ export class Region extends AModel<IRegion, Region> {
 
   constructor(regionId: string) {
     super();
+
     this.regionId = regionId;
   }
 
@@ -29,6 +31,18 @@ export class Region extends AModel<IRegion, Region> {
     this.addChild('regionId', environment, 'environmentName');
   }
 
+  addSubnet(subnet: Subnet): void {
+    const childrenDependencies = this.getChildren('subnet');
+    if (!childrenDependencies['subnet']) childrenDependencies['subnet'] = [];
+
+    // Check for duplicates.
+    const subnets = childrenDependencies['subnet'].map((d) => d.to);
+    if (subnets.find((z: Subnet) => z.subnetId === subnet.subnetId)) {
+      throw new Error('Subnet already exists!');
+    }
+    this.addChild('regionId', subnet, 'subnetId');
+  }
+
   getContext(): string {
     const parents = this.getParents();
     const app = parents['app'][0].to;

packages/octo/src/models/subnet/subnet.interface.ts

@@ -0,0 +1,7 @@
+import { IModelReference } from '../model.interface.js';
+import { Subnet } from './subnet.model.js';
+
+export interface ISubnet {
+  region: IModelReference;
+  subnetId: Subnet['subnetId'];
+}

packages/octo/src/models/subnet/subnet.model.ts

@@ -0,0 +1,42 @@
+import { UnknownModel } from '../../app.type.js';
+import { Model } from '../../decorators/model.decorator.js';
+import { AModel } from '../model.abstract.js';
+import { Region } from '../region/region.model.js';
+import { ISubnet } from './subnet.interface.js';
+
+@Model()
+export class Subnet extends AModel<ISubnet, Subnet> {
+  readonly MODEL_NAME: string = 'subnet';
+
+  readonly subnetId: string;
+
+  constructor(region: Region, name: string) {
+    super();
+
+    this.subnetId = region.regionId + '-' + name;
+  }
+
+  getContext(): string {
+    const parents = this.getParents();
+    const region = parents['region'][0].to;
+    return [`${this.MODEL_NAME}=${this.subnetId}`, region.getContext()].join(',');
+  }
+
+  synth(): ISubnet {
+    const parents = this.getParents();
+    const region = parents['region'][0].to as Region;
+
+    return {
+      region: { context: region.getContext() },
+      subnetId: this.subnetId,
+    };
+  }
+
+  static override async unSynth(
+    subnet: ISubnet,
+    deReferenceContext: (context: string) => Promise<UnknownModel>,
+  ): Promise<Subnet> {
+    const region = (await deReferenceContext(subnet.region.context)) as Region;
+    return new Subnet(region, subnet.subnetId);
+  }
+}

packages/octo/test/app.e2e-spec.ts

@@ -7,6 +7,7 @@ import {
   ModelSerializationService,
   Region,
   Server,
+  Subnet,
   Support,
 } from '../src/index.js';
 
@@ -34,6 +35,9 @@ describe('App E2E Test', () => {
     const qaEnvironment1 = region1.getChild('environment', [{ key: 'environmentName', value: 'qa' }]) as Environment;
     // Add a deployment to backend server.
     backendServer1.addDeployment(new Deployment('backend@v0.0.1'));
+    // Add a new subnet.
+    const publicSubnet1 = new Subnet(region1, 'public');
+    region1.addSubnet(publicSubnet1);
     // Add a new staging environment.
     const stagingEnvironment1 = new Environment('staging');
     stagingEnvironment1.environmentVariables.set('env', 'staging');
@@ -73,6 +77,11 @@ describe('App E2E Test', () => {
             "value": "staging",
           },
         },
+        {
+          "action": "add",
+          "field": "subnetId",
+          "value": "region-1-public",
+        },
         {
           "action": "add",
           "field": "deploymentTag",

packages/octo/test/models/__snapshots__/model.e2e-spec.ts.snap

@@ -17,6 +17,7 @@ exports[`Model E2E Test common functions Test app getBoundaryMembers() 1`] = `
   "region=region-1,app=test",
   "service=testService,app=test",
   "server=backend,app=test",
+  "subnet=region-1-public,region=region-1,app=test",
   "pipeline=testPipeline,app=test",
 ]
 `;
@@ -258,6 +259,7 @@ exports[`Model E2E Test common functions Test region getBoundaryMembers() 1`] =
 [
   "region=region-1,app=test",
   "app=test",
+  "subnet=region-1-public,region=region-1,app=test",
   "environment=qa,region=region-1,app=test",
   "execution=nginx@v1_qa,deployment=nginx@v1,support=nginx,app=test,environment=qa,region=region-1,app=test",
   "image=image:0.0.1,app=test",
@@ -269,6 +271,7 @@ exports[`Model E2E Test common functions Test region getBoundaryMembers() 1`] =
 exports[`Model E2E Test common functions Test region getChildren() 1`] = `
 [
   "environment",
+  "subnet",
 ]
 `;
 
@@ -347,6 +350,41 @@ exports[`Model E2E Test common functions Test service getParents() 1`] = `
 
 exports[`Model E2E Test common functions Test service synth() 1`] = `"Method not implemented! Use subclass"`;
 
+exports[`Model E2E Test common functions Test subnet getAncestors() 1`] = `
+[
+  "subnet=region-1-public,region=region-1,app=test",
+  "region=region-1,app=test",
+  "app=test",
+]
+`;
+
+exports[`Model E2E Test common functions Test subnet getBoundaryMembers() 1`] = `
+[
+  "subnet=region-1-public,region=region-1,app=test",
+  "region=region-1,app=test",
+  "app=test",
+]
+`;
+
+exports[`Model E2E Test common functions Test subnet getChildren() 1`] = `[]`;
+
+exports[`Model E2E Test common functions Test subnet getContext() 1`] = `"subnet=region-1-public,region=region-1,app=test"`;
+
+exports[`Model E2E Test common functions Test subnet getParents() 1`] = `
+[
+  "region",
+]
+`;
+
+exports[`Model E2E Test common functions Test subnet synth() 1`] = `
+{
+  "region": {
+    "context": "region=region-1,app=test",
+  },
+  "subnetId": "region-1-public",
+}
+`;
+
 exports[`Model E2E Test common functions Test support getAncestors() 1`] = `
 [
   "support=nginx,app=test",

packages/octo/test/models/model.e2e-spec.ts

@@ -8,6 +8,7 @@ import {
   Region,
   Server,
   Service,
+  Subnet,
   Support,
   UnknownModel,
 } from '../../src/index.js';
@@ -23,6 +24,7 @@ describe('Model E2E Test', () => {
     const region = new Region('region-1');
     const server = new Server('backend', image);
     const service = new Service('testService');
+    const subnet = new Subnet(region, 'public');
     const support = new Support('nginx', 'nginx');
     const deployment = new Deployment('nginx@v1');
     const environment = new Environment('qa');
@@ -36,6 +38,7 @@ describe('Model E2E Test', () => {
     app.addSupport(support);
     support.addDeployment(deployment);
     region.addEnvironment(environment);
+    region.addSubnet(subnet);
 
     const testCases: {
       model: UnknownModel;
@@ -68,6 +71,9 @@ describe('Model E2E Test', () => {
       {
         model: service,
       },
+      {
+        model: subnet,
+      },
       {
         model: support,
       },