Fix carvel usage for external database

Author: jvalkeal

src/carvel/config/db/_ytt_lib/external/external-secrets.yml

@@ -0,0 +1,14 @@
+#@ load("external.star", "name")
+#@ load("external.star", "username")
+#@ load("external.star", "password")
+#@ load("@ytt:base64", "base64")
+
+apiVersion: v1
+kind: Secret
+metadata:
+  name: #@ name()
+  labels:
+    app: #@ name()
+data:
+  external-user: #@ base64.encode(username())
+  external-password: #@ base64.encode(password())

src/carvel/config/db/_ytt_lib/external/external.star

@@ -0,0 +1,13 @@
+load("@ytt:data", "data")
+
+def name():
+  return data.values.name
+end
+
+def username():
+  return data.values.username
+end
+
+def password():
+  return data.values.password
+end

src/carvel/config/db/_ytt_lib/external/values.yml

@@ -0,0 +1,5 @@
+#@data/values-schema
+---
+name: ""
+username: ""
+password: ""

src/carvel/config/db/db-dataflow.yml

@@ -33,10 +33,20 @@ image:
 registrySecretRef: #@ data.values.scdf.registry.secret.ref
 #@ end
 
+#@ def db_external_values():
+name: db-dataflow
+username: #@ data.values.scdf.server.database.username
+password: #@ data.values.scdf.server.database.password
+#@ end
+
 #@ if mariadb_enabled():
 --- #@ template.replace(overlay.apply(library.get("mariadb").with_data_values(db_mariadb_values()).eval(), db_overlay()))
 #@ end
 
 #@ if postgres_enabled():
 --- #@ template.replace(overlay.apply(library.get("postgres").with_data_values(db_postgres_values()).eval(), db_overlay()))
 #@ end
+
+#@ if not mariadb_enabled() and not postgres_enabled():
+--- #@ template.replace(overlay.apply(library.get("external").with_data_values(db_external_values()).eval(), db_overlay()))
+#@ end

src/carvel/config/db/db-skipper.yml

@@ -33,10 +33,20 @@ image:
 registrySecretRef: #@ data.values.scdf.registry.secret.ref
 #@ end
 
+#@ def db_external_values():
+name: db-skipper
+username: #@ data.values.scdf.skipper.database.username
+password: #@ data.values.scdf.skipper.database.password
+#@ end
+
 #@ if mariadb_enabled():
 --- #@ template.replace(overlay.apply(library.get("mariadb").with_data_values(db_mariadb_values()).eval(), db_overlay()))
 #@ end
 
 #@ if postgres_enabled():
 --- #@ template.replace(overlay.apply(library.get("postgres").with_data_values(db_postgres_values()).eval(), db_overlay()))
 #@ end
+
+#@ if not mariadb_enabled() and not postgres_enabled():
+--- #@ template.replace(overlay.apply(library.get("external").with_data_values(db_external_values()).eval(), db_overlay()))
+#@ end

src/carvel/config/db/db.star

@@ -12,10 +12,10 @@ def db_external_dataflow():
     x.setdefault("url", data.values.scdf.server.database.url)
   end
   if len(data.values.scdf.server.database.username) > 0:
-    x.setdefault("username", data.values.scdf.server.database.username)
+    x.setdefault("username", "${external-user}")
   end
   if len(data.values.scdf.server.database.password) > 0:
-    x.setdefault("password", data.values.scdf.server.database.password)
+    x.setdefault("password", "${external-password}")
   end
   if len(data.values.scdf.server.database.driverClassName) > 0:
     x.setdefault("driverClassName", data.values.scdf.server.database.driverClassName)
@@ -37,10 +37,10 @@ def db_external_skipper():
     x.setdefault("url", data.values.scdf.skipper.database.url)
   end
   if len(data.values.scdf.skipper.database.username) > 0:
-    x.setdefault("username", data.values.scdf.skipper.database.username)
+    x.setdefault("username", "${external-user}")
   end
   if len(data.values.scdf.skipper.database.password) > 0:
-    x.setdefault("password", data.values.scdf.skipper.database.password)
+    x.setdefault("password", "${external-password}")
   end
   if len(data.values.scdf.skipper.database.driverClassName) > 0:
     x.setdefault("driverClassName", data.values.scdf.skipper.database.driverClassName)

src/carvel/test/databases.test.ts

