commit 739446ce63f09527d8df16718f96efba5d0f21e3 Author: Erik C. Thauvin Date: Tue Aug 29 08:47:13 2023 -0700 Inital commit diff --git a/.github/workflows/bld.yml b/.github/workflows/bld.yml new file mode 100644 index 0000000..2b0ba38 --- /dev/null +++ b/.github/workflows/bld.yml @@ -0,0 +1,32 @@ +name: bld-ci + +on: [ push, pull_request, workflow_dispatch ] + +jobs: + build-bld-project: + runs-on: ubuntu-latest + + strategy: + matrix: + java-version: [ 17, 20 ] + + steps: + - name: Checkout source repository + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Set up JDK ${{ matrix.java-version }} + uses: actions/setup-java@v3 + with: + distribution: 'zulu' + java-version: ${{ matrix.java-version }} + + - name: Grant execute permission for bld + run: chmod +x bld + + - name: Download the dependencies + run: ./bld download + + - name: Run tests with bld + run: ./bld compile test diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..f6122cd --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,57 @@ +name: javadocs-pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["master"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + + steps: + - name: Checkout source repository + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Set up JDK 17 + uses: actions/setup-java@v3 + with: + distribution: 'zulu' + java-version: 17 + + - name: Build Javadocs + run: ./bld download clean javadoc + + - name: Setup Pages + uses: actions/configure-pages@v3 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + # Upload generated Javadocs repository + path: 'build/javadoc/' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f301bde --- /dev/null +++ b/.gitignore @@ -0,0 +1,58 @@ +.gradle +.DS_Store +build +lib/bld/** +!lib/bld/bld-wrapper.jar +!lib/bld/bld-wrapper.properties +lib/compile/ +lib/runtime/ +lib/standalone/ +lib/test/ + +# IDEA ignores + +# User-specific +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Editor-based Rest Client +.idea/httpRequests + +# Local Properties +local.properties \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/.idea/app.iml b/.idea/app.iml new file mode 100644 index 0000000..787b59b --- /dev/null +++ b/.idea/app.iml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/bld.iml b/.idea/bld.iml new file mode 100644 index 0000000..e63e11e --- /dev/null +++ b/.idea/bld.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/copyright/Apache_License.xml b/.idea/copyright/Apache_License.xml new file mode 100644 index 0000000..15687f4 --- /dev/null +++ b/.idea/copyright/Apache_License.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/copyright/profiles_settings.xml b/.idea/copyright/profiles_settings.xml new file mode 100644 index 0000000..f2907f1 --- /dev/null +++ b/.idea/copyright/profiles_settings.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..1e01b48 --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,8 @@ + + + + \ No newline at end of file diff --git a/.idea/libraries/bld.xml b/.idea/libraries/bld.xml new file mode 100644 index 0000000..722b42e --- /dev/null +++ b/.idea/libraries/bld.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/compile.xml b/.idea/libraries/compile.xml new file mode 100644 index 0000000..9bd86aa --- /dev/null +++ b/.idea/libraries/compile.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/runtime.xml b/.idea/libraries/runtime.xml new file mode 100644 index 0000000..2ae5c4b --- /dev/null +++ b/.idea/libraries/runtime.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/libraries/test.xml b/.idea/libraries/test.xml new file mode 100644 index 0000000..b80486a --- /dev/null +++ b/.idea/libraries/test.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..3262de5 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..55adcb9 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/.idea/runConfigurations/Run Tests.xml b/.idea/runConfigurations/Run Tests.xml new file mode 100644 index 0000000..7c29bc6 --- /dev/null +++ b/.idea/runConfigurations/Run Tests.xml @@ -0,0 +1,9 @@ + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..dc9c0bf --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "java", + "name": "Run Tests", + "request": "launch", + "mainClass": "rife.bld.extension.PitestExtensionTest" + } + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..c4bc81e --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,15 @@ +{ + "java.project.sourcePaths": [ + "src/main/java", + "src/main/resources", + "src/test/java", + "src/bld/java" + ], + "java.configuration.updateBuildConfiguration": "automatic", + "java.project.referencedLibraries": [ + "${HOME}/.bld/dist/bld-1.7.2.jar", + "lib/compile/*.jar", + "lib/runtime/*.jar", + "lib/test/*.jar" + ] +} diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..49cc83d --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/README.md b/README.md new file mode 100755 index 0000000..7176ba6 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# [PIT Mutation Testing](https://pitest.org/) Extension for [bld](https://rife2.com/bldb) + +[![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Java](https://img.shields.io/badge/java-17%2B-blue)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) +[![bld](https://img.shields.io/badge/1.7.2-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld) +[![Release](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/releases/com/uwyn/rife2/bld-pitest/maven-metadata.xml?color=blue)](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-pitest) +[![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-pitest/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-pitest) +[![GitHub CI](https://github.com/rife2/bld-pitest/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-pitest/actions/workflows/bld.yml) + +To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions). + +To run mutation tests and coverage, add the following to your build file: + +```java +@BuildCommand(summary = "Run PIT mutation tests") +public void pit() throws Exception { + new PitestOperation() + .fromProject(this) + .reportDir(Path.of("reports", "mutations").toString()) + .targetClasses(pkg + ".*") + .targetTests(pkg + ".*") + .verbose(true) + .execute(); + } +``` + +``` +./bld compile pit + +``` + +- [View Examples](https://github.com/rife2/bld-pittest/blob/master/examples/src/bld/java/com/example/) + +Please check the [PitestOperation documentation](https://rife2.github.io/bld-pitest/rife/bld/extension/PitestOperation.html#method-summary) for all available configuration options. + +### Pitest (PIT) Dependency + +Don't forget to add the Pitest `test` dependencies to your build file, as they are not provided by the extension. For example: + +```java +repositories = List.of(MAVEN_CENTRAL); +scope(test) + .include(dependency("org.pitest", "pitest", version(1, 14, 4))) + .include(dependency("org.pitest", "pitest-command-line", version(1, 14, 4))) + .include(dependency("org.pitest", "pitest-junit5-plugin", version(1, 2, 0))) + .include(dependency("org.pitest", "pitest-testng-plugin", version(1, 0, 0))); +``` \ No newline at end of file diff --git a/bld b/bld new file mode 100755 index 0000000..68beba9 --- /dev/null +++ b/bld @@ -0,0 +1,2 @@ +#!/usr/bin/env sh +java -jar "$(dirname "$0")/lib/bld/bld-wrapper.jar" "$0" --build rife.bld.extension.PitestOperationBuild "$@" \ No newline at end of file diff --git a/bld.bat b/bld.bat new file mode 100644 index 0000000..4c02719 --- /dev/null +++ b/bld.bat @@ -0,0 +1,4 @@ +@echo off +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +java -jar "%DIRNAME%/lib/bld/bld-wrapper.jar" "%0" --build rife.bld.extension.PitestOperationBuild %* \ No newline at end of file diff --git a/config/pmd.xml b/config/pmd.xml new file mode 100644 index 0000000..c60ff7e --- /dev/null +++ b/config/pmd.xml @@ -0,0 +1,109 @@ + + + Erik's Ruleset + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.gitignore b/examples/.gitignore new file mode 100644 index 0000000..a2805aa --- /dev/null +++ b/examples/.gitignore @@ -0,0 +1,55 @@ +.gradle +.DS_Store +build +lib/bld/** +!lib/bld/bld-wrapper.jar +!lib/bld/bld-wrapper.properties +lib/compile/ +lib/runtime/ +lib/standalone/ +lib/test/ + +# IDEA ignores + +# User-specific +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Editor-based Rest Client +.idea/httpRequests \ No newline at end of file diff --git a/examples/.idea/.gitignore b/examples/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/examples/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/examples/.idea/app.iml b/examples/.idea/app.iml new file mode 100644 index 0000000..787b59b --- /dev/null +++ b/examples/.idea/app.iml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/bld.iml b/examples/.idea/bld.iml new file mode 100644 index 0000000..e63e11e --- /dev/null +++ b/examples/.idea/bld.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/inspectionProfiles/Project_Default.xml b/examples/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..1e01b48 --- /dev/null +++ b/examples/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,8 @@ + + + + \ No newline at end of file diff --git a/examples/.idea/libraries/bld.xml b/examples/.idea/libraries/bld.xml new file mode 100644 index 0000000..722b42e --- /dev/null +++ b/examples/.idea/libraries/bld.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/libraries/compile.xml b/examples/.idea/libraries/compile.xml new file mode 100644 index 0000000..9bd86aa --- /dev/null +++ b/examples/.idea/libraries/compile.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/libraries/runtime.xml b/examples/.idea/libraries/runtime.xml new file mode 100644 index 0000000..2ae5c4b --- /dev/null +++ b/examples/.idea/libraries/runtime.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/libraries/test.xml b/examples/.idea/libraries/test.xml new file mode 100644 index 0000000..b80486a --- /dev/null +++ b/examples/.idea/libraries/test.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/misc.xml b/examples/.idea/misc.xml new file mode 100644 index 0000000..fafd394 --- /dev/null +++ b/examples/.idea/misc.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/modules.xml b/examples/.idea/modules.xml new file mode 100644 index 0000000..55adcb9 --- /dev/null +++ b/examples/.idea/modules.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/examples/.idea/runConfigurations/Run Tests.xml b/examples/.idea/runConfigurations/Run Tests.xml new file mode 100644 index 0000000..c2657f9 --- /dev/null +++ b/examples/.idea/runConfigurations/Run Tests.xml @@ -0,0 +1,9 @@ + + + + \ No newline at end of file diff --git a/examples/.idea/vcs.xml b/examples/.idea/vcs.xml new file mode 100644 index 0000000..6c0b863 --- /dev/null +++ b/examples/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/examples/.vscode/launch.json b/examples/.vscode/launch.json new file mode 100644 index 0000000..71f6bb3 --- /dev/null +++ b/examples/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "java", + "name": "Run Tests", + "request": "launch", + "mainClass": "com.example.ExamplesTest" + } + ] +} diff --git a/examples/.vscode/settings.json b/examples/.vscode/settings.json new file mode 100644 index 0000000..c4bc81e --- /dev/null +++ b/examples/.vscode/settings.json @@ -0,0 +1,15 @@ +{ + "java.project.sourcePaths": [ + "src/main/java", + "src/main/resources", + "src/test/java", + "src/bld/java" + ], + "java.configuration.updateBuildConfiguration": "automatic", + "java.project.referencedLibraries": [ + "${HOME}/.bld/dist/bld-1.7.2.jar", + "lib/compile/*.jar", + "lib/runtime/*.jar", + "lib/test/*.jar" + ] +} diff --git a/examples/bld b/examples/bld new file mode 100755 index 0000000..762c8a2 --- /dev/null +++ b/examples/bld @@ -0,0 +1,2 @@ +#!/usr/bin/env sh +java -jar "$(dirname "$0")/lib/bld/bld-wrapper.jar" "$0" --build com.example.ExamplesBuild "$@" \ No newline at end of file diff --git a/examples/bld.bat b/examples/bld.bat new file mode 100644 index 0000000..e2dec1b --- /dev/null +++ b/examples/bld.bat @@ -0,0 +1,4 @@ +@echo off +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +java -jar "%DIRNAME%/lib/bld/bld-wrapper.jar" "%0" --build com.example.ExamplesBuild %* \ No newline at end of file diff --git a/examples/lib/bld/bld-wrapper.jar b/examples/lib/bld/bld-wrapper.jar new file mode 100644 index 0000000..491367b Binary files /dev/null and b/examples/lib/bld/bld-wrapper.jar differ diff --git a/examples/lib/bld/bld-wrapper.properties b/examples/lib/bld/bld-wrapper.properties new file mode 100644 index 0000000..1d80158 --- /dev/null +++ b/examples/lib/bld/bld-wrapper.properties @@ -0,0 +1,7 @@ +bld.downloadExtensionJavadoc=false +bld.downloadExtensionSources=true +bld.extensions=com.uwyn.rife2:bld-pitest:0.9.0-SNAPSHOT +bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_RELEASES +bld.downloadLocation= +bld.sourceDirectories= +bld.version=1.7.2 diff --git a/examples/reports/mutations/com.example/ExamplesLib.java.html b/examples/reports/mutations/com.example/ExamplesLib.java.html new file mode 100644 index 0000000..f21aa06 --- /dev/null +++ b/examples/reports/mutations/com.example/ExamplesLib.java.html @@ -0,0 +1,166 @@ + + + + + + + + + +

ExamplesLib.java

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +1 + + + + + + +
package com.example;
+ +2 + + + + + + +
+ +3 + + + + + + +
public class ExamplesLib {
+ +4 + + + + + + +
    public String getMessage() {
+ +5 + + +1 + +1. getMessage : replaced return value with "" for com/example/ExamplesLib::getMessage → KILLED
+ + + +
        return "Hello World!";
+ +6 + + + + + + +
    }
+ +7 + + + + + + +
}

Mutations

5 + + + +

1.1
Location : getMessage
Killed by : com.example.ExamplesTest.[engine:junit-jupiter]/[class:com.example.ExamplesTest]/[method:verifyHello()] replaced return value with "" for com/example/ExamplesLib::getMessage → KILLED

+
+ + +

Active mutators

+ + +

Tests examined

+ + +
+ +Report generated by PIT 1.14.4 + + + \ No newline at end of file diff --git a/examples/reports/mutations/com.example/ExamplesTest.java.html b/examples/reports/mutations/com.example/ExamplesTest.java.html new file mode 100644 index 0000000..669726b --- /dev/null +++ b/examples/reports/mutations/com.example/ExamplesTest.java.html @@ -0,0 +1,241 @@ + + + + + + + + + +

ExamplesTest.java

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +1 + + + + + + +
package com.example;
+ +2 + + + + + + +
+ +3 + + + + + + +
import org.junit.jupiter.api.Test;
+ +4 + + + + + + +
+ +5 + + + + + + +
import static org.junit.jupiter.api.Assertions.assertEquals;
+ +6 + + + + + + +
+ +7 + + + + + + +
public class ExamplesTest {
+ +8 + + + + + + +
    @Test
+ +9 + + + + + + +
    void verifyHello() {
+ +10 + + +1 + +1. verifyHello : removed call to org/junit/jupiter/api/Assertions::assertEquals → SURVIVED
+ + + +
        assertEquals("Hello World!", new ExamplesLib().getMessage());
+ +11 + + + + + + +
    }
+ +12 + + + + + + +
}

Mutations

10 + + + +

1.1
Location : verifyHello
Killed by : none removed call to org/junit/jupiter/api/Assertions::assertEquals → SURVIVED

+
+ + +

Active mutators

+ + +

Tests examined

+ + +
+ +Report generated by PIT 1.14.4 + + + \ No newline at end of file diff --git a/examples/reports/mutations/com.example/index.html b/examples/reports/mutations/com.example/index.html new file mode 100644 index 0000000..d8b9fcc --- /dev/null +++ b/examples/reports/mutations/com.example/index.html @@ -0,0 +1,69 @@ + + + + + + + + +

Pit Test Coverage Report

+

Package Summary

+

com.example

+ + + + + + + + + + + + + + + + + +
Number of ClassesLine CoverageMutation CoverageTest Strength
2100%
5/5
50%
1/2
50%
1/2
+ + +

Breakdown by Class

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameLine CoverageMutation CoverageTest Strength
ExamplesLib.java
100%
2/2
100%
1/1
100%
1/1
ExamplesTest.java
100%
3/3
0%
0/1
0%
0/1
+
+ + + +
+ +Report generated by PIT 1.14.4 + + + \ No newline at end of file diff --git a/examples/reports/mutations/index.html b/examples/reports/mutations/index.html new file mode 100644 index 0000000..da07e20 --- /dev/null +++ b/examples/reports/mutations/index.html @@ -0,0 +1,69 @@ + + + + + + + + +

Pit Test Coverage Report

+ +

Project Summary

+ + + + + + + + + + + + + + + + + +
Number of ClassesLine CoverageMutation CoverageTest Strength
2100%
5/5
50%
1/2
50%
1/2
+ + +

Breakdown by Package

+ + + + + + + + + + + + + + + + + + + + + +
NameNumber of ClassesLine CoverageMutation CoverageTest Strength
com.example2
100%
5/5
50%
1/2
50%
1/2
+
+ + + +
+ +Report generated by PIT 1.14.4 + +
+
+ +Enhanced functionality available at arcmutate.com + + + \ No newline at end of file diff --git a/examples/reports/mutations/style.css b/examples/reports/mutations/style.css new file mode 100644 index 0000000..303bfba --- /dev/null +++ b/examples/reports/mutations/style.css @@ -0,0 +1,563 @@ +html, body, div, span, p, blockquote, pre { + margin: 0; + padding: 0; + border: 0; + outline: 0; + font-weight: inherit; + font-style: inherit; + font-size: 100%; + font-family: inherit; + vertical-align: baseline; +} + +body{ + line-height: 1; + color: black; + background: white; + margin-left: 20px; +} + +.src { + border: 1px solid #dddddd; + padding-top: 10px; + padding-right: 5px; + padding-left: 5px; + font-family: Consolas, Courier, monospace; +} + +.covered, .COVERED { + background-color: #ddffdd; +} + +.uncovered, .UNCOVERED { + background-color: #ffdddd; +} + +.killed, .KILLED { + background-color: #aaffaa; +} + +.survived, .SURVIVED { + background-color: #ffaaaa; +} + +.uncertain, .UNCERTAIN { + background-color: #dde7ef; +} + +.run_error, .RUN_ERROR { + background-color: #dde7ef; +} + +.na { + background-color: #eeeeee; +} + +.timed_out, .TIMED_OUT { + background-color: #dde7ef; +} + +.non_viable, .NON_VIABLE { + background-color: #aaffaa; +} + +.memory_error, .MEMORY_ERROR { + background-color: #dde7ef; +} + +.not_started, .NO_STARTED { + background-color: #dde7ef; color : red +} + +.no_coverage, .NO_COVERAGE { + background-color: #ffaaaa; +} + +.tests { + width: 50%; + float: left; +} + +.mutees { + float: right; + width: 50%; +} + +.unit { + padding-top: 20px; + clear: both; +} + +.coverage_bar { + display: inline-block; + height: 1.1em; + width: 130px; + background: #FAA; + margin: 0 5px; + vertical-align: middle; + border: 1px solid #AAA; + position: relative; +} + +.coverage_complete { + display: inline-block; + height: 100%; + background: #DFD; + float: left; +} + +.coverage_legend { + position: absolute; + height: 100%; + width: 100%; + left: 0; + top: 0; + text-align: center; +} + +.line, .mut { + vertical-align: middle; +} + +.coverage_percentage { + display: inline-block; + width: 3em; + text-align: right; +} + +.pop { + outline:none; +} + +.pop strong { + line-height: 30px; +} + +.pop { + text-decoration: none; +} + +.pop span { + z-index: 10; + display: none; + padding: 14px 20px; + margin-top: -30px; + margin-left: 28px; + width: 800px; + line-height: 16px; + word-wrap: break-word; + border-radius: 4px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + -moz-box-shadow: 5px 5px 8px #CCC; + -webkit-box-shadow: 5px 5px 8px #CCC; + box-shadow: 5px 5px 8px #CCC; +} + +.pop:hover span { + display: inline; + position: absolute; + color: #111; + border: 1px solid #DCA; + background: #fffAF0; +} + +.width-1 { + width: 1%; +} + +.width-2 { + width: 2%; +} + +.width-3 { + width: 3%; +} + +.width-4 { + width: 4%; +} + +.width-5 { + width: 5%; +} + +.width-6 { + width: 6%; +} + +.width-7 { + width: 7%; +} + +.width-8 { + width: 8%; +} + +.width-9 { + width: 9%; +} + +.width-10 { + width: 10%; +} + +.width-11 { + width: 11%; +} + +.width-12 { + width: 12%; +} + +.width-13 { + width: 13%; +} + +.width-14 { + width: 14%; +} + +.width-15 { + width: 15%; +} + +.width-16 { + width: 16%; +} + +.width-17 { + width: 17%; +} + +.width-18 { + width: 18%; +} + +.width-19 { + width: 19%; +} + +.width-20 { + width: 20%; +} + +.width-21 { + width: 21%; +} + +.width-22 { + width: 22%; +} + +.width-23 { + width: 23%; +} + +.width-24 { + width: 24%; +} + +.width-25 { + width: 25%; +} + +.width-26 { + width: 26%; +} + +.width-27 { + width: 27%; +} + +.width-28 { + width: 28%; +} + +.width-29 { + width: 29%; +} + +.width-30 { + width: 30%; +} + +.width-31 { + width: 31%; +} + +.width-32 { + width: 32%; +} + +.width-33 { + width: 33%; +} + +.width-34 { + width: 34%; +} + +.width-35 { + width: 35%; +} + +.width-36 { + width: 36%; +} + +.width-37 { + width: 37%; +} + +.width-38 { + width: 38%; +} + +.width-39 { + width: 39%; +} + +.width-40 { + width: 40%; +} + +.width-41 { + width: 41%; +} + +.width-42 { + width: 42%; +} + +.width-43 { + width: 43%; +} + +.width-44 { + width: 44%; +} + +.width-45 { + width: 45%; +} + +.width-46 { + width: 46%; +} + +.width-47 { + width: 47%; +} + +.width-48 { + width: 48%; +} + +.width-49 { + width: 49%; +} + +.width-50 { + width: 50%; +} + +.width-51 { + width: 51%; +} + +.width-52 { + width: 52%; +} + +.width-53 { + width: 53%; +} + +.width-54 { + width: 54%; +} + +.width-55 { + width: 55%; +} + +.width-56 { + width: 56%; +} + +.width-57 { + width: 57%; +} + +.width-58 { + width: 58%; +} + +.width-59 { + width: 59%; +} + +.width-60 { + width: 60%; +} + +.width-61 { + width: 61%; +} + +.width-62 { + width: 62%; +} + +.width-63 { + width: 63%; +} + +.width-64 { + width: 64%; +} + +.width-65 { + width: 65%; +} + +.width-66 { + width: 66%; +} + +.width-67 { + width: 67%; +} + +.width-68 { + width: 68%; +} + +.width-69 { + width: 69%; +} + +.width-70 { + width: 70%; +} + +.width-71 { + width: 71%; +} + +.width-72 { + width: 72%; +} + +.width-73 { + width: 73%; +} + +.width-74 { + width: 74%; +} + +.width-75 { + width: 75%; +} + +.width-76 { + width: 76%; +} + +.width-77 { + width: 77%; +} + +.width-78 { + width: 78%; +} + +.width-79 { + width: 79%; +} + +.width-80 { + width: 80%; +} + +.width-81 { + width: 81%; +} + +.width-82 { + width: 82%; +} + +.width-83 { + width: 83%; +} + +.width-84 { + width: 84%; +} + +.width-85 { + width: 85%; +} + +.width-86 { + width: 86%; +} + +.width-87 { + width: 87%; +} + +.width-88 { + width: 88%; +} + +.width-89 { + width: 89%; +} + +.width-90 { + width: 90%; +} + +.width-91 { + width: 91%; +} + +.width-92 { + width: 92%; +} + +.width-93 { + width: 93%; +} + +.width-94 { + width: 94%; +} + +.width-95 { + width: 95%; +} + +.width-96 { + width: 96%; +} + +.width-97 { + width: 97%; +} + +.width-98 { + width: 98%; +} + +.width-99 { + width: 99%; +} + +.width-100 { + width: 100%; +} \ No newline at end of file diff --git a/examples/src/bld/java/com/example/ExamplesBuild.java b/examples/src/bld/java/com/example/ExamplesBuild.java new file mode 100644 index 0000000..121fb2e --- /dev/null +++ b/examples/src/bld/java/com/example/ExamplesBuild.java @@ -0,0 +1,46 @@ +package com.example; + +import rife.bld.BuildCommand; +import rife.bld.Project; +import rife.bld.extension.PitestOperation; +import rife.tools.FileUtils; + +import java.nio.file.Path; +import java.util.List; + +import static rife.bld.dependencies.Scope.test; + +import static rife.bld.dependencies.Repository.MAVEN_CENTRAL; +import static rife.bld.dependencies.Repository.RIFE2_RELEASES; + +public class ExamplesBuild extends Project { + public ExamplesBuild() { + pkg = "com.example"; + name = "Examples"; + version = version(0, 1, 0); + + repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES); + + scope(test) + .include(dependency("org.pitest", "pitest", version(1, 14, 4))) + .include(dependency("org.pitest", "pitest-command-line", version(1, 14, 4))) + .include(dependency("org.pitest", "pitest-junit5-plugin", version(1, 2, 0))) + .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 0))) + .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 0))); + } + + public static void main(String[] args) { + new ExamplesBuild().start(args); + } + + @BuildCommand(summary = "Run PIT mutation tests") + public void pit() throws Exception { + new PitestOperation() + .fromProject(this) + .reportDir(Path.of("reports", "mutations").toString()) + .targetClasses(pkg + ".*") + .targetTests(pkg + ".*") + .verbose(true) + .execute(); + } +} \ No newline at end of file diff --git a/examples/src/main/java/com/example/ExamplesLib.java b/examples/src/main/java/com/example/ExamplesLib.java new file mode 100644 index 0000000..e668826 --- /dev/null +++ b/examples/src/main/java/com/example/ExamplesLib.java @@ -0,0 +1,7 @@ +package com.example; + +public class ExamplesLib { + public String getMessage() { + return "Hello World!"; + } +} \ No newline at end of file diff --git a/examples/src/test/java/com/example/ExamplesTest.java b/examples/src/test/java/com/example/ExamplesTest.java new file mode 100644 index 0000000..3d848e6 --- /dev/null +++ b/examples/src/test/java/com/example/ExamplesTest.java @@ -0,0 +1,12 @@ +package com.example; + +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class ExamplesTest { + @Test + void verifyHello() { + assertEquals("Hello World!", new ExamplesLib().getMessage()); + } +} \ No newline at end of file diff --git a/lib/bld/bld-wrapper.jar b/lib/bld/bld-wrapper.jar new file mode 100644 index 0000000..609bf46 Binary files /dev/null and b/lib/bld/bld-wrapper.jar differ diff --git a/lib/bld/bld-wrapper.properties b/lib/bld/bld-wrapper.properties new file mode 100644 index 0000000..6a39ad1 --- /dev/null +++ b/lib/bld/bld-wrapper.properties @@ -0,0 +1,8 @@ +bld.downloadExtensionJavadoc=false +bld.downloadExtensionSources=true +bld.extension-pmd=com.uwyn.rife2:bld-pmd:0.9.2 +bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.0 +bld.repositories=MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES +bld.downloadLocation= +bld.sourceDirectories= +bld.version=1.7.2 diff --git a/src/bld/java/rife/bld/extension/PitestOperationBuild.java b/src/bld/java/rife/bld/extension/PitestOperationBuild.java new file mode 100644 index 0000000..3d82117 --- /dev/null +++ b/src/bld/java/rife/bld/extension/PitestOperationBuild.java @@ -0,0 +1,93 @@ +/* + * Copyright 2023 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package rife.bld.extension; + +import rife.bld.BuildCommand; +import rife.bld.Project; +import rife.bld.publish.PublishDeveloper; +import rife.bld.publish.PublishLicense; +import rife.bld.publish.PublishScm; + +import java.io.IOException; +import java.util.List; + +import static rife.bld.dependencies.Repository.MAVEN_CENTRAL; +import static rife.bld.dependencies.Repository.RIFE2_RELEASES; +import static rife.bld.dependencies.Scope.*; +import static rife.bld.operations.JavadocOptions.DocLinkOption.NO_MISSING; + +public class PitestOperationBuild extends Project { + public PitestOperationBuild() { + pkg = "rife.bld.extension"; + name = "PitestExtension"; + version = version(0, 9, 0, "SNAPSHOT"); + + javaRelease = 17; + downloadSources = true; + autoDownloadPurge = true; + repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES); + + scope(compile) + .include(dependency("com.uwyn.rife2", "bld", version(1, 7, 2))); + scope(test) + .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 0))) + .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 0))) + .include(dependency("org.assertj:assertj-joda-time:2.2.0")); + javadocOperation() + .javadocOptions() + .docLint(NO_MISSING) + .link("https://rife2.github.io/bld/") + .link("https://rife2.github.io/rife2/"); + + publishOperation() + .repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2")) + .info() + .groupId("com.uwyn.rife2") + .artifactId("bld-pitest") + .description("PIT Mutation Testing Extension for bld") + .url("https://github.com/rife2/bld-pitest") + .developer(new PublishDeveloper().id("ethauvin").name("Erik C. Thauvin").email("erik@thauvin.net") + .url("https://erik.thauvin.net/")) + .license(new PublishLicense().name("The Apache License, Version 2.0") + .url("http://www.apache.org/licenses/LICENSE-2.0.txt")) + .scm(new PublishScm().connection("scm:git:https://github.com/rife2/bld-pitest.git") + .developerConnection("scm:git:git@github.com:rife2/bld-pitest.git") + .url("https://github.com/rife2/bld-pitest")) + .signKey(property("sign.key")) + .signPassphrase(property("sign.passphrase")); + } + + public static void main(String[] args) { + new PitestOperationBuild().start(args); + } + + @BuildCommand(summary = "Generates JaCoCo Reports") + public void jacoco() throws IOException { + new JacocoReportOperation() + .fromProject(this) + .execute(); + } + + @BuildCommand(summary = "Runs PMD analysis") + public void pmd() { + new PmdOperation() + .fromProject(this) + .failOnViolation(true) + .ruleSets("config/pmd.xml") + .execute(); + } +} \ No newline at end of file diff --git a/src/main/java/rife/bld/extension/PitestOperation.java b/src/main/java/rife/bld/extension/PitestOperation.java new file mode 100644 index 0000000..781d8e7 --- /dev/null +++ b/src/main/java/rife/bld/extension/PitestOperation.java @@ -0,0 +1,733 @@ +/* + * Copyright 2023 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package rife.bld.extension; + +import rife.bld.BaseProject; +import rife.bld.operations.AbstractProcessOperation; + +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.logging.Logger; + +/** + * Mutation testing and coverage with PIT. + * + * @author Erik C. Thauvin + * @since 1.0 + */ +public class PitestOperation extends AbstractProcessOperation { + protected static final String FALSE = "false"; + protected static final String SOURCE_DIRS = "--sourceDirs"; + protected static final String TRUE = "true"; + private static final Logger LOGGER = Logger.getLogger(PitestOperation.class.getName()); + /** + * The PIT options. + */ + protected final Map options = new ConcurrentHashMap<>(); + private BaseProject project_; + + /** + * Line arguments for child JVMs. + */ + public PitestOperation argLine(String line) { + options.put("--argLine", line); + return this; + } + + /** + * List of packages and classes which are to be considered outside the scope of mutation. Any lines of code + * containing calls to these classes will not be mutated. + *

+ * If a list is not explicitly supplied then PIT will default to a list of common logging packages as follows + *

+ *

    + *
  • java.util.logging
    • + *
  • org.apache.log4j
    • + *
  • org.slf4j
    • + *
  • org.apache.commons.logging
    • + *
+ *

+ * If the feature {@code FLOGCALL} is disabled, this parameter is ignored and logging calls are also mutated. + * + * @see #avoidCallsTo(String...) + */ + public PitestOperation avoidCallsTo(Collection avoidCallsTo) { + options.put("--avoidCallsTo", String.join(",", avoidCallsTo)); + return this; + } + + /** + * List of packages and classes which are to be considered outside the scope of mutation. Any lines of code + * containing calls to these classes will not be mutated. + *

+ * If a list is not explicitly supplied then PIT will default to a list of common logging packages as follows + *

+ *

    + *
  • java.util.logging
    • + *
  • org.apache.log4j
    • + *
  • org.slf4j
    • + *
  • org.apache.commons.logging
    • + *
+ *

+ * If the feature {@code FLOGCALL} is disabled, this parameter is ignored and logging calls are also mutated. + * + * @see #avoidCallsTo(Collection) + */ + public PitestOperation avoidCallsTo(String... avoidCallTo) { + options.put("--avoidCallsTo", String.join(",", avoidCallTo)); + return this; + } + + /** + * List of packages and classes which are to be considered outside the scope of mutation. Any lines of code + * containing calls to these classes will not be mutated. + *

+ * If a list is not explicitly supplied then PIT will default to a list of common logging packages as follows + *

+ *

    + *
  • java.util.logging
    • + *
  • org.apache.log4j
    • + *
  • org.slf4j
    • + *
  • org.apache.commons.logging
    • + *
+ *

+ * If the feature {@code FLOGCALL} is disabled, this parameter is ignored and logging calls are also mutated. + * Additional classpath entries to use when looking for tests and mutable code. + * + * @see #classPath(Collection) + */ + public PitestOperation classPath(String... path) { + options.put("--classPath", String.join(",", path)); + return this; + } + + /** + * Additional classpath entries to use when looking for tests and mutable code. + * + * @see #classPath(String...) + */ + public PitestOperation classPath(Collection paths) { + options.put("--classPath", String.join(",", paths)); + return this; + } + + /** + * File with a list of additional classpath elements (one per line). + */ + public PitestOperation classPathFile(String file) { + options.put("--classPathFile", file); + return this; + } + + /** + * Line coverage threshold below which the build will fail. This is an integer percent (0-100) that represents the + * fraction of the project covered by the tests. + */ + public PitestOperation coverageThreshold(int threshold) { + if (threshold >= 0 && threshold <= 100) { + options.put("--coverageThreshold", String.valueOf(threshold)); + } + return this; + } + + /** + * Flag to indicate if PIT should attempt to detect the inlined code generated by the java compiler in order to + * implement finally blocks. Each copy of the inlined code would normally be mutated separately, resulting in + * multiple identical looking mutations. When inlined code detection is enabled PIT will attempt to spot inlined + * code and create only a single mutation that mutates all affected instructions simultaneously. + *

+ * The algorithm cannot easily distinguish between inlined copies of code, and genuine duplicate instructions on the same line within a finally block. + *

+ * In the case of any doubt PIT will act cautiously and assume that the code is not inlined. + *

+ * This will be detected as two separate inlined instructions + *

+ * finally { + *

+ *   int++; + *

+ *   int++; + *

+ * } + *

+ * But this will look confusing so PIT will assume no in-lining is taking place. + *

+ * finally { + *

+ *   int++; int++; + *

+ * } + *

+ * This sort of pattern might not be common with integer addition, but things like string concatenation are likely + * to produce multiple similar instructions on the same line. + *

+ * Defaults to {@code true} + */ + public PitestOperation detectInlinedCode(boolean isDetectInlinedCode) { + if (isDetectInlinedCode) { + options.put("--detectInlinedCode", TRUE); + } else { + options.put("--detectInlinedCode", FALSE); + } + return this; + } + + /** + * List of globs to match against class names. Matching classes will be excluded from mutation. + * + * @see #excludedClasses(Collection) + */ + public PitestOperation excludedClasses(String... excludedClass) { + options.put("--excludedClasses", String.join(",", excludedClass)); + return this; + } + + /** + * List of globs to match against class names. Matching classes will be excluded from mutation. + * + * @see #excludedClasses(String...) + */ + public PitestOperation excludedClasses(Collection excludedClasses) { + options.put("--excludedClasses", String.join(",", excludedClasses)); + return this; + } + + /** + * List of TestNG groups/JUnit categories to include in mutation analysis. Note that only class level categories + * are supported. + * + * @see #excludedGroups(Collection) + */ + public PitestOperation excludedGroups(String... excludedGroup) { + options.put("--excludedGroups", String.join(",", excludedGroup)); + return this; + } + + /** + * List of TestNG groups/JUnit categories to include in mutation analysis. Note that only class level categories + * are supported. + * + * @see #excludedGroups(String...) + */ + public PitestOperation excludedGroups(Collection excludedGroups) { + options.put("--excludedGroups", String.join(",", excludedGroups)); + return this; + } + + /** + * List of globs to match against method names. Methods matching the globs will be excluded from mutation. + * + * @see #excludedMethods(Collection) + */ + public PitestOperation excludedMethods(String... excludedMethod) { + options.put("--excludedMethods", String.join(",", excludedMethod)); + return this; + } + + /** + * List of globs to match against method names. Methods matching the globs will be excluded from mutation. + * + * @see #excludedMethods(String...) + */ + public PitestOperation excludedMethods(Collection excludedMethods) { + options.put("--excludedMethods", String.join(",", excludedMethods)); + return this; + } + + /** + * List of globs to match against test class names. Matching tests will not be run (note if a test suite includes + * an excluded class, then it will “leak” back in). + * + * @see #excludedTests(Collection) + */ + public PitestOperation excludedTests(String... excludedTest) { + options.put("--excludedTests", String.join(",", excludedTest)); + return this; + } + + /** + * List of globs to match against test class names. Matching tests will not be run (note if a test suite includes + * an excluded class, then it will “leak” back in). + * + * @see #excludedTests(String...) + */ + public PitestOperation excludedTests(Collection excludedTests) { + options.put("--excludedTests", String.join(",", excludedTests)); + return this; + } + + /** + * Part of the {@link #execute} operation, constructs the command list + * to use for building the process. + */ + @Override + protected List executeConstructProcessCommandList() { + if (project_ == null) { + LOGGER.severe("A project must be specified."); + } else if (!options.containsKey(SOURCE_DIRS)) { + options.put(SOURCE_DIRS, project_.srcDirectory().getPath()); + } + + final List args = new ArrayList<>(); + args.add(javaTool()); + + args.add("-cp"); + args.add(String.format("%s:%s:%s:%s", Path.of(project_.libTestDirectory().getPath(), "*"), + Path.of(project_.libCompileDirectory().getPath(), "*"), project_.buildMainDirectory(), + project_.buildTestDirectory())); + args.add("org.pitest.mutationtest.commandline.MutationCoverageReport"); + + options.forEach((k, v) -> { + args.add(k); + if (!v.isEmpty()) { + args.add(v); + } + }); + + return args; + } + + /** + * Configures the operation from a {@link BaseProject}. + * + * @param project the project to configure the operation from + * @since 1.5 + */ + @Override + public PitestOperation fromProject(BaseProject project) { + project_ = project; + return this; + } + + /** + * Whether or not to dump per test line coverage data to disk. + *

+ * Defaults to {@code false} + */ + public PitestOperation exportLineCoverage(boolean jsExport) { + if (jsExport) { + options.put("--exportLineCoverage", TRUE); + } else { + options.put("--exportLineCoverage", FALSE); + } + return this; + } + + /** + * Whether to throw an error when no mutations found. + *

+ * Defaults to {@code true} + */ + public PitestOperation failWhenNoMutations(boolean isFail) { + if (isFail) { + options.put("--failWhenNoMutations", TRUE); + } else { + options.put("--failWhenNoMutations", FALSE); + } + return this; + } + + /** + * List of features to enable/disable + *

+ * {@see #featrues(String) + */ + public PitestOperation features(Collection feature) { + options.put("--features", String.join(",", feature)); + return this; + } + + /** + * List of features to enable/disable + *

+ * {@see #featrues(String) + */ + public PitestOperation features(String... feature) { + options.put("--features", String.join(",", feature)); + return this; + } + + /** + * Path to a file containing history information for incremental analysis. + */ + public PitestOperation historyInputLocation(String path) { + options.put("--historyInputLocation", path); + return this; + } + + /** + * Path to write history information for incremental analysis. May be the same as + * {@link #historyInputLocation(String) historyInputLocation}. + */ + public PitestOperation historyOutputLocation(String path) { + options.put("--historyOutputLocation", path); + return this; + } + + /** + * Indicates if the PIT should try to mutate classes on the classpath with which it was launched. If not supplied + * this flag defaults to {@code true}. If set to {@code false} only classes found on the paths specified by the + * {@link #classPath(String...)} classPath} option will be considered. + *

+ * Defaults to {@code true} + */ + public PitestOperation includeLaunchClasspath(boolean isLaunchClasspath) { + if (isLaunchClasspath) { + options.put("--includeLaunchClasspath", TRUE); + } else { + options.put("--includeLaunchClasspath", FALSE); + } + return this; + } + + /** + * list of TestNG groups/JUnit categories to include in mutation analysis. Note that only class level categories are + * supported. + * + * @see #includedGroups(Collection) + */ + public PitestOperation includedGroups(String... includedGroup) { + options.put("--includedGroups", String.join(",", includedGroup)); + return this; + } + + /** + * list of TestNG groups/JUnit categories to include in mutation analysis. Note that only class level categories are + * supported. + * + * @see #includedGroups(String...) + */ + public PitestOperation includedGroups(Collection includedGroups) { + options.put("--includedGroups", String.join(",", includedGroups)); + return this; + } + + /** + * Argument string to use when PIT launches child processes. This is most commonly used to increase the amount of + * memory available to the process, but may be used to pass any valid JVM argument. + * + * @see #jvmArgs(Collection) + */ + public PitestOperation jvmArgs(String... args) { + options.put("--jvmArgs", String.join(",", args)); + return this; + } + + /** + * Argument string to use when PIT launches child processes. This is most commonly used to increase the amount of + * memory available to the process, but may be used to pass any valid JVM argument. + * + * @see #jvmArgs(String...) + */ + public PitestOperation jvmArgs(Collection args) { + options.put("--jvmArgs", String.join(",", args)); + return this; + } + + /** + * The path to the java executable to be used to launch test with. If none is supplied defaults to the one + * pointed to by {@code JAVA_HOME}. + */ + public PitestOperation jvmPath(String path) { + options.put("--jvmPath", path); + return this; + } + + /** + * List of classpaths which should be considered to contain mutable code. If your build maintains separate output + * directories for tests and production classes this parameter should be set to your code output directory in order + * to avoid mutating test helper classes etc. + *

+ * If no mutableCodePath is supplied PIT will default to considering anything not defined within a jar or zip file + * as being a candidate for mutation. + *

+ * PIT will always attempt not to mutate test classes even if they are defined on a mutable path. + * + * @see #mutableCodePaths(Collection) + */ + public PitestOperation mutableCodePaths(String... path) { + options.put("--mutableCodePaths", String.join(",", path)); + return this; + } + + /** + * List of classpaths which should be considered to contain mutable code. If your build maintains separate output + * directories for tests and production classes this parameter should be set to your code output directory in order + * to avoid mutating test helper classes etc. + *

+ * If no mutableCodePath is supplied PIT will default to considering anything not defined within a jar or zip file + * as being a candidate for mutation. + *

+ * PIT will always attempt not to mutate test classes even if they are defined on a mutable path. + * + * @see #mutableCodePaths(String...) + */ + public PitestOperation mutableCodePaths(Collection paths) { + options.put("--mutableCodePaths", String.join(",", paths)); + return this; + } + + /** + * Mutation score threshold below which the build will fail. This is an integer percent (0-100) that represents the + * fraction of killed mutations out of all mutations. + *

+ * Please bear in mind that your build may contain equivalent mutations. Careful thought must therefore be given + * when selecting a threshold. + */ + public PitestOperation mutationThreshold(int threshold) { + if (threshold >= 0 && threshold <= 100) { + options.put("--mutationThreshold", String.valueOf(threshold)); + } + return this; + } + + /** + * List of mutation operators. + * + * @see #mutators(Collection) + */ + public PitestOperation mutators(String... mutator) { + options.put("--mutators", String.join(",", mutator)); + return this; + } + + /** + * List of mutation operators. + * + * @see #mutators(String...) + */ + public PitestOperation mutators(Collection mutators) { + options.put("--mutators", String.join(",", mutators)); + return this; + } + + /** + * Output encoding. + *

+ * Default is {@code UTF-8}. + */ + public PitestOperation outputEncoding(String encoding) { + options.put("--outputEncoding", encoding); + return this; + } + + /** + * Comma separated list of formats in which to write mutation results as the mutations are analysed. + * Supported formats are {@code HTML}, {@code XML}, {@code CSV}. + *

+ * Defaults to {@code HTML}. + * + * @see #outputFormats(Collection) + */ + public PitestOperation outputFormats(String... outputFormat) { + options.put("--outputFormats", String.join(",", outputFormat)); + return this; + } + + /** + * Comma separated list of formats in which to write mutation results as the mutations are analysed. + * Supported formats are {@code HTML}, {@code XML}, {@code CSV}. + *

+ * Defaults to {@code HTML}. + * + * @see #outputFormats(String...) + */ + public PitestOperation outputFormats(Collection outputFormats) { + options.put("--outputFormats", String.join(",", outputFormats)); + return this; + } + + /** + * Output directory for the reports. + */ + public PitestOperation reportDir(String dir) { + options.put("--reportDir", dir); + return this; + } + + /** + * whether to ignore failing tests when computing coverage. + *

+ * Default is {@code false} + */ + public PitestOperation skipFailingTests(boolean isSkipFail) { + if (isSkipFail) { + options.put("--skipFailingTests", TRUE); + } else { + options.put("--skipFailingTests", FALSE); + } + return this; + } + + /** + * The folder(s) containing the source code. + * + * @see #sourceDirs(Collection) + */ + public PitestOperation sourceDirs(String... dir) { + options.put(SOURCE_DIRS, String.join(",", dir)); + return this; + } + + /** + * The folder(s) containing the source code. + * + * @see #sourceDirs(String...) + */ + public PitestOperation sourceDirs(Collection dirs) { + options.put(SOURCE_DIRS, String.join(",", dirs)); + return this; + } + + /** + * The classes to be mutated. This is expressed as a list of globs. + *

+ * For example + *

    + *
  • {@code com.myompany.*}
    • + *
  • {@code com.mycompany.package.*, com.mycompany.packageB.Foo, com.partner.*}
    • + *

+ * + * @see #targetClasses(Collection) + */ + public PitestOperation targetClasses(Collection targetClass) { + options.put("--targetClasses", String.join(",", targetClass)); + return this; + } + + /** + * The classes to be mutated. This is expressed as a list of globs. + *

+ * For example: + *

    + *
  • {@code com.myompany.*}
    • + *
  • {@code com.mycompany.package.*, com.mycompany.packageB.Foo, com.partner.*}
    • + *

+ * + * @see #targetClasses(String...) + */ + public PitestOperation targetClasses(String... targetClass) { + options.put("--targetClasses", String.join(",", targetClass)); + return this; + } + + /** + * A comma separated list of globs can be supplied to this parameter to limit the tests available to be run. + * If this parameter is not supplied then any test fixture that matched targetClasses may be used, it is however + * recommended that this parameter is always explicitly set. + *

+ * This parameter can be used to point PIT to a top level suite or suites. Custom suites such as + * ClassPathSuite are supported. + * + * @see #targetTests(Collection) + */ + public PitestOperation targetTests(String... test) { + options.put("--targetTests", String.join(",", test)); + return this; + } + + /** + * A comma separated list of globs can be supplied to this parameter to limit the tests available to be run. + * If this parameter is not supplied then any test fixture that matched targetClasses may be used, it is however + * recommended that this parameter is always explicitly set. + *

+ * This parameter can be used to point PIT to a top level suite or suites. Custom suites such as + * ClassPathSuite are supported. + * + * @see #targetTests(String...) + */ + public PitestOperation targetTests(Collection tests) { + options.put("--targetTests", String.join(",", tests)); + return this; + } + + /** + * The number of threads to use when mutation testing. + */ + public PitestOperation threads(int threads) { + options.put("--threads", String.valueOf(threads)); + return this; + } + + /** + * Constant amount of additional time to allow a test to run for (after the application of the timeoutFactor) + * before considering it to be stuck in an infinite loop. + *

+ * Defaults to {@code 4000} + */ + public PitestOperation timeoutConst(int factor) { + options.put("--timeoutConst", String.valueOf(factor)); + return this; + } + + /** + * A factor to apply to the normal runtime of a test when considering if it is stuck in an infinite loop. + *

+ * Defaults to {@code 1.25} + */ + public PitestOperation timeoutFactor(double factor) { + options.put("--timeoutFactor", String.valueOf(factor)); + return this; + } + + /** + * By default PIT will create a date and time stamped folder for its output each time it is run. This can can make + * automation difficult, so the behaviour can be suppressed by passing {@code false}. + *

+ * Defaults to {@code false} + */ + public PitestOperation timestampedReports(boolean isTimestamped) { + if (isTimestamped) { + options.put("--timestampedReports", TRUE); + } else { + options.put("--timestampedReports", FALSE); + } + return this; + } + + /** + * Support large classpaths by creating a classpath jar. + *

+ * Defaults to {@code false} + */ + public PitestOperation useClasspathJar(boolean isUseClasspathJar) { + if (isUseClasspathJar) { + options.put("--useClasspathJar", TRUE); + } else { + options.put("--useClasspathJar", FALSE); + } + return this; + } + + /** + * Output verbose logging. + *

+ * Defaults to {@code false} + */ + public PitestOperation verbose(boolean isVerbose) { + if (isVerbose) { + options.put("--verbose", TRUE); + } else { + options.put("--verbose", FALSE); + } + return this; + } +} \ No newline at end of file diff --git a/src/test/java/rife/bld/extension/PitestOperationTest.java b/src/test/java/rife/bld/extension/PitestOperationTest.java new file mode 100644 index 0000000..98f476c --- /dev/null +++ b/src/test/java/rife/bld/extension/PitestOperationTest.java @@ -0,0 +1,473 @@ +/* + * Copyright 2023 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package rife.bld.extension; + +import org.junit.jupiter.api.Test; +import rife.bld.BaseProject; +import rife.bld.Project; +import rife.bld.WebProject; + +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; +import static rife.bld.extension.PitestOperation.*; + +class PitestOperationTest { + private static final String AS_LIST = "as list"; + private final static String BAR = "bar"; + private final static String FOO = "foo"; + private final static String FOOBAR = FOO + ',' + BAR; + + @Test + void argLine() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .argLine(FOO); + assertThat(op.options.get("--argLine")).isEqualTo(FOO); + } + + @Test + void avoidCallsTo() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .avoidCallsTo(FOO, BAR); + assertThat(op.options.get("--avoidCallsTo")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .avoidCallsTo(List.of(FOO, BAR)); + assertThat(op.options.get("--avoidCallsTo")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void classPath() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .classPath(FOO, BAR); + assertThat(op.options.get("--classPath")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .classPath(List.of(FOO, BAR)); + assertThat(op.options.get("--classPath")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void classPathFile() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .classPathFile(FOO); + assertThat(op.options.get("--classPathFile")).isEqualTo(FOO); + } + + @Test + void coverageThreshold() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .coverageThreshold(3); + assertThat(op.options.get("--coverageThreshold")).isEqualTo("3"); + + op = new PitestOperation() + .fromProject(new BaseProject()) + .coverageThreshold(101); + assertThat(op.options.get("--coverageThreshold")).isNull(); + } + + @Test + void detectInlinedCode() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .detectInlinedCode(true); + assertThat(op.options.get("--detectInlinedCode")).isEqualTo(TRUE); + + op = new PitestOperation() + .fromProject(new Project()) + .detectInlinedCode(false); + assertThat(op.options.get("--detectInlinedCode")).isEqualTo(FALSE); + } + + @Test + void excludedClasses() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .excludedClasses(FOO, BAR); + assertThat(op.options.get("--excludedClasses")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .excludedClasses(List.of(FOO, BAR)); + assertThat(op.options.get("--excludedClasses")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void excludedGroups() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .excludedGroups(FOO, BAR); + assertThat(op.options.get("--excludedGroups")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .excludedGroups(List.of(FOO, BAR)); + assertThat(op.options.get("--excludedGroups")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void excludedMethods() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .excludedMethods(FOO, BAR); + assertThat(op.options.get("--excludedMethods")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .excludedMethods(List.of(FOO, BAR)); + assertThat(op.options.get("--excludedMethods")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void excludedTests() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .excludedTests(FOO, BAR); + assertThat(op.options.get("--excludedTests")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .excludedTests(List.of(FOO, BAR)); + assertThat(op.options.get("--excludedTests")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void executeConstructProcessCommandList() { + var op = new PitestOperation(). + fromProject(new WebProject()) + .reportDir("outputdir") + .targetClasses("com.your.package.tobemutated*") + .targetTests("com.your.package.*") + .sourceDirs("parthsource"); + + assertThat(String.join(" ", op.executeConstructProcessCommandList())).endsWith( + " org.pitest.mutationtest.commandline.MutationCoverageReport " + + "--targetTests com.your.package.* " + + "--reportDir outputdir " + + "--targetClasses com.your.package.tobemutated* " + + "--sourceDirs parthsource"); + + op = new PitestOperation() + .fromProject(new BaseProject()) + .reportDir("c:\\mutationReports") + .targetClasses("example.foo.*") + .sourceDirs("c:\\myProject\\src") + .targetTests("example.foo*") + .threads(2) + .excludedMethods("hashcode", "equals"); + assertThat(String.join(" ", op.executeConstructProcessCommandList())).as("mutationReports").endsWith( + "org.pitest.mutationtest.commandline.MutationCoverageReport " + + "--targetTests example.foo* " + + "--threads 2 " + + "--excludedMethods hashcode,equals " + + "--reportDir c:\\mutationReports " + + "--targetClasses example.foo.* " + + "--sourceDirs c:\\myProject\\src"); + } + + @Test + void exportLineCoverage() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .exportLineCoverage(true); + assertThat(op.options.get("--exportLineCoverage")).isEqualTo(TRUE); + + op = new PitestOperation() + .fromProject(new Project()) + .exportLineCoverage(false); + assertThat(op.options.get("--exportLineCoverage")).isEqualTo(FALSE); + } + + @Test + void failWhenNoMutations() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .failWhenNoMutations(true); + assertThat(op.options.get("--failWhenNoMutations")).isEqualTo(TRUE); + + op = new PitestOperation() + .fromProject(new Project()) + .failWhenNoMutations(false); + assertThat(op.options.get("--failWhenNoMutations")).isEqualTo(FALSE); + } + + @Test + void features() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .features(FOO, BAR); + assertThat(op.options.get("--features")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .features(List.of(FOO, BAR)); + assertThat(op.options.get("--features")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void historyInputLocation() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .historyInputLocation(FOO); + assertThat(op.options.get("--historyInputLocation")).isEqualTo(FOO); + } + + @Test + void historyOutputLocation() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .historyOutputLocation(FOO); + assertThat(op.options.get("--historyOutputLocation")).isEqualTo(FOO); + } + + @Test + void includeLaunchClasspath() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .includeLaunchClasspath(true); + assertThat(op.options.get("--includeLaunchClasspath")).isEqualTo(TRUE); + + op = new PitestOperation() + .fromProject(new Project()) + .includeLaunchClasspath(false); + assertThat(op.options.get("--includeLaunchClasspath")).isEqualTo(FALSE); + } + + @Test + void includedGroups() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .includedGroups(FOO, BAR); + assertThat(op.options.get("--includedGroups")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .includedGroups(List.of(FOO, BAR)); + assertThat(op.options.get("--includedGroups")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void jvmArgs() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .jvmArgs(FOO, BAR); + assertThat(op.options.get("--jvmArgs")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .jvmArgs(List.of(FOO, BAR)); + assertThat(op.options.get("--jvmArgs")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void jvmPath() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .jvmPath(FOO); + assertThat(op.options.get("--jvmPath")).isEqualTo(FOO); + } + + @Test + void mutableCodePaths() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .mutableCodePaths(FOO, BAR); + assertThat(op.options.get("--mutableCodePaths")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .mutableCodePaths(List.of(FOO, BAR)); + assertThat(op.options.get("--mutableCodePaths")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void mutationThreshold() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .mutationThreshold(3); + assertThat(op.options.get("--mutationThreshold")).isEqualTo("3"); + + op = new PitestOperation() + .fromProject(new BaseProject()) + .mutationThreshold(101); + assertThat(op.options.get("--mutationThreshold")).isNull(); + } + + @Test + void mutators() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .mutators(FOO, BAR); + assertThat(op.options.get("--mutators")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .mutators(List.of(FOO, BAR)); + assertThat(op.options.get("--mutators")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void outputEncoding() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .outputEncoding(FOO); + assertThat(op.options.get("--outputEncoding")).isEqualTo(FOO); + } + + @Test + void outputFormats() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .outputFormats(FOO, BAR); + assertThat(op.options.get("--outputFormats")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .outputFormats(List.of(FOO, BAR)); + assertThat(op.options.get("--outputFormats")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void reportDir() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .reportDir(FOO); + assertThat(op.options.get("--reportDir")).isEqualTo(FOO); + } + + @Test + void skipFailingTests() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .skipFailingTests(true); + assertThat(op.options.get("--skipFailingTests")).isEqualTo(TRUE); + + op = new PitestOperation() + .fromProject(new Project()) + .skipFailingTests(false); + assertThat(op.options.get("--skipFailingTests")).isEqualTo(FALSE); + } + + @Test + void sourceDirs() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .sourceDirs(FOO, BAR); + assertThat(op.options.get(SOURCE_DIRS)).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .sourceDirs(List.of(FOO, BAR)); + assertThat(op.options.get(SOURCE_DIRS)).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void targetClasses() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .targetClasses(FOO, BAR); + assertThat(op.options.get("--targetClasses")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .targetClasses(List.of(FOO, BAR)); + assertThat(op.options.get("--targetClasses")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void targetTests() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .targetTests(FOO, BAR); + assertThat(op.options.get("--targetTests")).isEqualTo(FOOBAR); + + op = new PitestOperation() + .fromProject(new Project()) + .targetTests(List.of(FOO, BAR)); + assertThat(op.options.get("--targetTests")).as(AS_LIST).isEqualTo(FOOBAR); + } + + @Test + void threads() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .threads(3); + assertThat(op.options.get("--threads")).isEqualTo("3"); + } + + @Test + void timeoutConst() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .timeoutConst(300); + assertThat(op.options.get("--timeoutConst")).isEqualTo("300"); + } + + @Test + void timeoutFactor() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .timeoutFactor(5.25); + assertThat(op.options.get("--timeoutFactor")).isEqualTo("5.25"); + } + + @Test + void timestampedReports() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .timestampedReports(true); + assertThat(op.options.get("--timestampedReports")).isEqualTo(TRUE); + + op = new PitestOperation() + .fromProject(new Project()) + .timestampedReports(false); + assertThat(op.options.get("--timestampedReports")).isEqualTo(FALSE); + } + + @Test + void useClasspathJar() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .useClasspathJar(true); + assertThat(op.options.get("--useClasspathJar")).isEqualTo(TRUE); + + op = new PitestOperation() + .fromProject(new Project()) + .useClasspathJar(false); + assertThat(op.options.get("--useClasspathJar")).isEqualTo(FALSE); + } + + @Test + void verbose() { + var op = new PitestOperation() + .fromProject(new BaseProject()) + .verbose(true); + assertThat(op.options.get("--verbose")).isEqualTo(TRUE); + + op = new PitestOperation() + .fromProject(new Project()) + .verbose(false); + assertThat(op.options.get("--verbose")).isEqualTo(FALSE); + } +} \ No newline at end of file