Test in-workspace git branch detection

Author: walles

src/getgitbranch.ts

@@ -9,10 +9,15 @@ const execFile = nodeUtil.promisify(child_process.execFile);
 export default async function getCurrentGitBranch(
   docUri: vscode.Uri,
 ): Promise<string | undefined> {
-  return (
+  const branch =
     getCurrentGitBranchFromVscode(docUri) ||
-    (await getCurrentGitBranchFromGit(docUri))
-  );
+    (await getCurrentGitBranchFromGit(docUri));
+
+  if (docUri.scheme == "file" && !branch) {
+    console.warn("No Git branch found for document", docUri);
+  }
+
+  return branch;
 }
 
 function getCurrentGitBranchFromVscode(docUri: vscode.Uri): string | undefined {
@@ -34,19 +39,19 @@ function getCurrentGitBranchFromVscode(docUri: vscode.Uri): string | undefined {
   const git = extension.exports.getAPI(1);
   const repository = git.getRepository(docUri);
   if (!repository) {
-    console.warn("No Git repository for current document", docUri);
+    console.debug("No vscode Git repository for current document", docUri);
     return undefined;
   }
 
   const currentBranch = repository.state.HEAD;
   if (!currentBranch) {
-    console.warn("No HEAD branch for current document", docUri);
+    console.debug("No vscode HEAD branch for current document", docUri);
     return undefined;
   }
 
   const branchName = currentBranch.name;
   if (!branchName) {
-    console.warn("Current branch has no name", docUri, currentBranch);
+    console.warn("Current vscode branch has no name", docUri, currentBranch);
     return undefined;
   }
 
@@ -74,14 +79,18 @@ async function getCurrentGitBranchFromGit(
 
     const branchName = stdout.trim();
     if (!branchName) {
-      console.warn("No git branch found", docUri, branchName);
+      console.warn(
+        `No git branch found in ${docDirectory}`,
+        docUri,
+        branchName,
+      );
       return undefined;
     }
 
     console.debug("Git: Current branch name", branchName);
     return branchName;
   } catch (e) {
-    console.warn("Git invocation failed", docUri, e);
+    console.warn(`Git invocation failed in ${docDirectory}`, docUri, e);
     return undefined;
   }
 }

src/test/suite/extensionIntegration.test.ts

@@ -7,38 +7,77 @@ import * as os from "os";
 import { execSync } from "child_process";
 
 suite("Extension Integration", () => {
+  test("Git branch detected in in-workspace file", async () => {
+    const expectedBranch = execSync("git branch --show-current", {
+      cwd: __dirname,
+    })
+      .toString()
+      .trim();
+
+    const commitMessage = path.join(__dirname, "COMMIT_EDITMSG");
+    fs.writeFileSync(commitMessage, "For testing\n\nThese are some words.\n");
+
+    try {
+      // Open the file in an editor
+      const doc = await vscode.workspace.openTextDocument(
+        vscode.Uri.file(commitMessage),
+      );
+      await vscode.window.showTextDocument(doc);
+
+      // Wait for extension activation to complete
+      const ext = vscode.extensions.getExtension(
+        "walles.git-commit-message-plus",
+      )!;
+      await ext.activate();
+
+      // Wait (up to ~2s) for async branch detection to populate gitBranch
+      const deadline = Date.now() + 2000;
+      let actualBranch: string | undefined = ext.exports.gitBranch;
+      while (actualBranch != expectedBranch && Date.now() < deadline) {
+        await new Promise((r) => globalThis.setTimeout(r, 50));
+        actualBranch = ext.exports.gitBranch;
+      }
+
+      assert.strictEqual(actualBranch, expectedBranch);
+    } finally {
+      fs.rmSync(commitMessage);
+    }
+  });
+
   test("Git branch detected in not-in-workspace file", async () => {
     const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "git-commit-test-"));
-    const commitMessage = path.join(tmpDir, "COMMIT_EDITMSG");
-    fs.writeFileSync(commitMessage, "Initial commit\n\nDetails here.\n");
-
-    // Create a repo and a branch that we can detect
-    execSync("git init", { cwd: tmpDir });
-    execSync("git checkout -b test-branch", { cwd: tmpDir });
-
-    // Open the file in an editor
-    const doc = await vscode.workspace.openTextDocument(
-      vscode.Uri.file(commitMessage),
-    );
-    await vscode.window.showTextDocument(doc);
-
-    // Wait for extension activation to complete
-    const ext = vscode.extensions.getExtension(
-      "walles.git-commit-message-plus",
-    )!;
-    await ext.activate();
-
-    // Wait (up to ~2s) for async branch detection to populate gitBranch
-    const deadline = Date.now() + 2000;
-    let actualBranch: string | undefined = ext.exports.gitBranch;
-    while (!actualBranch && Date.now() < deadline) {
-      await new Promise((r) => globalThis.setTimeout(r, 50));
-      actualBranch = ext.exports.gitBranch;
-    }
 
-    assert.strictEqual(actualBranch, "test-branch");
+    try {
+      const commitMessage = path.join(tmpDir, "COMMIT_EDITMSG");
+      fs.writeFileSync(commitMessage, "Initial commit\n\nDetails here.\n");
+
+      // Create a repo and a branch that we can detect
+      execSync("git init", { cwd: tmpDir });
+      execSync("git checkout -b test-branch", { cwd: tmpDir });
+
+      // Open the file in an editor
+      const doc = await vscode.workspace.openTextDocument(
+        vscode.Uri.file(commitMessage),
+      );
+      await vscode.window.showTextDocument(doc);
 
-    // Clean up
-    fs.rmSync(tmpDir, { recursive: true, force: true });
+      // Wait for extension activation to complete
+      const ext = vscode.extensions.getExtension(
+        "walles.git-commit-message-plus",
+      )!;
+      await ext.activate();
+
+      // Wait (up to ~2s) for async branch detection to populate gitBranch
+      const deadline = Date.now() + 2000;
+      let actualBranch: string | undefined = ext.exports.gitBranch;
+      while (actualBranch != "test-branch" && Date.now() < deadline) {
+        await new Promise((r) => globalThis.setTimeout(r, 50));
+        actualBranch = ext.exports.gitBranch;
+      }
+
+      assert.strictEqual(actualBranch, "test-branch");
+    } finally {
+      fs.rmSync(tmpDir, { recursive: true, force: true });
+    }
   });
 });