Brooklyn Maven Plugin

A Maven plugin to help test Apache Brooklyn blueprints. For full documentation see [the plugin website] (http://brooklyncentral.github.io/brooklyn-maven-plugin/index.html).

Download

Include this plugin in your pom:

<plugin>
    <groupId>io.brooklyn.maven</groupId>
    <artifactId>brooklyn-maven-plugin</artifactId>
    <version>${latestPluginVersion}</version>
</plugin>

Goals

start-server

Run a Brooklyn server.

deploy

Instruct an existing Brooklyn server to deploy the given blueprint.

sensor

Fetch the value of a sensor on entities at a given server whose types match a regular expression.

stop

Instruct a Brooklyn server to stop the application with the given ID.

stop-server

Instruct a Brooklyn server to shut down

help

Display help information on brooklyn-maven-plugin.

Example

The example-pom project:

• Deploys a blueprint from a file that runs a TomcatServer and an EmptySoftwareProcess.
• Queries Brooklyn for the main URL of the Tomcat application (the webapp.url sensor).
• Uses maven-antrun-plugin to echo these values to the console.
• Stops the deployment before Maven exits.

The important bits of the pom are:

<plugin>
    <groupId>io.brooklyn.maven</groupId>
    <artifactId>brooklyn-maven-plugin</artifactId>
    <version>0.2.0-SNAPSHOT</version>
    <executions>
        <execution>
            <id>Deploy blueprint</id>
            <goals>
                <goal>deploy</goal>
                <goal>sensor</goal>
                <goal>stop</goal>
            </goals>
            <configuration>
                <server>${server}</server>
                <blueprint>${project.basedir}/blueprint.yaml</blueprint>
                <sensor>webapp.url</sensor>
                <typeRegex>.*Tomcat.*</typeRegex>
            </configuration>
        </execution>
    </executions>
</plugin>

You can test this project by starting Brooklyn and running mvn clean install from the example-app directory. If Brooklyn starts on any port other than 8081 then run with -Dserver=http://host:port.

At the end of the build you should see output like:

[INFO] --- maven-antrun-plugin:1.3:run (default) @ test ---
[INFO] Executing tasks
    [echo] Maven plugin example results:
    [echo] Server was running at http://127.0.01:8081
    [echo] Application: T0tERELL
    [echo] Sensor value: http://127.0.0.1:8080/

Caveats

You may currently only query for entities by their type. If two or more entities match the query goal's regular expression the property will be set to result1,result2,....