Skip to content

Commit 11a0180

Browse files
committed
docs: update readme
1 parent b163347 commit 11a0180

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
<div align="center">
1717
<video src="https://github.com/codeintegrity-ai/mutahunter/assets/37044660/cca8a41b-b97e-4ce1-806d-e53d475d4226"></video>
18+
<p>Demo video of running mutation testing on a Go web project</p>
1819
</div>
1920

2021
## Table of Contents
@@ -25,13 +26,11 @@
2526

2627
## Overview
2728

28-
If you don't know what mutation testing is, you must be living under a rock! 🪨
29+
Mutation testing is used by big tech companies like [Google](https://research.google/pubs/state-of-mutation-testing-at-google/) to ensure the robustness of their test suites. With Mutahunter, we aim to empower other companies and developers to use this powerful tool to enhance their test suites and improve software quality.
2930

30-
Mutation testing is a way to verify how good your test cases are. It involves creating small changes, or "mutants," in the code and checking if the test cases can catch these changes. Line coverage only tells you how much of the code has been executed, not how well it's been tested. We all know line coverage is limited.
31+
To put it simply, mutation testing is a way to verify how good your test cases are. It involves creating small changes, or mutants, in the code and checking if the test cases can catch these changes. Line coverage only tells you how much of the code has been executed, not how well its been tested.
3132

32-
Mutahunter leverages LLM models to inject context-aware faults into your codebase. As the first AI-based mutation testing tool, it surpasses traditional “dumb” AST-based methods. Mutahunter’s AI-driven approach provides full contextual understanding of the entire codebase, enabling it to identify and inject mutations that closely resemble real vulnerabilities. This ensures comprehensive and effective testing, significantly enhancing software security and quality.
33-
34-
Mutation testing is used by big tech companies like [Google](https://research.google/pubs/state-of-mutation-testing-at-google/) to ensure the robustness of their test suites. With Mutahunter, we want other companies and developers to use this powerful tool to enhance their test suites and improve software quality.
33+
MutaHunter leverages LLM models to inject context-aware faults into your codebase. Unlike traditional rule-based methods, MutaHunter’s AI-driven approach provides a full contextual understanding of the entire codebase, enabling it to identify and inject mutations that closely resemble real bugs. This ensures comprehensive and effective testing, significantly enhancing software security and quality.
3534

3635
Examples:
3736

@@ -45,9 +44,9 @@ Feel free to add more examples! ✨
4544

4645
## Why you should use Mutahunter?
4746

48-
1. **AI-Driven Mutation Testing:** Mutahunter leverages advanced LLM models to inject context-aware faults into your codebase rather than blindly mutating the code. 🧠 This allows the mutants to closely resemble real vulnerabilities.
49-
2. **Language Agnostic:** Mutahunter supports various programming languages and can be extended to work with any language that provides a coverage report in **Cobertura** XML format, **Jacoco** XML format, and **lcov** format. 🌐
50-
3. **Enhanced Mutation Coverage Report:** Mutahunter provides detailed mutation coverage reports, highlighting the effectiveness of your test suite and identifying potential weaknesses. 📊
47+
1. **AI-Driven Mutation Testing:** Mutahunter leverages advanced LLM models to inject context-aware faults into your codebase rather than blindly mutating the code. This allows the mutants to closely resemble real bugs.
48+
2. **Language Agnostic:** Mutahunter supports various programming languages and can be extended to work with any language that provides a coverage report in **Cobertura** XML format, **Jacoco** XML format, and **lcov** format.
49+
3. **Enhanced Mutation Coverage Report (experimental):** Mutahunter provides detailed mutation coverage reports, highlighting the effectiveness of your test suite and identifying potential weaknesses.
5150

5251
**Afraid of sending code to OpenAI or Anthropic? No problem, we support self-hosted versions as well.** 🔒
5352

@@ -124,7 +123,7 @@ Options:
124123
Required: No
125124
Example: `--only-mutate-file-paths file1.py file2.py`
126125
127-
--generate-report
126+
--generate-report (experimental)
128127
Description: Generate a detailed report on identified weaknesses in the test suite and potential bugs not caught by the test suite.
129128
Required: No
130129
Example: `--generate-report`
@@ -159,7 +158,7 @@ An example survived mutant information would be like so:
159158

160159
Detailed report on identified weaknesses in the test suite and potential bugs not caught by the test suite:
161160

162-
Example report:
161+
Example report (**experimental*):
163162

164163
```markdown
165164
### Identified Weaknesses in the Test Suite
@@ -179,6 +178,7 @@ Example report:
179178
- [x] **Fault Injection:** Utilize advanced LLM models to inject context-aware faults into the codebase, ensuring comprehensive mutation testing.
180179
- [x] **Language Support:** Expand support to include various programming languages.
181180
- [x] **Support for Other Coverage Report Formats:** Add compatibility for various coverage report formats.
181+
- [ ] **Mutant Analysis:** Automatically analyze survived mutants to identify potential weaknesses in the test suite. Any suggestions are welcome!
182182

183183
### Continuous Integration and Deployment
184184

0 commit comments

Comments
 (0)