Skip to content

Commit 035d415

Browse files
authored
📖 Add run one test example to SAT readme (#22292)
1 parent 3bf87a9 commit 035d415

File tree

1 file changed

+15
-7
lines changed
  • airbyte-integrations/bases/connector-acceptance-test

1 file changed

+15
-7
lines changed

airbyte-integrations/bases/connector-acceptance-test/README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,35 @@
11
# Connector Acceptance Tests
2-
This package gathers multiple test suites to assess the sanity of any Airbyte connector.
2+
This package gathers multiple test suites to assess the sanity of any Airbyte connector.
33
It is shipped as a [pytest](https://docs.pytest.org/en/7.1.x/) plugin and relies on pytest to discover, configure and execute tests.
44
Test-specific documentation can be found [here](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference/)).
55

66
## Running the acceptance tests on a source connector:
7-
1. `cd` into your connector project (e.g. `airbyte-integrations/connectors/source-pokeapi`)
7+
1. `cd` into your connector project (e.g. `airbyte-integrations/connectors/source-pokeapi`)
88
2. Edit `acceptance-test-config.yml` according to your need. Please refer to our [Connector Acceptance Test Reference](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference/) if you need details about the available options.
99
3. Build the connector docker image ( e.g.: `docker build . -t airbyte/source-pokeapi:dev`)
1010
4. Use one of the following ways to run tests (**from your connector project directory**)
1111

12-
**Using python**
12+
### Using python
13+
_Note: these will assume that docker image for connector is already built_
14+
15+
**Running the whole suite**
1316
```bash
1417
python -m pytest integration_tests -p integration_tests.acceptance
1518
```
16-
_Note: this will assume that docker image for connector is already built_
1719

18-
**Using Gradle**
20+
**Running a specific test**
21+
```bash
22+
python -m pytest integration_tests -p integration_tests.acceptance -k "<TEST_NAME>"
23+
```
24+
25+
26+
### Using Gradle
1927
```bash
2028
./gradlew :airbyte-integrations:connectors:source-<name>:connectorAcceptanceTest
2129
```
2230
_Note: this way will also build docker image for the connector_
2331

24-
**Using Bash**
32+
### Using Bash
2533
```bash
2634
./acceptance-test-docker.sh
2735
```
@@ -67,4 +75,4 @@ To migrate a legacy configuration to the latest configuration format please run:
6775
python -m venv .venv # If you don't have a virtualenv already
6876
source ./.venv/bin/activate # If you're not in your virtualenv already
6977
python connector_acceptance_test/tools/strictness_level_migration/config_migration.py ../../connectors/source-to-migrate/acceptance-test-config.yml
70-
```
78+
```

0 commit comments

Comments
 (0)