Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs about registry server test and label #993

Merged
merged 1 commit into from
Jan 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/dev_guide/cloud_integration_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ parent: Developer Guides
---
# Cloud Integration Test/CI Pipeline

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:
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:

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

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

## Cloud Testing Pipelines

Expand Down
2 changes: 1 addition & 1 deletion docs/dev_guide/new_contributor_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You can ping your questions in the community Slack channel and Feathr developers
* "I am not sure how to setup the cluster and test my code. Can someone help me out?"

## My pull request(PR) requires testing against the database or cluster that I dont' have, how can I test?
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.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/dev_guide/test_coverage_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To maintain and improve codes quality of feathr, we expect test coverage ratio t

## How to conduct test coverage
### Through github workflows pipeline:
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.
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.

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