feat: add Testo coverage engine and program runner integration

Author: xepozz

gradle.properties

@@ -19,7 +19,7 @@ platformPlugins=com.jetbrains.php:243.25659.59,com.jetbrains.hackathon.indices.v
 # Example: platformBundledPlugins = com.intellij.java
 platformBundledPlugins =
 # Example: platformBundledModules = intellij.spellchecker
-platformBundledModules =
+platformBundledModules = intellij.platform.coverage
 
 # Gradle Releases -> https://github.com/gradle/gradle/releases
 gradleVersion = 9.3.0

src/main/kotlin/com/github/xepozz/testo/coverage/TestoCoverageEngine.kt

@@ -0,0 +1,51 @@
+package com.github.xepozz.testo.coverage
+
+import com.github.xepozz.testo.tests.run.TestoRunConfiguration
+import com.intellij.coverage.CoverageFileProvider
+import com.intellij.coverage.CoverageRunner
+import com.intellij.coverage.CoverageSuite
+import com.intellij.execution.configurations.RunConfigurationBase
+import com.intellij.execution.configurations.coverage.CoverageEnabledConfiguration
+import com.jetbrains.php.phpunit.coverage.PhpCoverageSuite
+import com.jetbrains.php.phpunit.coverage.PhpUnitCoverageEngine
+import com.jetbrains.php.phpunit.coverage.PhpUnitCoverageRunner
+
+
+class TestoCoverageEnabledConfiguration(
+    configuration: TestoRunConfiguration
+) : CoverageEnabledConfiguration(configuration, CoverageRunner.getInstance(PhpUnitCoverageRunner::class.java)) {
+    override fun coverageFileNameSeparator(): String = "@"
+
+    // Testo writes the Clover report to a path hardcoded inside the project's `testo.php`
+    // (see `new CloverReport(__DIR__ . '/runtime/clover.xml')`). Until Testo exposes a
+    // `--coverage-clover=<path>` CLI flag, we mirror that convention so the IDE reads
+    // coverage from the same place Testo writes it.
+    override fun getCoverageFilePath(): String =
+        configuration.project.basePath?.let { "$it/runtime/clover.xml" } ?: super.getCoverageFilePath()!!
+}
+
+class TestoCoverageEngine : PhpUnitCoverageEngine() {
+    override fun isApplicableTo(conf: RunConfigurationBase<*>) = conf is TestoRunConfiguration
+
+    override fun createCoverageEnabledConfiguration(conf: RunConfigurationBase<*>) =
+        TestoCoverageEnabledConfiguration(conf as TestoRunConfiguration)
+
+    override fun createCoverageSuite(
+        covRunner: CoverageRunner,
+        name: String,
+        coverageDataFileProvider: CoverageFileProvider,
+        config: CoverageEnabledConfiguration
+    ): CoverageSuite? {
+        if (config is TestoCoverageEnabledConfiguration) {
+            return PhpCoverageSuite(
+                name,
+                config.configuration.project,
+                covRunner,
+                coverageDataFileProvider,
+                config.createTimestamp()
+            )
+        }
+
+        return null
+    }
+}

src/main/kotlin/com/github/xepozz/testo/coverage/TestoCoverageProgramRunner.kt

@@ -0,0 +1,78 @@
+package com.github.xepozz.testo.coverage
+
+import com.github.xepozz.testo.tests.run.TestoRunConfiguration
+import com.intellij.execution.configurations.RunProfile
+import com.intellij.execution.configurations.RunProfileState
+import com.intellij.execution.runners.ExecutionEnvironment
+import com.jetbrains.php.config.commandLine.PhpCommandSettings
+import com.jetbrains.php.config.interpreters.PhpInterpreter
+import com.jetbrains.php.debug.xdebug.options.XdebugConfigurationOptionsManager
+import com.jetbrains.php.phpunit.coverage.PhpCoverageRunner
+import com.jetbrains.php.phpunit.coverage.PhpUnitCoverageEngine.CoverageEngine
+import com.jetbrains.php.run.PhpConfigurationOption
+import com.jetbrains.php.run.PhpRunConfigurationHolder
+
+open class TestoCoverageProgramRunner : PhpCoverageRunner() {
+    companion object {
+        const val EXECUTOR_ID: String = "Coverage"
+        const val RUNNER_ID: String = "TestoCoverageRunner"
+    }
+
+    override fun canRun(executorId: String, profile: RunProfile) =
+        executorId == EXECUTOR_ID && profile is TestoRunConfiguration
+
+    override fun createCoverageArguments(targetCoverage: String?) = mutableListOf("--coverage")
+
+    override fun getRunnerId(): String = RUNNER_ID
+
+    override fun createState(
+        env: ExecutionEnvironment,
+        interpreter: PhpInterpreter,
+        runConfigurationHolder: PhpRunConfigurationHolder<*>,
+        coverageArguments: MutableList<String>,
+        localCoverage: String,
+        targetCoverage: String
+    ): RunProfileState? {
+        val runConfiguration = runConfigurationHolder.runConfiguration as TestoRunConfiguration
+
+        val command = createTestoCoverageCommand(
+            runConfiguration,
+            interpreter,
+            coverageArguments,
+            localCoverage,
+            targetCoverage,
+        )
+
+        runConfiguration.checkConfiguration()
+        return runConfiguration.getState(env, command, null)
+    }
+
+    fun createTestoCoverageCommand(
+        runConfiguration: TestoRunConfiguration,
+        interpreter: PhpInterpreter,
+        coverageArguments: List<String>,
+        localCoverage: String,
+        targetCoverage: String
+    ): PhpCommandSettings {
+        val command = runConfiguration.createCommand(
+            interpreter,
+            mutableMapOf<String, String>(),
+            coverageArguments.toMutableList(),
+            true,
+        )
+
+        val options = when (runConfiguration.testoSettings.getTestoRunnerSettings().coverageEngine) {
+            CoverageEngine.XDEBUG -> XdebugConfigurationOptionsManager
+                .getConfigurationOptionsProvider(runConfiguration.project, interpreter)
+                .enableCoverage()
+                .createXdebugConfigurations()
+
+            CoverageEngine.PCOV -> listOf(PhpConfigurationOption("pcov.enabled", 1))
+            else -> throw IllegalArgumentException("Unsupported coverage engine.")
+        }
+        command.addConfigurationOptions(options)
+        setAdditionalMapping(localCoverage, targetCoverage, command)
+
+        return command
+    }
+}

src/main/resources/META-INF/coverage.xml

@@ -0,0 +1,6 @@
+<idea-plugin>
+    <extensions defaultExtensionNs="com.intellij">
+        <coverageEngine implementation="com.github.xepozz.testo.coverage.TestoCoverageEngine"/>
+        <programRunner implementation="com.github.xepozz.testo.coverage.TestoCoverageProgramRunner"/>
+    </extensions>
+</idea-plugin>

src/main/resources/META-INF/plugin.xml

@@ -6,6 +6,7 @@
 
     <depends>com.intellij.modules.platform</depends>
     <depends>com.jetbrains.php</depends>
+    <depends optional="true" config-file="coverage.xml">com.intellij.modules.coverage</depends>
 
     <resource-bundle>messages.TestoBundle</resource-bundle>