[
https://issues.apache.org/jira/browse/KNOX-3394?focusedWorklogId=1031962&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-1031962
]
ASF GitHub Bot logged work on KNOX-3394:
----------------------------------------
Author: ASF GitHub Bot
Created on: 24/Jul/26 05:57
Start Date: 24/Jul/26 05:57
Worklog Time Spent: 10m
Work Description: Raghav-Mah3shwari opened a new pull request, #1324:
URL: https://github.com/apache/knox/pull/1324
…integration test README
Here's a filled PR description you can paste:
---
**[KNOX-3394](https://issues.apache.org/jira/browse/KNOX-3394)** - Correct
outdated unittest documentation in Docker Compose integration test README
## What changes were proposed in this pull request?
This PR updates `.github/workflows/tests/README.md` so contributor
documentation matches how Docker Compose integration tests actually run in CI
and locally.
Changes include:
- Document **pytest** as the test runner instead of `unittest`
- Replace the unittest-based example with pytest-style test functions and
`assert` statements
- Note that existing `unittest.TestCase` tests remain supported by pytest
- Update subdirectory discovery guidance for pytest (recursive discovery;
`__init__.py` optional)
- Correct the "How It Works" section to describe the real CI behavior:
`pytest` with single-EKU suites excluded and run separately by the workflow
No test code or workflow behavior is changed—documentation only.
## How was this patch tested?
Documentation-only change; no runtime behavior was modified.
Verification:
1. Reviewed `.github/workflows/compose/docker-compose.yml` and confirmed the
`tests` service runs `pytest` (not `python -m unittest discover`)
2. Reviewed `.github/workflows/tests.yml` and confirmed single-EKU suites
are run in separate workflow steps
3. Compared README examples against existing tests in
`.github/workflows/tests/` (e.g. `unittest.TestCase` classes still valid under
pytest)
4. Manually proofread the updated README for accuracy and consistency
## Integration Tests
No new or updated integration tests are required. This change only updates
contributor documentation; it does not modify test logic, Compose
configuration, or CI workflows.
## UI changes
N/A — documentation-only change.
Issue Time Tracking
-------------------
Worklog Id: (was: 1031962)
Remaining Estimate: 0h
Time Spent: 10m
> Correct outdated unittest documentation in Docker Compose integration test
> README
> ---------------------------------------------------------------------------------
>
> Key: KNOX-3394
> URL: https://issues.apache.org/jira/browse/KNOX-3394
> Project: Apache Knox
> Issue Type: Improvement
> Reporter: Raghav Maheshwari
> Priority: Major
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Update {{.github/workflows/tests/README.md}} to document pytest as the test
> runner used by CI and local Docker Compose, replace unittest-based examples
> with pytest-style examples, and clarify test discovery and single-EKU suite
> exclusions.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
