Skip to content

test(git): ensures that global git user settings are not interfering with the tests #638

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

Merged
merged 1 commit into from
Dec 19, 2022
Merged

test(git): ensures that global git user settings are not interfering with the tests #638

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
23 changes: 15 additions & 8 deletions tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
import os
import re
import tempfile
from pathlib import Path

import pytest

from commitizen import cmd, defaults
from commitizen.config import BaseConfig

SIGNER = "GitHub Action"
SIGNER_MAIL = "action@github.com"


@pytest.fixture(autouse=True)
def git_sandbox(monkeypatch: pytest.MonkeyPatch, tmp_path: Path):
"""Ensure git commands are executed without the current user settings"""
monkeypatch.setenv("GIT_CONFIG_GLOBAL", str(tmp_path / "gitconfig"))
cmd.run(f"git config --global user.name {SIGNER}")
cmd.run(f"git config --global user.email {SIGNER_MAIL}")


@pytest.fixture(scope="function")
def tmp_git_project(tmpdir):
Expand Down Expand Up @@ -36,9 +48,6 @@ def _get_gpg_keyid(signer_mail):

@pytest.fixture(scope="function")
def tmp_commitizen_project_with_gpg(tmp_commitizen_project):
signer = "GitHub Action"
signer_mail = "action@github.com"

# create a temporary GPGHOME to store a temporary keyring.
# Home path must be less than 104 characters
gpg_home = tempfile.TemporaryDirectory(suffix="_cz")
Expand All @@ -47,17 +56,15 @@ def tmp_commitizen_project_with_gpg(tmp_commitizen_project):

# create a key (a keyring will be generated within GPUPGHOME)
c = cmd.run(
f"gpg --batch --yes --debug-quick-random --passphrase '' --quick-gen-key '{signer} {signer_mail}'"
f"gpg --batch --yes --debug-quick-random --passphrase '' --quick-gen-key '{SIGNER} {SIGNER_MAIL}'"
)
if c.return_code != 0:
raise Exception(f"gpg keygen failed with err: '{c.err}'")
key_id = _get_gpg_keyid(signer_mail)
key_id = _get_gpg_keyid(SIGNER_MAIL)
assert key_id

# configure git
# configure git to use gpg signing
cmd.run("git config commit.gpgsign true")
cmd.run(f"git config user.name {signer}")
cmd.run(f"git config user.email {signer_mail}")
cmd.run(f"git config user.signingkey {key_id}")

yield tmp_commitizen_project
Expand Down