Skip to content

Commit 1804f2d

Browse files
gbartoliniNiccoloFei
authored andcommitted
docs: add instructions on how to test it locally
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
1 parent 47d8864 commit 1804f2d

1 file changed

Lines changed: 33 additions & 5 deletions

File tree

CONTRIBUTING_NEW_EXTENSION.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -185,13 +185,22 @@ task e2e:test:full TARGET="<extension-name>"
185185

186186
### Local Manual Verification
187187

188-
Once the image is built, we recommend pulling it from your local registry,
189-
inspecting it manually to ensure the file structure is correct, and testing it
190-
with CloudNativePG.
188+
Once the automated tests have run, the Kind cluster remains active. You can
189+
"drop in" to this environment to verify the instructions you wrote in your
190+
`README.md`.
191+
192+
#### Export the Kubeconfig:
193+
194+
```sh
195+
task e2e:export-kubeconfig KUBECONFIG_PATH=./kubeconfig
196+
export KUBECONFIG=$PWD/kubeconfig
197+
```
198+
199+
#### Identify the Image Tag
191200

192201
Once the image is built and pushed to the local registry (`localhost:5000`),
193-
you should verify the generated tags. You can use `skopeo` to inspect the local
194-
registry:
202+
you should verify the generated tags. You can use tools like `skopeo` to
203+
inspect the local registry:
195204

196205
```bash
197206
skopeo list-tags --tls-verify=false docker://localhost:5000/<extension-name>-testing
@@ -203,12 +212,31 @@ skopeo list-tags --tls-verify=false docker://localhost:5000/<extension-name>-tes
203212
Verify that the output lists tags for all expected PostgreSQL and Debian
204213
version combinations.
205214

215+
#### Test the Extension
216+
217+
Create a `Cluster` resource using the instructions from your `README.md`.
218+
Pay close attention to the image location. Inside the Kubernetes cluster, the
219+
local registry is reachable at `registry.pg-extensions:5000`:
220+
221+
```yaml
222+
image: registry.pg-extensions:5000/<extension-name>-testing:<tag>
223+
```
224+
206225
### Extending Tests
207226
208227
While the framework provides a generic smoke test, we highly encourage you to
209228
add **extension-specific tests**. Review the [`postgis`](./postgis) directory
210229
for an example of additional testing using the Chainsaw framework.
211230

231+
### Cleanup
232+
233+
Once you have finished your manual verification, tear down the test
234+
environment:
235+
236+
```bash
237+
task e2e:cleanup
238+
```
239+
212240
## 5. Phase Five: Documentation & The Pull Request
213241

214242
### The `README.md` file

0 commit comments

Comments
 (0)