test: improve package manager install lock coverage

Author: EscapeB

libraries/rush-lib/src/logic/test/InstallHelpers.test.ts

@@ -81,6 +81,61 @@ describe('InstallHelpers', () => {
 
   describe(InstallHelpers.ensureLocalPackageManagerAsync.name, () => {
     const tempFolderPath: string = `${__dirname}/temp/${InstallHelpers.name}`;
+    const packageManager: 'pnpm' = 'pnpm';
+    const packageManagerVersion: string = '10.27.0';
+
+    function getRushGlobalFolder(): RushGlobalFolder {
+      return {
+        path: `${tempFolderPath}/rush-global`,
+        nodeSpecificPath: `${tempFolderPath}/rush-global/node-${process.version}`
+      } as RushGlobalFolder;
+    }
+
+    function getRushConfiguration(): RushConfiguration {
+      return {
+        commonRushConfigFolder: `${tempFolderPath}/common/config/rush`,
+        commonTempFolder: `${tempFolderPath}/common/temp`,
+        packageManager,
+        packageManagerToolVersion: packageManagerVersion
+      } as RushConfiguration;
+    }
+
+    function getPackageManagerToolFolder(rushGlobalFolder: RushGlobalFolder): string {
+      return path.join(rushGlobalFolder.nodeSpecificPath, `${packageManager}-${packageManagerVersion}`);
+    }
+
+    async function writeInstalledPackageManagerAsync(rushGlobalFolder: RushGlobalFolder): Promise<void> {
+      const packageManagerToolFolder: string = getPackageManagerToolFolder(rushGlobalFolder);
+
+      JsonFile.save(
+        {
+          dependencies: {
+            [packageManager]: packageManagerVersion
+          },
+          description: 'Temporary file generated by the Rush tool',
+          name: `${packageManager}-local-install`,
+          private: true,
+          version: '0.0.0'
+        },
+        path.join(packageManagerToolFolder, 'package.json'),
+        { ensureFolderExists: true }
+      );
+
+      JsonFile.save(
+        {
+          name: packageManager,
+          version: packageManagerVersion
+        },
+        path.join(packageManagerToolFolder, 'node_modules', packageManager, 'package.json'),
+        { ensureFolderExists: true }
+      );
+
+      const packageManagerBinFolder: string = path.join(packageManagerToolFolder, 'node_modules', '.bin');
+      FileSystem.ensureFolder(packageManagerBinFolder);
+      FileSystem.writeFile(path.join(packageManagerBinFolder, packageManager), '');
+
+      await new LastInstallFlag(packageManagerToolFolder, { node: process.versions.node }).createAsync();
+    }
 
     beforeEach(() => {
       FileSystem.ensureEmptyFolder(tempFolderPath);
@@ -92,56 +147,47 @@ describe('InstallHelpers', () => {
     });
 
     it('does not acquire the global lock when the package manager is already installed', async () => {
-      const rushGlobalFolder: RushGlobalFolder = {
-        path: `${tempFolderPath}/rush-global`,
-        nodeSpecificPath: `${tempFolderPath}/rush-global/node-${process.version}`
-      } as RushGlobalFolder;
-      const packageManagerToolFolder: string = path.join(rushGlobalFolder.nodeSpecificPath, 'pnpm-10.27.0');
-      await new LastInstallFlag(packageManagerToolFolder, { node: process.versions.node }).createAsync();
+      const rushGlobalFolder: RushGlobalFolder = getRushGlobalFolder();
+      await writeInstalledPackageManagerAsync(rushGlobalFolder);
 
-      const lockAcquireSpy: jest.SpyInstance = jest.spyOn(LockFile, 'acquireAsync');
-      const rushConfiguration: RushConfiguration = {
-        commonRushConfigFolder: `${tempFolderPath}/common/config/rush`,
-        commonTempFolder: `${tempFolderPath}/common/temp`,
-        packageManager: 'pnpm',
-        packageManagerToolVersion: '10.27.0'
-      } as RushConfiguration;
+      const lockAcquireSpy: jest.SpyInstance = jest
+        .spyOn(LockFile, 'acquireAsync')
+        .mockResolvedValue(false as unknown as LockFile);
+      const installSpy: jest.SpyInstance = jest
+        .spyOn(Utilities, 'installPackageInDirectoryAsync')
+        .mockRejectedValue(new Error('The package manager should already be installed.'));
+      const rushConfiguration: RushConfiguration = getRushConfiguration();
 
       await InstallHelpers.ensureLocalPackageManagerAsync(rushConfiguration, rushGlobalFolder, 1, true);
 
       expect(lockAcquireSpy).not.toHaveBeenCalled();
+      expect(installSpy).not.toHaveBeenCalled();
       expect(FileSystem.exists(`${rushConfiguration.commonTempFolder}/pnpm-local`)).toEqual(true);
     });
 
     it('acquires the global lock if an install lock file is present', async () => {
-      const rushGlobalFolder: RushGlobalFolder = {
-        path: `${tempFolderPath}/rush-global`,
-        nodeSpecificPath: `${tempFolderPath}/rush-global/node-${process.version}`
-      } as RushGlobalFolder;
-      const packageManagerToolFolder: string = path.join(rushGlobalFolder.nodeSpecificPath, 'pnpm-10.27.0');
-      await new LastInstallFlag(packageManagerToolFolder, { node: process.versions.node }).createAsync();
-      FileSystem.writeFile(`${rushGlobalFolder.nodeSpecificPath}/pnpm-10.27.0#123.lock`, '');
+      const rushGlobalFolder: RushGlobalFolder = getRushGlobalFolder();
+      await writeInstalledPackageManagerAsync(rushGlobalFolder);
+      FileSystem.writeFile(
+        path.join(rushGlobalFolder.nodeSpecificPath, `${packageManager}-${packageManagerVersion}#123.lock`),
+        ''
+      );
 
-      const releaseAsync: jest.Mock = jest.fn();
+      const releaseLockMock: jest.Mock = jest.fn();
       const lockAcquireSpy: jest.SpyInstance = jest.spyOn(LockFile, 'acquireAsync').mockResolvedValue({
         dirtyWhenAcquired: true,
-        release: releaseAsync
+        release: releaseLockMock
       } as unknown as LockFile);
       const installSpy: jest.SpyInstance = jest
         .spyOn(Utilities, 'installPackageInDirectoryAsync')
         .mockResolvedValue();
-      const rushConfiguration: RushConfiguration = {
-        commonRushConfigFolder: `${tempFolderPath}/common/config/rush`,
-        commonTempFolder: `${tempFolderPath}/common/temp`,
-        packageManager: 'pnpm',
-        packageManagerToolVersion: '10.27.0'
-      } as RushConfiguration;
+      const rushConfiguration: RushConfiguration = getRushConfiguration();
 
       await InstallHelpers.ensureLocalPackageManagerAsync(rushConfiguration, rushGlobalFolder, 1, true);
 
       expect(lockAcquireSpy).toHaveBeenCalledTimes(1);
       expect(installSpy).toHaveBeenCalledTimes(1);
-      expect(releaseAsync).toHaveBeenCalledTimes(1);
+      expect(releaseLockMock).toHaveBeenCalledTimes(1);
       expect(FileSystem.exists(`${rushConfiguration.commonTempFolder}/pnpm-local`)).toEqual(true);
     });
   });