Hi Derek, yes, the regexp is ^(?!(?:Test))(?!.*?(?:Tests)).*$
What we are trying to achieve by that is to have a test which ends on "Test" and nothing else and it may contain "Test" only in case it does not start with it. To your second paragraph, I do not think we have any *Base files which are tests (that would be a bug) nor they are standalone (not inherited). By first approach, TestBaseImpl (which we do have) would start to be invalid, we would have to rename it to "DistributedTestBaseImpl" because it was starting on "Test" which is no-no. I agree that "TestBaseImpl" is rather unfortunate name. Currently, TestBaseImpl itself extends "DistributedTestBase" so in the end we would have "DistributedTestBaseImpl -> TestBaseImpl -> DistributedTestBase". Please keep in mind that "DistributedTestBase" is located in dtest jar (separate project) and that is rather inconvenient to rename. Regards ________________________________________ From: Derek Chen-Becker <de...@chen-becker.org> Sent: Monday, October 24, 2022 15:09 To: dev@cassandra.apache.org Subject: Re: Some tests are never executed in CI due to their name NetApp Security WARNING: This is an external email. Do not click links or open attachments unless you recognize the sender and know the content is safe. For clarity, what is the final regex you've landed on for the first approach? Is it "^(?!(?:Test))(?!.*?(?:Tests)).*$" ? Are we just trying to reject anything that *starts* with "Test" or contains "Tests" somewhere in the name? It might be more clear to state what we think a valid test name should be, not in regex form. When it comes to "TestBase" files, are there any of these that are actually intended to be run as a test? The "Base" would indicate to me that it's intended to be inherited, not run directly. Do we have some "TestBase" classes somewhere that aren't inherited and are meant to be run directly, because that definitely seems like a misleading name that should be fixed, invasive or not. I would lean toward the principle of least surprise here, even if it means an involved one-time cleanup. Cheers, Derek On Mon, Oct 24, 2022 at 3:02 AM Miklosovic, Stefan <stefan.mikloso...@netapp.com<mailto:stefan.mikloso...@netapp.com>> wrote: Hi list, it was reported that some tests are not executed as part of CI because of their name (1). There is (2) and (3) so right now it runs only "*Test.java" files. Except of us renaming the affected classes, we should fix this in a more robust way - via checkstyle - so we enforce how test files have to be called. We came up with two approaches and we do not know which one to choose so we want to gather more feedback / opinions. The first approach would make this happen (implemented here (4)) class name - passes / fails the checkstyle TestIt - fails TestsThatFeature - fails ThisTestsMyFeature - fails SomeTests - fails SomeHelperClassForTesting - passes SomeTest - passes DistributedTestBase - passes MyTestSplit1 - passes We would fix "SplitN" test files by hand (I think they are not executed right now in CI either) to something like MySplit1Test and MySplit2Test but the regexp we would eventually use would not prevent this from happening in the future. I do not know how to construct such a complex regexp yet which would cover all cases above plus this splitting one. Feel free to look into the ticket where details are discussed. The second approach would forbid to have any occurrence of "test" in the file name but at the end. For example, it would fail on classes like these MyTestSplit1 TestHelper BurnTestUtil FuzzTestBase DistributedTestSnitch CASCommonTestCases ServerTestUtils AuthTestUtils TestMemtable While this would also fix "MyTestSplitN" cases, I consider this to be way more invasive to the current codebase because we would have to rename a lot of files (like, hundreds, plus a lot of places they are referenced / used at) and I do not even think this is necessary and desirable. Like, how would we call "FuzzTestBase" to not contain "Test" in it? I think having "test" string in the middle is just fine, specifically for helper classes. One possible fix would be to replace "Test" with "Tester" so we would have "TesterMemtable", "AuthTesterUtils", "TesterHelper", "DistributedTesterSnitch" ... Word "Tester" would be explicitly allowed. I personally lean to the first approach even though cases like "MyTestSplit1" will not be spotted in compile time, but hey, we still do have a review process on top of this. The obvious violations like "TestThisFeature" and "MySuperTests" would be evaluated as violations which I would argue happens the most often. Please keep in mind that we have checkstyle only in 4.1 and trunk. So, while we would fix names of classes in all branches we support so they are picked up by CI, checkstyle for this would be introduced in 4.1 and trunk only. (1) https://issues.apache.org/jira/browse/CASSANDRA-17964 (2) https://github.com/apache/cassandra/blob/trunk/build.xml#L61 (3) https://github.com/apache/cassandra/blob/trunk/build.xml#L1033 (4) https://github.com/instaclustr/cassandra/commits/CASSANDRA-17964-4.1-2 -- +---------------------------------------------------------------+ | Derek Chen-Becker | | GPG Key available at https://keybase.io/dchenbecker and | | https://pgp.mit.edu/pks/lookup?search=derek%40chen-becker.org | | Fngrprnt: EB8A 6480 F0A3 C8EB C1E7 7F42 AFC5 AFEE 96E4 6ACC | +---------------------------------------------------------------+
