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

chore: add warning if only special labels in report #116

Merged
merged 2 commits into from
Sep 27, 2023

Conversation

giovanni-guidini
Copy link
Contributor

After merging #113 I decided to investigate a little more why we would receive nothing but SpecialLabels in a report.
Turns out that if you generate the reports without --cov-context=test but do coverage json --show-contexts it does that.

So having a report with only special labels might indicate that ATS is not properly configured,
that is, the tests are not running as they should.

Ideally we would have a better place to surface this to customers, but right now we don't.
So the least we can do is add a warning. In this case, if we look at all the logs in the task,
we will see this detail.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. In 2022 this entity acquired Codecov and as result Sentry is going to need some rights from me in order to utilize my contributions in this PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

@codecov
Copy link

codecov bot commented Sep 26, 2023

Codecov Report

Merging #116 (1de29b3) into main (b1ff653) will increase coverage by 0.04%.
The diff coverage is 100.00%.

❗ Current head 1de29b3 differs from pull request most recent head fc48709. Consider uploading reports for the commit fc48709 to get more accurate results

Changes have been made to critical files, which contain lines commonly executed in production. Learn more

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #116      +/-   ##
==========================================
+ Coverage   98.45%   98.49%   +0.04%     
==========================================
  Files         364      364              
  Lines       26980    27522     +542     
==========================================
+ Hits        26562    27108     +546     
+ Misses        418      414       -4     
Flag Coverage Δ
integration 98.46% <100.00%> (+0.04%) ⬆️
latest-uploader-overall 98.46% <100.00%> (+0.04%) ⬆️
onlysomelabels 97.65% <50.00%> (-0.80%) ⬇️
unit 98.46% <100.00%> (+0.04%) ⬆️

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

Components Coverage Δ
NonTestCode 97.12% <100.00%> (+0.09%) ⬆️
OutsideTasks 98.26% <100.00%> (+0.06%) ⬆️
Files Coverage Δ
services/report/report_builder.py Critical 99.07% <100.00%> (+0.03%) ⬆️

... and 6 files with indirect coverage changes

This change has been scanned for critical changes. Learn more

After merging #113 I decided to investigate a little more why we would receive nothing but SpecialLabels in a report.
Turns out that if you generate the reports without `--cov-context=test` but do `coverage json --show-contexts` it does that.

So having a report with only special labels might indicate that ATS is not properly configured,
that is, the tests are not running as they should.

Ideally we would have a better place to surface this to customers, but right now we don't.
So the least we can do is add a warning. In this case, if we look at all the logs in the task,
we will see this detail.
@giovanni-guidini giovanni-guidini force-pushed the gio/add-warning-if-all-special-labels branch from 072f9ae to 1de29b3 Compare September 26, 2023 12:39
@codecov-staging
Copy link

codecov-staging bot commented Sep 26, 2023

Codecov Report

Merging #116 (fc48709) into main (b1ff653) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #116   +/-   ##
=======================================
  Coverage   98.41%   98.41%           
=======================================
  Files         341      341           
  Lines       26636    26640    +4     
=======================================
+ Hits        26215    26219    +4     
  Misses        421      421           
Flag Coverage Δ
integration 98.41% <100.00%> (+<0.01%) ⬆️
latest-uploader-overall 98.41% <100.00%> (+<0.01%) ⬆️
unit 98.41% <100.00%> (+<0.01%) ⬆️

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

Components Coverage Δ
NonTestCode 96.97% <100.00%> (+<0.01%) ⬆️
OutsideTasks 98.20% <100.00%> (+<0.01%) ⬆️
Files Coverage Δ
services/report/report_builder.py 99.07% <100.00%> (+0.03%) ⬆️

@codecov-public-qa
Copy link

codecov-public-qa bot commented Sep 26, 2023

Codecov Report

Merging #116 (fc48709) into main (b1ff653) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #116   +/-   ##
=======================================
  Coverage   98.41%   98.41%           
=======================================
  Files         341      341           
  Lines       26636    26640    +4     
=======================================
+ Hits        26215    26219    +4     
  Misses        421      421           
Flag Coverage Δ
integration 98.41% <100.00%> (+<0.01%) ⬆️
latest-uploader-overall 98.41% <100.00%> (+<0.01%) ⬆️
unit 98.41% <100.00%> (+<0.01%) ⬆️

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

Components Coverage Δ
NonTestCode 96.97% <100.00%> (+<0.01%) ⬆️
OutsideTasks 98.20% <100.00%> (+<0.01%) ⬆️
Files Changed Coverage Δ
services/report/report_builder.py 99.07% <100.00%> (+0.03%) ⬆️

@giovanni-guidini giovanni-guidini merged commit 68f9fa1 into main Sep 27, 2023
18 checks passed
@giovanni-guidini giovanni-guidini deleted the gio/add-warning-if-all-special-labels branch September 27, 2023 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants