Skip to content

Commit 97b42d9

Browse files
authored
Add docs about registry server test and label (feathr-ai#993)
1 parent d869dd3 commit 97b42d9

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

docs/dev_guide/cloud_integration_testing.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ parent: Developer Guides
55
---
66
# Cloud Integration Test/CI Pipeline
77

8-
We use [GitHub Actions](https://github.com/feathr-ai/feathr/tree/main/.github/workflows) to do cloud integration test. Currently the integration test has 4 jobs:
8+
We use [GitHub Actions](https://github.com/feathr-ai/feathr/tree/main/.github/workflows) to do cloud integration test. Currently the integration test has 5 jobs:
99

1010
- running `./gradlew test` to verify if the scala/spark related code has passed all the test
1111
- running `flake8` to lint python scripts and make sure there are no obvious syntax errors
1212
- running the built jar in databricks environment with end to end test to make sure it passed the end to end test
1313
- running the built jar in Azure Synapse environment with end to end test to make sure it passed the end to end test
14+
- running the end to end test cases for registry server to make sure related code can passed all the tests
1415

15-
The above 4 jobs will ran in parallel, and if any one of them fails, the integration test will fail.
16+
The above 5 jobs will ran in parallel, and if any one of them fails, the integration test will fail.
1617

1718
## Cloud Testing Pipelines
1819

docs/dev_guide/new_contributor_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You can ping your questions in the community Slack channel and Feathr developers
3333
* "I am not sure how to setup the cluster and test my code. Can someone help me out?"
3434

3535
## My pull request(PR) requires testing against the database or cluster that I dont' have, how can I test?
36-
Develop your implementation locally first and use unit tests to ensure correctness. Later, you can ask PR reviewers to label them with `safe to test` so Github will kick off a integration test in our test cluster with your code.
36+
Develop your implementation locally first and use unit tests to ensure correctness. Later, you can ask PR reviewers to label them with `safe to test` so Github will kick off a integration test in our test cluster with your code. If your PR contains any change about registry server it should also be labeled with `registry test`. Then related test cases will be triggered in Github workflow.
3737

3838
If you need more assistance regarding testing your code or development, reach out in our Slack channel.
3939

docs/dev_guide/test_coverage_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To maintain and improve codes quality of feathr, we expect test coverage ratio t
1111

1212
## How to conduct test coverage
1313
### Through github workflows pipeline:
14-
We already added this coverage checking into our CI pipeline. For every pull request, push and scheduled jobs, github will check the coverage when runing 'pytest' automatically. You can find the result for 'azure_synapse', 'databricks' and 'local spark', respectively from each PR and commit.
14+
We already added this coverage checking into our CI pipeline. For every pull request, push and scheduled jobs, github will check the coverage when runing 'pytest' automatically. You can find the result for 'azure_synapse', 'databricks', 'local spark' and 'registry_test', respectively from each PR and commit.
1515

1616
An example of test coverage result:
1717
![test coverage example](./images/coverage_res.png)

0 commit comments

Comments
 (0)