Skip to content
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.

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

Issue/improve unit testing setup #1090

Merged

Conversation

onefloid
Copy link
Contributor

@onefloid onefloid commented Apr 4, 2024

Description

To run the unit tests, you need to customize Tests/config.ini. Since this file is versioned with Git, it ends up in a unclean working directory with changes you don't want to commit. I suggest including only a template file in the repository Tests/config.ini.template

Changes

This pull request includes:

  • Introducing the Tests/config.ini.template file and adding Tests/config.ini to .gitignore
  • Updated the documentation on how to create the file config.ini.
  • Updated the documentation on how to run the test from the command line

Does it include Breaking Changes?

This PR shouldn't break anything as long as nobody relies on the currently saved config.ini If so, it would be very bad pratice
For people who have overwritten the config.ini locally, a git pull would fail as long as the working directory includes the modified config.ini

@MariusWirtz
Copy link
Collaborator

Nice contribution. I agree with your ideas re the config.ini

Thank you @onefloid.

@MariusWirtz MariusWirtz merged commit 05adfd6 into cubewise-code:master Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants