Merge pull request #6 from wickedOne/phpunit-baseline

phpunit baseline

Author: wickedOne

coverage2codeowner.pl

@@ -17,6 +17,8 @@
 my $paths = $ENV{'EXCLUDE_PATHS'} || '';
 my @excludes = split /,/, $paths;
 
-my $phpunit = PHPUnit->new($owner, CODEOWNERS_FILE, CLASSMAP_FILE, $coverage, @excludes);
+my $baseline = $ENV{'PHPUNIT_BASELINE'} || undef;
+
+my $phpunit = PHPUnit->new($owner, CODEOWNERS_FILE, CLASSMAP_FILE, $coverage, \@excludes, $baseline);
 
 exit $phpunit->Parse();

doc/PHPUnit.md

@@ -14,6 +14,7 @@ the following environment variables are used by all scripts
 
 the following environment variable is used by the coverage2codeowner script
 - `MIN_COVERAGE` (optional): minimum coverage required for the job to succeed. defaults to 0.1
+- `PHPUNIT_BASELINE` (optional): filepath of file containing paths to files and / or directories which are within the defined code space, but should be ignored while calculating coverage statistics.
 
 ### assumptions
 
@@ -32,9 +33,10 @@ this way the other coverage artifacts (junit & xml) can be used by for example i
 >    needs:
 >      - composer-install
 >    variables:
->      MIN_COVERAGE: '85.00'
 >      DEV_TEAM: '@team-awesome'
 >      EXCLUDE_PATHS: 'legacy/'
+>      MIN_COVERAGE: '85.00'
+>      PHPUNIT_BASELINE: './baselines/phpunit.txt'
 >    artifacts:
 >      expire_in: 1 hour
 >      when: always

lib/PHPUnit.pm

@@ -1,11 +1,14 @@
 #------------------------------------------------------------------------------
 # File:         PHPUnit.pm
 #
-# Description:  Parses PHPUnit coverage output and filters it for given 
+# Description:  Parses PHPUnit coverage output and filters it for given
 #               code owner. Provides option to fail if coverage is below
-#               rquired threshold
+#               required threshold
 #
 # Revisions:    2023-01-21 - created
+#               2024-01-23 - added baseline option to ignore certain paths / files
+#                            within owner's code-space.
+#                            sort stats output for ease of lookup
 #------------------------------------------------------------------------------
 package PHPUnit;
 
@@ -48,23 +51,38 @@ my %classreport = ();
 #          2) string path to classmap file
 #          3) float minimal coverage percentage threshold, defaults to 0.0
 #          4) array code owner paths to exclude
+#          5) string path to baseline file, defaults to undef
 #
 # Returns: reference to PHPUnit object
 sub new {
-    my ($class, $owner, $codeowners, $classmap, $threshold, @excludes) = @_;
+    my ($class, $owner, $codeowners, $classmap, $threshold, $excludes, $baseline) = @_;
 
-    my $gitlab = Gitlab->new($codeowners, $owner, @excludes);
+    my $gitlab = Gitlab->new($codeowners, $owner, @{$excludes});
     my $composer = Composer->new($classmap);
 
     my $self = {
         gitlab    => $gitlab,
         composer  => $composer,
         owner     => $owner,
         threshold => $threshold || 0.0,
+        baseline  => [],
     };
 
     bless $self, $class;
 
+    if  (defined $baseline) {
+        open(FH, $baseline) or die "unable to open phpunit baseline file ${baseline} $!";
+        my @lines = ();
+
+        while (<FH>) {
+            chomp $_;
+            push(@lines, $_);
+        }
+        close(FH);
+
+        $self->{baseline} = \@lines;
+    }
+
     return $self;
 }
 
@@ -79,8 +97,9 @@ sub Parse {
         chomp $_;
 
         # ignore lines with spaces
-        next unless $_ =~ /[^ ]/;
+        next unless $_ =~ /^[^ ]+$/;
         next unless $self->{composer}->Match($_, $self->{gitlab}->GetPaths());
+        next if $self->{composer}->Match($_, @{$self->{baseline}});
         next if $self->{composer}->Match($_, $self->{gitlab}->GetBlacklistPaths());
 
         # read next line for stats
@@ -150,8 +169,8 @@ sub Report {
         print "% (" . $lines{'covered'} . "/" . $lines{'total'} . ")\n\n";
     }
 
-    while (my ($key, $value) = each %classreport) {
-        print "$key\n$value\n";
+    foreach my $stats (sort keys %classreport) {
+        printf "%s\n%s\n", $stats , $classreport{$stats};
     }
 }
 
@@ -184,4 +203,4 @@ sub CollectStats {
     $lines{'total'} += $linesTotal;
 }
 
-1;
+1;