Trivial cleanup in test utils

Author: J-Fields

test/cmd_line/tabCompletion.test.ts

@@ -1,5 +1,6 @@
 import * as vscode from 'vscode';
 import * as assert from 'assert';
+import * as os from 'os';
 import { join, sep, basename } from 'path';
 import { getAndUpdateModeHandler } from '../../extension';
 import { ModeHandler } from '../../src/mode/modeHandler';
@@ -238,12 +239,15 @@ suite('cmd_line tabComplete', () => {
   });
 
   test('command line file tab completion with space in file path', async () => {
-    // Create an random file in temp folder with a space in the file name
-    const spacedFilePath = await t.createFile({ fileExtension: 'vscode-vim completion-test' });
+    // Create a random file in temp folder with a space in the file name
+    const prefix = t.rndName();
+    const spacedFilePath = await t.createFile({
+      fsPath: join(os.tmpdir(), prefix + 'vscode-vim completion-test'),
+    });
     try {
-      // Get the base name of the path which is <random name>vscode-vim completion-test
+      // Get the base name of the path which is '<prefix>vscode-vim completion-test'
       const baseName = basename(spacedFilePath);
-      // Get the base name exclude the space which is <random name>vscode-vim
+      // Get the base name exclude the space which is '<prefix>vscode-vim'
       const baseNameExcludeSpace = baseName.substring(0, baseName.lastIndexOf(' '));
       const fullPathExcludeSpace = spacedFilePath.substring(0, spacedFilePath.lastIndexOf(' '));
       const failMsg = 'Cannot complete to a path with space';

test/testSimplifier.ts

@@ -250,22 +250,22 @@ async function testIt(testObj: ITestObject): Promise<ModeHandler> {
   // Check final cursor position
   const actualPosition = modeHandler.vimState.editor.selection.start;
   const expectedPosition = end.cursor;
-  assert.deepStrictEqual(
+  assert.deepEqual(
     { line: actualPosition.line, character: actualPosition.character },
     { line: expectedPosition.line, character: expectedPosition.character },
     'Cursor position is wrong.',
   );
 
   if (testObj.endMode !== undefined) {
-    assert.strictEqual(
+    assert.equal(
       Mode[modeHandler.vimState.currentMode],
       Mode[testObj.endMode],
       "Didn't enter correct mode.",
     );
   }
 
   if (testObj.endFsPath !== undefined) {
-    assert.strictEqual(
+    assert.equal(
       vscode.window.activeTextEditor?.document.uri.fsPath,
       typeof testObj.endFsPath === 'string' ? testObj.endFsPath : testObj.endFsPath(),
       'Active document is wrong.',
@@ -275,15 +275,15 @@ async function testIt(testObj: ITestObject): Promise<ModeHandler> {
   if (testObj.registers !== undefined) {
     for (const reg in testObj.registers) {
       if (testObj.registers[reg] !== undefined) {
-        assert.strictEqual((await Register.get(reg))?.text, testObj.registers[reg]);
+        assert.equal((await Register.get(reg))?.text, testObj.registers[reg]);
       } else {
-        assert.strictEqual(await Register.get(reg), undefined);
+        assert.equal(await Register.get(reg), undefined);
       }
     }
   }
 
   if (testObj.statusBar !== undefined) {
-    assert.strictEqual(
+    assert.equal(
       StatusBar.getText(),
       testObj.statusBar.replace('{FILENAME}', modeHandler.vimState.document.fileName),
       'Status bar text is wrong.',
@@ -293,7 +293,7 @@ async function testIt(testObj: ITestObject): Promise<ModeHandler> {
   // jumps: check jumps are correct if given
   if (testObj.jumps !== undefined) {
     // TODO: Jumps should be specified by Positions, not line contents
-    assert.deepStrictEqual(
+    assert.deepEqual(
       globalState.jumpTracker.jumps.map((j) => end.lines[j.position.line] || '<MISSING>'),
       testObj.jumps.map((t) => t.replace('|', '')),
       'Incorrect jumps found',
@@ -306,11 +306,7 @@ async function testIt(testObj: ITestObject): Promise<ModeHandler> {
       '<FRONT>';
     const expectedJumpPosition = stripBar(testObj.jumps.find((t) => t.includes('|'))) || '<FRONT>';
 
-    assert.deepStrictEqual(
-      actualJumpPosition,
-      expectedJumpPosition,
-      'Incorrect jump position found',
-    );
+    assert.deepEqual(actualJumpPosition, expectedJumpPosition, 'Incorrect jump position found');
   }
 
   return modeHandler;
@@ -451,7 +447,7 @@ async function testItWithRemaps(testObj: ITestWithRemapsObject): Promise<ModeHan
     // Lines after keys pressed but before any timeout
 
     // Check given end output is correct
-    assert.strictEqual(
+    assert.equal(
       result1.lines,
       resolvedStep.end.lines.join(os.EOL),
       `Document content does not match on step ${stepTitleOrIndex}.`,
@@ -460,7 +456,7 @@ async function testItWithRemaps(testObj: ITestWithRemapsObject): Promise<ModeHan
     // Check end cursor position
     const actualEndPosition = result1.position;
     const expectedEndPosition = resolvedStep.end.cursor;
-    assert.deepStrictEqual(
+    assert.deepEqual(
       { line: actualEndPosition.line, character: actualEndPosition.character },
       { line: expectedEndPosition.line, character: expectedEndPosition.character },
       `Cursor position is wrong on step ${stepTitleOrIndex}.`,
@@ -469,7 +465,7 @@ async function testItWithRemaps(testObj: ITestWithRemapsObject): Promise<ModeHan
     // endMode: check end mode is correct if given
     const expectedEndMode = step.stepResult.endMode;
     if (expectedEndMode !== undefined) {
-      assert.strictEqual(
+      assert.equal(
         Mode[result1.endMode],
         Mode[expectedEndMode],
         `Didn't enter correct mode on step ${stepTitleOrIndex}.`,
@@ -478,10 +474,10 @@ async function testItWithRemaps(testObj: ITestWithRemapsObject): Promise<ModeHan
 
     if (result2) {
       // After the timeout finishes (plus an offset to be sure it finished)
-      assert.notStrictEqual(result2, undefined);
+      assert.notEqual(result2, undefined);
 
       // Check given endAfterTimeout output is correct
-      assert.strictEqual(
+      assert.equal(
         result2.lines,
         resolvedStep.endAfterTimeout?.lines.join(os.EOL),
         `Document content does not match on step ${stepTitleOrIndex} after timeout.`,
@@ -490,7 +486,7 @@ async function testItWithRemaps(testObj: ITestWithRemapsObject): Promise<ModeHan
       // Check endAfterTimeout cursor position
       const actualEndAfterTimeoutPosition = result2.position;
       const expectedEndAfterTimeoutPosition = resolvedStep.endAfterTimeout!.cursor;
-      assert.deepStrictEqual(
+      assert.deepEqual(
         {
           line: actualEndAfterTimeoutPosition.line,
           character: actualEndAfterTimeoutPosition.character,
@@ -505,7 +501,7 @@ async function testItWithRemaps(testObj: ITestWithRemapsObject): Promise<ModeHan
       // endMode: check end mode is correct if given
       const expectedEndAfterTimeoutMode = step.stepResult.endModeAfterTimeout;
       if (expectedEndAfterTimeoutMode !== undefined) {
-        assert.strictEqual(
+        assert.equal(
           Mode[result2.endMode],
           Mode[expectedEndAfterTimeoutMode],
           `Didn't enter correct mode on step ${stepTitleOrIndex} after Timeout.`,

test/testUtils.ts

@@ -75,6 +75,9 @@ export async function createFile(
     contents?: string;
   } = {},
 ): Promise<string> {
+  if (args.fileExtension) {
+    assert.ok(args.fileExtension.startsWith('.'));
+  }
   args.fsPath ??= join(os.tmpdir(), rndName() + (args.fileExtension ?? ''));
   await promisify(fs.writeFile)(args.fsPath, args.contents ?? '');
   return args.fsPath;
@@ -115,7 +118,7 @@ export async function waitForEditorsToClose(numExpectedEditors: number = 0): Pro
 }
 
 export function assertEqualLines(expectedLines: string[]) {
-  assert.strictEqual(
+  assert.equal(
     vscode.window.activeTextEditor?.document.getText(),
     expectedLines.join(os.EOL),
     'Document content does not match.',
@@ -126,7 +129,7 @@ export function assertStatusBarEqual(
   expectedText: string,
   message: string = 'Status bar text does not match',
 ) {
-  assert.strictEqual(StatusBar.getText(), expectedText, message);
+  assert.equal(StatusBar.getText(), expectedText, message);
 }
 
 export async function setupWorkspace(
@@ -179,7 +182,7 @@ export async function setupWorkspace(
 
 export async function cleanUpWorkspace(): Promise<void> {
   await vscode.commands.executeCommand('workbench.action.closeAllEditors');
-  assert.strictEqual(vscode.window.visibleTextEditors.length, 0, 'Expected all editors closed.');
+  assert.equal(vscode.window.visibleTextEditors.length, 0, 'Expected all editors closed.');
   assert(!vscode.window.activeTextEditor, 'Expected no active text editor.');
 }