pytest-gitconfig 0.2.0

Provide a gitconfig sandbox for testing

pytest-gitconfig

Provide a gitconfig sandbox for testing

Getting started

Install pytest-gitconfig:

# pip
pip install pytest-gitconfig
# pipenv
pipenv install pytest-gitconfig
# PDM
pdm add pytest-gitconfig

Provided fixtures

All fixtures are session-scoped.

gitconfig -> GitConfig

This is the main fixture which is creating a new and clean git config file for the test session.

By default, it will set 3 settings:

• user.name
• user.email
• init.defaultBranch

The fixture when required provide a GitConfig object with the following methods:

• gitconfig.set() accepting either a dict with the parsed data sections or key-values with dotted key names.
• gitconfig.get() to get a setting given its dotted key.

git_user_name -> str

Provide the initial user.name setting. By default gitconfig.DEFAULT_GIT_USER_NAME. Override to provide a different initial value.

git_user_email -> str

Provide the initial user.email setting. By default gitconfig.DEFAULT_GIT_USER_EMAIL. Override to provide a different initial value.

git_init_default_branch -> str

Provide the initial init.defaultBranch setting. By default gitconfig.DEFAULT_GIT_BRANCH (main). Override to provide a different initial value.

sessionpatch -> pytest.MonkeyPatch

A pytest.MonkeyPatch session instance.