Support file and package exclusions for Scala 3.4.2+

Author: jozic

README.md

@@ -325,8 +325,10 @@ If you want to customize plugin's configuration parameters used by compilation s
 </project>
 ```
 
-Read [SBT SCoverage Plugin documentation](https://github.com/scoverage/sbt-scoverage) for more information about [highlighting](https://github.com/scoverage/sbt-scoverage#highlighting) and [excludedPackages](https://github.com/scoverage/sbt-scoverage#exclude-classes-and-packages).
+Read [SBT SCoverage Plugin documentation](https://github.com/scoverage/sbt-scoverage) for more information about
+[excludedPackages and excludedFiles](https://github.com/scoverage/sbt-scoverage?tab=readme-ov-file#exclude-classes-and-packages-and-files).
 
+File and package exclusions are supported for Scala 2 and Scala 3 since version `3.4.2`.
 
 ### Checking minimum test coverage level
 

src/it/integration_tests_parent/pom.xml

@@ -18,7 +18,7 @@
 
         <compiler.plugin.version>3.11.0</compiler.plugin.version>
         <surefire.plugin.version>3.1.2</surefire.plugin.version>
-        <scala.plugin.version>4.8.1</scala.plugin.version>
+        <scala.plugin.version>4.9.1</scala.plugin.version>
         <scalatest.plugin.version>2.0.0</scalatest.plugin.version>
         <project-info-reports.plugin.version>3.5.0</project-info-reports.plugin.version>
         <site.plugin.version>3.12.1</site.plugin.version>

src/it/test_exclusion_Scala3_4_1/invoker.properties

@@ -0,0 +1 @@
+invoker.goals=clean verify site -e -ntp

src/it/test_exclusion_Scala3_4_1/pom.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>it.scoverage-maven-plugin</groupId>
+        <artifactId>integration_tests_parent</artifactId>
+        <version>1.0-SNAPSHOT</version>
+        <relativePath>../integration_tests_parent/pom.xml</relativePath>
+    </parent>
+
+    <artifactId>test_exclusion</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <packaging>jar</packaging>
+    <name>Test Scoverage exclusion</name>
+    <description>Test Scoverage exclusion</description>
+
+    <properties>
+        <scala.compat.version>3</scala.compat.version>
+        <scala.version>3.4.1</scala.version>
+        <scala.library.artifact.id>scala3-library_3</scala.library.artifact.id>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>net.alchim31.maven</groupId>
+                <artifactId>scala-maven-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.scalatest</groupId>
+                <artifactId>scalatest-maven-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>@project.groupId@</groupId>
+                <artifactId>@project.artifactId@</artifactId>
+                <configuration>
+                    <excludedPackages>.*package02.*;.*package05</excludedPackages>
+                    <excludedFiles>.*Package03HelloService.*;.*Package03ByeService</excludedFiles>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

src/it/test_exclusion_Scala3_4_1/src/main/scala/org/package01/Package01HelloService.scala

@@ -0,0 +1,8 @@
+package org.package01
+
+object Package01HelloService {
+
+  // gonna be included in coverage report
+  def hello: String = "Hello from package01"
+
+}

src/it/test_exclusion_Scala3_4_1/src/main/scala/org/package02/nested02/package02nested02objects.scala

@@ -0,0 +1,14 @@
+// gonna be excluded from coverage report by package exclusion
+package org.package02.nested02
+
+object ImGonnaBeExcludedCauseImInPackage02Nested02 {
+
+  def hello: String = "Hello from package02.nested02"
+
+}
+
+object SameStoryBro {
+
+  def hello: String = "Hello from package02.nested02 again"
+
+}

src/it/test_exclusion_Scala3_4_1/src/main/scala/org/package02/package02objects.scala

@@ -0,0 +1,14 @@
+// gonna be excluded from coverage report by package exclusion
+package org.package02
+
+object ImGonnaBeExcludedCauseImInPackage02 {
+
+  def hello: String = "Hello from package02"
+
+}
+
+object SameStoryBro {
+
+  def hello: String = "Hello from package02 again"
+
+}

src/it/test_exclusion_Scala3_4_1/src/main/scala/org/package03/Package03ByeService.scala

@@ -0,0 +1,8 @@
+package org.package03
+
+object Package03ByeService {
+
+  // gonna be excluded from coverage report by file exclusion
+  def bye: String = "Bye from package03"
+
+}

src/it/test_exclusion_Scala3_4_1/src/main/scala/org/package03/Package03HelloService1.scala

@@ -0,0 +1,8 @@
+package org.package03
+
+object Package03HelloService1 {
+
+  // gonna be excluded from coverage report by file exclusion
+  def hello: String = "Hello from package03 service 1"
+
+}

src/it/test_exclusion_Scala3_4_1/src/main/scala/org/package03/Package03HelloService2.scala

@@ -0,0 +1,8 @@
+package org.package03
+
+object Package03HelloService2 {
+
+  // gonna be excluded from coverage report by file exclusion
+  def hello: String = "Hello from package03 service 2"
+
+}

src/it/test_exclusion_Scala3_4_1/src/main/scala/org/package05/package05objects.scala

@@ -0,0 +1,14 @@
+// gonna be excluded from coverage report by package exclusion
+package org.package05
+
+object ImGonnaBeExcludedCauseImInPackage05 {
+
+  def hello: String = "Hello from package05"
+
+}
+
+object SameStoryBro {
+
+  def hello: String = "Hello from package05 again"
+
+}

src/it/test_exclusion_Scala3_4_1/src/test/scala/org/package01/Package01HelloServiceTest.scala

@@ -0,0 +1,12 @@
+package org.package01
+
+import org.scalatest.wordspec.AnyWordSpec
+
+class Package01HelloServiceTest extends AnyWordSpec {
+
+  "Package01HelloService" should {
+    "say hello" in {
+      assert(Package01HelloService.hello == "Hello from package01")
+    }
+  }
+}

src/it/test_exclusion_Scala3_4_1/validate.groovy

@@ -0,0 +1,14 @@
+try {
+
+    def logFile = new File(basedir, "build.log")
+    def lines = logFile.readLines()
+    assert lines.contains("[WARNING] Package exclusion is supported since Scala 3.4.2")
+    assert lines.contains("[WARNING] File exclusion is supported since Scala 3.4.2")
+    assert lines.contains("[INFO] Statement coverage.: 10.00%")
+
+    return true
+
+} catch (Throwable e) {
+    e.printStackTrace()
+    return false
+}

src/it/test_exclusion_Scala3_4_2/invoker.properties

@@ -0,0 +1 @@
+invoker.goals=clean verify site -e -ntp

src/it/test_exclusion_Scala3_4_2/pom.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>it.scoverage-maven-plugin</groupId>
+        <artifactId>integration_tests_parent</artifactId>
+        <version>1.0-SNAPSHOT</version>
+        <relativePath>../integration_tests_parent/pom.xml</relativePath>
+    </parent>
+
+    <artifactId>test_exclusion</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <packaging>jar</packaging>
+    <name>Test Scoverage exclusion</name>
+    <description>Test Scoverage exclusion</description>
+
+    <properties>
+        <scala.compat.version>3</scala.compat.version>
+        <scala.version>3.4.2</scala.version>
+        <scala.library.artifact.id>scala3-library_3</scala.library.artifact.id>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>net.alchim31.maven</groupId>
+                <artifactId>scala-maven-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.scalatest</groupId>
+                <artifactId>scalatest-maven-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>@project.groupId@</groupId>
+                <artifactId>@project.artifactId@</artifactId>
+                <configuration>
+                    <excludedPackages>.*package02.*;.*package05</excludedPackages>
+                    <excludedFiles>.*Package03HelloService.*;.*Package03ByeService</excludedFiles>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

src/it/test_exclusion_Scala3_4_2/src/main/scala/org/package01/Package01HelloService.scala

@@ -0,0 +1,8 @@
+package org.package01
+
+object Package01HelloService {
+
+  // gonna be included in coverage report
+  def hello: String = "Hello from package01"
+
+}

src/it/test_exclusion_Scala3_4_2/src/main/scala/org/package02/nested02/package02nested02objects.scala

@@ -0,0 +1,14 @@
+// gonna be excluded from coverage report by package exclusion
+package org.package02.nested02
+
+object ImGonnaBeExcludedCauseImInPackage02Nested02 {
+
+  def hello: String = "Hello from package02.nested02"
+
+}
+
+object SameStoryBro {
+
+  def hello: String = "Hello from package02.nested02 again"
+
+}

src/it/test_exclusion_Scala3_4_2/src/main/scala/org/package02/package02objects.scala

@@ -0,0 +1,14 @@
+// gonna be excluded from coverage report by package exclusion
+package org.package02
+
+object ImGonnaBeExcludedCauseImInPackage02 {
+
+  def hello: String = "Hello from package02"
+
+}
+
+object SameStoryBro {
+
+  def hello: String = "Hello from package02 again"
+
+}

src/it/test_exclusion_Scala3_4_2/src/main/scala/org/package03/Package03ByeService.scala

@@ -0,0 +1,8 @@
+package org.package03
+
+object Package03ByeService {
+
+  // gonna be excluded from coverage report by file exclusion
+  def bye: String = "Bye from package03"
+
+}

src/it/test_exclusion_Scala3_4_2/src/main/scala/org/package03/Package03HelloService1.scala

@@ -0,0 +1,8 @@
+package org.package03
+
+object Package03HelloService1 {
+
+  // gonna be excluded from coverage report by file exclusion
+  def hello: String = "Hello from package03 service 1"
+
+}

src/it/test_exclusion_Scala3_4_2/src/main/scala/org/package03/Package03HelloService2.scala

@@ -0,0 +1,8 @@
+package org.package03
+
+object Package03HelloService2 {
+
+  // gonna be excluded from coverage report by file exclusion
+  def hello: String = "Hello from package03 service 2"
+
+}

src/it/test_exclusion_Scala3_4_2/src/main/scala/org/package05/package05objects.scala

@@ -0,0 +1,14 @@
+// gonna be excluded from coverage report by package exclusion
+package org.package05
+
+object ImGonnaBeExcludedCauseImInPackage05 {
+
+  def hello: String = "Hello from package05"
+
+}
+
+object SameStoryBro {
+
+  def hello: String = "Hello from package05 again"
+
+}

src/it/test_exclusion_Scala3_4_2/src/test/scala/org/package01/Package01HelloServiceTest.scala

@@ -0,0 +1,12 @@
+package org.package01
+
+import org.scalatest.wordspec.AnyWordSpec
+
+class Package01HelloServiceTest extends AnyWordSpec {
+
+  "Package01HelloService" should {
+    "say hello" in {
+      assert(Package01HelloService.hello == "Hello from package01")
+    }
+  }
+}

src/it/test_exclusion_Scala3_4_2/validate.groovy

@@ -0,0 +1,19 @@
+try {
+
+    def logFile = new File(basedir, "build.log")
+    def lines = logFile.readLines()
+    assert lines.contains("[INFO] Statement coverage.: 100.00%")
+    assert lines.contains("[INFO] Branch coverage....: 100.00%")
+
+    def scoverageFile = new File(basedir, "target/scoverage.xml")
+    assert scoverageFile.exists()
+
+    def reportFile = new File(basedir, "target/site/scoverage/index.html")
+    assert reportFile.exists()
+
+    return true
+
+} catch (Throwable e) {
+    e.printStackTrace()
+    return false
+}