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

docs: Updating docs for e2e tests #1625

Merged
merged 11 commits into from
Mar 22, 2021
Merged

Conversation

bisakhmondal
Copy link
Member

@bisakhmondal bisakhmondal commented Mar 20, 2021

Please answer these questions before submitting a pull request

Changes made:

  • New doc introducing how to write e2e & unit tests.
  • Merged the back-end-e2e.md doc with back-end-tests.md along with updating the contents.
  • a script to automate setting up the environment for e2e tests.

Thanks :)

@codecov-io
Copy link

codecov-io commented Mar 20, 2021

Codecov Report

Merging #1625 (77b7c47) into master (1ba32d9) will decrease coverage by 0.41%.
The diff coverage is n/a.

❗ Current head 77b7c47 differs from pull request most recent head 429253e. Consider uploading reports for the commit 429253e to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1625      +/-   ##
==========================================
- Coverage   71.69%   71.27%   -0.42%     
==========================================
  Files         133       47      -86     
  Lines        5469     3116    -2353     
  Branches      592        0     -592     
==========================================
- Hits         3921     2221    -1700     
+ Misses       1305      652     -653     
  Partials      243      243              
Flag Coverage Δ
backend-e2e-test 62.13% <ø> (+0.38%) ⬆️
backend-e2e-test-ginkgo 47.65% <ø> (-0.21%) ⬇️
backend-unit-test 51.77% <ø> (-0.04%) ⬇️
frontend-e2e-test ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
api/internal/core/store/store.go 86.14% <0.00%> (-1.81%) ⬇️
api/internal/utils/closer.go 33.33% <0.00%> (ø)
api/internal/handler/ssl/ssl.go 73.29% <0.00%> (ø)
api/internal/handler/data_loader/route_export.go 69.17% <0.00%> (ø)
api/internal/handler/data_loader/route_import.go 64.91% <0.00%> (ø)
web/src/pages/Consumer/Create.tsx
web/src/pages/Upstream/transform.ts
...eb/src/components/PluginOrchestration/constants.ts
...ages/Route/components/Step2/RequestRewriteView.tsx
web/src/pages/Route/constants.ts
... and 84 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1ba32d9...429253e. Read the comment docs.

@bisakhmondal bisakhmondal marked this pull request as ready for review March 20, 2021 18:31
@bisakhmondal
Copy link
Member Author

cc @nic-chen, @juzhiyuan to review when you have time :)

Guys, please suggest me a markdown linter, it seems mine is not working😄

Copy link
Member

@nic-chen nic-chen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we put the content of back-end-e2e.md into back-end-tests.md?

@bisakhmondal
Copy link
Member Author

Thanks, @nic-chen for fixing the lint :) It's really helpful. Definitely! we can merge these docs together.

Copy link
Contributor

@starsz starsz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty good.Thank you for your contribution.

docs/en/latest/back-end-e2e.md Outdated Show resolved Hide resolved
docs/en/latest/back-end-tests.md Show resolved Hide resolved
Copy link
Member

@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

docs/en/latest/back-end-tests.md Show resolved Hide resolved
Copy link
Member

@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't forget to update this file:

"items": ["develop", "I18N_USER_GUIDE", "front-end-e2e", "back-end-e2e"]

@nic-chen
Copy link
Member

ping @starsz @gxthrj

Copy link
Member

@Jaycean Jaycean left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thks.

@nic-chen nic-chen merged commit e86859d into apache:master Mar 22, 2021
@nic-chen
Copy link
Member

merged. thanks a lot. @bisakhmondal

@bisakhmondal
Copy link
Member Author

😁 Thank you, everyone, for such wonderful quick reviews. V2.5 💪

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
10 participants