Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

Latest commit

 

History

History
62 lines (53 loc) · 2.82 KB

README.md

File metadata and controls

62 lines (53 loc) · 2.82 KB
Raw

This repository is deprecated, its content has been merged to the main PerfCake repository.

Maven plugin for PerfCake

Maven plugin which allows to run PerfCake scenarion within Maven build. This makes perfomance test automation more easy and encourage you to run perfomance tests on a regular basis, e.g. in within your favourite CI server. Runnning perfomance test on a regular basis allows you to spot perfomance drops very soon and thus make much more easy to identify, which commit has caused perfomance regression.

Configuration

Currently plugin has only one goal scenario-run, which runs specified PerfCake scenario. By default, this goal is executed in integration-test phase (i.e. assumes, that you deploy/start your application in pre-integration-test phase and shut it down in post-integration-test phase).

The only mandatory parameter is <scenario>, which specifies the name of the scenario to be run. Optionally, you can also specify scenarios-dir, messages-dir and plugins-dir, which speficy paths to directory containing scenarios, messages and plugins, respectivelly. If you don't setup these parameters, pluing assumes, that appropriate directories (scenarios, messages, plugins) are in src/test/resources/perfcake. If any of them doesn't exists, plugin will use src/test/resources as a fallback value for missing parameter. You can also speficy PerfCake version which should be used for scenario execution. It can be set up by adding <perfcake-version> element into plugin configuration. Appropriate PerfCake jar file is obtained via Maven, so you can use any PerfCake version which is available in your Maven repository. If the version is not specified or appropriate artifact cannot be resolved, PerfCake on the class path is used - if not changed by other set up, there should be PerfCake which this plugin depends on.

Example configuration

  <build>
    <plugins>
      <plugin>
        <groupId>org.perfcake.maven</groupId>
        <artifactId>perfcake-maven-plugin</artifactId>
        <version>0.1-SNAPSHOT</version>
        <configuration>
          <scenario>my_perfcake_scenario</scenario>
          <perfcake-version>2.0</perfcake-version>
        </configuration>
        <executions>
          <execution>
            <id>perfcake-scenario-run</id>
            <goals>
              <goal>scenario-run</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

Versioning

Please note that this repository follows Git Flow workflow. The development branch name is devel.

Bug reporting

Please report bugs to https://github.com/PerfCake/PerfCake/issues