Feature LCOV code coverage #869

Bwen · 2021-09-29T10:21:26Z

Feature request issue #735

Generate an lcov code coverage, which can be tested with genhtml which is part of most Debian derived distribution package lcov.
Ref: http://ltp.sourceforge.net/coverage/lcov/geninfo.1.php

Once you have generated the lcov file you can generate the html coverage with the following command:

vendor/bin/phpunit --path-coverage --coverage-lcov lcov.info

genhtml lcov.info -o html-coverage-directory --branch-coverage

sebastianbergmann · 2021-09-30T06:11:55Z

Please rebase your branch so that it has #870. Thanks!

codecov · 2021-09-30T06:35:24Z

Codecov Report

Merging #869 (5b12628) into master (2e93305) will increase coverage by 0.07%.
The diff coverage is 90.00%.

❗ Current head 5b12628 differs from pull request most recent head 9a17e03. Consider uploading reports for the commit 9a17e03 to get more accurate results

@@             Coverage Diff              @@
##             master     #869      +/-   ##
============================================
+ Coverage     84.75%   84.82%   +0.07%     
- Complexity     1086     1104      +18     
============================================
  Files            60       61       +1     
  Lines          3575     3625      +50     
============================================
+ Hits           3030     3075      +45     
- Misses          545      550       +5

Impacted Files	Coverage Δ
src/Report/Lcov.php	`90.00% <90.00%> (ø)`

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 2e93305...9a17e03. Read the comment docs.

.gitignore

src/Report/Lcov.php

sebastianbergmann · 2021-10-03T09:09:10Z

Out of curiosity: what are you missing from the HTML report generated by this library that you get from the one generated by LCOV's genhtml?

Bwen · 2021-10-03T11:28:33Z

Out of curiosity: what are you missing from the HTML report generated by this library that you get from the one generated by LCOV's genhtml?

To be honest, I prefer the built-in HTML report. I am only using the genhtml to test out the lcov.info file. The reason for me doing this is purely for convenience for external tools as mentioned in:
#735

And for that specific case, line coverage is more than enough imo.

tests/_files/BankAccount-lcov-line.info

src/Report/Lcov.php

Bwen · 2021-10-12T10:09:51Z

@sebastianbergmann @dvdoug
Fixed all the lil count problems. It now matches exactly the count of --coverage-text, Cheers!

dvdoug · 2021-10-13T20:56:34Z

src/Report/Lcov.php

+        return $testName[0];
+    }
+
+    private function getCoverageByTestCase(File $file): array


I get the below when generating LCOV for php-code-coverage's own test suite (using version of PHPUnit from your PR in that repo). I think you need a guard clause around line 35/36

Message: SebastianBergmann\CodeCoverage\Report\Lcov::getCoverageByTestCase(): Argument #1 ($file) must be of type SebastianBergmann\CodeCoverage\Node\File, SebastianBergmann\CodeCoverage\Node\Directory given

dvdoug · 2021-10-13T20:57:09Z

src/Report/Lcov.php

+        foreach ($report as $file) {
+            $tests = $this->getCoverageByTestCase($file);
+
+            foreach ($tests as $name => $test) {


This overrides the $name given in the function signature (which is unused?)

dvdoug · 2021-10-13T20:59:52Z

src/Report/Lcov.php

+
+                    $testSpecificData[$test]['functionLineNumbers'][$methodName] = $method['startLine'];
+
+                    if (0 < $method['executedLines'] && $method['coverage'] == 100) {


I recommend strict equality (===) here and on line 118

dvdoug · 2021-10-13T21:04:22Z

src/Report/Lcov.php

+            }
+        }
+
+        $buffer = implode("\n", $lcovLines) . "\n";


I understand this is how the other reports do it (generate in memory and then write to disk), but I'm concerned these might turn out to be very, very large files.

What's the largest project you've tested this with?

I've been trying to find a good phpunit project that I could wire up to test, has been challenging... Any suggestions? 😅

Since lcov is pretty much a per line file, not like a closed structure like xml or json, I was tempted to just file_put_contents($filename, $line, FILE_APPEND); but seeing how the other coverage did it, I didnt want to "rock the boat"... I could switch it tho?

EDIT: Only concerned I had about the file append, is the buffer that is returned? file_get_content() ?

fwrite is probably a better choice? file_put_contents would open and close the file on every call.

I've had good luck with Symfony in the past when seeking out a giant codebase, it's one repo that has all of the individual components.

fwrite is probably a better choice? file_put_contents would open and close the file on every call.

What do I do about returning the "buffer" at the end? Just open up the file and return the whole thing as string? 🤔

EDIT: what about Moderate phpunit projects I could rewire up easily for further testing?

What do I do about returning the "buffer" at the end? Just open up the file and return the whole thing as string?

It's only the text report where the contents are reused by the calling application 🤔. @sebastianbergmann would you be OK if nothing was returned?

its used for the tests as well, returning an empty string would make the lcov tests fail... I would have to refactor to test it another way... 🤔

IonBazan · 2021-10-15T03:45:23Z

tests/tests/LcovTest.php

+        );
+    }
+
+    public function testCloverForFileWithIgnoredLines(): void


