Maven Plugin getting started🔗

Before you begin🔗

Please make sure that you have the following information available:

• AQtive Guard root URL - optional
  • The default for this URL is https://analyzer.cryptosense.com if you use SaaS.
  • If you installed AQtive Guard on-premises, it will be in the form https://domain.example.net.
• Your Sandbox API Key - required
  • This key can be found at <https://analyzer.cryptosense.com/api>.
• Your target project ID (projectId) - required
  • Found in the project overview URL in the Web Interface: https://analyzer.cryptosense.com/project/<projectId>/dashboard See Find the project ID.
• Your target profile ID (profileId) - required
  • Found in the profiles page URL in the Web Interface: https://analyzer.cryptosense.com/organization/profiles/<profileId> See Find the profile ID.

Installation🔗

1. Extract the package (example: cryptosense-maven-plugin-1.2.3.zip).
2. Copy the extracted artifacts to a repository that Maven can access, such as a standalone directory in the filesystem or an internal Maven repository.

Configuration🔗

In the instructions that follow, assume that the Maven repository containing SandboxAQ artifacts is located at /path/to/cryptosense/repository on the filesystem.

Plugin repository🔗

Add the following to the project section of your pom.xml to add the Sandbox repository as a configured plugin repository:

<project>
  ...
  <pluginRepositories>
    ...
    <pluginRepository>
      <id>cryptosense-repository</id>
      <url>file://path/to/cryptosense/repository</url>
    </pluginRepository>
    ...
  </pluginRepositories>
  ...
</project>

Create an AQtive Guard build profile🔗

The most flexible way to use the plugin consists in creating a build profile. Add the <profile> below to your pom.xml configuration:

<project>
  ...
  <profiles>
    ...
    <profile>
      <id>sandbox</id>
      <build>
        <plugins>
          <plugin>
            <groupId>com.cryptosense</groupId>
            <artifactId>cryptosense-maven-plugin</artifactId>
            <version>MAVEN PLUGIN VERSION</version>  <!-- change this -->
            <configuration>
              <apiUrl>AQtive Guard API URL</apiUrl>  <!-- change this -->
              <apiKey>${env.CS_API_KEY}</apiKey>
              <projectId>AQtive Guard PROJECT ID</projectId>  <!-- change this -->
              <profileId>AQtive Guard PROFILE ID</profileId>  <!-- change this -->
            </configuration>
            <executions>
              <execution>
                <id>inject-agent</id>
                <goals>
                  <goal>inject-agent</goal>
                </goals>
              </execution>
              <execution>
                <id>generate-report</id>
                <goals>
                  <goal>generate-report</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </profile>
    ...
  </profiles>
  ...
</project>

This code assumes that the API key will be provided as the CS_API_KEY environment variable.

Run tests with the plugin🔗

When running your tests, add -P sandbox to enable the profile. For example, a full test suite (with trace upload) can be run using the command:

mvn clean install -P sandbox

This will run your tests with the Sandbox Java Tracer attached and will upload the results to the project chosen in the previous section.

To make sure the plugin was used, check the output to see if the inject-agent and generate-report goals were triggered as part of the build.

Next steps🔗

Customize the prefix used for traces and reports🔗

In order to customize the prefix that is used by the Sandbox java agent when generating trace files (and therefore the uploaded traces and reports), add the following to the configuration in your pom.xml:

<configuration>
  ...
  <agentOutputPrefix>myprefix</agentOutputPrefix>
</configuration>