refactor(ecs): refactor addPortMapping method (#24227)

bun913 · web-flow · commit c7b71bd9b9f9 · 2023-03-01T00:20:02.000Z
This PR... - Refactor ecs.ContainerDefintion.addPortMapping method - The addPortMapping method had many if statements and it was difficult to understand what was being determined. - It was also difficult to make changes. - Therefore, I divided the classes by interest to improve visibility. Closes #24170 . ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
diff --git a/packages/@aws-cdk/aws-ecs/lib/container-definition.ts b/packages/@aws-cdk/aws-ecs/lib/container-definition.ts
@@ -566,43 +566,15 @@ export class ContainerDefinition extends Construct {
    */
   public addPortMappings(...portMappings: PortMapping[]) {
     this.portMappings.push(...portMappings.map(pm => {
-      if (this.taskDefinition.networkMode === NetworkMode.AWS_VPC || this.taskDefinition.networkMode === NetworkMode.HOST) {
-        if (pm.containerPort !== pm.hostPort && pm.hostPort !== undefined) {
-          throw new Error(`Host port (${pm.hostPort}) must be left out or equal to container port ${pm.containerPort} for network mode ${this.taskDefinition.networkMode}`);
-        }
-      }
-      // No empty strings as port mapping names.
-      if (pm.name === '') {
-        throw new Error('Port mapping name cannot be an empty string.');
-      }
-      // Service connect logic.
-      if (pm.name || pm.appProtocol) {
-
-        // Service connect only supports Awsvpc and Bridge network modes.
-        if (![NetworkMode.BRIDGE, NetworkMode.AWS_VPC].includes(this.taskDefinition.networkMode)) {
-          throw new Error(`Service connect related port mapping fields 'name' and 'appProtocol' are not supported for network mode ${this.taskDefinition.networkMode}`);
-        }
-
-        // Name is not set but App Protocol is; this config is meaningless and we should throw.
-        if (!pm.name) {
-          throw new Error('Service connect-related port mapping field \'appProtocol\' cannot be set without \'name\'');
-        }
-
-        if (this._namedPorts.has(pm.name)) {
-          throw new Error(`Port mapping name '${pm.name}' already exists on this container`);
-        }
-        this._namedPorts.set(pm.name, pm);
+      const portMap = new PortMap(this.taskDefinition.networkMode, pm);
+      portMap.validate();
+      const serviceConnect = new ServiceConnect(this.taskDefinition.networkMode, pm);
+      if (serviceConnect.isServiceConnect()) {
+        serviceConnect.validate();
+        this.setNamedPort(pm);
       }
-
-      if (this.taskDefinition.networkMode === NetworkMode.BRIDGE) {
-        if (pm.hostPort === undefined) {
-          pm = {
-            ...pm,
-            hostPort: 0,
-          };
-        }
-      }
-      return pm;
+      const sanitizedPM = this.addHostPortIfNeeded(pm);
+      return sanitizedPM;
     }));
   }
 
@@ -688,6 +660,32 @@ export class ContainerDefinition extends Construct {
     return this._namedPorts.get(name);
   }
 
+  /**
+   * This method adds an namedPort
+   */
+  private setNamedPort(pm: PortMapping) :void {
+    if (!pm.name) return;
+    if (this._namedPorts.has(pm.name)) {
+      throw new Error(`Port mapping name '${pm.name}' already exists on this container`);
+    }
+    this._namedPorts.set(pm.name, pm);
+  }
+
+
+  /**
+   * Set HostPort to 0 When netowork mode is Brdige
+   */
+  private addHostPortIfNeeded(pm: PortMapping) :PortMapping {
+    const newPM = {
+      ...pm,
+    };
+    if (this.taskDefinition.networkMode !== NetworkMode.BRIDGE) return newPM;
+    if (pm.hostPort !== undefined) return newPM;
+    newPM.hostPort = 0;
+    return newPM;
+  }
+
+
   /**
    * Whether this container definition references a specific JSON field of a secret
    * stored in Secrets Manager.
@@ -1086,6 +1084,116 @@ export interface PortMapping {
   readonly appProtocol?: AppProtocol;
 }
 
+/**
+ * PortMap ValueObjectClass having by ContainerDefinition
+ */
+export class PortMap {
+
+  /**
+   * The networking mode to use for the containers in the task.
+   */
+  readonly networkmode: NetworkMode;
+
+  /**
+   * Port mappings allow containers to access ports on the host container instance to send or receive traffic.
+   */
+  readonly portmapping: PortMapping;
+
+  constructor(networkmode: NetworkMode, pm: PortMapping) {
+    this.networkmode = networkmode;
+    this.portmapping = pm;
+  }
+
+  /**
+   * validate invalid portmapping and networkmode parameters.
+   * throw Error when invalid parameters.
+   */
+  public validate(): void {
+    if (!this.isvalidPortName()) {
+      throw new Error('Port mapping name cannot be an empty string.');
+    }
+    if (!this.isValidPorts()) {
+      const pm = this.portmapping;
+      throw new Error(`Host port (${pm.hostPort}) must be left out or equal to container port ${pm.containerPort} for network mode ${this.networkmode}`);
+    }
+  }
+
+  private isvalidPortName(): boolean {
+    if (this.portmapping.name === '') {
+      return false;
+    }
+    return true;
+  }
+
+  private isValidPorts() :boolean {
+    const isAwsVpcMode = this.networkmode == NetworkMode.AWS_VPC;
+    const isHostMode = this.networkmode == NetworkMode.HOST;
+    if (!isAwsVpcMode && !isHostMode) return true;
+    const hostPort = this.portmapping.hostPort;
+    const containerPort = this.portmapping.containerPort;
+    if (containerPort !== hostPort && hostPort !== undefined ) return false;
+    return true;
+  }
+
+}
+
+
+/**
+ * ServiceConnect ValueObjectClass having by ContainerDefinition
+ */
+export class ServiceConnect {
+  /**
+   * Port mappings allow containers to access ports on the host container instance to send or receive traffic.
+   */
+  readonly portmapping: PortMapping;
+
+  /**
+   * The networking mode to use for the containers in the task.
+   */
+  readonly networkmode: NetworkMode;
+
+  constructor(networkmode: NetworkMode, pm: PortMapping) {
+    this.portmapping = pm;
+    this.networkmode = networkmode;
+  }
+
+  /**
+   * Judge parameters can be serviceconnect logick.
+   * If parameters can be serviceConnect return true.
+   */
+  public isServiceConnect() :boolean {
+    const hasPortname = this.portmapping.name;
+    const hasAppProtcol = this.portmapping.appProtocol;
+    if (hasPortname || hasAppProtcol) return true;
+    return false;
+  }
+
+  /**
+   * Judge serviceconnect parametes are valid.
+   * If invalid, throw Error.
+   */
+  public validate() :void {
+    if (!this.isValidNetworkmode()) {
+      throw new Error(`Service connect related port mapping fields 'name' and 'appProtocol' are not supported for network mode ${this.networkmode}`);
+    }
+    if (!this.isValidPortName()) {
+      throw new Error('Service connect-related port mapping field \'appProtocol\' cannot be set without \'name\'');
+    }
+  }
+
+  private isValidNetworkmode() :boolean {
+    const isAwsVpcMode = this.networkmode == NetworkMode.AWS_VPC;
+    const isBridgeMode = this.networkmode == NetworkMode.BRIDGE;
+    if (isAwsVpcMode || isBridgeMode) return true;
+    return false;
+  }
+
+  private isValidPortName() :boolean {
+    if (!this.portmapping.name) return false;
+    return true;
+  }
+}
+
 /**
  * Network protocol
  */
diff --git a/packages/@aws-cdk/aws-ecs/test/container-definition.test.ts b/packages/@aws-cdk/aws-ecs/test/container-definition.test.ts
@@ -35,6 +35,156 @@ describe('container definition', () => {
       });
     });
 
+    describe('PortMap validates', () => {
+      test('throws when PortMapping.name is empty string.', () => {
+        // GIVEN
+        const portMapping: ecs.PortMapping = {
+          containerPort: 8080,
+          name: '',
+        };
+        const networkmode = ecs.NetworkMode.AWS_VPC;
+        const portMap = new ecs.PortMap(networkmode, portMapping);
+        // THEN
+        expect(() => {
+          portMap.validate();
+        }).toThrow();
+      });
+
+      describe('ContainerPort should not eqaul Hostport', () => {
+        test('when AWS_VPC Networkmode', () => {
+          // GIVEN
+          const portMapping: ecs.PortMapping = {
+            containerPort: 8080,
+            hostPort: 8081,
+          };
+          const networkmode = ecs.NetworkMode.AWS_VPC;
+          const portMap = new ecs.PortMap(networkmode, portMapping);
+          // THEN
+          expect(() => {
+            portMap.validate();
+          }).toThrow();
+        });
+
+        test('when Host Networkmode', () => {
+          // GIVEN
+          const portMapping: ecs.PortMapping = {
+            containerPort: 8080,
+            hostPort: 8081,
+          };
+          const networkmode = ecs.NetworkMode.HOST;
+          const portMap = new ecs.PortMap(networkmode, portMapping);
+          // THEN
+          expect(() => {
+            portMap.validate();
+          }).toThrow();
+        });
+      });
+
+      describe('ContainerPort can equal HostPort cases', () => {
+        test('when Bridge Networkmode', () => {
+          // GIVEN
+          const portMapping: ecs.PortMapping = {
+            containerPort: 8080,
+            hostPort: 8080,
+          };
+          const networkmode = ecs.NetworkMode.BRIDGE;
+          const portMap = new ecs.PortMap(networkmode, portMapping);
+          // THEN
+          expect(() => {
+            portMap.validate();
+          }).not.toThrow();
+        });
+
+      });
+
+    });
+
+    describe('ServiceConnect class', () => {
+      describe('isServiceConnect', () => {
+        test('return true if params has portname', () => {
+          // GIVEN
+          const portMapping: ecs.PortMapping = {
+            containerPort: 8080,
+            name: 'test',
+          };
+          const networkmode = ecs.NetworkMode.AWS_VPC;
+          const serviceConnect = new ecs.ServiceConnect(networkmode, portMapping);
+          // THEN
+          expect(serviceConnect.isServiceConnect()).toEqual(true);
+        });
+
+        test('return true if params has appProtocol', () => {
+          // GIVEN
+          const portMapping: ecs.PortMapping = {
+            containerPort: 8080,
+            appProtocol: ecs.AppProtocol.http2,
+          };
+          const networkmode = ecs.NetworkMode.AWS_VPC;
+          const serviceConnect = new ecs.ServiceConnect(networkmode, portMapping);
+          // THEN
+          expect(serviceConnect.isServiceConnect()).toEqual(true);
+        });
+
+        test('return false if params has not appProtocl and portName ', () => {
+          // GIVEN
+          const portMapping: ecs.PortMapping = {
+            containerPort: 8080,
+          };
+          const networkmode = ecs.NetworkMode.AWS_VPC;
+          const serviceConnect = new ecs.ServiceConnect(networkmode, portMapping);
+          // THEN
+          expect(serviceConnect.isServiceConnect()).toEqual(false);
+        });
+
+      });
+
+      describe('validate', () => {
+        test('throw if Host Networkmode', () => {
+          // GIVEN
+          const portMapping: ecs.PortMapping = {
+            containerPort: 8080,
+            name: 'test',
+          };
+          const networkmode = ecs.NetworkMode.HOST;
+          const serviceConnect = new ecs.ServiceConnect(networkmode, portMapping);
+          // THEN
+          expect(() => {
+            serviceConnect.validate();
+          }).toThrow();
+        });
+
+        test('throw if has not portmap name', () => {
+          // GIVEN
+          const portMapping: ecs.PortMapping = {
+            containerPort: 8080,
+            appProtocol: ecs.AppProtocol.http2,
+          };
+          const networkmode = ecs.NetworkMode.AWS_VPC;
+          const serviceConnect = new ecs.ServiceConnect(networkmode, portMapping);
+          // THEN
+          expect(() => {
+            serviceConnect.validate();
+          }).toThrow('Service connect-related port mapping field \'appProtocol\' cannot be set without \'name\'');
+        });
+
+        test('should not throw if AWS_VPC NetworkMode and has portname', () => {
+          // GIVEN
+          const portMapping: ecs.PortMapping = {
+            containerPort: 8080,
+            name: 'test',
+          };
+          const networkmode = ecs.NetworkMode.AWS_VPC;
+          const serviceConnect = new ecs.ServiceConnect(networkmode, portMapping);
+          // THEN
+          expect(() => {
+            serviceConnect.validate();
+          }).not.toThrow();
+        });
+
+      });
+
+    });
+
     test('port mapping throws an error when appProtocol is set without name', () => {
       // GIVEN
       const stack = new cdk.Stack();
