TESTING.asciidoc fix examples using forbidden annotation #34515
Conversation
Clean up examples not to use forbidden test annotation `@Nightly`.
TESTING.asciidoc
Outdated
| @@ -91,23 +91,22 @@ Run any test methods that contain 'esi' (like: ...r*esi*ze...). | |||
|
|
|||
| You can also filter tests by certain annotations ie: | |||
|
|
|||
| * `@Nightly` - tests that only run in nightly builds (disabled by default) | |||
| * `@Backwards` - backwards compatibility tests (disabled by default) | |||
There was a problem hiding this comment.
We don't actually use @Backwards or @BadApple either! At this point we really only use @AwaitsFix I think.
There was a problem hiding this comment.
I left the @BadApple and @Backwards so that the filtering examples with more complicated boolean operators and grouping are valid. But you are right, as only @AwaitsFix is still used, the other annotations should be removed as well.
I was thinking to remove the @Backwards separately as there is also a section using the backwards filtering which I guess is outdated: https://github.com/elastic/elasticsearch/blob/ad26075e989de81df61ec9f2eabce2bbc00a4896/TESTING.asciidoc#backwards-compatibility-tests
and should be replaced by:
https://github.com/elastic/elasticsearch/blob/ad26075e989de81df61ec9f2eabce2bbc00a4896/TESTING.asciidoc#testing-backwards-compatibility
I simply did not want to mix it all together ;)
Just let me know if you prefer having the changes at the same PR or several dedicated ones ;)
There was a problem hiding this comment.
How would you feel about removing the complex filtering examples in this PR because, not that we really only have the one annotation, we really can only document the one filter and then doing a separate PR for @Backwards like you say?
colings86
added
>docs
|
Pinging @elastic/es-core-infra |
|
Thanks for bringing his up to date with the request changes @lipsill. Note that is it best to ping on the PR when you push changes, as not everyone follows all changes to PRs, but only comments. This LGTM @elasticmachine ok to test |
Clean up examples not to use forbidden test annotation `@Nightly`. remove references to unused annotations
* master: (24 commits) ingest: better support for conditionals with simulate?verbose (elastic#34155) [Rollup] Job deletion should be invoked on the allocated task (elastic#34574) [DOCS] .Security index is never auto created (elastic#34589) CCR: Requires soft-deletes on the follower (elastic#34725) re-enable bwc tests (elastic#34743) Empty GetAliases authorization fix (elastic#34444) INGEST: Document Processor Conditional (elastic#33388) [CCR] Add total fetch time leader stat (elastic#34577) SQL: Support pattern against compatible indices (elastic#34718) [CCR] Auto follow pattern APIs adjustments (elastic#34518) [Test] Remove dead code from ExceptionSerializationTests (elastic#34713) A small typo in migration-assistance doc (elastic#34704) ingest: processor stats (elastic#34724) SQL: Implement IN(value1, value2, ...) expression. (elastic#34581) Tests: Add checks to GeoDistanceQueryBuilderTests (elastic#34273) INGEST: Rename Pipeline Processor Param. (elastic#34733) Core: Move IndexNameExpressionResolver to java time (elastic#34507) [DOCS] Force Merge: clarify execution and storage requirements (elastic#33882) TESTING.asciidoc fix examples using forbidden annotation (elastic#34515) SQL: Implement `CONVERT`, an alternative to `CAST` (elastic#34660) ...
Clean up examples not to use forbidden test annotation `@Nightly`. remove references to unused annotations
@Nightlyhas been added to the forbidden test annotations :elasticsearch/buildSrc/src/main/resources/forbidden/es-test-signatures.txt
Line 24 in 237650e
guaranteeing that no tests can be annotated as
@Nightly.This PR removes any examples containing
@Nightly, so that contributors do not try to implement, filter or run nightly tests.