Skip to content

Commit 164cdd9

Browse files
committed
fix: update Readme file based on review comments
Signed-off-by: Debarati Basu-Nag <dbasunag@redhat.com>
1 parent 0bf4b46 commit 164cdd9

File tree

7 files changed

+41
-63
lines changed

7 files changed

+41
-63
lines changed

tests/cluster_health/README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,18 @@ Tests use the following markers defined in `pytest.ini`:
3939
### Run All Cluster Health Tests
4040

4141
```bash
42-
pytest tests/cluster_health/
42+
uv run pytest tests/cluster_health/
4343
```
4444

4545
### Run by Marker
4646

4747
```bash
4848
# Run cluster node health tests
49-
pytest -m cluster_health
49+
uv run pytest -m cluster_health
5050

5151
# Run operator health tests
52-
pytest -m operator_health
52+
uv run pytest -m operator_health
5353

5454
# Run both
55-
pytest -m "cluster_health or operator_health"
55+
uv run pytest -m "cluster_health or operator_health"
5656
```
57-
58-
## Additional Resources
59-
60-
- [OpenDataHub Documentation](https://opendatahub.io/docs)
61-
- [OpenShift AI Documentation](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed)

tests/fixtures/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,3 @@ def test_with_vector_db(vector_io_provider_deployment_config_factory):
7272
## Adding New Fixtures
7373

7474
When adding shared fixtures, place them in the appropriate module file (or create a new one), and register the new module in `/tests/conftest.py` under `pytest_plugins`. Follow the project's fixture conventions: use noun-based names, narrowest appropriate scope, and context managers for resource lifecycle.
75-
76-
## Additional Resources
77-
78-
- [OpenDataHub Documentation](https://opendatahub.io/docs)
79-
- [OpenShift AI Documentation](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed)

tests/llama_stack/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,23 +88,23 @@ LLS_FILES_S3_AUTO_CREATE_BUCKET=true # Optional
8888
To run all tests in the `/tests/llama_stack` directory:
8989

9090
```bash
91-
pytest tests/llama_stack/
91+
uv run pytest tests/llama_stack/
9292
```
9393

9494
### Run Tests by Component/Team
9595

9696
To run tests for a specific team (e.g. rag):
9797

9898
```bash
99-
pytest -m rag tests/llama_stack/
99+
uv run pytest -m rag tests/llama_stack/
100100
```
101101

102102
### Run Tests for a llama-stack API
103103

104104
To run tests for a specific API (e.g., vector_io):
105105

106106
```bash
107-
pytest tests/llama_stack/vector_io
107+
uv run pytest tests/llama_stack/vector_io
108108
```
109109

110110
### Run Tests with Additional Markers
@@ -113,10 +113,10 @@ You can combine team markers with other pytest markers:
113113

114114
```bash
115115
# Run only smoke tests for rag
116-
pytest -m "rag and smoke" tests/llama_stack/
116+
uv run pytest -m "rag and smoke" tests/llama_stack/
117117

118118
# Run all rag tests except the ones requiring a GPU
119-
pytest -m "rag and not gpu" tests/llama_stack/
119+
uv run pytest -m "rag and not gpu" tests/llama_stack/
120120
```
121121

122122
## Related Testing Repositories
@@ -145,5 +145,3 @@ For information about the APIs and Providers available in the Red Hat LlamaStack
145145
## Additional Resources
146146

147147
- [Llama Stack Documentation](https://llamastack.github.io/docs/)
148-
- [OpenDataHub Documentation](https://opendatahub.io/docs)
149-
- [OpenShift AI Documentation](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed)

tests/model_explainability/README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,40 +86,38 @@ model_explainability/
8686
### Run All Model Explainability Tests
8787

8888
```bash
89-
pytest tests/model_explainability/
89+
uv run pytest tests/model_explainability/
9090
```
9191

9292
### Run Tests by Component
9393

9494
```bash
9595
# Run TrustyAI Service tests
96-
pytest tests/model_explainability/trustyai_service/
96+
uv run pytest tests/model_explainability/trustyai_service/
9797

9898
# Run Guardrails tests
99-
pytest tests/model_explainability/guardrails/
99+
uv run pytest tests/model_explainability/guardrails/
100100

101101
# Run LM Eval tests
102-
pytest tests/model_explainability/lm_eval/
102+
uv run pytest tests/model_explainability/lm_eval/
103103

104104
# Run EvalHub tests
105-
pytest tests/model_explainability/evalhub/
105+
uv run pytest tests/model_explainability/evalhub/
106106
```
107107

108108
### Run Tests with Markers
109109

110110
```bash
111111
# Run only smoke tests
112-
pytest -m "model_explainability and smoke" tests/model_explainability/
112+
uv run pytest -m "model_explainability and smoke" tests/model_explainability/
113113

114114
# Run drift detection tests
115-
pytest tests/model_explainability/trustyai_service/drift/
115+
uv run pytest tests/model_explainability/trustyai_service/drift/
116116

117117
# Run fairness tests
118-
pytest tests/model_explainability/trustyai_service/fairness/
118+
uv run pytest tests/model_explainability/trustyai_service/fairness/
119119
```
120120

121121
## Additional Resources
122122

123123
- [TrustyAI Documentation](https://github.com/trustyai-explainability)
124-
- [OpenDataHub Documentation](https://opendatahub.io/docs)
125-
- [OpenShift AI Documentation](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed)

tests/model_registry/README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ model_registry/
6161
@pytest.mark.smoke # Critical smoke tests
6262
@pytest.mark.tier1 # Tier 1 tests
6363
@pytest.mark.tier2 # Tier 2 tests
64+
@pytest.mark.tier3 # Tier 3 tests, includes negative tests
6465
@pytest.mark.custom_namespace # Custom namespace tests
6566
@pytest.mark.component_health # Component health checks
6667
@pytest.mark.skip_on_disconnected # Requires internet connectivity
@@ -85,40 +86,38 @@ Tests are parametrized across multiple database backends:
8586
### Run All Model Registry Tests
8687

8788
```bash
88-
pytest tests/model_registry/
89+
uv run pytest tests/model_registry/
8990
```
9091

9192
### Run Tests by Component
9293

9394
```bash
9495
# Run core registry tests
95-
pytest tests/model_registry/model_registry/
96+
uv run pytest tests/model_registry/model_registry/
9697

9798
# Run catalog tests
98-
pytest tests/model_registry/model_catalog/
99+
uv run pytest tests/model_registry/model_catalog/
99100

100101
# Run MCP server tests
101-
pytest tests/model_registry/mcp_servers/
102+
uv run pytest tests/model_registry/mcp_servers/
102103

103104
# Run HuggingFace integration tests
104-
pytest tests/model_registry/model_catalog/huggingface/
105+
uv run pytest tests/model_registry/model_catalog/huggingface/
105106
```
106107

107108
### Run Tests with Markers
108109

109110
```bash
110111
# Run smoke tests
111-
pytest -m smoke tests/model_registry/
112+
uv run pytest -m smoke tests/model_registry/
112113

113114
# Run RBAC tests
114-
pytest tests/model_registry/model_registry/rbac/
115+
uv run pytest tests/model_registry/model_registry/rbac/
115116

116117
# Run upgrade tests
117-
pytest -m pre_upgrade tests/model_registry/
118+
uv run pytest -m pre_upgrade tests/model_registry/
118119
```
119120

120121
## Additional Resources
121122

122123
- [Model Registry Documentation](https://github.com/kubeflow/model-registry)
123-
- [OpenDataHub Documentation](https://opendatahub.io/docs)
124-
- [OpenShift AI Documentation](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed)

tests/model_serving/README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -112,42 +112,42 @@ model_serving/
112112
### Run All Model Serving Tests
113113

114114
```bash
115-
pytest tests/model_serving/
115+
uv run pytest tests/model_serving/
116116
```
117117

118118
### Run Tests by Component
119119

120120
```bash
121121
# Run vLLM runtime tests
122-
pytest tests/model_serving/model_runtime/vllm/
122+
uv run pytest tests/model_serving/model_runtime/vllm/
123123

124124
# Run OpenVINO tests
125-
pytest tests/model_serving/model_runtime/openvino/
125+
uv run pytest tests/model_serving/model_runtime/openvino/
126126

127127
# Run KServe platform tests
128-
pytest tests/model_serving/model_server/kserve/
128+
uv run pytest tests/model_serving/model_server/kserve/
129129

130130
# Run MaaS billing tests
131-
pytest tests/model_serving/maas_billing/
131+
uv run pytest tests/model_serving/maas_billing/
132132

133133
# Run LLMD tests
134-
pytest tests/model_serving/model_server/llmd/
134+
uv run pytest tests/model_serving/model_server/llmd/
135135
```
136136

137137
### Run Tests with Markers
138138

139139
```bash
140140
# Run smoke tests
141-
pytest -m smoke tests/model_serving/
141+
uv run pytest -m smoke tests/model_serving/
142142

143143
# Run GPU tests only
144-
pytest -m gpu tests/model_serving/
144+
uv run pytest -m gpu tests/model_serving/
145145

146146
# Run raw deployment tests
147-
pytest -m rawdeployment tests/model_serving/
147+
uv run pytest -m rawdeployment tests/model_serving/
148148

149149
# Run tests excluding GPU
150-
pytest -m "not gpu" tests/model_serving/
150+
uv run pytest -m "not gpu" tests/model_serving/
151151
```
152152

153153
## Additional Resources
@@ -156,5 +156,3 @@ pytest -m "not gpu" tests/model_serving/
156156
- [vLLM Documentation](https://docs.vllm.ai/)
157157
- [OpenVINO Documentation](https://docs.openvino.ai/)
158158
- [Triton Inference Server](https://github.com/triton-inference-server/server)
159-
- [OpenDataHub Documentation](https://opendatahub.io/docs)
160-
- [OpenShift AI Documentation](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed)

tests/workbenches/README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,34 +33,29 @@ workbenches/
3333
### Run All Workbenches Tests
3434

3535
```bash
36-
pytest tests/workbenches/
36+
uv run pytest tests/workbenches/
3737
```
3838

3939
### Run Tests by Component
4040

4141
```bash
4242
# Run ImageStream health tests
43-
pytest tests/workbenches/test_imagestream_health.py
43+
uv run pytest tests/workbenches/test_imagestream_health.py
4444

4545
# Run notebook spawning tests
46-
pytest tests/workbenches/notebook-controller/test_spawning.py
46+
uv run pytest tests/workbenches/notebook-controller/test_spawning.py
4747

4848
# Run custom image validation tests
49-
pytest tests/workbenches/notebook-controller/test_custom_images.py
49+
uv run pytest tests/workbenches/notebook-controller/test_custom_images.py
5050
```
5151

5252
### Run Tests with Markers
5353

5454
```bash
5555
# Run smoke tests only
56-
pytest -m smoke tests/workbenches/
57-
58-
# Run all except slow tests
59-
pytest -m "not slow" tests/workbenches/
56+
uv run pytest -m smoke tests/workbenches/
6057
```
6158

6259
## Additional Resources
6360

6461
- [Kubeflow Notebook Controller](https://github.com/kubeflow/kubeflow/tree/master/components/notebook-controller)
65-
- [OpenDataHub Documentation](https://opendatahub.io/docs)
66-
- [OpenShift AI Documentation](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed)

0 commit comments

Comments
 (0)