Local Accelerator Authoring Test Suite Example

May 7, 2025 · View on GitHub

This directory contains an example of a test suite you can create for testing accelerators that you are authoring.

Setup

You need to download the vmware-tanzu/application-accelerator-samples repository from GitHub. The URL is https://github.com/vmware-tanzu/application-accelerator-samples/archive/refs/heads/main.zip.

You can use wget using these commands:

cd $HOME/Downloads
wget https://github.com/vmware-tanzu/application-accelerator-samples/archive/refs/heads/main.zip \
  -O application-accelerator-samples-main.zip

Then, extract the downloaded archive:

unzip application-accelerator-samples-main.zip

This should create a directory named application-accelerator-samples-main containing all the accelerator samples and a local test suite example. To be able to run this local test suite example you need to download the "App Accelerator Local Server Engine" ZIP archive from the Tanzu Platform Developer Tools on the Broadcom Support Portal. Download the "acc-engine" archive that matches your operating system and processor architecture.

Once downloaded extract the "acc-engine" archive:

cd $HOME/Downloads
unzip acc-engine-*-*-v2.1.0*.zip -d application-accelerator-samples-main/local-test-suite-example

Creating a test suite

The scripts included in this example relies on a directory structure where each test in the test suite is in a separate directory named based on a test-suite-name-suffix pattern. This example uses:

tests/suite
├── tanzu-java-web-app-defaults
│   ├── assertions.sh
│   └── options.json
└── tanzu-java-web-app-mvn_java21
    ├── assertions.sh
    └── options.json

where tanzu-java-web-app is the test suite name and each test has a descriptive suffix like -defaults and mvn_java21 in this example.

Each test contains two files:

.
└── tanzu-java-web-app-mvn_java21
    ├── assertions.sh
    └── options.json

Where options.json file is used to specify the configurable options for generating the accelerator and assertions.sh is a script the will be run to check the generated content.

The options.json file can be created using the "Tanzu Platform Developer Tools" IDE plugin for either IntelliJ or VS Code. These plugins can be downloaded from the the Broadcom Support Portal. There is an "Export Options" button you can use to export the option values selected in the configuration step.

Here is an example of the options.json file:

{
  "projectName": "tanzu-java-web-app",
  "buildTool": "maven",
  "javaVersion": "21",
  "includeBuildToolWrapper": true
}

The assertions.sh script can then be used to verify the generated content. Here is an example based on the above options:

#!/bin/bash
set -euxo pipefail

source $(dirname ${BASH_SOURCE[0]})/../../testFunctions.sh

pushd \$1

assertFileExists ./pom.xml
assertFileDoesntExist ./build.gradle.kts
assertFileContains ./pom.xml '<java.version>21</java.version>'

./mvnw package

popd

A few things to mention here:

  1. We source a ../../.github/tests/testFunctions.sh file available in the local-test-suite-example download.
  2. The script expects to get the directory for the test as first argument so we can switch to that directory
  3. We can provide as many asserts that we think is reasonable to test the accelerator generated content
  4. We can also provide a build command to verify the project can build and run tests

Using local filesystem accelerators instead of accelerators in a Git repository

The local-test-suite-example/tests/accelerator-resources.yaml file defines the location of the accelerators and fragments to be used for the test suite. Here is the definition for the tanzu-java-web-app accelerator:

---
apiVersion: accelerator.tanzu.vmware.com/v2
kind: Accelerator
metadata:
  name: tanzu-java-web-app
spec:
  displayName: Tanzu Java Web App
  description: A sample Spring Boot web application for Tanzu Platform
  iconURL: ""
  tags:
  - java
  - spring
  - gradle
  - maven
  - web
  - tanzu
  git:
    ref:
      branch: main
    url: https://github.com/vmware-tanzu/application-accelerator-samples
    subPath: tanzu-java-web-app

When testing an accelerator with all files in a local directory, you can specify localFile.path property as in the following example (replacing the <path-to-unzipped-samples-archive> placeholder with the actual directry where the files are):

---
apiVersion: accelerator.tanzu.vmware.com/v2
kind: Accelerator
metadata:
  name: tanzu-java-web-app
spec:
  displayName: Tanzu Java Web App
  description: A sample Spring Boot web application for Tanzu Platform
  iconURL: ""
  tags:
  - java
  - spring
  - gradle
  - maven
  - web
  - tanzu
  localFile:
    path: <path-to-unzipped-samples-archive>/tanzu-java-web-app

Running the test suite

We need to change to the directory with the test suite scripts which should be inside the directory where you extracted the vmware-tanzu/application-accelerator-samples repository archive ZIP file. Then, we need to change to use the local-test-suite-example/tests directory.

cd $HOME/Downloads/application-accelerator-samples-main
cd local-test-suite-example/tests

Then, we simply run the run-test-suite.sh script:

./run-test-suite.sh

This example has three scripts that are used to drive the test suite runs.

  1. run-test-suite.sh is the top level script that orchestrates the run
  2. run-engine.sh starts a local engine server for generating the accelerators in the test.
  3. acc-generate.sh generates the accelerator using the options from each tests options.json file
  4. acc-run-test.sh runs the assertion.sh script against the generated content

The accelerator content is generated into a local workspace directory and a workspace/results.txt file is created containing a test report.

Any assertion failures should result in a message displayed with the actual failure:

+ assertFileContains ./config/workload.yaml 'value: "21"'
+ grep -Fq 'value: "21"' ./config/workload.yaml
+ echo './config/workload.yaml DOES NOT contain "value: "21""'
./config/workload.yaml DOES NOT contain "value: "21""
+ exit 1

When you have resolved any issues the test suite should finish with a success message and the test report:

** SUCCESS
Stopping process 81692
--------- TEST REPORT ------------------------------------
START Fri May  2 15:38:49 EDT 2025

TESTING: tanzu-java-web-app-defaults
GENERATING: tanzu-java-web-app
OPTIONS:
{
  "projectName": "tanzu-java-web-app"
}
VERIFYING: tanzu-java-web-app-defaults
ASSERTIONS: /Users/risbergt/test/acc-engine/tests/suite/tanzu-java-web-app-defaults/assertions.sh
COMPLETE: tanzu-java-web-app-defaults

TESTING: tanzu-java-web-app-mvn_java21
GENERATING: tanzu-java-web-app
OPTIONS:
{
  "projectName": "tanzu-java-web-app",
  "buildTool": "maven",
  "javaVersion": "21",
  "includeBuildToolWrapper": true
}
VERIFYING: tanzu-java-web-app-mvn_java21
ASSERTIONS: /Users/risbergt/test/acc-engine/tests/suite/tanzu-java-web-app-mvn_java21/assertions.sh
COMPLETE: tanzu-java-web-app-mvn_java21

SUCCESS Fri May  2 15:39:08 EDT 2025
----------------------------------------------------------