chore: explicitly git init with the master branch in tests requiring it

[nathanwn]

Improves a unit test that fails on my machine.

The test fails due to the assumption that git init always initializes a repo with the branch master. Meanwhile, the git defaultBranch configured on my machine is not master. I think this git config is quite common since GitHub now defaults to main as the main branch.

I also reckon if the test is based on the precondition of "the repo should have a master branch", then it'd better be stated explicitly. This fix tries to achieve that.

[benmss]

This is an interesting failure case. However, reliance on branch information in the commit finder (and tests) will be removed in PR #586. When that is merged (without major changes), I think this PR can be closed.

[nathanwn]

Given the changes in #586, I will close this PR for now.

[nathanwn]

I still get this error on my side. I don't think the change made in #586 solved the issue.

The result of the test case:

FAILED tests/repo_finder/test_commit_finder.py::test_commit_finder - AttributeError: 'IterableList' object has no attribute 'master'

Here is the line causing the issue:

macaron/tests/repo_finder/test_commit_finder.py

Line 120 in 744335d

tree = git_obj.repo.heads.master.commit.tree

.

To reproduce:

• Add the following to your ~/.gitconfig file:

[init]
    defaultBranch = main

• Remove the mock repository used in the test:

rm -rf ./tests/repo_finder/mock_repos/commit_finder/sample_repo

• Re-run the test.

As I have mentioned in the initial PR description, this is not an uncommon config, especially since it is in line with GitHub's default branch naming practice. On the other hand, I don't see why we don't want to explicitly initiate the test repo under the exact condition that the test relies on.

[tromai]

I had a look at the initial-branch option for git init here. It is mentioned that the default branch name master is subject to change in the future. Therefore, I think it makes sense not to assume that the default branch for a newly initiated repository is always master.
And I agree that we need to ensure the environment is as expected before the test is run.

[tromai]

Thanks for the changes. I have requested some changes on the documentation of the initiate_repo method.

[tromai]

Thanks for the changes. LGTM.