feat: wrap tests in a describe block

Author: mshanemc

test/nut/metadata.nut.ts

@@ -11,72 +11,73 @@ import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { DescribeMetadataResult } from 'jsforce/lib/api/metadata/schema';
 import { ListMetadataCommandResult } from '../../src/commands/org/list/metadata';
 
-let session: TestSession;
-
-before(async () => {
-  session = await TestSession.create({
-    project: {
-      gitClone: 'https://github.com/trailheadapps/dreamhouse-lwc.git',
-    },
-    devhubAuthStrategy: 'AUTO',
-    scratchOrgs: [
-      {
-        executable: 'sfdx',
-        config: path.join('config', 'project-scratch-def.json'),
-        setDefault: true,
-        duration: 1,
+describe('org list metadata*', () => {
+  let session: TestSession;
+  before(async () => {
+    session = await TestSession.create({
+      project: {
+        gitClone: 'https://github.com/trailheadapps/dreamhouse-lwc.git',
       },
-    ],
-  });
-
-  execCmd('force:source:deploy -p force-app', { cli: 'sfdx' });
-});
+      devhubAuthStrategy: 'AUTO',
+      scratchOrgs: [
+        {
+          executable: 'sfdx',
+          config: path.join('config', 'project-scratch-def.json'),
+          setDefault: true,
+          duration: 1,
+        },
+      ],
+    });
 
-after(async () => {
-  await session?.zip(undefined, 'artifacts');
-  await session?.clean();
-});
+    execCmd('force:source:deploy -p force-app', { cli: 'sfdx' });
+  });
 
-describe('list metadata', () => {
-  it('should successfully execute list metadata for type CustomObject', () => {
-    const result = execCmd<ListMetadataCommandResult>(
-      'org:list:metadata -f output --json --metadatatype CustomObject'
-    ).jsonOutput;
-    expect(result?.status).to.equal(0);
-    expect(result?.result).to.be.an('array').with.length.greaterThan(3);
-    expect(result?.result[0]).to.have.property('type', 'CustomObject');
-    expect(fs.existsSync(path.join(session.project.dir, 'output'))).to.equal(true);
+  after(async () => {
+    await session?.zip(undefined, 'artifacts');
+    await session?.clean();
   });
 
-  it('should successfully execute list metadata for type ListView', () => {
-    // ListView is sensitive to how the connection.metadata.list() call is made.
-    // e.g., if you pass { type: 'ListView', folder: undefined } it will not return
-    // any ListViews but if you pass { type: 'ListView' } it returns all ListViews.
-    const result = execCmd<ListMetadataCommandResult>('org:list:metadata --json --metadatatype ListView').jsonOutput;
-    expect(result?.status).to.equal(0);
-    expect(result?.result).to.be.an('array').with.length.greaterThan(10);
-    expect(result?.result[0]).to.have.property('type', 'ListView');
+  describe('list metadata', () => {
+    it('should successfully execute list metadata for type CustomObject', () => {
+      const result = execCmd<ListMetadataCommandResult>(
+        'org:list:metadata -f output --json --metadatatype CustomObject'
+      ).jsonOutput;
+      expect(result?.status).to.equal(0);
+      expect(result?.result).to.be.an('array').with.length.greaterThan(3);
+      expect(result?.result[0]).to.have.property('type', 'CustomObject');
+      expect(fs.existsSync(path.join(session.project.dir, 'output'))).to.equal(true);
+    });
+
+    it('should successfully execute list metadata for type ListView', () => {
+      // ListView is sensitive to how the connection.metadata.list() call is made.
+      // e.g., if you pass { type: 'ListView', folder: undefined } it will not return
+      // any ListViews but if you pass { type: 'ListView' } it returns all ListViews.
+      const result = execCmd<ListMetadataCommandResult>('org:list:metadata --json --metadatatype ListView').jsonOutput;
+      expect(result?.status).to.equal(0);
+      expect(result?.result).to.be.an('array').with.length.greaterThan(10);
+      expect(result?.result[0]).to.have.property('type', 'ListView');
+    });
   });
-});
 
-describe('list metadata-types', () => {
-  it('should successfully execute describemetadata', () => {
-    const result = execCmd<DescribeMetadataResult>('org:list:metadata-types --json --resultfile md-describe.json', {
-      ensureExitCode: 0,
-    }).jsonOutput;
-    const json = result?.result;
-    expect(json).to.have.property('metadataObjects');
-    const mdObjects = json?.metadataObjects;
-    expect(mdObjects).to.be.an('array').with.length.greaterThan(100);
-    const customLabelsDef = mdObjects?.find((md) => md.xmlName === 'CustomLabels');
-    expect(customLabelsDef).to.deep.equal({
-      childXmlNames: ['CustomLabel'],
-      directoryName: 'labels',
-      inFolder: false,
-      metaFile: false,
-      suffix: 'labels',
-      xmlName: 'CustomLabels',
+  describe('list metadata-types', () => {
+    it('should successfully execute describemetadata', () => {
+      const result = execCmd<DescribeMetadataResult>('org:list:metadata-types --json --resultfile md-describe.json', {
+        ensureExitCode: 0,
+      }).jsonOutput;
+      const json = result?.result;
+      expect(json).to.have.property('metadataObjects');
+      const mdObjects = json?.metadataObjects;
+      expect(mdObjects).to.be.an('array').with.length.greaterThan(100);
+      const customLabelsDef = mdObjects?.find((md) => md.xmlName === 'CustomLabels');
+      expect(customLabelsDef).to.deep.equal({
+        childXmlNames: ['CustomLabel'],
+        directoryName: 'labels',
+        inFolder: false,
+        metaFile: false,
+        suffix: 'labels',
+        xmlName: 'CustomLabels',
+      });
+      expect(fs.existsSync(path.join(session.project.dir, 'md-describe.json'))).to.be.true;
     });
-    expect(fs.existsSync(path.join(session.project.dir, 'md-describe.json'))).to.be.true;
   });
 });