fix(plus-17): L2 default child (#389)

All L1 children are now called `Resource` to mark them as the default child of the L2. BREAKING CHANGE: All L2 resource names will undergo a name change (e.g `test-chart-config-configmap-233db8e7` -> `test-chart-config-c3f7d3c0`) Resolves #373 *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
cdk8s-team · Nov 18, 2020 · a8337e8 · a8337e8
1 parent ffce8c6
commit a8337e8
Show file tree

Hide file tree

Showing 21 changed files with 186 additions and 83 deletions.
diff --git a/examples/typescript/cdk8s-plus-elasticsearch-query/__snapshots__/main.test.ts.snap b/examples/typescript/cdk8s-plus-elasticsearch-query/__snapshots__/main.test.ts.snap
@@ -46,7 +46,7 @@ Array [
     "apiVersion": "apps/v1",
     "kind": "Deployment",
     "metadata": Object {
-      "name": "test-chart-deployment-c5d38cbe",
+      "name": "test-chart-deployment-e606f14e",
     },
     "spec": Object {
       "replicas": 1,
@@ -99,7 +99,7 @@ Array [
               "volumeMounts": Array [
                 Object {
                   "mountPath": "/root",
-                  "name": "configmap-test-chart-config-configmap-233db8e7",
+                  "name": "configmap-test-chart-config-c3f7d3c0",
                 },
               ],
               "workingDir": "/root",
@@ -108,9 +108,9 @@ Array [
           "volumes": Array [
             Object {
               "configMap": Object {
-                "name": "test-chart-config-configmap-233db8e7",
+                "name": "test-chart-config-c3f7d3c0",
               },
-              "name": "configmap-test-chart-config-configmap-233db8e7",
+              "name": "configmap-test-chart-config-c3f7d3c0",
             },
           ],
         },
@@ -121,7 +121,7 @@ Array [
     "apiVersion": "v1",
     "kind": "Service",
     "metadata": Object {
-      "name": "test-chart-deployment-service-pod-28e7837f",
+      "name": "test-chart-deployment-service-7f4c5401",
     },
     "spec": Object {
       "externalIPs": Array [],
@@ -210,7 +210,7 @@ function doSearch(uri, callback) {
     },
     "kind": "ConfigMap",
     "metadata": Object {
-      "name": "test-chart-config-configmap-233db8e7",
+      "name": "test-chart-config-c3f7d3c0",
     },
   },
 ]

diff --git a/packages/cdk8s-plus-17/src/config-map.ts b/packages/cdk8s-plus-17/src/config-map.ts
@@ -67,7 +67,7 @@ export class ConfigMap extends Resource implements IConfigMap {
   public constructor(scope: Construct, id: string, props: ConfigMapProps = { }) {
     super(scope, id, { metadata: props.metadata });
 
-    this.apiObject = new k8s.KubeConfigMap(this, 'ConfigMap', {
+    this.apiObject = new k8s.KubeConfigMap(this, 'Resource', {
       metadata: props.metadata,
 
       // we need lazy here because we filter empty

diff --git a/packages/cdk8s-plus-17/src/deployment.ts b/packages/cdk8s-plus-17/src/deployment.ts
@@ -113,7 +113,7 @@ export class Deployment extends Resource implements IPodTemplate {
   constructor(scope: Construct, id: string, props: DeploymentProps = {}) {
     super(scope, id, { metadata: props.metadata });
 
-    this.apiObject = new k8s.KubeDeployment(this, 'Deployment', {
+    this.apiObject = new k8s.KubeDeployment(this, 'Resource', {
       metadata: props.metadata,
       spec: Lazy.any({ produce: () => this._toKube() }),
     });

diff --git a/packages/cdk8s-plus-17/src/ingress-v1beta1.ts b/packages/cdk8s-plus-17/src/ingress-v1beta1.ts
@@ -48,7 +48,7 @@ export class IngressV1Beta1 extends Resource {
   constructor(scope: Construct, id: string, props: IngressV1Beta1Props = {}) {
     super(scope, id, { metadata: props.metadata });
 
-    this.apiObject = new k8s.KubeIngressV1Beta1(this, 'Ingress', {
+    this.apiObject = new k8s.KubeIngressV1Beta1(this, 'Resource', {
       metadata: props.metadata,
       spec: {
         backend: Lazy.any({ produce: () => this._defaultBackend?._toKube() }),

diff --git a/packages/cdk8s-plus-17/src/job.ts b/packages/cdk8s-plus-17/src/job.ts
@@ -53,7 +53,7 @@ export class Job extends Resource implements IPodTemplate {
   constructor(scope: Construct, id: string, props: JobProps = {}) {
     super(scope, id, { metadata: props.metadata });
 
-    this.apiObject = new k8s.KubeJob(this, 'Default', {
+    this.apiObject = new k8s.KubeJob(this, 'Resource', {
       metadata: props.metadata,
       spec: Lazy.any({ produce: () => this._toKube() }),
     });

diff --git a/packages/cdk8s-plus-17/src/pod.ts b/packages/cdk8s-plus-17/src/pod.ts
@@ -252,7 +252,7 @@ export class Pod extends Resource implements IPodSpec {
   constructor(scope: Construct, id: string, props: PodProps = {}) {
     super(scope, id, { metadata: props.metadata });
 
-    this.apiObject = new k8s.KubePod(this, 'Pod', {
+    this.apiObject = new k8s.KubePod(this, 'Resource', {
       metadata: props.metadata,
       spec: Lazy.any({ produce: () => this._spec._toPodSpec() }),
     });

diff --git a/packages/cdk8s-plus-17/src/secret.ts b/packages/cdk8s-plus-17/src/secret.ts
@@ -62,7 +62,7 @@ export class Secret extends Resource implements ISecret {
 
     this.stringData = props.stringData ?? {};
 
-    this.apiObject = new k8s.KubeSecret(this, 'Secret', {
+    this.apiObject = new k8s.KubeSecret(this, 'Resource', {
       metadata: props.metadata,
       stringData: this.stringData,
     });

diff --git a/packages/cdk8s-plus-17/src/service.ts b/packages/cdk8s-plus-17/src/service.ts
@@ -131,7 +131,7 @@ export class Service extends Resource {
   constructor(scope: Construct, id: string, props: ServiceProps = {}) {
     super(scope, id, { metadata: props.metadata });
 
-    this.apiObject = new k8s.KubeService(this, 'Pod', {
+    this.apiObject = new k8s.KubeService(this, 'Resource', {
       metadata: props.metadata,
       spec: cdk8s.Lazy.any({ produce: () => this._toKube() }),
     });

diff --git a/packages/cdk8s-plus-17/test/__snapshots__/config-map.test.ts.snap b/packages/cdk8s-plus-17/test/__snapshots__/config-map.test.ts.snap
@@ -9,7 +9,7 @@ Array [
     },
     "kind": "ConfigMap",
     "metadata": Object {
-      "name": "test-my-config-map-configmap-d0fa5644",
+      "name": "test-my-config-map-91419662",
     },
   },
 ]
@@ -25,7 +25,7 @@ Array [
     },
     "kind": "ConfigMap",
     "metadata": Object {
-      "name": "test-my-config-map-configmap-d0fa5644",
+      "name": "test-my-config-map-91419662",
     },
   },
 ]
@@ -41,7 +41,7 @@ Array [
     },
     "kind": "ConfigMap",
     "metadata": Object {
-      "name": "test-my-config-map-configmap-d0fa5644",
+      "name": "test-my-config-map-91419662",
     },
   },
 ]
@@ -56,7 +56,7 @@ Array [
     },
     "kind": "ConfigMap",
     "metadata": Object {
-      "name": "test-my-config-map-configmap-d0fa5644",
+      "name": "test-my-config-map-91419662",
     },
   },
 ]
@@ -72,7 +72,7 @@ Array [
     },
     "kind": "ConfigMap",
     "metadata": Object {
-      "name": "test-my-config-map-configmap-d0fa5644",
+      "name": "test-my-config-map-91419662",
     },
   },
 ]

diff --git a/packages/cdk8s-plus-17/test/config-map.test.ts b/packages/cdk8s-plus-17/test/config-map.test.ts
@@ -1,6 +1,17 @@
-import { Testing } from 'cdk8s';
+import { Testing, ApiObject } from 'cdk8s';
+import { Node } from 'constructs';
 import { ConfigMap } from '../src';
 
+test('defaultChild', () => {
+
+  const chart = Testing.chart();
+
+  const defaultChild = Node.of(new ConfigMap(chart, 'ConfigMap')).defaultChild as ApiObject;
+
+  expect(defaultChild.kind).toEqual('ConfigMap');
+
+});
+
 test('minimal', () => {
   // GIVEN
   const chart = Testing.chart();
@@ -14,7 +25,7 @@ test('minimal', () => {
       apiVersion: 'v1',
       kind: 'ConfigMap',
       metadata: {
-        name: 'test-my-config-map-configmap-d0fa5644',
+        name: 'test-my-config-map-91419662',
       },
     },
   ]);
@@ -42,7 +53,7 @@ test('with data', () => {
         key2: 'bar',
       },
       metadata: {
-        name: 'test-my-config-map-configmap-d0fa5644',
+        name: 'test-my-config-map-91419662',
       },
     },
   ]);
@@ -70,7 +81,7 @@ test('with binaryData', () => {
         key2: 'bar',
       },
       metadata: {
-        name: 'test-my-config-map-configmap-d0fa5644',
+        name: 'test-my-config-map-91419662',
       },
     },
   ]);
@@ -104,7 +115,7 @@ test('with binaryData and data', () => {
         key2: 'bar',
       },
       metadata: {
-        name: 'test-my-config-map-configmap-d0fa5644',
+        name: 'test-my-config-map-91419662',
       },
     },
   ]);
@@ -163,7 +174,7 @@ test('addData()/addBinaryDataq() can be used to add data', () => {
       },
       kind: 'ConfigMap',
       metadata: {
-        name: 'test-my-config-map-configmap-d0fa5644',
+        name: 'test-my-config-map-91419662',
       },
     },
   ]);

diff --git a/packages/cdk8s-plus-17/test/deployment.test.ts b/packages/cdk8s-plus-17/test/deployment.test.ts
@@ -1,6 +1,17 @@
-import { Testing } from 'cdk8s';
+import { Testing, ApiObject } from 'cdk8s';
+import { Node } from 'constructs';
 import * as kplus from '../src';
 
+test('defaultChild', () => {
+
+  const chart = Testing.chart();
+
+  const defaultChild = Node.of(new kplus.Deployment(chart, 'Deployment')).defaultChild as ApiObject;
+
+  expect(defaultChild.kind).toEqual('Deployment');
+
+});
+
 test('A label selector is automatically allocated', () => {
 
   const chart = Testing.chart();