add helper test.if, ifWindows, and ifNotWindows function to retain snapshots when running on different OS's

Author: mmaietta

jest.config.js

@@ -12,6 +12,7 @@ module.exports = {
       },
     ],
   },
-  globalSetup: './test/jest.setup.ts',
+  globalSetup: './test/setup/jest.global.setup.ts',
+  setupFilesAfterEnv: ['<rootDir>/test/setup/jest.env.setup.ts'],
   testTimeout: 10000,
 };

test/__snapshots__/cli-spec.ts.snap

@@ -842,6 +842,87 @@ exports[`command line interface should create archive from directory with unpack
 ]
 `;
 
+exports[`command line interface should create archive from directory with windows-style path separators 1`] = `
+{
+  "files": {
+    ".hiddenfile.txt": {
+      "integrity": {
+        "algorithm": "SHA256",
+        "blockSize": 4194304,
+        "blocks": [
+          "d400d9a74f67e724a4793173d73e1403bd6b734930632f4eee50a3a5a1e5a478",
+        ],
+        "hash": "d400d9a74f67e724a4793173d73e1403bd6b734930632f4eee50a3a5a1e5a478",
+      },
+      "size": 19,
+    },
+    "dir1": {
+      "files": {
+        "file1.txt": {
+          "integrity": {
+            "algorithm": "SHA256",
+            "blockSize": 4194304,
+            "blocks": [
+              "420149d3f852894ba7f32e9d3ec7d8919ee2451724bf2580b0186cd373bd6d82",
+            ],
+            "hash": "420149d3f852894ba7f32e9d3ec7d8919ee2451724bf2580b0186cd373bd6d82",
+          },
+          "size": 9,
+        },
+      },
+    },
+    "dir2": {
+      "files": {
+        "file2.png": {
+          "integrity": {
+            "algorithm": "SHA256",
+            "blockSize": 4194304,
+            "blocks": [
+              "cc402b796dc92b2b1f3a6d09515003d8400e63d8acaffc967e49c0cf015fcffe",
+            ],
+            "hash": "cc402b796dc92b2b1f3a6d09515003d8400e63d8acaffc967e49c0cf015fcffe",
+          },
+          "size": 182,
+        },
+        "file3.txt": {
+          "integrity": {
+            "algorithm": "SHA256",
+            "blockSize": 4194304,
+            "blocks": [
+              "a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3",
+            ],
+            "hash": "a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3",
+          },
+          "size": 3,
+        },
+      },
+    },
+    "emptyfile.txt": {
+      "integrity": {
+        "algorithm": "SHA256",
+        "blockSize": 4194304,
+        "blocks": [
+          "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+        ],
+        "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+      },
+      "size": 0,
+    },
+    "file0.txt": {
+      "integrity": {
+        "algorithm": "SHA256",
+        "blockSize": 4194304,
+        "blocks": [
+          "41a978be88ff87a57308bf234106a57ebf9aa0971e2101e75113547a815be72b",
+        ],
+        "hash": "41a978be88ff87a57308bf234106a57ebf9aa0971e2101e75113547a815be72b",
+      },
+      "size": 13,
+    },
+  },
+}
+`;
+
 exports[`command line interface should create archive from directory without hidden files 1`] = `
 {
   "files": {

test/api-spec.ts

@@ -20,12 +20,10 @@ describe('api', function () {
     await asar.createPackage('test/input/packthis/', 'tmp/packthis-api.asar');
     return compFiles('tmp/packthis-api.asar', 'test/expected/packthis.asar');
   });
-  if (os.platform() === 'win32') {
-    it('should create archive with windows-style path separators', async () => {
-      await asar.createPackage('test\\input\\packthis\\', 'tmp\\packthis-api.asar');
-      return compFiles('tmp/packthis-api.asar', 'test/expected/packthis.asar');
-    });
-  }
+  it.ifWindows('should create archive with windows-style path separators', async () => {
+    await asar.createPackage('test\\input\\packthis\\', 'tmp\\packthis-api.asar');
+    return compFiles('tmp/packthis-api.asar', 'test/expected/packthis.asar');
+  });
   it('should create archive from directory (without hidden files)', async () => {
     await asar.createPackageWithOptions(
       'test/input/packthis/',
@@ -103,45 +101,43 @@ describe('api', function () {
   });
 
   // We don't extract symlinks on Windows, so skip these tests
-  if (os.platform() !== 'win32') {
-    it('should extract an archive with symlink', async () => {
-      assert.strictEqual(isSymbolicLinkSync('test/input/packthis-with-symlink/real.txt'), true);
-      await asar.createPackageWithOptions(
-        'test/input/packthis-with-symlink/',
-        'tmp/packthis-with-symlink.asar',
-        { dot: false },
-      );
-      asar.extractAll('tmp/packthis-with-symlink.asar', 'tmp/packthis-with-symlink/');
-      return compFiles(
-        'tmp/packthis-with-symlink/real.txt',
-        'test/input/packthis-with-symlink/real.txt',
-      );
-    });
-    it('should extract an archive with symlink having the same prefix', async () => {
-      assert.strictEqual(
-        isSymbolicLinkSync('test/input/packthis-with-symlink-same-prefix/real.txt'),
-        true,
-      );
-      await asar.createPackageWithOptions(
-        'test/input/packthis-with-symlink-same-prefix/',
-        'tmp/packthis-with-symlink-same-prefix.asar',
-        { dot: false },
-      );
-      asar.extractAll(
-        'tmp/packthis-with-symlink-same-prefix.asar',
-        'tmp/packthis-with-symlink-same-prefix/',
-      );
-      return compFiles(
-        'tmp/packthis-with-symlink-same-prefix/real.txt',
-        'test/input/packthis-with-symlink-same-prefix/real.txt',
-      );
-    });
-    it('should not extract an archive with a bad symlink', async () => {
-      assert.throws(() => {
-        asar.extractAll('test/input/bad-symlink.asar', 'tmp/bad-symlink/');
-      });
+  it.ifNotWindows('should extract an archive with symlink', async () => {
+    assert.strictEqual(isSymbolicLinkSync('test/input/packthis-with-symlink/real.txt'), true);
+    await asar.createPackageWithOptions(
+      'test/input/packthis-with-symlink/',
+      'tmp/packthis-with-symlink.asar',
+      { dot: false },
+    );
+    asar.extractAll('tmp/packthis-with-symlink.asar', 'tmp/packthis-with-symlink/');
+    return compFiles(
+      'tmp/packthis-with-symlink/real.txt',
+      'test/input/packthis-with-symlink/real.txt',
+    );
+  });
+  it.ifNotWindows('should extract an archive with symlink having the same prefix', async () => {
+    assert.strictEqual(
+      isSymbolicLinkSync('test/input/packthis-with-symlink-same-prefix/real.txt'),
+      true,
+    );
+    await asar.createPackageWithOptions(
+      'test/input/packthis-with-symlink-same-prefix/',
+      'tmp/packthis-with-symlink-same-prefix.asar',
+      { dot: false },
+    );
+    asar.extractAll(
+      'tmp/packthis-with-symlink-same-prefix.asar',
+      'tmp/packthis-with-symlink-same-prefix/',
+    );
+    return compFiles(
+      'tmp/packthis-with-symlink-same-prefix/real.txt',
+      'test/input/packthis-with-symlink-same-prefix/real.txt',
+    );
+  });
+  it.ifNotWindows('should not extract an archive with a bad symlink', async () => {
+    assert.throws(() => {
+      asar.extractAll('test/input/bad-symlink.asar', 'tmp/bad-symlink/');
     });
-  }
+  });
   it('should handle multibyte characters in paths', async () => {
     await asar.createPackageWithOptions(
       'test/input/packthis-unicode-path/',

test/cli-spec.ts

@@ -7,7 +7,7 @@ import fs from '../lib/wrapped-fs';
 
 import compFileLists from './util/compareFileLists';
 import { compFiles } from './util/compareFiles';
-import createSymlinkApp from './util/createSymlinkApp';
+import createSymlinkApp from './util/createTestApp';
 import { verifyFileTree, verifySmartUnpack } from './util/verifySmartUnpack';
 
 const exec = promisify(childProcess.exec);
@@ -29,12 +29,13 @@ describe('command line interface', function () {
     await execAsar('p test/input/packthis/ tmp/packthis-cli.asar');
     await verifySmartUnpack('tmp/packthis-cli.asar');
   });
-  if (os.platform() === 'win32') {
-    it('should create archive from directory with windows-style path separators', async () => {
+  it.ifWindows(
+    'should create archive from directory with windows-style path separators',
+    async () => {
       await execAsar('p test\\input\\packthis\\ tmp\\packthis-cli.asar');
       await verifySmartUnpack('tmp/packthis-cli.asar');
-    });
-  }
+    },
+  );
   it('should create archive from directory without hidden files', async () => {
     await execAsar('p test/input/packthis/ tmp/packthis-without-hidden-cli.asar --exclude-hidden');
     await verifySmartUnpack('tmp/packthis-without-hidden-cli.asar');

test/filesystem-spec.ts

@@ -1,6 +1,6 @@
 import assert from 'assert';
 import path from 'path';
-import createSymlinkedApp from './util/createSymlinkApp';
+import createSymlinkedApp from './util/createTestApp';
 
 import { Filesystem } from '../lib/filesystem';
 

test/jest-ex.d.ts

@@ -0,0 +1,7 @@
+declare namespace jest {
+  interface It {
+    if: (condition: boolean) => jest.It;
+    ifWindows: jest.It;
+    ifNotWindows: jest.It;
+  }
+}

test/jest.setup.ts

@@ -0,0 +1,5 @@
+import { platform } from 'os';
+
+test.if = (condition: boolean) => (condition ? test : test.skip);
+test.ifWindows = test.if(platform() === 'win32');
+test.ifNotWindows = test.if(platform() !== 'win32');

test/setup/jest.env.setup.ts

@@ -0,0 +1,7 @@
+import rimraf from 'rimraf';
+import * as path from 'path';
+import fs from '../../lib/wrapped-fs';
+
+export default () => {
+  rimraf.sync(path.join(__dirname, '..', '..', 'tmp'), fs);
+};

test/setup/jest.global.setup.ts

@@ -1,6 +1,7 @@
 import path from 'path';
 import fs from '../../lib/wrapped-fs';
 import rimraf from 'rimraf';
+
 /**
  * Directory structure:
  * testName
@@ -12,19 +13,20 @@ import rimraf from 'rimraf';
  * └── var -> private/var
  */
 const appsDir = path.join(__dirname, '../..', 'tmp');
-let counter = 0;
-const createTestApp = async (testName: string, additionalFiles: Record<string, string> = {}) => {
-  const outDir = testName || 'app-' + counter++;
-  const testPath = path.join(appsDir, outDir);
-  if (fs.existsSync(testPath)) {
-    fs.rmdirSync(testPath);
-  }
 
+const createTestApp = async (
+  testName: string | undefined,
+  additionalFiles: Record<string, string> = {},
+) => {
+  const outDir = testName || 'app' + Math.floor(Math.random() * 100);
+  const testPath = path.join(appsDir, outDir);
   const privateVarPath = path.join(testPath, 'private', 'var');
   const varPath = path.join(testPath, 'var');
 
-  await fs.mkdirp(privateVarPath);
-  await fs.symlink(path.relative(testPath, privateVarPath), varPath);
+  rimraf.sync(testPath, fs);
+
+  fs.mkdirSync(privateVarPath, { recursive: true });
+  fs.symlinkSync(path.relative(testPath, privateVarPath), varPath);
 
   const files = {
     'file.txt': 'hello world',
@@ -34,15 +36,12 @@ const createTestApp = async (testName: string, additionalFiles: Record<string, s
     const originFilePath = path.join(varPath, filename);
     await fs.writeFile(originFilePath, fileData);
   }
+
   const appPath = path.join(varPath, 'app');
-  await fs.mkdirp(appPath);
-  await fs.symlink('../file.txt', path.join(appPath, 'file.txt'));
+  fs.mkdirpSync(appPath);
+  fs.symlinkSync('../file.txt', path.join(appPath, 'file.txt'));
 
-  return {
-    testPath,
-    varPath,
-    appPath,
-  };
+  return { testPath, varPath, appPath };
 };
 
 export default createTestApp;

test/util/createSymlinkApp.ts renamed to test/util/createTestApp.ts

@@ -40,6 +40,9 @@ export function removeUnstableProperties(data: any) {
       if (name === 'offset') {
         return undefined;
       }
+      if (name === 'link') {
+        return toSystemIndependentPath(value);
+      }
       return value;
     }),
   );