test: add stream snapshot test

Author: WillieRuemmele

src/convert/streams.ts

@@ -36,7 +36,6 @@ export const stream2buffer = async (stream: Stream): Promise<Buffer> =>
     const buf = Array<any>();
     stream.on('data', (chunk) => buf.push(chunk));
     stream.on('end', () => resolve(Buffer.concat(buf)));
-    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
     stream.on('error', (err) => reject(`error converting stream - ${err}`));
   });
 

test/snapshot/sampleProjects/forceignore/.forceignore

@@ -0,0 +1 @@
+**/*.profile

test/snapshot/sampleProjects/forceignore/__snapshots__/ignores-source-format-path.expected/testOutput/source-format/main/default/classes/OneClass.cls

@@ -0,0 +1,5 @@
+public with sharing class OneClass {
+    public OneClass() {
+
+    }
+}

test/snapshot/sampleProjects/forceignore/__snapshots__/ignores-source-format-path.expected/testOutput/source-format/main/default/classes/OneClass.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>59.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

test/snapshot/sampleProjects/forceignore/originalMdapi/classes/OneClass.cls

@@ -0,0 +1,5 @@
+public with sharing class OneClass {
+    public OneClass() {
+
+    }
+}

test/snapshot/sampleProjects/forceignore/originalMdapi/classes/OneClass.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>59.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

test/snapshot/sampleProjects/forceignore/originalMdapi/package.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>OneClass</members>
+        <name>ApexClass</name>
+    </types>
+    <types>
+        <members>Admin</members>
+        <name>Profile</name>
+    </types>
+    <version>60.0</version>
+</Package>

test/snapshot/sampleProjects/forceignore/originalMdapi/profiles/Admin.profile

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Profile xmlns="http://soap.sforce.com/2006/04/metadata">
+    <custom>false</custom>
+    <userLicense>Salesforce</userLicense>
+    <userPermissions>
+        <enabled>true</enabled>
+        <name>AIViewInsightObjects</name>
+    </userPermissions>
+</Profile>

test/snapshot/sampleProjects/forceignore/originalSource/classes/BlueClass.cls

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>59.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

test/snapshot/sampleProjects/forceignore/originalSource/classes/BlueClass.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>59.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

test/snapshot/sampleProjects/forceignore/originalSource/classes/OneClass.cls

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Profile xmlns="http://soap.sforce.com/2006/04/metadata">
+    <custom>false</custom>
+    <userLicense>Salesforce</userLicense>
+    <userPermissions>
+        <enabled>true</enabled>
+        <name>AIViewInsightObjects</name>
+    </userPermissions>
+</Profile>

test/snapshot/sampleProjects/forceignore/originalSource/classes/OneClass.cls-meta.xml

@@ -0,0 +1,12 @@
+{
+  "name": "forceignore",
+  "namespace": "",
+  "packageDirectories": [
+    {
+      "default": true,
+      "path": "force-app"
+    }
+  ],
+  "sfdcLoginUrl": "https://login.salesforce.com",
+  "sourceApiVersion": "52.0"
+}

test/snapshot/sampleProjects/forceignore/originalSource/profiles/Admin.profile-meta.xml

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { dirsAreIdentical, dirEntsToPaths, fileSnap } from '../../helper/conversions';
+import { MetadataConverter } from '../../../../src/convert/metadataConverter';
+import { ComponentSetBuilder } from '../../../../src/collections/componentSetBuilder';
+
+// we don't want failing tests outputting over each other
+/* eslint-disable no-await-in-loop */
+
+describe('Creating and converting ComponentSets with destructive changes', () => {
+  const testDir = path.join('test', 'snapshot', 'sampleProjects', 'forceignore');
+
+  // The directory containing metadata in source format to be converted
+  const mdapiDir = path.join(testDir, 'originalMdapi');
+
+  // The directory of snapshots containing expected conversion results
+  const snapshotsDir = path.join(testDir, '__snapshots__');
+
+  // The directory where metadata is converted as part of testing
+  const testOutput = path.join(testDir, 'testOutput');
+
+  /** Return only the files involved in the conversion */
+  const getConvertedFilePaths = async (outputDir: string): Promise<string[]> =>
+    dirEntsToPaths(
+      await fs.promises.readdir(outputDir, {
+        recursive: true,
+        withFileTypes: true,
+      })
+    );
+
+  it('ignores source format path', async () => {
+    const cs = await ComponentSetBuilder.build({
+      metadata: {
+        metadataEntries: ['ApexClass:OneClass', 'Profile:Admin'],
+        directoryPaths: [mdapiDir],
+      },
+      projectDir: testDir,
+    });
+
+    const sourceOutput = path.join(testOutput, 'source-format');
+
+    await new MetadataConverter().convert(cs, 'source', {
+      type: 'directory',
+      outputDirectory: sourceOutput,
+      genUniqueDir: false,
+    });
+
+    const convertedFiles = await getConvertedFilePaths(sourceOutput);
+    for (const file of convertedFiles) {
+      await fileSnap(file, testDir);
+    }
+    dirsAreIdentical(path.join(snapshotsDir, 'testOutput', 'pre1'), sourceOutput);
+  });
+
+  after(async () => {
+    await fs.promises.rm(testOutput, { recursive: true, force: true });
+  });
+});