README.md
March 6, 2025 ยท View on GitHub
Getting Started with Mutation Testing
# Install Mutahunter package via GitHub. Python 3.11+ is required.
$ pip install https://github.com/codeintegrity-ai/mutahunter
# Work with GPT-4o on your repo
$ export OPENAI_API_KEY=your-key-goes-here
# Run Mutahunter on a specific file.
$ mutahunter run --test-command "mvn clean test" --model "gpt-4o-mini" --source-path "src/main/java/com/example/BankAccount.java" --test-path "src/test/java/BankAccountTest.java"
2025-03-05 18:56:42,528 INFO: 'mvn clean test' - '/Users/taikorind/Desktop/mutahunter/examples/java_maven/logs/_latest/mutants/34a5d8a5_BankAccount.java'
2025-03-05 18:56:44,935 INFO: ๐ก๏ธ Mutant survived ๐ก๏ธ
2025-03-05 18:56:44,936 INFO: 'mvn clean test' - '/Users/taikorind/Desktop/mutahunter/examples/java_maven/logs/_latest/mutants/183e6826_BankAccount.java'
2025-03-05 18:56:47,308 INFO: ๐ก๏ธ Mutant killed ๐ก๏ธ
. . . .-. .-. . . . . . . .-. .-. .-.
|\/| | | | |-| |-| | | |\| | |-| |
' ` `-' ' ` ` ' ' ` `-' ' ` `-' ' '
2024-07-29 12:31:22,045 INFO:
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
๐ Overall Mutation Coverage ๐
๐ฏ Mutation Coverage: 57.14% ๐ฏ
๐ฆ Total Mutants: 7 ๐ฆ
๐ก๏ธ Survived Mutants: 3 ๐ก๏ธ
๐ก๏ธ Killed Mutants: 4 ๐ก๏ธ
๐ Timeout Mutants: 0 ๐
๐ฅ Compile Error Mutants: 1 ๐ฅ
๐ฐ Total Cost: \$0.00060 USD ๐ฐ
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
2025-03-05 18:56:54,689 INFO: Mutation Testing Ended. Took 29s
Examples
Go to the examples directory to see how to run Mutahunter on different programming languages:
Check Java Example to see some interesting LLM-based mutation testing examples.