Gareth is platform that allows you to make business goal validation part of your development process.
For extra information visit our lean startup site
Gareth can be run in two different manners, can be run with or without a REST interface.
The Gareth framework must be fed with two pieces of information, the 'experiment' and the 'definitions'.
The experiments describes the assumptions somebody has when they have certain functionality build. For example a certain functionality is build is build to reduce failed logins. (The why) Within a experiment you can describe this in a structured manner.
Experiment: reduce failed logins
Baseline: Get current failed logins
Assume: Failed login are reduced by 500
Time: 1 week
Baseline: Get current failed logins
Assume: Failed login are reduced by 1000
Time: 1 month
Baseline: Get current failed logins
Assume: Failed login are reduced by 2000
Time: 1 months
Success: Sent cake to the developers
Failure: Remove functionality
Definitions is the code that is glued to the experiments structured language, by allowing this aproach there is no limitation how you can validate your assumptions.
import org.craftsmenlabs.gareth.api.annotation.Assume;
import org.craftsmenlabs.gareth.api.annotation.Baseline;
import org.craftsmenlabs.gareth.api.annotation.Failure;
import org.craftsmenlabs.gareth.api.annotation.Time;
import org.craftsmenlabs.gareth.api.storage.Storage;
import java.time.Duration;
import java.time.temporal.ChronoUnit;
public class LoginFailuresDefinitions {
@Baseline(glueLine = "Get current failed logins")
public void baseline(final Storage storage) {
// Code to get failed logins
storage.store("failedLogins", 1);
}
@Assume(glueLine = "Failed login are reduced by 500")
public void assume500(final Storage storage) {
// Code to get failed logins
int failedLoginBefore = storage.get("failedLogins");
// Code to get failed logins
}
@Assume(glueLine = "Failed login are reduced by 1000")
public void assume1000(final Storage storage) {
// Code to get failed logins
int failedLoginBefore = storage.get("failedLogins");
// Code to get failed logins
}
@Assume(glueLine = "Failed login are reduced by 2000")
public void assume2000(final Storage storage) {
// Code to get failed logins
int failedLoginBefore = storage.get("failedLogins");
// Code to get failed logins
}
@Success(glueLine = "Sent cake to the developers")
public void success(){
// Code to sent cake to the developers
}
@Failure(glueLine = "Remove functionality")
public void failure(){
// Code to remove functionality
}
@Time(glueLine = "1 week")
public Duration getOneWeek(){
return Duration.of(1, ChronoUnit.WEEKS);
}
@Time(glueLine = "1 month")
public Duration getOneMonth(){
return Duration.of(1, ChronoUnit.MONTHS);
}
@Time(glueLine = "2 months")
public Duration getTwoMonths(){
return Duration.of(2, ChronoUnit.MONTHS);
}
}Running Gareth without a REST interface can be done by creating a maven project that depends on the following maven dependency:
<dependency>
<groupId>org.craftsmenlabs.gareth</groupId>
<artifactId>gareth-core</artifactId>
<version>0.8.1</version>
</dependency>Create a java application that starts the Gareth framework:
import org.craftsmenlabs.gareth.api.ExperimentEngine;
import org.craftsmenlabs.gareth.api.ExperimentEngineConfig;
import org.craftsmenlabs.gareth.core.ExperimentEngineConfigImpl;
import org.craftsmenlabs.gareth.core.ExperimentEngineImpl;
import org.craftsmenlabs.gareth.examples.definition.SampleDefinition;
public class ExampleApplication {
public static void main(final String[] args) {
final ExperimentEnginePersistence experimentEnginePersistence = new FileSystemExperimentEnginePersistence.Builder().build();
final ExperimentEngineConfig experimentEngineConfig = new ExperimentEngineConfigImpl
.Builder()
.addDefinitionClass(SampleDefinition.class)
.addInputStreams(ExampleApplication.class.getClass().getResourceAsStream("/experiments/businessgoal-01.experiment"))
.setIgnoreInvocationExceptions(true)
.build();
final ExperimentEngine experimentEngine = new ExperimentEngineImpl
.Builder(experimentEngineConfig)
.setExperimentEnginePersistence(experimentEnginePersistence)
.build();
experimentEngine.start();
Runtime.getRuntime().addShutdownHook(new ShutdownHook(experimentEngine));
}
/**
* Shutdown hook when application is stopped then also stop the experiment engine.
*/
static class ShutdownHook extends Thread {
private final ExperimentEngine experimentEngine;
private ShutdownHook(final ExperimentEngine experimentEngine) {
this.experimentEngine = experimentEngine;
}
@Override
public void run() {
experimentEngine.stop();
}
}
}For building the standalone application, you can use the maven-shade-plugin to create a single jar containing all the necessary classes. You can add this your project pom.xml.
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>2.4.1</version>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>org.craftsmenlabs.gareth.examples.ExampleApplication</mainClass>
</transformer>
</transformers>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>After doing a maven clean package you now can run the Gareth platform with your own definitions and experiments.
java -jar /path/to/project.jarRunning Gareth with a REST interface can be done by creating a maven project that depends on the following maven dependency:
<dependency>
<groupId>org.craftsmenlabs.gareth</groupId>
<artifactId>gareth-core</artifactId>
<version>0.8.1</version>
</dependency>
<dependency>
<groupId>org.craftsmenlabs.gareth</groupId>
<artifactId>gareth-rest</artifactId>
<version>0.8.1</version>
</dependency>Create a java application that starts the Gareth framework:
import org.craftsmenlabs.gareth.api.ExperimentEngine;
import org.craftsmenlabs.gareth.api.ExperimentEngineConfig;
import org.craftsmenlabs.gareth.api.rest.RestServiceFactory;
import org.craftsmenlabs.gareth.core.ExperimentEngineConfigImpl;
import org.craftsmenlabs.gareth.core.ExperimentEngineImpl;
/**
* Created by hylke on 17/08/15.
*/
public class GarethContext {
public static void main(final String[] args) throws Exception {
final RestServiceFactory restServiceFactory = new RestServiceFactoryImpl(); // Create a new rest service factory
final ExperimentEngineConfig config = new ExperimentEngineConfigImpl.Builder().build();
final ExperimentEngine engine = new ExperimentEngineImpl.Builder(config).setRestServiceFactory(restServiceFactory).build(); // And just include it in the engine
engine.start();
}
}For building the standalone application, you can use the maven-shade-plugin to create a single jar containing all the necessary classes. You can add this your project pom.xml.
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>2.4.1</version>
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>org.craftsmenlabs.gareth.examples.ExampleApplication</mainClass>
</transformer>
</transformers>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>After doing a maven clean package you now can run the Gareth platform with your own definitions and experiments.
java -jar /path/to/project.jarYou can contribute to this repository the by following these steps.
- Fork this repository
- Create a branch
- Do your coding
- Create a pull request to integrate the branch
We need some help to achieve the following goals:
- Create plugins for the major IDEs
- Have support for other languages than Java
The following functionality is planned for next releases:
- Add experiment examples
- Re-run experiments
- Have run numbers to have historic information about runs
- Build examples
- REST interface
- Add Gareth based asserts
- Maintain state after restart
- Store values thru experiments
- Replace AKKA with lightweight scheduler
- Allow for regex glue lines