Suggested change

public function testCloverForFileWithIgnoredLines(): void

public function testLcovForFileWithIgnoredLines(): void

IonBazan · 2021-10-15T03:45:34Z

tests/tests/LcovTest.php

+        );
+    }
+
+    public function testCloverForClassWithAnonymousFunction(): void


Suggested change

public function testCloverForClassWithAnonymousFunction(): void

public function testLcovForClassWithAnonymousFunction(): void

Bwen · 2021-10-18T08:12:53Z

I think we've been going about this the wrong way. I dont think we should have the "per test case basis" as a default output, this will create huge files ex: number of source files * number of test cases.

I believe we should have a sane default output which should be on a source file basis line coverage, and if the user really want the coverage on a per test basis he can add the extra option --coverage-lcov-per-test or maybe based on an already existing option. The genhtml does not give you the per test case coverage details unless you request it, I think we should follow that logic as well.

@sebastianbergmann @dvdoug What do you think? 🤔 💭

dvdoug · 2021-10-19T21:33:47Z

I will defer to @sebastianbergmann on adding options, I'm just a humble contributor.

sebastianbergmann · 2022-09-24T14:29:29Z

Thank you for your contribution. I appreciate the time you invested in preparing this pull request. However, I have decided not to merge it.

Bwen mentioned this pull request Sep 29, 2021

Add option --coverage-lcov <file> sebastianbergmann/phpunit#4787

Closed

Bwen changed the title ~~Feature request issue #735~~ Feature LCOV code coverage Sep 29, 2021

sebastianbergmann added the enhancement label Sep 29, 2021

dvdoug mentioned this pull request Sep 29, 2021

Fix CI for branches that target master #870

Merged

sebastianbergmann reviewed Sep 30, 2021

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

sebastianbergmann reviewed Sep 30, 2021

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

dvdoug reviewed Oct 1, 2021

View reviewed changes

src/Report/Lcov.php Show resolved Hide resolved

src/Report/Lcov.php Show resolved Hide resolved

src/Report/Lcov.php Outdated Show resolved Hide resolved

dvdoug reviewed Oct 3, 2021

View reviewed changes

tests/_files/BankAccount-lcov-line.info Outdated Show resolved Hide resolved

Bwen added 2 commits October 3, 2021 13:20

Implement Lcov coverage

0d1fe8a

Refactor on a test case basis

b9ec6ff

dvdoug reviewed Oct 10, 2021

View reviewed changes

src/Report/Lcov.php Show resolved Hide resolved

dvdoug reviewed Oct 10, 2021

View reviewed changes

src/Report/Lcov.php Outdated Show resolved Hide resolved

Fixed lil bugs in lines/branches/functions coverage for lcov

9a17e03

dvdoug reviewed Oct 13, 2021

View reviewed changes

IonBazan reviewed Oct 15, 2021

View reviewed changes

sebastianbergmann mentioned this pull request Sep 23, 2022

Feature request: LCOV report #735

Closed

sebastianbergmann closed this Sep 24, 2022

juanjoDiaz mentioned this pull request Oct 19, 2022

Add automatic coverage results and badge using coveralls, codecov or similar Languagewire/html-dumper#14

Open


		$testSpecificData[$test]['functionLineNumbers'][$methodName] = $method['startLine'];

		if (0 < $method['executedLines'] && $method['coverage'] == 100) {

	public function testCloverForFileWithIgnoredLines(): void
	public function testLcovForFileWithIgnoredLines(): void

	public function testCloverForClassWithAnonymousFunction(): void
	public function testLcovForClassWithAnonymousFunction(): void

Uh oh!

Feature LCOV code coverage #869

Feature LCOV code coverage #869

Uh oh!

Conversation

Bwen commented Sep 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sebastianbergmann commented Sep 30, 2021

Uh oh!

codecov bot commented Sep 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sebastianbergmann commented Oct 3, 2021

Uh oh!

Bwen commented Oct 3, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Bwen commented Oct 12, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bwen Oct 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bwen Oct 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bwen commented Oct 18, 2021

Uh oh!

dvdoug commented Oct 19, 2021

Uh oh!

sebastianbergmann commented Sep 24, 2022

Uh oh!

Uh oh!

Bwen commented Sep 29, 2021 •

edited

Loading

codecov bot commented Sep 30, 2021 •

edited

Loading

Bwen Oct 13, 2021 •

edited

Loading

Bwen Oct 14, 2021 •

edited

Loading