chore(docs): give a high level overview

hashicorp · Dec 6, 2021 · 5af34e7 · 5af34e7
1 parent 53db8d4
commit 5af34e7
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/test/Readme.md b/test/Readme.md
@@ -39,3 +39,11 @@ Test Environment:
 - To install dependencies from pacakge managers, use `yarn`, `npm`, `pipenv`,
   `mvn` and `nuget`. Those programs will be shimmed to allow consuming local
   dependencies.
+
+## Edge Provider Tests
+
+To test all edge cases without building all providers we create an edge provider that contains all these edge cases.
+The provider lives under `packages/@cdktf/provider-generator/lib/__tests__/edge-provider-schema` and the provider bindings are tested there through snapshots.
+We generate the schema into `packages/@cdktf/provider-generator/edge-provider-bindings` on build and copy them through GH Actions or the `edge:install` command.
+
+We also build a helper to translate an initial version of these tests through the different languages, `edge:translateTests` takes the typescript `main.ts` and translates it to the other languages. The translation is not perfect, but a good start.