Gradual naming convention enforcement. #1743
Open
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
mikemccand
reviewed
Aug 12, 2020
| private void dumpSuiteNamesOnly(String suiteName) throws IOException { | ||
| // Has to be a global unique path (not a temp file because temp files | ||
| // are different for each JVM). | ||
| Path temporaryFile = Paths.get("c:\\_tmp\\test-naming-exceptions.txt"); |
There was a problem hiding this comment.
Hmm this is effectively a // nocommit right? I.e. we must find the right place for this to live in the sources?
There was a problem hiding this comment.
Mike, this patch was just to show how it can be done. And this method only collects test cases for exclusion - it's not used and could be removed since in theory we'd only want to take away from once-generated exceptions file. I left it to show how I collected the list in the first place.
| if (!ALLOWED_CONVENTION.matcher(suiteName).matches()) { | ||
| // if this class exists on the exception list, leave it. | ||
| if (!exceptions.contains("!" + suiteName)) { | ||
| throw new AssertionError("Suite must follow Test*.java naming convention: " |
There was a problem hiding this comment.
Hmm shouldn't it say *Test.java naming convention?
There was a problem hiding this comment.
Again - this was just to show how it can be done; I used prefix convention because it was mentioned on the list, that's it.
|
Another few, not sure if these also fail on mainline (though prolly we have seed shifting?): and this exciting one: This is an interesting failure, but does not repro on two tries: Also does not repro, but looks very exciting: |
|
Ugh sorry wrong PR! |
|
@mikemccand I opened #1751 for one of the failures and fixed the cloning issue in main line. I can't reproduce any of the other issues |
cpoerschke
reviewed
Sep 4, 2020
lucene/test-framework/src/java/org/apache/lucene/util/VerifyTestClassNamingConvention.java
Show resolved
Hide resolved
| @@ -613,6 +613,7 @@ public static TestRuleIgnoreAfterMaxFailures replaceMaxFailureRule(TestRuleIgnor | |||
| RuleChain r = RuleChain.outerRule(new TestRuleIgnoreTestSuites()) | |||
| .around(ignoreAfterMaxFailures) | |||
| .around(suiteFailureMarker = new TestRuleMarkFailure()) | |||
| .around(new VerifyTestClassNamingConvention()) | |||
There was a problem hiding this comment.
question: would this convention automatically and always apply to all classes derived from LuceneTestCase including any non-org.apache name spaces or would it be possible to opt-out (without an exclusion list) somehow for custom code that might perhaps have chosen a different convention?
There was a problem hiding this comment.
This is just code, anything can be changed... In the example I wrote it can't be turned off.
…st' resolution changes (apache#1745 apache#1790 apache#1890 apache#2032)
…he exception list, disallow TestFooBar.java addition
Resolved Conflicts: lucene/test-framework/src/java/org/apache/lucene/util/LuceneTestCase.java
This reverts commit 095d7aa.
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.
LUCENE-8626. Here's how you can do it in a progressive, incremental way: make an exception list for existing suites not following the convention, but enforce it on anything new.