ad82ad88b1
We have a load of engine logic in the grpc layer for providers. Skipping that and going directly to the Provider objects doesn't give an accurate test of how the engine will work from these tests. This is _really_ needed when we want to test things like the engine options to disable various resource properties (e.g. resource references, or disable provider preview). Currently all that engine logic lives in the provider client grpc layer (well it would if it was complete). This PR doesn't add tests for any of that but splits the test_host into its own file and handles the grpc wrapping. It's questionable if we care that much about these old untested flags (like disable outputs), but we will want to make use of this change for testing any new flags (e.g. adding integer support and checking that if it's disabled in the engine the SDK still works correctly). |
||
---|---|---|
.. | ||
providers | ||
testdata | ||
README.md | ||
go.mod | ||
go.sum | ||
interface.go | ||
interface_test.go | ||
internal_test.go | ||
l1empty_test.go | ||
l1main_test.go | ||
l2continue_on_error_test.go | ||
l2destroy_test.go | ||
l2large_test.go | ||
l2resourceasset_test.go | ||
l2resourcesimple_test.go | ||
main.go | ||
runtime_options_test.go | ||
snapshot_test.go | ||
snapshots.go | ||
test_host.go | ||
testing.go | ||
tests.go |
README.md
pulumi-language-test runs a gRPC interface that language plugins can use to run a suite of standard tests.
Architecture
pulumi-language-test is used to run a standard suite of tests against any compliant language plugin.
The diagram below shows the main interactions and data flows for how this system works.
There are three main actors involved. Firstly test
which is a test function coordinating the language plugin and pulumi-language-test. Secondly ptl
which is the pulumi-language-test process. Finally uut
which is the language plugin actually being tested. This will generally be a grpc server running in the same process as the test method.
sequenceDiagram
test->>ptl: Start ptl process
ptl-->>test: Read stdout for ptl address to connect to
Note right of test: All future calls to ptl are via grpc
test->>+ptl: GetLanguageTests()
ptl-->>-test: Returns list of test names
test->>+uut: Serve
uut-->>-test: Returns uut server address
test->>+ptl: PrepareLanguageTests(uut)
ptl->>+uut: Pack(core)
uut-->>-ptl: Returns name of core artifact
ptl-->>-test: Returns `token`
loop for each test
test->>+ptl: RunLanguageTest(token, test)
loop for each sdk used in test
ptl->>+uut: GeneratePackage(sdk)
uut-->>-ptl: Write package code to temporary directory
ptl->>ptl: Verify sdk snapshot
ptl->>+uut: Pack(sdk)
uut-->>-ptl: Returns name of sdk artifact
end
ptl->>+uut: GenerateProject(test)
uut-->>-ptl: Write project code to temporary directory
ptl->>ptl: Verify project snapshot
ptl->>+uut: InstallDependencies(project)
uut-->>-ptl:
note right of ptl: Execute test with engine
activate ptl
ptl->>+uut: Run(project)
uut-->>-ptl: Return run result
ptl->>ptl: Run test asserts against run result and snapshot
deactivate ptl
ptl-->>-test: Returns test result from asserts
end
test->>ptl: sigkill
Meta tests
This module contains a number of _test.go
files. These are tests of the conformance test system itself. The actual conformance tests are all defined in tests.go
.