Ashwin Pankaj created KAFKA-20779:
-------------------------------------
Summary: followup review on the merged KIP-1265 PR
[https://github.com/apache/kafka/pull/21337]
Key: KAFKA-20779
URL: https://issues.apache.org/jira/browse/KAFKA-20779
Project: Kafka
Issue Type: Bug
Reporter: Ashwin Pankaj
Assignee: Ashwin Pankaj
Follow-up nits from [~chia7712]'s review on the merged KIP-1265 PR
[https://github.com/apache/kafka/pull/21337]. None affects checker behaviour;
grouped as a single small PR to keep review overhead low.
h3. Changes
* {{PublicApiViolation.equals}}: replace the ternary null-check on
{{memberName}}
with {{Objects.equals(memberName, that.memberName)}}.
* {{CascadeValidator.asSuppression}}: omit the {{#member}} portion when the
finding has no {{memberName}}. Class-scope {{INVALID_SUPERTYPE}}
suppressions
currently render as {{Suppressed INVALID_SUPERTYPE in
org.apache.kafka.clients.consumer.CooperativeStickyAssignor#null}}; after
the
fix they render as {{...CooperativeStickyAssignor}}.
* {{KafkaInternalApiCheckerMojo}}: add doc comments and {{@param}} tags to the
class default constructor and the six setters so
{{:api-checker:maven-plugin:javadoc}} is warning-free (chia7712 quoted 7
warnings on the PR).
* {{api-checker/build.gradle}}: add {{testLogging \{ events "passed",
"skipped",
"failed" \}}} to the shared subprojects test config for consistency with the
rest of the Kafka build.
* Root {{build.gradle}}: extend the root {{check}} task to depend on the
composite-included api-checker's {{:core:check}}, {{:gradle-plugins:check}},
and {{:maven-plugin:check}}. The {{.github/workflows/build.yml}} PR job runs
{{./gradlew check}}, so this wires the api-checker's checkstyle + unit tests
(including {{PluginXmlParityTest}}) into the standard PR workflow. Closes
the
reviewer's "Have we integrated this module into our CI?" question.
* {{api-checker/README.md}}: document {{:maven-plugin:test}} and
{{PluginXmlParityTest}}; update the layout tree to show the test folder;
rewrite the "CI integration" section to reflect the new wiring.
h3. Verification
* {{./gradlew check -x test}} — clean end-to-end in 7m 38s; all 13 api-checker
verification tasks appear in the task plan and pass.
* {{./gradlew :api-checker:maven-plugin:javadoc}} — zero warnings.
* {{./gradlew check --dry-run}} confirms {{:api-checker:*:check}} /
{{:test}} / {{:checkstyle*}} now show up under root {{check}}.
h3. Related
* Parent KIP: KAFKA-20032 (KIP-1265)
* Original PR: [https://github.com/apache/kafka/pull/21337]
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
