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

Delete BigDiffTest #723

Merged
merged 1 commit into from
Mar 23, 2024
Merged

Delete BigDiffTest #723

merged 1 commit into from
Mar 23, 2024

Conversation

Marcono1234
Copy link
Contributor

Context

Resolves #483

This test was originally added to make sure the git process does not hang in case it writes a lot of output to the output streams.

To check this behavior, the test created 100.000 (!) files each a few KBs large and then invoked the plugin, hoping that git would produce enough output.
However, this puts a lot of pressure on the file system and disk due to the large number of files. For GitHub CI whose runners are probably using SSDs, this test alone took more than 50% of the time of the complete Maven build. And when running the test with an HDD the test could easily take minutes.

git-commit-id/git-commit-id-plugin-core#101 has added a dedicated and more reliable test which makes sure that the process output is properly consumed, so there is probably no need for this BigDiffTest anymore, especially due to the downsides mentioned above.

Contributor Checklist

  • Added relevant integration or unit tests to verify the changes
  • Update the Readme or any other documentation (including relevant Javadoc)
  • Ensured that tests pass locally: mvn clean package
  • Ensured that the code meets the current checkstyle coding style definition: mvn clean verify -Pcheckstyle -Dmaven.test.skip=true -B

This test was originally added to make sure the `git` process does not hang
in case it writes a lot of output to the output streams.

To check this behavior, the test created 100.000 (!) files each a few KBs
large and then invoked the plugin, hoping that `git` would produce enough
output.
However, this puts a lot of pressure on the file system and disk due to
the large number of files.
For GitHub CI whose runners are probably using SSDs, this test alone
took more than 50% of the time of the complete Maven build. And when
running the test with an HDD the test could easily take minutes.

git-commit-id/git-commit-id-plugin-core#101
has added a dedicated and more reliable test which makes sure that the
process output is properly consumed, so there is probably no need for this
`BigDiffTest` anymore, especially due to the downsides mentioned above.
@TheSnoozer
Copy link
Collaborator

Mhh, ok why not. Thanks for the contribution!

@TheSnoozer TheSnoozer merged commit a36b76a into git-commit-id:master Mar 23, 2024
21 checks passed
@TheSnoozer TheSnoozer added this to the next milestone Mar 23, 2024
@Marcono1234 Marcono1234 deleted the delete-BigDiffTest branch March 24, 2024 11:58
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.

Improve BigDiffTest
2 participants