diff --git a/README.md b/README.md index c6e3b43..7a9a7d2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Pitest-Gradle -This is a plugin for IntelliJ IDEA that allows you to run PIT mutation testing on your Gradle project. +This is a plugin for IntelliJ IDEA that allows you to run PITest (https://pitest.org/) mutation testing on your Gradle project. ## Features @@ -23,9 +23,40 @@ This is a plugin for IntelliJ IDEA that allows you to run PIT mutation testing o 3. Input the target mutation test class, for example `com.example.MyClass` or `MyClass`, and click `OK` 4. The mutation test will run and the results will be displayed in the `Mutation Tool Window` +## Screenshots + + +To run the plugin, right click on the test file and select `Run Mutation Test` in the `Unittest Helpers` menu. + +![run pitest](./screenshots/1.png) + + +Input the target mutation test class, for example `com.example.MyClass` or `MyClass`, and click `OK` + +![input target class](./screenshots/2.png) + +It will prompt you with the collected classpath information, click `OK` (you can also click `Cancel` to stop the mutation test) + +![classpath](./screenshots/3.png) + +The mutation test will run; and upon finishing, it will popup a dialog with the verbose output of the mutation test, as well as a button to view the results in the browser + +![mutation test results](./screenshots/4.png) + +You can also navigate to the `MutationTestHistory` tool window to view the results; +double click on a row to will open the code editor to the class under test, and the editor will be decorated with the mutation test results + +![mutation test history](./screenshots/5.png) + +`MutationTestHistory` tool window also support searching, input the class name and press enter to locate the class; and a second enter will open the code editor to the class under test. + +![search](./screenshots/6.png) + + + + ## Known Issues -- [ ] [!due to issue](https://stackoverflow.com/questions/70448459/gradle-error-in-ijresolvers-gradle-when-running-using-intellij-idea/70597547#70597547) you need to disable kotlin plugin if using old version of gradle like 4.4 - [ ] it cannot find the classpath if the project is not managed by Gradle, click on the Project structure and import the project as Gradle project - [ ] it cannot find the resource directory if you don't mark the directory as resource root, right click on the directory and mark as resource root diff --git a/screenshots/1.png b/screenshots/1.png new file mode 100644 index 0000000..dc8484b Binary files /dev/null and b/screenshots/1.png differ diff --git a/screenshots/2.png b/screenshots/2.png new file mode 100644 index 0000000..074eadc Binary files /dev/null and b/screenshots/2.png differ diff --git a/screenshots/3.png b/screenshots/3.png new file mode 100644 index 0000000..4c16d62 Binary files /dev/null and b/screenshots/3.png differ diff --git a/screenshots/4.png b/screenshots/4.png new file mode 100644 index 0000000..746d049 Binary files /dev/null and b/screenshots/4.png differ diff --git a/screenshots/5.png b/screenshots/5.png new file mode 100644 index 0000000..7c1cc01 Binary files /dev/null and b/screenshots/5.png differ diff --git a/screenshots/6.png b/screenshots/6.png new file mode 100644 index 0000000..f74a8ae Binary files /dev/null and b/screenshots/6.png differ