@@ -34,7 +34,7 @@ describe('databases', () => {
     expect(postgresDataflowDeployment).toBeTruthy();
     const postgresDataflowContainer = deploymentContainer(postgresDataflowDeployment, DB_POSTGRES_NAME);
     expect(postgresDataflowContainer?.image).toBe('postgres:10');
-    const postgresDataflowSecret = findSecret(yaml, DB_SKIPPER_NAME);
+    const postgresDataflowSecret = findSecret(yaml, DB_DATAFLOW_NAME);
     expect(postgresDataflowSecret).toBeTruthy();
     const postgresDataflowSecretData = postgresDataflowSecret?.data || {};
     expect(postgresDataflowSecretData['postgres-user']).toBe('ZGF0YWZsb3c=');
@@ -134,7 +134,7 @@ describe('databases', () => {
     expect(postgresDataflowDeployment).toBeTruthy();
     const postgresDataflowContainer = deploymentContainer(postgresDataflowDeployment, DB_POSTGRES_NAME);
     expect(postgresDataflowContainer?.image).toContain('postgres');
-    const postgresDataflowSecret = findSecret(yaml, DB_SKIPPER_NAME);
+    const postgresDataflowSecret = findSecret(yaml, DB_DATAFLOW_NAME);
     expect(postgresDataflowSecret).toBeTruthy();
     const postgresDataflowSecretData = postgresDataflowSecret?.data || {};
     expect(postgresDataflowSecretData['postgres-user']).toBe('ZGF0YWZsb3c=');
@@ -202,7 +202,7 @@ describe('databases', () => {
     expect(postgresDataflowDeployment).toBeTruthy();
     const postgresDataflowContainer = deploymentContainer(postgresDataflowDeployment, DB_POSTGRES_NAME);
     expect(postgresDataflowContainer?.image).toContain('postgres');
-    const postgresDataflowSecret = findSecret(yaml, DB_SKIPPER_NAME);
+    const postgresDataflowSecret = findSecret(yaml, DB_DATAFLOW_NAME);
     expect(postgresDataflowSecret).toBeTruthy();
     const postgresDataflowSecretData = postgresDataflowSecret?.data || {};
     expect(postgresDataflowSecretData['postgres-user']).toBe('user');
@@ -216,7 +216,11 @@ describe('databases', () => {
         ...DEFAULT_REQUIRED_DATA_VALUES,
         'scdf.deploy.database.enabled=false',
         'scdf.server.database.url=fakeurl1',
-        'scdf.skipper.database.url=fakeurl2'
+        'scdf.server.database.username=fakeuser1',
+        'scdf.server.database.password=fakepass1',
+        'scdf.skipper.database.url=fakeurl2',
+        'scdf.skipper.database.username=fakeuser2',
+        'scdf.skipper.database.password=fakepass2'
       ]
     });
     expect(result.success, result.stderr).toBeTruthy();
@@ -237,10 +241,30 @@ describe('databases', () => {
     const dataflowJson = dataflowDoc.toJSON();
     const dataflowDatasourceUrl = lodash.get(dataflowJson, 'spring.datasource.url') as string;
     expect(dataflowDatasourceUrl).toBe('fakeurl1');
+    const dataflowDatasourceUsername = lodash.get(dataflowJson, 'spring.datasource.username') as string;
+    expect(dataflowDatasourceUsername).toBe('${external-user}');
+    const dataflowDatasourcePassword = lodash.get(dataflowJson, 'spring.datasource.password') as string;
+    expect(dataflowDatasourcePassword).toBe('${external-password}');
+
+    const postgresDataflowSecret = findSecret(yaml, DB_DATAFLOW_NAME);
+    expect(postgresDataflowSecret).toBeTruthy();
+    const postgresDataflowSecretData = postgresDataflowSecret?.data || {};
+    expect(postgresDataflowSecretData['external-user']).toBe('ZmFrZXVzZXIx');
+    expect(postgresDataflowSecretData['external-password']).toBe('ZmFrZXBhc3Mx');
 
     const skipperDoc = parseYamlDocument(skipperApplicationYaml);
     const skipperJson = skipperDoc.toJSON();
     const skipperDatasourceUrl = lodash.get(skipperJson, 'spring.datasource.url') as string;
     expect(skipperDatasourceUrl).toBe('fakeurl2');
+    const skipperDatasourceUsername = lodash.get(skipperJson, 'spring.datasource.username') as string;
+    expect(skipperDatasourceUsername).toBe('${external-user}');
+    const skipperDatasourcePassword = lodash.get(skipperJson, 'spring.datasource.password') as string;
+    expect(skipperDatasourcePassword).toBe('${external-password}');
+
+    const postgresSkipperSecret = findSecret(yaml, DB_SKIPPER_NAME);
+    expect(postgresSkipperSecret).toBeTruthy();
+    const postgresSkipperSecretData = postgresSkipperSecret?.data || {};
+    expect(postgresSkipperSecretData['external-user']).toBe('ZmFrZXVzZXIy');
+    expect(postgresSkipperSecretData['external-password']).toBe('ZmFrZXBhc3My');
   });
 });