stryker-mutator / sonar-stryker-plugin Goto Github PK

View Code? Open in Web Editor NEW

11.0 17.0 6.0 29 KB

A plugin to report stryker results to Sonar

License: Apache License 2.0

Java 100.00%

stryker-plugin stryker-reporter sonar-plugin

sonar-stryker-plugin's Introduction

This repository contains a sonar plugin to report on Stryker, the JavaScript mutation testing framework.

Getting started

As of now the sonar-stryker-plugin is not distributed via any artifact repository. However, it can be installed manually:

Install plugin in sonar qube

Make sure you have git and maven installed locally. Make sure you have a running sonar qube server (or installed locally).

Clone this repository

git clone [email protected]:stryker-mutator/sonar-stryker-plugin.git

Package the sonar plugin
```
cd sonar-stryker-plugin
mvn package
```
Copy the target/stryker-sonar-plugin.jar to the downloads folder of your sonar qube instance (for example: /sonarqube-6.2/extensions/downloads)
Restart sonar qube
Log on to the sonar qube web interface, go to 'rules'. Two new rules should be present under language "JavaScript". Enable these rules for the profile of choice:
- Mutant not covered
- Mutant survived

Run stryker

Next, setup Stryker in your project. See stryker-mutator.github.io. Make sure to enable the 'event-recorder' reporter. This will record all reporter events and write them to disk (reports/mutation/events by default). Make sure that works before proceeding.

Report survived mutants

Run sonar in your projects folder. This can be done in a number of ways:

Using the sonar-scanner
Using the sonar-maven-plugin
(Other sonar plugins not further explained here)

Make sure you configure the sonar.sources correctly. This should point to the root directory of your source files.

For example (using the sonar-scanner):

# sonar-project.properties
sonar.sources=src

Or (using the sonar-maven-plugin)

<!-- pom.xml -->
<properties>
  <sonar.sources>src</sonar.sources>
</properties>

sonar-stryker-plugin's People

Contributors

Stargazers

Watchers

Forkers

bobvandenberge mthmulders jmpresso tscafejr jwcastillo prosidney

sonar-stryker-plugin's Issues

Error in SonarQube 7.9.1

20:08:16.925 ERROR: Error during SonarQube Scanner execution
org.picocontainer.injectors.AbstractInjector$UnsatisfiableDependenciesException: io.github.strykermutator.StrykerSensor has unsatisfied dependency 'class org.sonar.api.profiles.RulesProfile' for constructor 'public io.github.strykermutator.StrykerSensor(org.sonar.api.config.Settings,org.sonar.api.batch.fs.FileSystem,org.sonar.api.profiles.RulesProfile)' from org.sonar.core.platform.ComponentContainer$ExtendedDefaultPicoContainer@26f3d90c:104<[Immutable]:org.sonar.core.platform.ComponentContainer$ExtendedDefaultPicoContainer@45d84a20:348<[Immutable]:org.sonar.core.platform.ComponentContainer$ExtendedDefaultPicoContainer@4c48fe92:52<|
at org.picocontainer.injectors.ConstructorInjector.getGreediestSatisfiableConstructor(ConstructorInjector.java:191)
at org.picocontainer.injectors.ConstructorInjector.getGreediestSatisfiableConstructor(ConstructorInjector.java:110)
at org.picocontainer.injectors.ConstructorInjector.access$100(ConstructorInjector.java:51)
at org.picocontainer.injectors.ConstructorInjector$1.run(ConstructorInjector.java:331)
at org.picocontainer.injectors.AbstractInjector$ThreadLocalCyclicDependencyGuard.observe(AbstractInjector.java:270)
at org.picocontainer.injectors.ConstructorInjector.getComponentInstance(ConstructorInjector.java:364)
at org.picocontainer.injectors.AbstractInjectionFactory$LifecycleAdapter.getComponentInstance(AbstractInjectionFactory.java:56)
at org.picocontainer.behaviors.AbstractBehavior.getComponentInstance(AbstractBehavior.java:64)
at org.picocontainer.behaviors.Stored.getComponentInstance(Stored.java:91)
at org.picocontainer.DefaultPicoContainer.getLocalInstance(DefaultPicoContainer.java:606)
at org.picocontainer.DefaultPicoContainer.getComponents(DefaultPicoContainer.java:587)
at org.sonar.core.platform.ComponentContainer.getComponentsByType(ComponentContainer.java:290)
at org.sonar.scanner.bootstrap.AbstractExtensionDictionnary.completeScannerExtensions(AbstractExtensionDictionnary.java:82)
at org.sonar.scanner.bootstrap.AbstractExtensionDictionnary.getExtensions(AbstractExtensionDictionnary.java:77)
at org.sonar.scanner.bootstrap.AbstractExtensionDictionnary.getFilteredExtensions(AbstractExtensionDictionnary.java:67)
at org.sonar.scanner.sensor.ModuleSensorExtensionDictionnary.selectSensors(ModuleSensorExtensionDictionnary.java:40)
at org.sonar.scanner.sensor.ModuleSensorsExecutor.lambda$execute$0(ModuleSensorsExecutor.java:52)
at org.sonar.scanner.sensor.ModuleSensorsExecutor.withModuleStrategy(ModuleSensorsExecutor.java:77)
at org.sonar.scanner.sensor.ModuleSensorsExecutor.execute(ModuleSensorsExecutor.java:52)
at org.sonar.scanner.scan.ModuleScanContainer.doAfterStart(ModuleScanContainer.java:82)
at org.sonar.core.platform.ComponentContainer.startComponents(ComponentContainer.java:136)
at org.sonar.core.platform.ComponentContainer.execute(ComponentContainer.java:122)
at org.sonar.scanner.scan.ProjectScanContainer.scan(ProjectScanContainer.java:400)
at org.sonar.scanner.scan.ProjectScanContainer.scanRecursively(ProjectScanContainer.java:395)
at org.sonar.scanner.scan.ProjectScanContainer.doAfterStart(ProjectScanContainer.java:358)
at org.sonar.core.platform.ComponentContainer.startComponents(ComponentContainer.java:136)
at org.sonar.core.platform.ComponentContainer.execute(ComponentContainer.java:122)
at org.sonar.scanner.bootstrap.GlobalContainer.doAfterStart(GlobalContainer.java:141)
at org.sonar.core.platform.ComponentContainer.startComponents(ComponentContainer.java:136)
at org.sonar.core.platform.ComponentContainer.execute(ComponentContainer.java:122)
at org.sonar.batch.bootstrapper.Batch.doExecute(Batch.java:73)
at org.sonar.batch.bootstrapper.Batch.execute(Batch.java:67)
at org.sonarsource.scanner.api.internal.batch.BatchIsolatedLauncher.execute(BatchIsolatedLauncher.java:46)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:498)
at org.sonarsource.scanner.api.internal.IsolatedLauncherProxy.invoke(IsolatedLauncherProxy.java:60)
at com.sun.proxy.$Proxy0.execute(Unknown Source)
at org.sonarsource.scanner.api.EmbeddedScanner.doExecute(EmbeddedScanner.java:171)
at org.sonarsource.scanner.api.EmbeddedScanner.execute(EmbeddedScanner.java:128)
at org.sonarsource.scanner.cli.Main.execute(Main.java:111)
at org.sonarsource.scanner.cli.Main.execute(Main.java:75)
at org.sonarsource.scanner.cli.Main.main(Main.java:61)

