feat(CI): Merge the unit test and e2e test coverage report in CI.yaml

[gaocegege]

Description

https://github.com/tensorchord/envd/blob/main/.github/workflows/CI.yml#L203

We should merge e2e test coverage e2e-coverage.out and unit test coverage report coverage.out into one, and push the new one to coveralls.

---

Message from the maintainers:

Love this enhancement proposal? Give it a 👍. We prioritise the proposals with the most 👍.

[lunarwhite]

Hi @gaocegege, I'd like to help with this issue.

In .github/workflows/CI.yml, I found that there are four test coverage report files:

• coverage.out
• e2e-cli-coverage.out
• e2e-doc-coverage.out
• e2e-lang-coverage.out

As your designed, will we merge these files and put it into a new file like *.out?

BTW, I noticed that in L251-256, there is a section for sending report to coveralls.io.

# - name: Send coverage
#   env:
#     COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
#   run: |
#     gocovmerge e2e-coverage.out coverage.out > final.out
#     goveralls -coverprofile=final.out -service=github

Is it related to this issue? Will we finish this feature on this base?

[gaocegege]

Thanks for your interest!

As your designed, will we merge these files and put it into a new file like *.out?

Yep.

Is it related to this issue? Will we finish this feature on this base?

Yep I tried it before but it does not work as expected. The test coverage only includes the coverage.out, instead of the two files.

I think this issue may be not easy, thus please ask if there is any problem.

BTW, if you are interested in the envd code, please also have a look at this issue. https://github.com/tensorchord/envd/issues/663

It should be a good entrypoint to dive into the source code of envd.

[cutecutecat]

Here is a tool might be helpful https://github.com/wadey/gocovmerge

@lunarwhite

If you are too busy for working on this problem, I would like to help.

[gaocegege]

Thanks for your interest! Please go ahead. I think @lunarwhite did not have the bandwidth for the issue.

/assign @cutecutecat

[lunarwhite]

@cutecutecat Feel free to take this issue!

[cutecutecat]

I have tested gocovmerge and it works well on these coverage files. I think it much better to write an Github Action plugin to wrapper it, instead of clone and run gocovmerge from CI. Then we only need to refer that plagin, it would be much more readiable.

I would pick goaction to build this plugin.

[gaocegege]

Cool!