Yet Another Software Test Environment (YASTE) Documentation

TODO: This section has not really been modified from the original OpenEngSB introduction. TBW (explain which sections are interesting for which target audience)

What is YASTE?

TBW

Glossary

OpenEngSB: TBW
EngSB: TBW
Domain: TBW
Tool Domain: TBW
Tool Connector: TBW
Value Added Components: TBW
OpenEngSB Platform: TBW
Context: TBW
Registry: TBW
Workflow: TBW

Part II. Installation & Administration

This section explains how to install and use YASTE.

Table of Contents

2. YASTE Quickstart

3. How to use YASTE with OpenEngSB

title

Chapter 2. YASTE Quickstart

This chapter gives an overview how to quickly get started with YASTE.

Chapter 3. How to use YASTE with OpenEngSB

Table of Contents

title

title

para

Part III. Developer Manual

This section describes the rules and infrastructure according to which the YASTE project is developed - it explains how to develop additional plugins.

Table of Contents

4. YASTE Architecture Overview

Plugins

5. YASTE Developer

Prerequisite

Install GIT

6. How to use the Maven archetype to create a YASTE plugin

Using the archetype

7. Development Guidelines

Storage Guidelines

Chapter 4. YASTE Architecture Overview

Table of Contents

Plugins

For a more detailed description see the architectural manual provided here...

Plugins

TBW(General parts about the plugins)

TBW

Chapter 5. YASTE Developer

Table of Contents

Prerequisite

Install GIT

This chapter describes how to quickly get started with YASTE development.

Prerequisite

TBW

Install GIT

Further more its assumed that GIT had been installed. For GIT we recommend the latest Cygwin with the git packages. Please set at least the following variables:

git config --global user.name "Firstname Secondname"
git config --global user.email "my@email.com"
git config --global core.autcrlf input

Finally download Apache Maven and unpack it. Add the path of the maven binary to your PATH variable. Further more you should add a MAVEN_OPTS variable with "-Xmx1024M -XX:MaxPermSize=512m".

Chapter 6. How to use the Maven archetype to create a YASTE plugin

Table of Contents

Using the archetype

This section describes how a new YASTE plugin can be created using a Maven archetype.

Using the archetype

The following command is used to start the project generation:

        
   mvn archetype:generate -DarchetypeCatalog="http://maven.openengsb.org/archetypes/"

The archetype named connector-archetype should show up in the archetype list. Select the archetype connector-archetype. Maven will ask if the default values for the properties shall be used. Type 'n' to overwrite the default values. The following properties are needed to generate a connector project:

artifactId: The artifactId of the generated wrapper project for the service-engine and the service-unit.
groupId: The groupId of the generated wrapper project. Should be org.openengsb.
version: The version of the generated wrapper project.
se-artifactId: The artifactId of the service-engine.
su-artifactId: The artifactId of the service-unit.
description: The description of the tool connector.
namespace: The namespace of the tool connector.
package: The package for the source code of the service-engine.
connector-name: The connector name. This is used as prefix for Java classes so it should start with a upper-case letter.
domain-package: The package where the domain interface can be found which is implemented by this tool connector.
domain-name: The interface name of the domain interface that is implemented by this tool connector.
urn: The URN that will be used to address this tool connector.

Chapter 7. Development Guidelines

Table of Contents

Storage Guidelines

This section contains the design, architecture and development guidelines for YASTE.

Storage Guidelines

TBW