Create and View Build Configurations for C3 AI Release Management

Configurations can be set to determine certain build behaviors. Build-level configurations can be useful for storing and retrieving information for custom steps. They are also used to determine certain behaviors in the pipeline such as whether to get a particular type of test coverage.

Copy link to this section

Create the config file

Regardless of whether you are using custom steps, you must set the jarvisFilePath for your desired branch group. Refer to the instructions Customize the Build Pipeline in C3 AI Release Management to do so. First, a config folder must exist at the specified jarvisFilePath. Create a config.js file inside of the config folder. Release Management explicitly looks for this file to retrieve build-level configurations before running the build. The config.js should look as follows:

data = {
  configValues: {
    testKey: 'testValue'
  }
}

Release Management consumes the entire object and persists it as a JarvisService.BuildConfig. Note that only regular config values should live here. Release Management does not ingest secretValues even if provided due to security concerns.

If secret values must be provided to a build, you must manually trigger a build with Jarvis.triggerBuild. This function has a config parameter through which both configValues and secretValues can be provided. The parameter should be of type JSON as follows:

{
  "configValues": {
    "testKey": "testValue"
  },
  "secretValues": {
    "userName": "<password>"
  }
}

Copy link to this section

Add or modify config values

The following config values are currently being used in the pipeline.

If you are using custom steps that need specific values, you can store them here and retrieve them in the custom step by calling Jarvis.buildConfigValue with the appropriate key. If necessary, the value can be set with Jarvis.setBuildConfigValue.

Copy link to this section

Parallel testing

You can use parallel testing by setting testStrategies in the configValues of their config/config.js file. This section focuses on how testStrategies is parsed by Release Management to orchestrate tests between executors.

There are 3 concepts involved in parallel testing:

1. Test group — A test group is a list of all the tests that are run in a single testPackages step. Different test groups run tests in parallel across different Java Virtual Machines (JVMs). If no testStrategies are specified, a test group consists of all the tests in one package.
2. Test thread — A test thread specifies a subset of tests within the test group that are run by a single thread within the environment that executes the testPackages step. Within a single test group, there can be multiple test threads. These threads run tests in parallel within the same JVM.
3. Test strategy — A test strategy specifies how to distribute tests among threads within a single test group. Currently, there are only 2 supported testing strategies: SERIAL and MANUAL.

A test group can have multiple fields:

A config.js file with multiple test strategies could look as follows:

data = {
  configValues: {
    testStrategies: [{
      // Run all the tests that match the regexes in the list in serial order.
      // Tests that match the first regex are run before tests that match the second regex.
      tests: ['.*/a1/.*', '.*/a2/.*'],
      strategy: 'SERIAL'
    },
    {
      // Spin up 2 threads, 1 to run tests that match '.*/c/c1.*' and 1 to run tests that match '.*/c/c2.*'
      tests: ['.*/c/.*'],
      strategy: 'MANUAL',
      threads: [
          ['.*/c/c1.*'],
          ['.*/c/c2.*']
      ]
    }]
  }
}

Note that parallel testing DOES NOT let the user skip tests.

1. If there are any tests that do not match any of the specified regexes, they are collected and run in a separate test group.
2. If these tests come from n different packages, n extra groups are created with each test group running the tests remaining within each package.

Copy link to this section

View the build config values

To view the config values for a build, navigate to the page for the build and click the Config tab. This tab lists both branch group and build-level configs with secret values only displayed as asterisks.

Copy link to this section

See also

• Customize the Build Pipeline in C3 AI Release Management