Skip to content

MINOR: fix e2e docs for test that cannot be run directly#20145

Merged
chia7712 merged 2 commits intoapache:trunkfrom
Yunyung:MINOR-fix-e2e-docs-unrunnable-test
Jul 30, 2025
Merged

MINOR: fix e2e docs for test that cannot be run directly#20145
chia7712 merged 2 commits intoapache:trunkfrom
Yunyung:MINOR-fix-e2e-docs-unrunnable-test

Conversation

@Yunyung
Copy link
Copy Markdown
Collaborator

@Yunyung Yunyung commented Jul 10, 2025

tests/kafkatest/services/console_consumer.py cannot be run directly.
The correct way is to run
tests/kafkatest/sanity_checks/test_console_consumer.py.

Reviewers: Chia-Ping Tsai chia7712@gmail.com

@github-actions github-actions Bot added triage PRs from the community docs tests Test fixes (including flaky tests) small Small PRs labels Jul 10, 2025
@Yunyung
Copy link
Copy Markdown
Collaborator Author

Yunyung commented Jul 10, 2025

Many assume that the files under tests/kafkatest/services can be run directly, but this is not the case. We should consider adding a note to clarify this.

@Yunyung Yunyung changed the title MINOR: fix e2e docs for unrunnable test MINOR: fix e2e docs for test that cannot be run directly Jul 10, 2025
@Yunyung Yunyung changed the title MINOR: fix e2e docs for test that cannot be run directly MINOR: fix e2e docs for the test that cannot be run directly Jul 10, 2025
@Yunyung Yunyung changed the title MINOR: fix e2e docs for the test that cannot be run directly MINOR: fix e2e docs for test that cannot be run directly Jul 10, 2025
@github-actions
Copy link
Copy Markdown

A label of 'needs-attention' was automatically added to this PR in order to raise the
attention of the committers. Once this issue has been triaged, the triage label
should be removed to prevent this automation from happening again.

@chia7712
Copy link
Copy Markdown
Member

@Yunyung the example of section Run a specific test method with specific parameters is also broken. Could you please fix it in this PR?

@github-actions github-actions Bot removed needs-attention triage PRs from the community labels Jul 23, 2025
@Yunyung
Copy link
Copy Markdown
Collaborator Author

Yunyung commented Jul 25, 2025

@Yunyung the example of section Run a specific test method with specific parameters is also broken. Could you please fix it in this PR?

Thanks for checking. Done.
I saw the method was changed in #12122, so I updated it accordingly.

@chia7712 chia7712 merged commit 4c1b798 into apache:trunk Jul 30, 2025
17 of 20 checks passed
airlock-confluentinc Bot pushed a commit to confluentinc/kafka that referenced this pull request Aug 6, 2025
`tests/kafkatest/services/console_consumer.py` cannot be run directly.
The correct way is to run
`tests/kafkatest/sanity_checks/test_console_consumer.py`.

Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
k-apol pushed a commit to k-apol/kafka that referenced this pull request Aug 8, 2025
`tests/kafkatest/services/console_consumer.py` cannot be run directly.
The correct way is to run
`tests/kafkatest/sanity_checks/test_console_consumer.py`.

Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs small Small PRs tests Test fixes (including flaky tests)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants