Skip to content

Commit 74ed9fd

Browse files
simonklbaarnq
andcommitted
docs: Add how Modules are tested to the Development guide
Co-authored-by: André Arnqvist <58822152+aarnq@users.noreply.github.com>
1 parent 9328c90 commit 74ed9fd

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

DEVELOPMENT.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,21 @@ These are the general steps to do when replacing old Helm chart(s) with a Module
303303
+ - crossplane-system/crossplane-packages
304304
```
305305

306+
### Testing Modules
307+
308+
Modules should be tested just as components have been tested previously in the [tests](tests/).
309+
310+
#### Testing Chart to Module migration
311+
312+
For every release that replaces a Helm chart with a Module a maintenance test should be added to the migration prepare step.
313+
This maintenance test will verify that the existing Helm release is adopted by the Module and not recreated as well as making sure that there is no unexpected diff in the resources managed by the Helm release.
314+
315+
The maintenance test implementation is [here](scripts/migration/crossplane.sh) and an example of a prepare step that uses the maintenance test looks like this:
316+
317+
```sh
318+
module_maintenance_test "${CK8S_CLUSTER}" app=node-local-dns "${HERE}/module-accepted-changes/node-local-dns"
319+
```
320+
306321
## Code styling guidelines
307322

308323
### Bash

0 commit comments

Comments
 (0)