Owner: Architect:

Francesco Ilario

Story (Required)

As a Primaza User,
I would like documentation to be well tested
so that I can easily try Primaza

Background (Required)

Documentation has been enriched with a Tutorials section.
Tutorials are automatically injected into the Documentation starting from some scripts.
We want to ensure that scripts works for each release.

See epic for arch document link.

Glossary

See glossary in architecture document

Out of scope

• ACK Integration script

In Scope

• Add tests for Tutorials scripts
• Add a GitHub Action for testing Tutorials scripts that's executed whenever a Release is created or updated

Approach(Required)

Create a simple script (or a set of them) that checks that each script is executed correctly and use them in the GitHub Action.

Add set -e -o pipefail # mdbash: skip-line to each documentation scripts, execute them, and check for results.

Demo requirements(Required)

NA

Dependencies

NA

Edge Case

NA

BDD Tests

You can find BDD Test specification for this story in the "Testing Instruction" Field Tab or in the GitHub Issue linked to this story.
Click here for all BDD Tests Issues.

Acceptance Criteria

• QE
  There are test cases for each script in hack/tutorials/tenant
  There are test cases for each script in hack/tutorials/claiming
  There are test cases for each script in hack/tutorials/discovery
  There is a GitHub Action executing when the a Release is created or updated

INVEST Checklist

Dependencies identified
Blockers noted and expected delivery timelines set
Design is implementable
Acceptance criteria agreed upon
Story estimated

Legend

Unknown
Verified
Unsatisfied