Skip to content

F-032: test(history): hermetic git-config isolation for history tests #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sephyi wants to merge 1 commit into
base: development
Choose a base branch
from
Open

F-032: test(history): hermetic git-config isolation for history tests #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 30 additions & 80 deletions tests/history.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Commercial

use commitbee::services::history::{HistoryContext, HistoryService};
use std::path::Path;
use std::process::Command;

// ─── Subject Analysis (Pure Functions) ───────────────────────────────────────

Expand Down Expand Up @@ -315,29 +317,30 @@ fn prompt_section_percentage_calculation() {

// ─── Git Integration (requires tempdir with git repo) ────────────────────────

/// Builds a `git` invocation that is hermetic against ambient git
/// configuration. Disables system/global config, redirects `HOME` to
/// the test's own tempdir, and pre-supplies author/committer identity
/// so commits succeed even when the host has no `user.email` set or
/// has `commit.gpgsign=true` globally.
fn hermetic_git(dir: &Path) -> Command {
let mut cmd = Command::new("git");
cmd.current_dir(dir)
.env("GIT_CONFIG_NOSYSTEM", "1")
.env("GIT_CONFIG_GLOBAL", "/dev/null")
Comment on lines +326 to +329
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GIT_CONFIG_GLOBAL is hardcoded to /dev/null, which will break these tests on Windows (and potentially other non-Unix environments). To keep the test hermetic and cross-platform, prefer pointing GIT_CONFIG_GLOBAL at an empty file created inside the tempdir (or conditionally use the platform null device), rather than relying on /dev/null.

Suggested change
let mut cmd = Command::new("git");
cmd.current_dir(dir)
.env("GIT_CONFIG_NOSYSTEM", "1")
.env("GIT_CONFIG_GLOBAL", "/dev/null")
let global_config = dir.join(".gitconfig-empty");
std::fs::OpenOptions::new()
.create(true)
.write(true)
.open(&global_config)
.unwrap();
let mut cmd = Command::new("git");
cmd.current_dir(dir)
.env("GIT_CONFIG_NOSYSTEM", "1")
.env("GIT_CONFIG_GLOBAL", &global_config)

Copilot uses AI. Check for mistakes.
.env("HOME", dir)
.env("GIT_AUTHOR_NAME", "test")
.env("GIT_AUTHOR_EMAIL", "test@example.com")
.env("GIT_COMMITTER_NAME", "test")
.env("GIT_COMMITTER_EMAIL", "test@example.com");
cmd
}

#[tokio::test]
async fn analyze_repo_with_enough_commits() {
let dir = tempfile::tempdir().unwrap();
let path = dir.path();

// Init repo
std::process::Command::new("git")
.args(["init"])
.current_dir(path)
.output()
.unwrap();

std::process::Command::new("git")
.args(["config", "user.email", "test@test.com"])
.current_dir(path)
.output()
.unwrap();

std::process::Command::new("git")
.args(["config", "user.name", "Test"])
.current_dir(path)
.output()
.unwrap();
hermetic_git(path).args(["init"]).output().unwrap();

Comment on lines +343 to 344
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These git invocations unwrap Command::output() but never assert status.success(). If git returns a non-zero exit code (e.g., missing binary, permission issue, repo corruption), the test will continue and fail later with a less actionable assertion. Consider centralizing execution in the helper to check the exit status and include stderr/stdout in the failure message.

Copilot uses AI. Check for mistakes.
// Create 6 commits (above MIN_COMMITS_FOR_ANALYSIS = 5)
let commit_subjects = [
Expand All @@ -353,15 +356,10 @@ async fn analyze_repo_with_enough_commits() {
let file = path.join(format!("file_{}.txt", i));
std::fs::write(&file, format!("content {}", i)).unwrap();

std::process::Command::new("git")
.args(["add", "."])
.current_dir(path)
.output()
.unwrap();
hermetic_git(path).args(["add", "."]).output().unwrap();

std::process::Command::new("git")
hermetic_git(path)
.args(["commit", "-m", subject])
.current_dir(path)
.output()
.unwrap();
}
Expand All @@ -381,39 +379,17 @@ async fn analyze_repo_with_too_few_commits() {
let dir = tempfile::tempdir().unwrap();
let path = dir.path();

// Init repo
std::process::Command::new("git")
.args(["init"])
.current_dir(path)
.output()
.unwrap();

std::process::Command::new("git")
.args(["config", "user.email", "test@test.com"])
.current_dir(path)
.output()
.unwrap();

std::process::Command::new("git")
.args(["config", "user.name", "Test"])
.current_dir(path)
.output()
.unwrap();
hermetic_git(path).args(["init"]).output().unwrap();

// Create only 3 commits (below MIN_COMMITS_FOR_ANALYSIS = 5)
for i in 0..3 {
let file = path.join(format!("file_{}.txt", i));
std::fs::write(&file, format!("content {}", i)).unwrap();

std::process::Command::new("git")
.args(["add", "."])
.current_dir(path)
.output()
.unwrap();
hermetic_git(path).args(["add", "."]).output().unwrap();

std::process::Command::new("git")
hermetic_git(path)
.args(["commit", "-m", &format!("feat: feature {}", i)])
.current_dir(path)
.output()
.unwrap();
}
Expand All @@ -427,12 +403,7 @@ async fn analyze_empty_repo() {
let dir = tempfile::tempdir().unwrap();
let path = dir.path();

// Init repo but make no commits
std::process::Command::new("git")
.args(["init"])
.current_dir(path)
.output()
.unwrap();
hermetic_git(path).args(["init"]).output().unwrap();

let result = HistoryService::analyze(path, 50).await;
assert!(result.is_none(), "should return None for empty repo");
Expand All @@ -453,38 +424,17 @@ async fn analyze_respects_sample_size() {
let dir = tempfile::tempdir().unwrap();
let path = dir.path();

std::process::Command::new("git")
.args(["init"])
.current_dir(path)
.output()
.unwrap();

std::process::Command::new("git")
.args(["config", "user.email", "test@test.com"])
.current_dir(path)
.output()
.unwrap();

std::process::Command::new("git")
.args(["config", "user.name", "Test"])
.current_dir(path)
.output()
.unwrap();
hermetic_git(path).args(["init"]).output().unwrap();

// Create 10 commits
for i in 0..10 {
let file = path.join(format!("file_{}.txt", i));
std::fs::write(&file, format!("content {}", i)).unwrap();

std::process::Command::new("git")
.args(["add", "."])
.current_dir(path)
.output()
.unwrap();
hermetic_git(path).args(["add", "."]).output().unwrap();

std::process::Command::new("git")
hermetic_git(path)
.args(["commit", "-m", &format!("feat: feature {}", i)])
.current_dir(path)
.output()
.unwrap();
}
Expand Down
Loading