Skip to content

MINOR: Improve IntegrationTestUtils documentation#5664

Merged
vahidhashemian merged 2 commits intoapache:trunkfrom
dongjinleekr:feature/integration-test-utils-javadoc
Jan 25, 2019
Merged

MINOR: Improve IntegrationTestUtils documentation#5664
vahidhashemian merged 2 commits intoapache:trunkfrom
dongjinleekr:feature/integration-test-utils-javadoc

Conversation

@dongjinleekr
Copy link
Copy Markdown
Contributor

While I was writing an example project on testing Kafka Streams, I found that there are several problems with the documentation of IntegrationTestUtils.

  • The documentation of Time parameter in produceKeyValuesSynchronously methods is missing. This parameter was added in commit de1b853, but documentation was omitted then.
  • Change parameter enableTransactions in produceKeyValuesSynchronouslyWithTimestamp(String, Collection, Properties, Headers headers, Long, boolean) into enableTransactions: for consistency with the other overloads.
  • Add Javadoc to undocumented methods, like produceKeyValuesSynchronouslyWithTimestamp, waitUntilMinRecordsReceived, etc.
  • Fix ordering: waitUntilMinRecordsReceived
  • Upper bound in ... -> Upper bound of ...

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

Copy link
Copy Markdown
Contributor

@vvcephei vvcephei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the cleanup @dongjinleekr !

This looks good to me.

@dongjinleekr
Copy link
Copy Markdown
Contributor Author

Is there anyone who can merge this PR into 2.1.0 release?

@dongjinleekr
Copy link
Copy Markdown
Contributor Author

@lindong28 Excuse me. Could this be included in 2.1.0?

@dongjinleekr dongjinleekr force-pushed the feature/integration-test-utils-javadoc branch from 59b506b to 1003515 Compare January 11, 2019 14:54
@dongjinleekr
Copy link
Copy Markdown
Contributor Author

Cc/ @cmccabe @ijuma @guozhangwang

…eters in methods. 3. Fix typo and method ordering.
@dongjinleekr dongjinleekr force-pushed the feature/integration-test-utils-javadoc branch from 1003515 to 6c13b37 Compare January 21, 2019 11:34
@dongjinleekr
Copy link
Copy Markdown
Contributor Author

@vahidhashemian Excuse me. Could have a look?

Copy link
Copy Markdown
Contributor

@vahidhashemian vahidhashemian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. Just one question inline.

Copy link
Copy Markdown
Contributor

@vvcephei vvcephei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @dongjinleekr ,

Sorry for the silence... I think the only controversial portion is the new test util method. Otherwise, this PR has my approval (for what it's worth).

Maybe @guozhangwang can take a look?

-John

…p(String, Collection<KeyValue<K, V>>, Properties, Headers, Long)
@dongjinleekr
Copy link
Copy Markdown
Contributor Author

@vvcephei @vahidhashemian Here it is. I removed the method.

@mjsax
Copy link
Copy Markdown
Member

mjsax commented Jan 24, 2019

@dongjinleekr Kafka 2.1.0 was release 4 month ago. We can get it into 2.2.0 thought. Also, it's only test code, so we could, if we want back port it to get it into 2.1.1 -- however, @cmccabe is cutting 2.1.1-rc0 soon, so it might not make it -- also not worth blocking 2.1.1 release for this.

Retest this please.

@cmccabe
Copy link
Copy Markdown
Contributor

cmccabe commented Jan 25, 2019

@mjsax: agreed.

@dongjinleekr
Copy link
Copy Markdown
Contributor Author

@mjsax @cmccabe No problem. Thanks for your comment!

Copy link
Copy Markdown
Contributor

@vahidhashemian vahidhashemian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for addressing the earlier comments.

@vahidhashemian vahidhashemian merged commit 64d6e56 into apache:trunk Jan 25, 2019
jarekr pushed a commit to confluentinc/kafka that referenced this pull request Apr 18, 2019
* ak/trunk:
  MINOR: Update usage of deprecated API (apache#6146)
  KAFKA-4217: Add KStream.flatTransform (apache#5273)
  MINOR: Update Gradle to 5.1.1 (apache#6160)
  KAFKA-3522: Generalize Segments (apache#6170)
  Added quotes around the class path (apache#4469)
  KAFKA-7837: Ensure offline partitions are picked up as soon as possible when shrinking ISR (apache#6202)
  MINOR: In the MetadataResponse schema, ignorable should be a boolean
  KAFKA-7838: Log leader and follower end offsets when shrinking ISR (apache#6168)
  KAFKA-5692: Change PreferredReplicaLeaderElectionCommand to use Admin… (apache#3848)
  MINOR: clarify why suppress can sometimes drop tombstones (apache#6195)
  MINOR: Upgrade ducktape to 0.7.5 (apache#6197)
  MINOR: Improve IntegrationTestUtils documentation (apache#5664)
  MINOR: upgrade to jdk8 8u202
  KAFKA-7693; Fix SequenceNumber overflow in producer (apache#5989)
  KAFKA-7692; Fix ProducerStateManager SequenceNumber overflow (apache#5990)
  MINOR: update copyright year in the NOTICE file. (apache#6196)
  KAFKA-7793: Improve the Trogdor command line. (apache#6133)
pengxiaolong pushed a commit to pengxiaolong/kafka that referenced this pull request Jun 14, 2019
* 1. Add Javadoc to undocumented methods. 2. Add documentation on  parameters in  methods. 3. Fix typo and method ordering.

* Remove IntegrationTestUtils#produceKeyValuesSynchronouslyWithTimestamp(String, Collection<KeyValue<K, V>>, Properties, Headers, Long)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants