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 test coverage check to CI.yaml #13

Merged
merged 10 commits into from
Jul 13, 2023
Merged

Add test coverage check to CI.yaml #13

merged 10 commits into from
Jul 13, 2023

Conversation

thepetk
Copy link
Contributor

@thepetk thepetk commented Jul 12, 2023

What does this PR do?

Adds a new job for coverage inside the CI.yml file. More detailed we are updating the command:

code-coverage-report:
  runs-on: ubuntu-20.04
  steps:
    - name: Checkout
      uses: actions/checkout@v2.3.1
      with:
        persist-credentials: false
    - name: Set up Go 1.x
      uses: actions/setup-go@v2
      with:
        go-version: 1.19
    - name: Run tests
      run: go test -coverprofile cover.out -v ./...
    - name: Codecov
      uses: codecov/codecov-action@v2.1.0

This may runs twice the tests but it explicitly has an additional check and remains consistent with the devfile/library flow.

All preferences for codecov have been set with the addition of .codecov.yaml

Which issue(s) does this PR fix

fixes devfile/api#1164

PR acceptance criteria

Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.

  • Unit/Functional tests

  • Documentation

How to test changes / Special notes to the reviewer

I have created some tests runs here: https://github.com/thepetk/devfile-alizer/actions/runs/5543302687/jobs/10119130147?pr=2

thepetk added 3 commits July 12, 2023 14:45
Signed-off-by: thepetk <thepetk@gmail.com>
Signed-off-by: thepetk <thepetk@gmail.com>
@mike-hoang
Copy link
Contributor

I noticed that in some of the other repos, we use the codecov gh action: https://github.com/devfile/library/blob/main/.github/workflows/codecov.yml#L20-L21

What do you think about:

  1. Splitting the test into a separate workflow yaml (this does mean running the tests twice)
  2. Using the code-cov-action which would add more details to the checks section
code-cov

@thepetk
Copy link
Contributor Author

thepetk commented Jul 13, 2023

I noticed that in some of the other repos, we use the codecov gh action: https://github.com/devfile/library/blob/main/.github/workflows/codecov.yml#L20-L21

What do you think about:

  1. Splitting the test into a separate workflow yaml (this does mean running the tests twice)
  2. Using the code-cov-action which would add more details to the checks section
code-cov

Yes I thnk is a good catch. I like it and is more consistent as we are using the same way with the library :)

thepetk added 4 commits July 13, 2023 13:21
Signed-off-by: thepetk <thepetk@gmail.com>
Add separate check for code coverage
Signed-off-by: thepetk <thepetk@gmail.com>
@codecov
Copy link

codecov bot commented Jul 13, 2023

Codecov Report

❗ No coverage uploaded for pull request base (main@e55ee31). Click here to learn what that means.
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #13   +/-   ##
=======================================
  Coverage        ?   73.30%           
=======================================
  Files           ?        6           
  Lines           ?      618           
  Branches        ?        0           
=======================================
  Hits            ?      453           
  Misses          ?      136           
  Partials        ?       29           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Signed-off-by: thepetk <thepetk@gmail.com>
@thepetk
Copy link
Contributor Author

thepetk commented Jul 13, 2023

@mike-hoang updated the PR :)

Copy link
Contributor

@mike-hoang mike-hoang left a comment

Choose a reason for hiding this comment

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

I like it! Small changes, but let's use the newest version of the codecov action to fix the annotation warnings

https://github.com/devfile/alizer/actions/runs/5543299324

.github/workflows/CI.yml Outdated Show resolved Hide resolved
.github/workflows/CI.yml Outdated Show resolved Hide resolved
Signed-off-by: thepetk <thepetk@gmail.com>
@thepetk thepetk requested a review from mike-hoang July 13, 2023 14:25
@thepetk
Copy link
Contributor Author

thepetk commented Jul 13, 2023

@mike-hoang I've bumped up both codecov and checkout :)

Signed-off-by:thepetk <thepetk@gmail.com>
@openshift-ci
Copy link

openshift-ci bot commented Jul 13, 2023

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mike-hoang, thepetk

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@thepetk thepetk merged commit 1e2e10b into devfile:main Jul 13, 2023
thepetk referenced this pull request in thepetk/devfile-alizer Jul 27, 2023
* Add test coverage workflow

Signed-off-by: thepetk <thepetk@gmail.com>

* Update ci.yaml

Signed-off-by: thepetk <thepetk@gmail.com>

* Add separate check for code coverage

Signed-off-by: thepetk <thepetk@gmail.com>

* Move code report in ci file

Signed-off-by: thepetk <thepetk@gmail.com>

* Add .codecov.yaml

Signed-off-by: thepetk <thepetk@gmail.com>

* Update workflow

Signed-off-by: thepetk <thepetk@gmail.com>

* Bump up setup-go

Signed-off-by:thepetk <thepetk@gmail.com>

---------

Signed-off-by: thepetk <thepetk@gmail.com>
thepetk referenced this pull request in thepetk/devfile-alizer Aug 1, 2023
* Add binaries to every new release (#237)

* Add release yaml to workflows

Signed-off-by: thepetk <thepetk@gmail.com>

* Remove autogeneration of release notes

Signed-off-by: thepetk <thepetk@gmail.com>

* Update readme

Signed-off-by: thepetk <thepetk@gmail.com>

* Update Readme.md

Signed-off-by: thepetk <thepetk@gmail.com>

---------

Signed-off-by: thepetk <thepetk@gmail.com>

* flattening go dir (#1)

Signed-off-by: Michael Hoang <mhoang@redhat.com>
Signed-off-by: thepetk <thepetk@gmail.com>

* Update realease.yaml (#2)

Signed-off-by: thepetk <thepetk@gmail.com>

* adding proposal for dockerfile components (#3)

Signed-off-by: Michael Hoang <mhoang@redhat.com>
Signed-off-by: thepetk <thepetk@gmail.com>

* Merge all test resources (#6)

* Update test paths

Signed-off-by: thepetk <thepetk@gmail.com>

* Update angular test resource

Signed-off-by: thepetk <thepetk@gmail.com>

* Remove projectAngularjs

Signed-off-by: thepetk <thepetk@gmail.com>

* Update containerfile test

Signed-off-by: thepetk <thepetk@gmail.com>

* Update django test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update docker compose test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update tests for docker compose with ports

Signed-off-by: thepetk <thepetk@gmail.com>

* Update test project dockerfile

Signed-off-by: thepetk <thepetk@gmail.com>

* Update express js port tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Update flask port tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Update golang test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update jboss test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update laravel test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update test micronaut resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update container docker file nested tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Update nuxt and next js tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Update port test for quarkus

Signed-off-by: thepetk <thepetk@gmail.com>

* Update reactjs tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Remove port test project quarkus

Signed-off-by: thepetk <thepetk@gmail.com>

* Update rest of port tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Fix issue with ip host go format

Signed-off-by: thepetk <thepetk@gmail.com>

* Update test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Finalize new component detection format

Signed-off-by: thepetk <thepetk@gmail.com>

---------

Signed-off-by: thepetk <thepetk@gmail.com>

* Add min max cli args (#5)

* Create dependabot.yml

Signed-off-by: thepetk <thepetk@gmail.com>

* Update dependabot.yml

Signed-off-by: thepetk <thepetk@gmail.com>

* Update realease.yaml (#2)

Signed-off-by: thepetk <thepetk@gmail.com>

* adding proposal for dockerfile components (#3)

Signed-off-by: Michael Hoang <mhoang@redhat.com>
Signed-off-by: thepetk <thepetk@gmail.com>

* Merge all test resources (#6)

* Update test paths

Signed-off-by: thepetk <thepetk@gmail.com>

* Update angular test resource

Signed-off-by: thepetk <thepetk@gmail.com>

* Remove projectAngularjs

Signed-off-by: thepetk <thepetk@gmail.com>

* Update containerfile test

Signed-off-by: thepetk <thepetk@gmail.com>

* Update django test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update docker compose test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update tests for docker compose with ports

Signed-off-by: thepetk <thepetk@gmail.com>

* Update test project dockerfile

Signed-off-by: thepetk <thepetk@gmail.com>

* Update express js port tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Update flask port tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Update golang test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update jboss test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update laravel test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update test micronaut resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Update container docker file nested tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Update nuxt and next js tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Update port test for quarkus

Signed-off-by: thepetk <thepetk@gmail.com>

* Update reactjs tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Remove port test project quarkus

Signed-off-by: thepetk <thepetk@gmail.com>

* Update rest of port tests

Signed-off-by: thepetk <thepetk@gmail.com>

* Fix issue with ip host go format

Signed-off-by: thepetk <thepetk@gmail.com>

* Update test resources

Signed-off-by: thepetk <thepetk@gmail.com>

* Finalize new component detection format

Signed-off-by: thepetk <thepetk@gmail.com>

---------

Signed-off-by: thepetk <thepetk@gmail.com>

* Run tidy

Signed-off-by: thepetk <thepetk@gmail.com>

* Update devfile_recognizer and models

Signed-off-by: thepetk <thepetk@gmail.com>

* Update cli

Signed-off-by: thepetk <thepetk@gmail.com>

* Update docs

Signed-off-by: thepetk <thepetk@gmail.com>

* Add test cases for versions cli args

Signed-off-by: thepetk <thepetk@gmail.com>

* Fix sec alert

Signed-off-by: thepetk <thepetk@gmail.com>

* Fix typo

Signed-off-by: thepetk <thepetk@gmail.com>

---------

Signed-off-by: thepetk <thepetk@gmail.com>
Signed-off-by: Michael Hoang <mhoang@redhat.com>
Co-authored-by: Michael Hoang <35011707+mike-hoang@users.noreply.github.com>
Signed-off-by: thepetk <thepetk@gmail.com>

* Remove dependabot (#10)

Signed-off-by: thepetk@gmail.com

Signed-off-by: thepetk@gmail.com
Signed-off-by: thepetk <thepetk@gmail.com>

* Minor update on devfiles versioning (#11)

* Remove dependabot

Signed-off-by: thepetk@gmail.com
Signed-off-by: thepetk <thepetk@gmail.com>

* Add versions to alizer devfile response

Signed-off-by: thepetk <thepetk@gmail.com>

* Update readme.md

Signed-off-by: thepetk <thepetk@gmail.com>

* Update naming and devfile models in the proposal

Signed-off-by: thepetk <thepetk@gmail.com>

* Update code naming

Signed-off-by: thepetk <thepetk@gmail.com>

* Update tests after renaming

Signed-off-by: thepetk <thepetk@gmail.com>

---------

Signed-off-by: thepetk@gmail.com
Signed-off-by: thepetk <thepetk@gmail.com>

* fixing gosec alerts (#12)

Signed-off-by: Michael Hoang <mhoang@redhat.com>
Signed-off-by: thepetk <thepetk@gmail.com>

* Add test coverage check to CI.yaml (#13)

* Add test coverage workflow

Signed-off-by: thepetk <thepetk@gmail.com>

* Update ci.yaml

Signed-off-by: thepetk <thepetk@gmail.com>

* Add separate check for code coverage

Signed-off-by: thepetk <thepetk@gmail.com>

* Move code report in ci file

Signed-off-by: thepetk <thepetk@gmail.com>

* Add .codecov.yaml

Signed-off-by: thepetk <thepetk@gmail.com>

* Update workflow

Signed-off-by: thepetk <thepetk@gmail.com>

* Bump up setup-go

Signed-off-by:thepetk <thepetk@gmail.com>

---------

Signed-off-by: thepetk <thepetk@gmail.com>

* adding support for dockerfile components (#14)

Signed-off-by: Michael Hoang <mhoang@redhat.com>
Signed-off-by: thepetk <thepetk@gmail.com>

* Add test coverage workflow

Signed-off-by: thepetk <thepetk@gmail.com>

* Update ci.yaml

Signed-off-by: thepetk <thepetk@gmail.com>

* Add separate check for code coverage

Signed-off-by: thepetk <thepetk@gmail.com>

* Move code report in ci file

Signed-off-by: thepetk <thepetk@gmail.com>

* Update workflow

Signed-off-by: thepetk <thepetk@gmail.com>

* Bump up setup-go

Signed-off-by:thepetk <thepetk@gmail.com>
Signed-off-by: thepetk <thepetk@gmail.com>

* Make DownloadDevFileTypesFromRegistry public

Signed-off-by: thepetk <thepetk@gmail.com>

* Add devfile.yaml schema

Signed-off-by: thepetk <thepetk@gmail.com>

* Add go script for generating registry entries json

Signed-off-by: thepetk <thepetk@gmail.com>

* Implement nightly run script and workflow

Signed-off-by: thepetk <thepetk@gmail.com>

* Update go mod

Signed-off-by: thepetk <thepetk@gmail.com>

* Add new schedule to registry check

signed-off-by: thepetk <thepetk@gmail.com>
Signed-off-by: thepetk <thepetk@gmail.com>

* Update workflow name

Signed-off-by: thepetk <thepetk@gmail.com>

* Update go mod

Signed-off-by: thepetk <thepetk@gmail.com>

* Update funcs in order to be mockable

Signed-off-by: thepetk <thepetk@gmail.com>

* Move devfile_recognizer_test.go to recognizer dir

Signed-off-by: thepetk <thepetk@gmail.com>

* Update docstring of script

Signed-off-by: thepetk <thepetk@gmail.com>

* Add tests for check_registry.go

Signed-off-by: thepetk <thepetk@gmail.com>

* Fix test paths

Signed-off-by: thepetk <thepetk@gmail.com>

* Remove unecessary logging

Signed-off-by: thepetk <thepetk@gmail.com>

* Remove binary

Signed-off-by: thepetk <thepetk@gmail.com>

* Use make build instead of go command

Signed-off-by: thepetk <thepetk@gmail.com>

* Further fixes on the workflow

Signed-off-by: thepetk <thepetk@gmail.com>

---------

Signed-off-by: thepetk <thepetk@gmail.com>
Signed-off-by: Michael Hoang <mhoang@redhat.com>
Signed-off-by: thepetk@gmail.com
Co-authored-by: Michael Hoang <35011707+mike-hoang@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add code coverage check to alizer workflows
2 participants