@salesforce/salesforcedx-vscode-test-tools/src/system-operations/fileSystem.ts

Test automation framework for Salesforce Extensions for VS Code

/*
 * Copyright (c) 2025, 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 path from 'path';
import fs from 'fs';
import { TestSetup } from '../testSetup';
import { log } from '../core/miscellaneous';
import FastGlob from 'fast-glob';

/**
 * Creates a directory at the specified path
 * @param folderPath - The file system path where the folder should be created
 */
export function createFolder(folderPath: string): void {
  fs.mkdirSync(folderPath, { recursive: true });
}

/**
 * Creates a file at the specified path, overwriting the file if it already exists
 * @param filePath - The file system path where the file should be created
 * @param content - The content to be written to the file
 */
export function createOrOverwriteFile(filePath: string, content: string): void {
  fs.writeFileSync(filePath, content);
}

/**
 * Removes a directory and all its contents at the specified path
 * @param folderPath - The file system path of the folder to be removed
 */
export function removeFolder(folderPath: string): void {
  fs.rmdirSync(folderPath, { recursive: true });
}

/**
 * Creates custom Salesforce objects in the project's force-app directory
 * Copies object definitions from testSetup.testDataFolderPath to the project
 * @param testSetup - The test setup object containing project paths
 * @throws Error if copying fails or paths are undefined
 */
export async function createCustomObjects(testSetup: TestSetup): Promise<void> {
  const projectPath = testSetup.projectFolderPath;
  const testDataFolderPath = testSetup.testDataFolderPath;
  if (!testDataFolderPath) {
    throw new Error('testDataFolderPath is undefined');
  }
  if (!projectPath) {
    throw new Error('projectPath is undefined');
  }

  const source = testDataFolderPath;
  const destination = path.join(projectPath, 'force-app', 'main', 'default', 'objects');

  // Ensure the project path has been created
  fs.mkdirSync(path.dirname(destination), { recursive: true });

  const copyRecursive = (src: string, dest: string) => {
    if (fs.statSync(src).isDirectory()) {
      fs.mkdirSync(dest, { recursive: true });
      fs.readdirSync(src).forEach(child => {
        copyRecursive(path.join(src, child), path.join(dest, child));
      });
    } else {
      fs.copyFileSync(src, dest);
    }
  };

  try {
    copyRecursive(source, destination);
  } catch (error) {
    if (error instanceof Error) {
      log(`Failed in copying custom objects ${error.message}`);
    }
    log(`source was: '${source}'`);
    log(`destination was: '${destination}'`);
    await testSetup?.tearDown();
    throw error;
  }
}

/**
 * Creates a global Apex code snippets file in the project's .vscode directory
 * @param testSetup - The test setup object containing project paths
 * @throws Error if file creation fails or paths are undefined
 */
export async function createGlobalSnippetsFile(testSetup: TestSetup): Promise<void> {
  const projectPath = testSetup.projectFolderPath;
  if (!projectPath) {
    throw new Error('projectPath is undefined');
  }
  const destination = path.join(projectPath, '.vscode', 'apex.json.code-snippets');
  const apexSnippet = [
    `{`,
    `"SOQL": {`,
    `"prefix": "soql",`,
    `"body": [`,
    `  "[SELECT \${1:field1, field2} FROM \${2:SobjectName} WHERE \${3:clause}];"`,
    `],`,
    `"description": "Apex SOQL query"`,
    `}`,
    `}`
  ].join('\n');

  try {
    fs.writeFileSync(destination, apexSnippet);
  } catch (error) {
    if (error instanceof Error) {
      log(`Failed in creating apex snippets file ${error.message}`);
    }
    log(`destination was: '${destination}'`);
    await testSetup?.tearDown();
    throw error;
  }
}
/**
 * Scans the directory for vsix files and returns the full path to each file
 * @param vsixDir
 * @returns
 */
export function getVsixFilesFromDir(vsixDir: string): string[] {
  return FastGlob.sync('**/*.vsix', { cwd: vsixDir }).map(vsixFile => path.join(vsixDir, vsixFile));
}

/**
 * Return folder name if given path is a directory, otherwise return null
 * @param folderPath
 * @returns folder name
 */
export function getFolderName(folderPath: string): string | null {
  try {
    // Check if the given path exists and if it is a directory
    const stats = fs.statSync(folderPath);
    if (stats.isDirectory()) {
      // Extract and return the folder name
      return path.basename(folderPath);
    } else {
      return null; // It's not a directory
    }
  } catch (err) {
    console.error('Error checking path:', err);
    return null; // The path doesn't exist or isn't accessible
  }
}