README.md

OSMO Sugar provides support for model based testing with Teemu Kanstrén's OSMO Tester.

Sugar

1. The RequirementEnforcingOsmoTester is a thin wrapper over OSMOTester that guarantees every requirement has been met.
2. The RequirementAnnotationListener automates requirement registration and coverage. Just add @Requirement annotations to methods that assert requirements. The default RequirementNamingStrategy will prefer the value provided in the @Requirement annotation. Otherwise, it will use the name of the annotated method.

Getting started.

1. Add the dependency.

<dependency>
    <groupId>com.agilarity</groupId>
    <artifactId>osmo-sugar</artifactId>
    <version>2.0.7</version>
</dependency>

2. Write single step models that cover the user actions under test. Add a Requirements field to the model so that OSMO knows you want to track requirements.
3. Add a @Requirement annotation to each method that assures a requirement scenario has been covered.
4. Run your test class from your favorite testing tool, like JUnit or TestNG.

See the com.agilarity.osmo.example.vend in the test package for a vending machine example.