Throw GradleException if .git directory is missing #162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`GitPropertiesPluginTests#testGenerateWithMissingGitRepoShouldFail` incorrectly asserted that every exception would be a `RepositoryNotFoundException` while in reality the exception was about `Assert.fail()` not being imported and no such method could be found. While fixing the test, I learned that JGit wouldn't throw a `RepositoryNotFoundException` in every case but happily walk up the directory tree until it found a `.git` directory with `BaseRepositoryBuilder#findGitDir()` (see [1], [2]). Instead of relying on this behavior, `GenerateGitPropertiesTask#getGeneratedProperties()` will now throw a `GradleException` if `dotGitDirectory` is `null` to get the expected behavior. [1]: https://archive.eclipse.org/jgit/site/3.7.0.201502260915-r/org.eclipse.jgit/apidocs/org/eclipse/jgit/lib/BaseRepositoryBuilder.html#findGitDir() [2]: https://archive.eclipse.org/jgit/site/3.7.0.201502260915-r/org.eclipse.jgit/apidocs/org/eclipse/jgit/lib/BaseRepositoryBuilder.html#findGitDir(java.io.File)
|
The early access build of Java 17 ( |
|
Thanks. It looks great to me. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GitPropertiesPluginTests#testGenerateWithMissingGitRepoShouldFailincorrectly asserted that every exception would be aRepositoryNotFoundExceptionwhile in reality the thrown exception was aboutAssert.fail()not being imported and no such method could be found.While fixing the test, I learned that JGit wouldn't throw a
RepositoryNotFoundExceptionin every case but happily walk up the directory tree until it found a.gitdirectory starting from the current working directory withfindGitDir()(seeBaseRepositoryBuilder#findGitDir(),BaseRepositoryBuilder#findGitDir(java.io.File)).Instead of relying on this behavior,
GenerateGitPropertiesTask#getGeneratedProperties()will now throw aGradleExceptionifdotGitDirectoryisnullto get the expected behavior.As an alternative,
GitPropertiesPluginTests#testGenerateWithMissingGitRepoShouldFailcould be removed if the default behavior of JGit (walking up the directory tree until a.gitdirectory was found, starting from the current working directory) is the desired behavior.