Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc for incremental testing #348

Merged
merged 1 commit into from
Sep 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Flags:
-request : Override request config
--max_backends : Override max backends limitation
--max_acls : Override max acl limitation
--watch : Watch VCL file changes and run test

Local testing example:
falco test -I . -I ./tests /path/to/vcl/main.vcl
Expand Down Expand Up @@ -78,6 +79,17 @@ falco test -I vcl_tests ./vcl/default.vcl

falco finds `default.test.vcl` as testing file for both case.

## Incremental Testing

If you provide `--watch` option for testing command, test runner watches source and testing VCL file change and run tests.
For example,

```shell
falco test -I vcl_tests ./vcl/default.vcl --watch
```

Then falco observes `vcl_tests/*` and `vcl/*` file changes and run test incrementally.

## Testing Subroutine

Unit testing file can be written as VCL subroutine, example is the following:
Expand Down