# Levenshtein Testing Framework

> Structural and behavioural tests for student code that tolerate small naming deviations, built on Ares 2.

Structural and behavioural tests for Java student code that tolerate small naming deviations (typos, case
slips, int vs. Integer), built on Ares 2 for exams and exercises on Artemis. Wrappers (ClassWrapper,
AttributeWrapper, MethodWrapper, ConstructorWrapper) describe the expected classes; the framework finds the
student's elements with Levenshtein distance and grades them EXACT, DEVIATES or MISSING. The Javadoc is at
https://valentinherrmann.github.io/Levenshtein-Testing-Framework/api/.

## Getting started

- [Home](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/index.md>): Overview, key features and the list of guides
- [Quick Start](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/quick-start/index.md>): From zero to a running test in four steps
- [Writing Tests](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/writing-tests/index.md>): Wrapper reference, structural and behavioural tests, getters and setters, failure format, configuration, annotations
- [Independent Tests and Mocks](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/independent-tests/index.md>): Objects without constructor, method overrides and mocks
- [Ares 2 Setup in Detail](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/ares-setup/index.md>): Ares 2 dependencies, build wiring, reserved-package guard and security policy

## Reference

- [How Matching Works](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/matching/index.md>): How elements are found and graded: names, types, modifiers, methods, constructors, classes
- [Architecture](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/architecture/index.md>): How the parts fit together, class overview and diagrams

## Help

- [FAQ &amp; Troubleshooting](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/faq/index.md>): Common problems, fixes and known limitations
- [Versions and Migrating](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/migration/index.md>): Changes per release and how to update existing tests
- [Development and Releasing](<https://valentinherrmann.github.io/Levenshtein-Testing-Framework/releasing/index.md>): Building, testing and releasing the framework (maintainers)