fix(GITHUB-6525-5172): Rewrite copyDirContentsSyncAllow to call fs-extra::copySync() on the directories instead of calling it on the files to copy individually

lib/classes/Utils.test.js

@@ -224,7 +224,7 @@ describe('Utils', () => {
   });
 
   describe('#copyDirContentsSync()', () => {
-    it('recursively copy directory files', () => {
+    it('should recursively copy directory files', () => {
       const tmpSrcDirPath = path.join(process.cwd(), 'testSrc');
       const tmpDestDirPath = path.join(process.cwd(), 'testDest');
 

lib/utils/fs/copyDirContentsSync.js

@@ -1,16 +1,16 @@
 'use strict';
 
-const path = require('path');
+const fs = require('fs');
 const fse = require('./fse');
-const walkDirSync = require('./walkDirSync');
 
-function fileExists(srcDir, destDir, options) {
-  const fullFilesPaths = walkDirSync(srcDir, options);
+const isNotSymbolicLink = src => !fs.lstatSync(src).isSymbolicLink();
 
-  fullFilesPaths.forEach(fullFilePath => {
-    const relativeFilePath = fullFilePath.replace(srcDir, '');
-    fse.copySync(fullFilePath, path.join(destDir, relativeFilePath));
-  });
+function copyDirContentsSync(srcDir, destDir, { noLinks = false } = {}) {
+  const copySyncOptions = {
+    dereference: true,
+    filter: noLinks ? isNotSymbolicLink : null,
+  };
+  fse.copySync(srcDir, destDir, copySyncOptions);
 }
 
-module.exports = fileExists;
+module.exports = copyDirContentsSync;

lib/utils/fs/copyDirContentsSync.test.js

@@ -0,0 +1,75 @@
+'use strict';
+
+const expect = require('chai').expect;
+const fs = require('fs');
+const path = require('path');
+const copyDirContentsSync = require('./copyDirContentsSync');
+const fileExistsSync = require('./fileExistsSync');
+const removeFileSync = require('./removeFileSync');
+const writeFileSync = require('./writeFileSync');
+const { skipOnWindowsDisabledSymlinks } = require('../../../tests/utils/misc');
+
+describe('#copyDirContentsSync()', () => {
+  afterEach(() => {
+    removeFileSync(path.join(process.cwd(), 'testSrc'));
+    removeFileSync(path.join(process.cwd(), 'testDest'));
+  });
+
+  it('should recursively copy directory files including symbolic links', function() {
+    const tmpSrcDirPath = path.join(process.cwd(), 'testSrc');
+    const tmpDestDirPath = path.join(process.cwd(), 'testDest');
+
+    const srcFile1 = path.join(tmpSrcDirPath, 'file1.txt');
+    const srcFile2 = path.join(tmpSrcDirPath, 'folder', 'file2.txt');
+    const srcFile3 = path.join(tmpSrcDirPath, 'folder', 'file3.txt');
+
+    const destFile1 = path.join(tmpDestDirPath, 'file1.txt');
+    const destFile2 = path.join(tmpDestDirPath, 'folder', 'file2.txt');
+    const destFile3 = path.join(tmpDestDirPath, 'folder', 'file3.txt');
+
+    writeFileSync(srcFile1, 'foo');
+    writeFileSync(srcFile2, 'bar');
+    try {
+      fs.symlinkSync(srcFile2, srcFile3);
+    } catch (error) {
+      skipOnWindowsDisabledSymlinks(error, this);
+      throw error;
+    }
+
+    copyDirContentsSync(tmpSrcDirPath, tmpDestDirPath);
+
+    expect(fileExistsSync(destFile1)).to.equal(true);
+    expect(fileExistsSync(destFile2)).to.equal(true);
+    expect(fileExistsSync(destFile3)).to.equal(true);
+  });
+
+  it('should recursively copy directory files excluding symbolic links', function() {
+    const tmpSrcDirPath = path.join(process.cwd(), 'testSrc');
+    const tmpDestDirPath = path.join(process.cwd(), 'testDest');
+
+    const srcFile1 = path.join(tmpSrcDirPath, 'file1.txt');
+    const srcFile2 = path.join(tmpSrcDirPath, 'folder', 'file2.txt');
+    const srcFile3 = path.join(tmpSrcDirPath, 'folder', 'file3.txt');
+
+    const destFile1 = path.join(tmpDestDirPath, 'file1.txt');
+    const destFile2 = path.join(tmpDestDirPath, 'folder', 'file2.txt');
+    const destFile3 = path.join(tmpDestDirPath, 'folder', 'file3.txt');
+
+    writeFileSync(srcFile1, 'foo');
+    writeFileSync(srcFile2, 'bar');
+    try {
+      fs.symlinkSync(srcFile2, srcFile3);
+    } catch (error) {
+      skipOnWindowsDisabledSymlinks(error, this);
+      throw error;
+    }
+
+    copyDirContentsSync(tmpSrcDirPath, tmpDestDirPath, {
+      noLinks: true,
+    });
+
+    expect(fileExistsSync(destFile1)).to.equal(true);
+    expect(fileExistsSync(destFile2)).to.equal(true);
+    expect(fileExistsSync(destFile3)).to.equal(false);
+  });
+});