search

artemiscloud / activemq-artemis-operator

Apache License 2.0
69 stars 63 forks source link

Tutorials: explore testing solutions for the tutorials #894

Closed lavocatt closed 2 months ago

lavocatt commented 7 months ago

Tutorials can get out of sync with the current state of the operator. There's currently two ideas to have them automatically tested.

A related bash script

We could have a related set of bash scripts per tutorial file that would get tested onto the CI. If the bash test suite fails, then the suite & its tutorial must get updated to the latest version.

Executable markdown files

Rmarkdown is a way to get markdown files with executable code chunks. There could be a way to use the tool to execute the tutorials and to produce an intermediate markdown file to be used as the input markdown for the Hugo server.

[!TIP] Vote this issue reacting with :+1: or :-1:

gtully commented 5 months ago

It may make sense to do a trivial restricted version of md execution in the envTest suite, we typically will just need to execute kubectl and we can carefully extend as needed. @brusdev has a nice little POC in bash, but we can do it in go. see: https://github.com/brusdev/mdexec/blob/main/README.md?plain=1#L3

brusdev commented 2 months ago

Resolved by https://github.com/artemiscloud/activemq-artemis-operator/commit/6ae91ca331cea6d3bc380909863a311ee1b9d976