Support implementation agnostic mutation testing schema

If anyone is still using sonar qube, it would be cool if this plugin supported the mutation-testing-report-schema. Making it compatible with (in theory) a big list of mutation testing frameworks. Stryker4s, Stryker.NET, Stryker, PIT, Mull, InfectionPHP, and anyone else that decides to allign on the schema.

https://github.com/stryker-mutator/mutation-testing-elements/tree/master/packages/mutation-testing-report-schema

Usage License

What is the license for usage of this plugin?

Support SonarQube 7.6 and up

This plugin does not support the latest versions of SonarQube. With SonarQube 7.9 LTS being released, we should update it.

There is an error during the scan:

org.picocontainer.injectors.AbstractInjector$UnsatisfiableDependenciesException: 
io.github.strykermutator.StrykerSensor has unsatisfied dependency 'class org.sonar.api.profiles.RulesProfile' for constructor 'public io.github.strykermutator.StrykerSensor(org.sonar.api.config.Settings,org.sonar.api.batch.fs.FileSystem,org.sonar.api.profiles.RulesProfile)' 
from org.sonar.core.platform.ComponentContainer$ExtendedDefaultPicoContainer@5cbe2654:104<
[Immutable]:org.sonar.core.platform.ComponentContainer$ExtendedDefaultPicoContainer@3c9168dc:348<
[Immutable]:org.sonar.core.platform.ComponentContainer$ExtendedDefaultPicoContainer@535b1ae6:52<|

This deprecated API call was removed in SonarQube 7.6: SonarSource/sonarqube@33851f1

Build fail

Hello,

When I try to build de project with:

Java: openjdk version "1.8.0_322"
Maven: Apache Maven 3.6.3

The next error is present

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.10.1:compile (default-compile) on project sonar-stryker-plugin: Fatal error compiling: java.lang.IllegalAccessError: class lombok.javac.apt.LombokProcessor (in unnamed module @0x74606204) cannot access class com.sun.tools.javac.processing.JavacProcessingEnvironment (in module jdk.compiler) because module jdk.compiler does not export com.sun.tools.javac.processing to unnamed module @0x74606204 -> [Help 1]

Workaround

Changue de lombok version

org.projectlombok lombok 1.18.24 provided

Thanks

Jar

Does a JAR of the latest version of this plugin exist anywhere that I can download it?

Background: Trying to use this at the office but when we try to build the artifact, we get maven failures because our in house repository does not contain the this projects deps and/or the versions it requires. If an existing jar doesn't exist, this will require me to go through the paperwork to get all of these deps approved before we can start using sonar-stryker-plugin.

Report Mutation Percentage Coverage Measure

Was able to verify that the plugin captured survived & not covered mutants in our Sonar DB and were viewable on the project dashboard.

Currently the above metrics are reported as issues. However, it would be nice if this plugin also stored a Coverage Measure that captured Mutation Coverage % similar to Line & Condition.

@nicojs @simondel - Any thoughts on whether this could be supported?