Directory JSON actions secrets matches YAML (#954)

* Directory JSON actions secrets matches YAML Signed-off-by: Sebastian Detering <[email protected]> * Unit test for actions secrets KEYWORD Signed-off-by: Sebastian Detering <[email protected]> * existing mapSecrets string placeholder return Signed-off-by: Sebastian Detering <[email protected]> * type check in YAML mapSecrets Signed-off-by: Sebastian Detering <[email protected]> Rebased to master * update e2e recordings --------- Signed-off-by: Sebastian Detering <[email protected]> Co-authored-by: kushalshit27 <[email protected]>
auth0 · Oct 14, 2024 · dbbb13d · dbbb13d
1 parent 075747c
commit dbbb13d
Show file tree

Hide file tree

Showing 9 changed files with 15,586 additions and 4,404 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -82,9 +82,6 @@ workflows:
     jobs:
       - e2e_test_as_node_module:
           name: E2E tests as Node module
-          filters:
-            branches:
-              ignore: /pull\/[0-9]+/ # Forked pull requests
       - e2e_test_as_cli:
           name: E2E tests as CLI
           filters:

diff --git a/src/context/directory/handlers/actions.ts b/src/context/directory/handlers/actions.ts
@@ -43,6 +43,9 @@ function parse(context: DirectoryContext): ParsedActions {
 }
 
 function mapSecrets(secrets) {
+  if (typeof secrets === 'string') {
+    return secrets;
+  }
   if (secrets && secrets.length > 0) {
     return secrets.map((secret) => ({ name: secret.name, value: secret.value }));
   }

diff --git a/src/context/yaml/handlers/actions.ts b/src/context/yaml/handlers/actions.ts
@@ -36,7 +36,10 @@ async function parse(context: YAMLContext): Promise<ParsedActions> {
   };
 }
 
-function mapSecrets(secrets: { name: string; value: string }[]): Secret[] {
+function mapSecrets(secrets) {
+  if (typeof secrets === 'string') {
+    return secrets; //Enables keyword preservation to operate on action secrets
+  }
   if (secrets && secrets.length > 0) {
     return secrets.map((secret) => ({ name: secret.name, value: secret.value }));
   }
@@ -86,8 +89,7 @@ async function dump(context: YAMLContext): Promise<ParsedActions> {
       runtime: action.runtime,
       dependencies: action.dependencies || [],
       status: action.status,
-      secrets:
-        typeof action.secrets === 'string' ? action.secrets : mapSecrets(action.secrets || []), //Enables keyword preservation to operate on action secrets
+      secrets: mapSecrets(action.secrets),
       supported_triggers: action.supported_triggers,
     })),
   };

diff --git a/test/context/directory/actions.test.js b/test/context/directory/actions.test.js
@@ -266,4 +266,34 @@ describe('#directory context actions', () => {
 
     expect(dumpedFiles).to.have.length(0);
   });
+
+  it('should process actions secrets with AUTH0_PRESERVE_KEYWORDS: true', async () => {
+    const dir = path.join(testDataDir, 'directory', 'test6');
+    const actionsDir = path.join(dir, 'actions');
+    cleanThenMkdir(actionsDir);
+
+    const json = `{
+      "name": "action-one",
+      "secrets": "@@SECRETS@@"
+    }`;
+    const jsonFile = path.join(actionsDir, 'action-one.json');
+
+    fs.writeFileSync(jsonFile, json);
+
+    const target = [
+      {
+        name: 'action-one',
+        secrets: { name: 'SECRETNAME', value: 'SECRETVALUE' }
+      },
+    ];
+
+    const config = {
+      AUTH0_INPUT_FILE: dir,
+      AUTH0_KEYWORD_REPLACE_MAPPINGS: { SECRETS: { name: 'SECRETNAME', value: 'SECRETVALUE' } },
+      AUTH0_PRESERVE_KEYWORDS: true,
+    };
+    const context = new Context(config, mockMgmtClient());
+    await context.loadAssetsFromLocal();
+    expect(context.assets.actions).to.deep.equal(target);
+  });
 });
diff --git a/test/e2e/e2e.test.ts b/test/e2e/e2e.test.ts
@@ -140,7 +140,6 @@ describe('#end-to-end deploy', function () {
     const yaml = yamlLoad(fs.readFileSync(files[0]));
 
     expect(yaml.emailTemplates.length).to.be.above(0);
-    expect(yaml.rules.length).to.be.above(0);
     expect(yaml.pages.length).to.be.above(0);
     expect(yaml.clients.length).to.be.above(0);
     expect(yaml.databases.length).to.be.above(0);
@@ -203,7 +202,7 @@ describe('#end-to-end deploy', function () {
     const yaml = yamlLoad(fs.readFileSync(files[0]));
 
     expect(yaml.rules).to.have.length(0);
-    expect(yaml.clients).to.have.length(2); //Accounting for Deploy CLI and Default App client
+    expect(yaml.clients).to.have.length(2); // Accounting for Deploy CLI and Default App client
     expect(yaml.databases).to.have.length(1); // Default user database
     expect(yaml.connections).to.have.length(0);
     expect(yaml.roles).to.have.length(0);