Skip to content

Commit

Permalink
[docs] add sanitycheck readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ben8t committed Feb 26, 2025
1 parent 39086b3 commit 58e92d0
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions sanitychecks/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# TL;DR: Sanity Checks in Kestra

Please check the [full Notion page](https://www.notion.so/kestra-io/Sanity-Checks-17c36907f7b58050ba65efe468e19011?pvs=4) for full information

Sanity checks in Kestra are test flows used to verify functionality of plugins and tasks:

**Structure:**

- Plugin sanity checks: Flow ID is the task name, namespace "sanitychecks", and include Assert tasks to test task outputs.
- Flow sanity checks: Flow ID mentions main tasks, namespace "sanitychecks", they tests complete workflow (always self-contained)

**External Dependencies:**

- OSS services: Use Docker Run/Stop tasks
- Cloud services: Leverage sandbox environments when possible
- SaaS/License services: Not currently supported (or hard coded credentials from demo accounts)

**Organization:**

- All sanity checks are synced to the blueprint repository
- Plugin checks: Located in plugin repos, pulled to blueprint repo via CI/CD
- Flow checks: Written directly in blueprint repo into the `sanitychecks/flows` folder. Blueprints with `demo: true` are also synced into `sanitychecks/flows/blueprints`


**Deployment:**

For now deploy to preview environment is done via GitSync flows (see Notion page).
Alternatively, you can upload through UI.

0 comments on commit 58e92d0

Please sign in to comment.