Merge pull request #3220 from iclanton/clean-up-tests

Improve refactorability of tests and remove some superfluous path.* operations.

Author: iclanton

apps/api-extractor/src/analyzer/test/PackageMetadataManager.test.ts

@@ -30,8 +30,8 @@ function firstArgument(mockFn: jest.Mock): any {
 
 /* eslint-disable @typescript-eslint/typedef */
 
-describe('PackageMetadataManager', () => {
-  describe('.writeTsdocMetadataFile()', () => {
+describe(PackageMetadataManager.name, () => {
+  describe(PackageMetadataManager.writeTsdocMetadataFile.name, () => {
     const originalWriteFile = FileSystem.writeFile;
     const mockWriteFile: jest.Mock = jest.fn();
     beforeAll(() => {
@@ -50,7 +50,7 @@ describe('PackageMetadataManager', () => {
     });
   });
 
-  describe('.resolveTsdocMetadataPath()', () => {
+  describe(PackageMetadataManager.resolveTsdocMetadataPath.name, () => {
     describe('when an empty tsdocMetadataPath is provided', () => {
       const tsdocMetadataPath: string = '';
       describe('given a package.json where the field "tsdocMetadata" is defined', () => {

apps/api-extractor/src/analyzer/test/SyntaxHelpers.test.ts

@@ -3,8 +3,8 @@
 
 import { SyntaxHelpers } from '../SyntaxHelpers';
 
-describe('SyntaxHelpers', () => {
-  test('.toAlphaNumericCamelCase()', () => {
+describe(SyntaxHelpers.name, () => {
+  it(SyntaxHelpers.makeCamelCaseIdentifier.name, () => {
     // prettier-ignore
     const inputs:string[] = [
       '',

apps/api-extractor/src/api/test/ExtractorConfig-lookup.test.ts

@@ -15,7 +15,7 @@ function expectEqualPaths(path1: string, path2: string): void {
 }
 
 // Tests for expanding the "<lookup>" token for the "projectFolder" setting in api-extractor.json
-describe('ExtractorConfig-lookup', () => {
+describe(`${ExtractorConfig.name}.${ExtractorConfig.loadFileAndPrepare.name}`, () => {
   it.only('config-lookup1: looks up ./api-extractor.json', () => {
     const extractorConfig: ExtractorConfig = ExtractorConfig.loadFileAndPrepare(
       path.join(testDataFolder, 'config-lookup1/api-extractor.json')

apps/heft/src/pluginFramework/logging/test/FileError.test.ts

@@ -3,7 +3,7 @@
 
 import { FileError, FileErrorFormat } from '../FileError';
 
-describe('FileError', () => {
+describe(FileError.name, () => {
   it('normalizes slashes in file paths', () => {
     const error1: FileError = new FileError('message', 'path\\to\\file', 0);
     expect(error1.filePath).toEqual('path/to/file');

apps/heft/src/utilities/subprocess/test/SubprocessRunnerBase.test.ts

@@ -4,7 +4,7 @@
 import { SubprocessRunnerBase } from '../SubprocessRunnerBase';
 import { FileError } from '../../../pluginFramework/logging/FileError';
 
-describe('SubprocessRunnerBase', () => {
+describe(SubprocessRunnerBase.name, () => {
   it(`${SubprocessRunnerBase.serializeForIpcMessage.name} correctly serializes objects`, () => {
     expect(SubprocessRunnerBase.serializeForIpcMessage(1)).toMatchSnapshot();
     expect(SubprocessRunnerBase.serializeForIpcMessage(false)).toMatchSnapshot();

apps/rush-lib/src/api/test/ChangeFile.test.ts

@@ -1,15 +1,13 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import * as path from 'path';
-
 import { ChangeFile } from '../ChangeFile';
 import { RushConfiguration } from '../RushConfiguration';
 import { ChangeType } from '../ChangeManagement';
 
-describe('ChangeFile', () => {
+describe(ChangeFile.name, () => {
   it('can add a change', () => {
-    const rushFilename: string = path.resolve(__dirname, 'repo', 'rush-npm.json');
+    const rushFilename: string = `${__dirname}/repo/rush-npm.json`;
     const rushConfiguration: RushConfiguration = RushConfiguration.loadFromConfigurationFile(rushFilename);
 
     const changeFile: ChangeFile = new ChangeFile(

apps/rush-lib/src/api/test/CommonVersionsConfiguration.test.ts

@@ -1,13 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import * as path from 'path';
-
 import { CommonVersionsConfiguration } from '../CommonVersionsConfiguration';
 
-describe('CommonVersionsConfiguration', () => {
+describe(CommonVersionsConfiguration.name, () => {
   it('can load the file', () => {
-    const filename: string = path.resolve(__dirname, 'jsonFiles', 'common-versions.json');
+    const filename: string = `${__dirname}/jsonFiles/common-versions.json`;
     const configuration: CommonVersionsConfiguration = CommonVersionsConfiguration.loadFromFile(filename);
 
     expect(configuration.preferredVersions.get('@scope/library-1')).toEqual('~3.2.1');

apps/rush-lib/src/api/test/EnvironmentConfiguration.test.ts

@@ -4,7 +4,7 @@
 import * as path from 'path';
 import { EnvironmentConfiguration } from '../EnvironmentConfiguration';
 
-describe('EnvironmentConfiguration', () => {
+describe(EnvironmentConfiguration.name, () => {
   let _oldEnv: typeof process.env;
 
   beforeEach(() => {
@@ -17,7 +17,7 @@ describe('EnvironmentConfiguration', () => {
     process.env = _oldEnv;
   });
 
-  describe('validate', () => {
+  describe(EnvironmentConfiguration.validate.name, () => {
     it('correctly allows no environment variables', () => {
       expect(EnvironmentConfiguration.validate).not.toThrow();
     });
@@ -99,7 +99,7 @@ describe('EnvironmentConfiguration', () => {
     });
 
     it('returns expected path from environment variable with normalization', () => {
-      const expectedValue: string = path.resolve(path.join(process.cwd(), 'temp'));
+      const expectedValue: string = path.resolve(process.cwd(), 'temp');
       const envVar: string = './temp';
       process.env[ENV_VAR] = envVar;
 

apps/rush-lib/src/api/test/EventHooks.test.ts

@@ -1,13 +1,12 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import * as path from 'path';
 import { RushConfiguration } from '../RushConfiguration';
 import { Event, EventHooks } from '../EventHooks';
 
-describe('EventHooks', () => {
+describe(EventHooks.name, () => {
   it('loads a post build hook from rush.json', () => {
-    const rushFilename: string = path.resolve(__dirname, 'repo', 'rush-npm.json');
+    const rushFilename: string = `${__dirname}/repo/rush-npm.json`;
     const rushConfiguration: RushConfiguration = RushConfiguration.loadFromConfigurationFile(rushFilename);
     expect(rushConfiguration.eventHooks.get(Event.postRushBuild)).toEqual(['do something']);
   });

apps/rush-lib/src/api/test/LastInstallFlag.test.ts

@@ -1,25 +1,24 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import * as path from 'path';
+import { FileSystem } from '@rushstack/node-core-library';
 
 import { LastInstallFlag } from '../LastInstallFlag';
-import { FileSystem } from '@rushstack/node-core-library';
 
-const TEMP_DIR: string = path.join(__dirname, 'temp');
+const TEMP_DIR_PATH: string = `${__dirname}/temp`;
 
-describe('LastInstallFlag', () => {
+describe(LastInstallFlag.name, () => {
   beforeEach(() => {
-    FileSystem.ensureEmptyFolder(TEMP_DIR);
+    FileSystem.ensureEmptyFolder(TEMP_DIR_PATH);
   });
 
   afterEach(() => {
-    FileSystem.ensureEmptyFolder(TEMP_DIR);
+    FileSystem.ensureEmptyFolder(TEMP_DIR_PATH);
   });
 
   it('can create and remove a flag in an empty directory', () => {
     // preparation
-    const flag: LastInstallFlag = new LastInstallFlag(TEMP_DIR);
+    const flag: LastInstallFlag = new LastInstallFlag(TEMP_DIR_PATH);
     FileSystem.deleteFile(flag.path);
 
     // test state, should be invalid since the file doesn't exist
@@ -38,8 +37,8 @@ describe('LastInstallFlag', () => {
 
   it('can detect if the last flag was in a different state', () => {
     // preparation
-    const flag1: LastInstallFlag = new LastInstallFlag(TEMP_DIR, { node: '5.0.0' });
-    const flag2: LastInstallFlag = new LastInstallFlag(TEMP_DIR, { node: '8.9.4' });
+    const flag1: LastInstallFlag = new LastInstallFlag(TEMP_DIR_PATH, { node: '5.0.0' });
+    const flag2: LastInstallFlag = new LastInstallFlag(TEMP_DIR_PATH, { node: '8.9.4' });
     FileSystem.deleteFile(flag1.path);
 
     // test state, should be invalid since the file doesn't exist
@@ -63,7 +62,7 @@ describe('LastInstallFlag', () => {
 
   it('can detect if the last flag was in a corrupted state', () => {
     // preparation, write non-json into flag file
-    const flag: LastInstallFlag = new LastInstallFlag(TEMP_DIR);
+    const flag: LastInstallFlag = new LastInstallFlag(TEMP_DIR_PATH);
     FileSystem.writeFile(flag.path, 'sdfjkaklfjksldajgfkld');
 
     // test state, should be invalid since the file is not JSON
@@ -72,13 +71,13 @@ describe('LastInstallFlag', () => {
   });
 
   it("throws an error if new storePath doesn't match the old one", () => {
-    const flag1: LastInstallFlag = new LastInstallFlag(TEMP_DIR, {
+    const flag1: LastInstallFlag = new LastInstallFlag(TEMP_DIR_PATH, {
       packageManager: 'pnpm',
-      storePath: path.join(TEMP_DIR, 'pnpm-store')
+      storePath: `${TEMP_DIR_PATH}/pnpm-store`
     });
-    const flag2: LastInstallFlag = new LastInstallFlag(TEMP_DIR, {
+    const flag2: LastInstallFlag = new LastInstallFlag(TEMP_DIR_PATH, {
       packageManager: 'pnpm',
-      storePath: path.join(TEMP_DIR, 'temp-store')
+      storePath: `${TEMP_DIR_PATH}/temp-store`
     });
 
     flag1.create();
@@ -88,11 +87,11 @@ describe('LastInstallFlag', () => {
   });
 
   it("doesn't throw an error if conditions for error aren't met", () => {
-    const flag1: LastInstallFlag = new LastInstallFlag(TEMP_DIR, {
+    const flag1: LastInstallFlag = new LastInstallFlag(TEMP_DIR_PATH, {
       packageManager: 'pnpm',
-      storePath: path.join(TEMP_DIR, 'pnpm-store')
+      storePath: `${TEMP_DIR_PATH}/pnpm-store`
     });
-    const flag2: LastInstallFlag = new LastInstallFlag(TEMP_DIR, {
+    const flag2: LastInstallFlag = new LastInstallFlag(TEMP_DIR_PATH, {
       packageManager: 'npm'
     });