Skip to content

Commit e74c62a

Browse files
committed
Update README with bin/ directory paths
- Updated all binary paths to use test/extended/tests-extension/bin/ - Added Makefile and bin/ directory to test module structure diagram - Clarified build output location in Makefile commands table - Updated all command examples to reference bin/ subdirectory
1 parent 19a46ad commit e74c62a

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

test/extended/tests-extension/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ They use the framework: https://github.com/openshift-eng/openshift-tests-extensi
1010
| Command | Description |
1111
|----------------------------------------------------------------------------|--------------------------------------------------------------------------|
1212
| `make tests-ext-build` | Builds the test extension binary. |
13-
| `test/extended/tests-extension/openshift-apiserver-tests-ext list` | Lists all available test cases. |
14-
| `test/extended/tests-extension/openshift-apiserver-tests-ext run-suite <suite-name>` | Runs a test suite. e.g., `openshift/openshift-apiserver/conformance/parallel` |
15-
| `test/extended/tests-extension/openshift-apiserver-tests-ext run <test-name>` | Runs one specific test. |
13+
| `test/extended/tests-extension/bin/openshift-apiserver-tests-ext list` | Lists all available test cases. |
14+
| `test/extended/tests-extension/bin/openshift-apiserver-tests-ext run-suite <suite-name>` | Runs a test suite. e.g., `openshift/openshift-apiserver/conformance/parallel` |
15+
| `test/extended/tests-extension/bin/openshift-apiserver-tests-ext run <test-name>` | Runs one specific test. |
1616

1717

1818
## How to Run the Tests Locally
@@ -22,7 +22,7 @@ Use the environment variable `KUBECONFIG` to point to your cluster configuration
2222

2323
```shell
2424
export KUBECONFIG=path/to/kubeconfig
25-
test/extended/tests-extension/openshift-apiserver-tests-ext run <test-name>
25+
test/extended/tests-extension/bin/openshift-apiserver-tests-ext run <test-name>
2626
```
2727

2828
### Local Test using OCP
@@ -48,7 +48,7 @@ export KUBECONFIG=~/.kube/cluster-bot.kubeconfig
4848

4949
**Example:**
5050
```shell
51-
test/extended/tests-extension/openshift-apiserver-tests-ext run-suite openshift/openshift-apiserver/all
51+
test/extended/tests-extension/bin/openshift-apiserver-tests-ext run-suite openshift/openshift-apiserver/all
5252
```
5353

5454
## Writing Tests
@@ -63,6 +63,9 @@ This test extension uses a **separate Go module** to isolate test dependencies f
6363
test/extended/tests-extension/
6464
├── go.mod # Separate module with test dependencies
6565
├── go.sum
66+
├── Makefile # Build targets for test binary
67+
├── bin/ # Built test binaries (gitignored)
68+
│ └── openshift-apiserver-tests-ext
6669
├── cmd/openshift-apiserver-tests-ext/
6770
│ └── main.go # Test binary entry point
6871
├── apiserver/ # Test packages
@@ -88,7 +91,7 @@ test/extended/tests-extension/
8891

8992
## How to Rename a Test
9093

91-
1. Run `test/extended/tests-extension/openshift-apiserver-tests-ext list` to see the current test names
94+
1. Run `test/extended/tests-extension/bin/openshift-apiserver-tests-ext list` to see the current test names
9295
2. Find the name of the test you want to rename
9396
3. Add a Ginkgo label with the original name, like this:
9497

@@ -106,7 +109,7 @@ It("should pass a renamed sanity check",
106109

107110
## How to Delete a Test
108111

109-
1. Run `test/extended/tests-extension/openshift-apiserver-tests-ext list` to find the test name
112+
1. Run `test/extended/tests-extension/bin/openshift-apiserver-tests-ext list` to find the test name
110113
2. Add the test name to the `IgnoreObsoleteTests` block in `test/extended/tests-extension/cmd/openshift-apiserver-tests-ext/main.go`, like this:
111114

112115
```go
@@ -158,7 +161,7 @@ More info: https://docs.ci.openshift.org/docs/architecture/ci-operator/#testing-
158161
| Target | Description |
159162
|--------------------------|------------------------------------------------------------------------------|
160163
| `make build` | Builds the operator binary. |
161-
| `make tests-ext-build` | Builds the test extension binary. |
164+
| `make tests-ext-build` | Builds the test extension binary into `test/extended/tests-extension/bin/`. |
162165
| `make tests-ext-update` | Updates the metadata JSON file and cleans machine-specific codeLocations. |
163166
| `make verify` | Runs formatting, vet, and linter. |
164167

0 commit comments

Comments
 (0)