Jaguar Portal Submit is a command line application responsible for collecting Spectrum-based Fault Localization (SFL) data generated by the Jaguar 2 tool and submitting it to Jaguar Portal Web. This application is also available as a GitHub Action, can be used in GitHub Actions and it's available on GitHub Marketplace.
Jaguar Portal is a solution composed of a group of tools that together bring the Spectrum-based Fault Localization (SFL) functionality in a continuous integration environment:
- Jaguar 2 - JavA coveraGe faUlt locAlization Rank 2 - Jaguar implements the Spectrum-based Fault Localization (SFL) technique for Java programs.
- Jaguar Portal Web - Web API and Web Site responsible for receiving and displaying Spectrum-based Fault Localization (SFL) information.
- Jaguar Portal Submit - Command Line responsible for submitting Spectrum-based Fault Localization (SFL) data to the Jaguar Portal Web API. This component is also available as a GitHub Action, for use in GitHub Actions.
Add jaguar2 dependency on your POM.XML:
<dependency>
<groupId>br.usp.each.saeg</groupId>
<artifactId>jaguar2-junit4</artifactId>
<version>0.0.2-SNAPSHOT</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>br.usp.each.saeg</groupId>
<artifactId>jaguar2-jacoco-provider</artifactId>
<version>0.0.2-SNAPSHOT</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>br.usp.each.saeg</groupId>
<artifactId>jaguar2-xml-exporter</artifactId>
<version>0.0.2-SNAPSHOT</version>
<scope>test</scope>
</dependency>
And add plugins:
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.7</version>
<executions>
<execution>
<id>prepare-agent</id>
<goals>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
<id>report</id>
<phase>prepare-package</phase>
<goals>
<goal>report</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<properties>
<property>
<name>listener</name>
<value>br.usp.each.saeg.jaguar2.junit.JaguarJUnitRunListener</value>
</property>
</properties>
<systemPropertyVariables>
<jaguar2.classesDirs>target/classes</jaguar2.classesDirs>
</systemPropertyVariables>
</configuration>
</plugin>
In your GitHub Actions add Jaguar Portal Submit:
- name: Submit to Jaguar Portal
uses: saeg/[email protected]
if: failure()
with:
jaguarPortalProjectKey: {{GENERATED BY JAGUAR PORTAL WEB}}
jaguarPortalHostUrl: {{URL HOSTED YOUR JAGUAR PORTAL WEB}}
jaguarPortalClientId: {{GENERATED BY JAGUAR PORTAL WEB}}
jaguarPortalClientSecret: ${{ secrets.jaguarPortalClientSecret }}
jaguarPortalAnalysisPath: /target
After running a GitHub Action, if any test fails, Jaguar 2 will generate SFL data in the /target directory, and when Jaguar Portal Submit is run, it will collect this data and send it to the Jaguar Portal Web.
The TOP 10 results can be viewed in Annotations itself, see an example:
You can also view the Pull Request conversation:
Or via the Jaguar Portal Web, where you can view SFL information together with the code, showing suspicious lines marked with colors ranging from green (least suspicious) to red (most suspicious):
