pulumi/docs
Will Jones 51a62a9265
Add Go tests for fuzzing the engine (#17717)
In #17623 through #17627 and some follow-up PRs, we built out a
framework for fuzzing lifecycle tests in order to help track down
snapshot integrity violations in the Pulumi engine. All that remains now
is to actually provide ways to trigger a fuzzing run in useful ways.
This commit kicks this off by introducing two Go test functions that can
be run with `go test` or our `Makefile`:

* `TestFuzz` -- this runs the fuzzer and generates a brand new set of
scenarios (1,000 by default) and checks whether any of them result in a
snapshot integrity error. This test is skipped unless an environment
variable is set (which the `Makefile` handles if one runs `make
test_lifecycle_fuzz`). The intended purpose of this test is to back one
or more CI workflows that will run periodically in order to slowly
explore the state space.

* `TestFuzzFromStateFile` -- this accepts a path to a JSON state file
(such as that produced by a `pulumi stack export`) and uses that state
to seed the fuzzer, subsequently trying to find provider and operation
configurations that lead to a snapshot integrity error. This test is
skipped unless a state file path is set using the relevant environment
variable. The intended purpose of this test is to make it possible to
find root causes for user issues when all we have is a state and we'd
like to guess the program/provider configurations that led to an issue.

Alongside introducing these two tests, we bulk out the fuzzing
documentation a bit to help engineers run them, and link to the new
sections from the existing docs on snapshot integrity issues.
2024-11-08 13:11:03 +00:00
..
architecture Add Go tests for fuzzing the engine (#17717) 2024-11-08 13:11:03 +00:00
references Generate reference documentation from Protobufs (#17120) 2024-08-30 17:04:16 +00:00
sphinx Add GitHub links to developer documentation (#17191) 2024-09-06 15:58:45 +00:00
.gitignore Generate reference documentation from Protobufs (#17120) 2024-08-30 17:04:16 +00:00
Makefile Generate reference documentation from Protobufs (#17120) 2024-08-30 17:04:16 +00:00
README.md Generate reference documentation from Protobufs (#17120) 2024-08-30 17:04:16 +00:00
diagrams.md Introduce Sphinx-backed developer documentation (#16953) 2024-08-22 12:20:20 +00:00
documentation.md Document developer documentation deployments (#17119) 2024-08-30 16:17:46 +00:00
make.py Generate reference documentation from Protobufs (#17120) 2024-08-30 17:04:16 +00:00
requirements.txt Have Read the Docs use `docs/Makefile` (#17099) 2024-08-29 13:08:35 +00:00
writing.md Explain how to contribute to dev docs (#17604) 2024-10-23 20:58:18 +00:00

README.md

Home

Welcome to the Pulumi developer documentation! This site is designed to provide complete documentation for maintainers of and contributors to Pulumi.

:::{toctree} :maxdepth: 2 :titlesonly:

self /docs/documentation /docs/architecture/README /docs/references/README :::