Adding test cases for deletions

Author: willvedd

.eslintignore

@@ -1,4 +1,5 @@
 examples/
+test/e2e/testdata/**/**
 local/
 node_modules/
 lib/

.prettierignore

@@ -7,4 +7,5 @@ lib
 node_modules
 examples
 test/**/*.json
-test/**/*.yaml
+test/**/*.yaml
+test/e2e/testdata

test/e2e/e2e-utils.ts

@@ -5,11 +5,10 @@ import { back as nockBack, BackMode, Definition } from 'nock';
 
 export function decodeBuffer(recordingResponse: Definition['response']) {
   try {
-    // Decode the hex buffer that nock made
-    const response = Array.isArray(recordingResponse)
-      ? recordingResponse.join('')
-      : recordingResponse?.toString() || '';
-    const decoded = Buffer.from(response, 'hex');
+    const isArray = Array.isArray(recordingResponse);
+    if (!isArray) return recordingResponse; // Some Auth0 Management API endpoints aren't gzipped, we can tell this if they are an array or not
+
+    const decoded = Buffer.from(recordingResponse.join(''), 'hex');
     const unzipped = zlib.gunzipSync(decoded).toString('utf-8');
     return JSON.parse(unzipped);
   } catch (err) {
@@ -50,6 +49,7 @@ export function sanitizeRecording(recording: Definition): Definition {
     'client_secret',
     'cert',
     'pkcs7',
+    'key',
   ]);
 
   return sanitizedRecording;

test/e2e/e2e.test.ts

@@ -1,6 +1,8 @@
 import { expect } from 'chai';
 import path from 'path';
+import fs from 'fs';
 import { getFiles, existsMustBeDir } from '../../src/utils';
+import { load as yamlLoad } from 'js-yaml';
 import { setupRecording, testNameToWorkingDirectory } from './e2e-utils';
 import { dump, deploy } from '../../src';
 
@@ -58,6 +60,128 @@ describe('#end-to-end deploy', function () {
 
     recordingDone();
   });
+
+  it('should deploy without deleting resources if AUTH0_ALLOW_DELETE is false', async function () {
+    const { recordingDone } = await setupRecording(this.test?.title);
+
+    // Loading tenant with a good bit of config
+    await deploy({
+      input_file: `${__dirname}/testdata/lots-of-configuration/tenant.yaml`,
+      config: {
+        AUTH0_DOMAIN,
+        AUTH0_CLIENT_ID,
+        AUTH0_CLIENT_SECRET,
+        AUTH0_ACCESS_TOKEN,
+        AUTH0_ALLOW_DELETE: false,
+      },
+    });
+
+    // Applying configuration to clear tenant out
+    await deploy({
+      input_file: `${__dirname}/testdata/empty-tenant/tenant.yaml`,
+      config: {
+        AUTH0_DOMAIN,
+        AUTH0_CLIENT_ID,
+        AUTH0_CLIENT_SECRET,
+        AUTH0_ACCESS_TOKEN,
+        AUTH0_ALLOW_DELETE: false,
+      },
+    });
+
+    const workDirectory = testNameToWorkingDirectory(this.test?.title);
+
+    // Perform a subsequent dump to know the new state of remote
+    await dump({
+      output_folder: workDirectory,
+      format: 'yaml',
+      config: {
+        AUTH0_DOMAIN,
+        AUTH0_CLIENT_ID,
+        AUTH0_CLIENT_SECRET,
+        AUTH0_ACCESS_TOKEN,
+      },
+    });
+
+    const files = getFiles(workDirectory, ['.yaml']);
+    expect(files).to.have.length(1);
+    expect(files[0]).to.equal(path.join(workDirectory, 'tenant.yaml'));
+
+    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);
+    expect(yaml.connections.length).to.be.above(0);
+    expect(yaml.roles.length).to.be.above(0);
+    expect(yaml.guardianFactorProviders.length).to.be.above(0);
+    expect(yaml.guardianFactorTemplates.length).to.be.above(0);
+    expect(yaml.actions.length).to.be.above(0);
+    expect(yaml.organizations.length).to.be.above(0);
+    expect(yaml.logStreams.length).to.be.above(0);
+
+    recordingDone();
+  });
+
+  it('should deploy while deleting resources if AUTH0_ALLOW_DELETE is true', async function () {
+    const { recordingDone } = await setupRecording(this.test?.title);
+
+    // Loading tenant with a good bit of config
+    await deploy({
+      input_file: `${__dirname}/testdata/lots-of-configuration/tenant.yaml`,
+      config: {
+        AUTH0_DOMAIN,
+        AUTH0_CLIENT_ID,
+        AUTH0_CLIENT_SECRET,
+        AUTH0_ACCESS_TOKEN,
+        AUTH0_ALLOW_DELETE: true,
+      },
+    });
+
+    // Applying configuration to clear tenant out
+    await deploy({
+      input_file: `${__dirname}/testdata/empty-tenant/tenant.yaml`,
+      config: {
+        AUTH0_DOMAIN,
+        AUTH0_CLIENT_ID,
+        AUTH0_CLIENT_SECRET,
+        AUTH0_ACCESS_TOKEN,
+        AUTH0_ALLOW_DELETE: true,
+      },
+    });
+
+    const workDirectory = testNameToWorkingDirectory(this.test?.title);
+
+    // Perform a subsequent dump to know the new state of remote
+    await dump({
+      output_folder: workDirectory,
+      format: 'yaml',
+      config: {
+        AUTH0_DOMAIN,
+        AUTH0_CLIENT_ID,
+        AUTH0_CLIENT_SECRET,
+        AUTH0_ACCESS_TOKEN,
+      },
+    });
+
+    const files = getFiles(workDirectory, ['.yaml']);
+    expect(files).to.have.length(1);
+    expect(files[0]).to.equal(path.join(workDirectory, 'tenant.yaml'));
+
+    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.databases).to.have.length(1); // Default user database
+    expect(yaml.connections).to.have.length(0);
+    expect(yaml.roles).to.have.length(0);
+    expect(yaml.actions).to.have.length(0);
+    expect(yaml.organizations).to.have.length(0);
+    expect(yaml.logStreams).to.have.length(0);
+
+    recordingDone();
+  });
 });
 
 describe('#end-to-end dump and deploy cycle', function () {