Skip to content

Commit 0dd31bc

Browse files
committed
docs: add info on fixture types
risk: nonprod
1 parent 2bdd0fc commit 0dd31bc

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ But there is one disadvantage. One needs a GoodData instance with the original s
209209
aws ecr get-login-password | docker login --username AWS --password-stdin 020413372491.dkr.ecr.us-east-1.amazonaws.com
210210
```
211211
212-
2. **GoodData License Key** - Get from the GoodData team and place it in the `./build/license` file:
212+
2. **GoodData License Key** - Get from the GoodData team (or check out [GoodData License Key](https://gooddata.atlassian.net/wiki/spaces/support/pages/2783313974/GoodData+CN+License+keys+for+employees)) and place it in the `./build/license` file:
213213
```bash
214214
mkdir -p build
215215
echo "<your_license_key>" > build/license
@@ -328,3 +328,23 @@ venv automatically. So when docker tox tests are executed after localhost tests
328328
329329
# How to generate and maintain OpenAPI clients
330330
Refer to our [OpenAPI client README](./.openapi-generator/README.md)
331+
332+
# Kinds of fixtures and layouts
333+
334+
There are several kinds of fixtures used for the tests.
335+
This is important to know about when you're making changes or updating cassettes as it can surprise you.
336+
You have to keep in mind especially if you want to add new attributes to be used across several tests.
337+
338+
## Gooddata SDK
339+
340+
These are common places for fixtures used in Gooddata SDK:
341+
342+
- `packages/tests-support/fixtures` are used as the default layout for tests that are uploaded by docker compose. They
343+
are also uploaded by the `upload_demo_layout.py` script.
344+
- `packages/gooddata-sdk/tests/catalog/refresh`: this is the layout that actually *replaces* the layout after some kinds of catalog tests, and hence overrides the layout from docker compose.
345+
You have to make changes also here if you want to make changes to the default layout.
346+
It's a current TODO to merge this and `packages/tests-support/fixtures` into one layout.
347+
- `packages/gooddata-sdk/tests/catalog/expected`: these are fixtures that are used to compare against in various catalog tests.
348+
- `packages/gooddata-sdk/tests/catalog/store`, `packages/gooddata-sdk/tests/catalog/load`, `packages/gooddata-sdk/tests/catalog/load_with_locale`, `packages/gooddata-sdk/tests/catalog/load_with_locale`, ...
349+
- These are numerous fixtures that are used for load and put tests. You often need to change more of them.
350+
- Note that some of these contain `workspace` and `workspace_content` subfolders, depending on where the fixtures are used to load

0 commit comments

Comments
 (0)