Component configuration file

Updated:2022-11-22

The Component Configuration File is a YAML file with erb-syntax where you configure specific instructions for MAIA Agent. It defines the steps needed to perform and/or send information about checkout, build, fetch, test and deploy a specific component and track to MAIA web app.

The file must be stored at the root of your repository. If more than one track is built, a new configuration file must be checked out before the track is built.

The default name name of the file is MAIA.yml after installation, but can be redefined by editing the parameter COMPONENT_CONFIG_FILE in the environment file.

Parameters

The column headed M/C/O in the table refers to whether the parameter/attribute is mandatory, conditional or optional. The following notation is used:

MAIA Agent is used for scanning (SCAN) or/and Build/Deploy/Test (BDT), which activity is indicated in the parameter list below.

Parameter dependency_generator:

references one ore more scripts that fetches external software for the build. The script must print to standard output (stdout) and use CycloneDX json format.

Example:

{
  "bomFormat": "CycloneDX",
  "specVersion": "1.3",
  "version": 1,
  "components": [
    {
      "type": "library",
      "name": "libxml2",
      "version": "2.9.9",
      "purl": "pkg:generic/libxml2@2.9.9",
      "externalReferences": [
        {
          "type": "website",
          "url": "http://xmlsoft.org/sources/libxml2-2.9.9.tar.gz"
        }
      ],
      "licenses": [
        {
          "license": {
            "name": "MIT",
            }
          }
        }
      ]
    }
  ]
}

Parameter deploy_path_generator:

must reference a user defined script that returns the deliverables on a build that:

• Print to standard output (stdout).
• Print one line for each deliverable with syntax .

Example of script printed to standard output.

Image http:/mynexus.com/repositories/r-abc133/base.iso
Signature http:/mynexus.com/repositories/r-abc133/base.iso.sig

Predefined variables

There are a number of predefined variables that can be used within the <%%> signs in the Component configuration file:

Example :

MAIA.yml, simple example file:

---
version: 5.0
rev: <%= `make -s version`.chomp %>
prepare:
 cmd: make clean
build:
 cmd: make build
 dependency_generator: make -s dependency_list

MAIA.yml, one more example file:

---
version: 5.0              # Protocol version, must be 5.0
component_name: template  # Optional. If defined it must be the same as the name of the component.
rev: 1.0.2                # User-specified revision
subcomponents:            # If this is a collection, specify sub component to builds before this component
- rf-common               # Default, checkout and build with latest in track 'main'
- name: ps-common         # Checkout and build with latest in a specified track
  track: bug-fix4
- name: camel-rf-net      # Do not checkout or build, reuse from build label
  label: CAMEL_RF_NET_1.2-4
  rebuild: false
- name: rf-common         # Do not checkout or build, reuse from revision
  revision: 4.0.5
  rebuild: false
- name: rf-common         # Checkout and rebuild, with label given by environment
  label: <%= ENV['RF_COMMON_LABEL'] %>
  rebuild: true
  test: false             # Don't test
clean:
  cmd: rm -rf <%= build_root %>
prepare:
  cmd: make clean
build:
  cmd:
  - mvn clean install
  - rm -f <%= log_root %>/depend.txt
  - mvn dependency:list > <%= log_root %>/depend.txt
  dependency_generator:
  - grep-dependencies <%= log_root %>/depend.txt <%= src_root %>/pom.xml <%= src_root %>/features.xml
deploy:
  cmd: mvn deploy |tee > <%= log_root %>/deploy.txt
  deploy_path_generator: grep-nexus-path <%= log_root %>/deploy.txt
test:
  prepare_cmd:
  - make clean_test
  suites:
  - name: system_test
    cmd:
    - do_test --suite regression.xml <%= rev %> <%= tested_component %> <%= tested_rev %> <%= maia_core %>
  deliverables:
  - name: mm-features       # Specify deliverables and how to unpack them
    unpack:
      cmd: 'tar xf <%= deliverable_root %>/mm-features-<%= rev % >.jar'

MAIA.yml, another example file:

---
<% test_arg = "TEST_SUITE_ID=$test_suite_id API_TOKEN=#{api_token} ARTIFACT_ID=#{artifact_id} KAFKA_BROKERS=#{kafka_brokers} KAFKA_TOPIC=#{kafka_topic}" %>
<% set_env = "export PATH=#{build_root}/bin:$PATH; export LD_LIBRARY_PATH=#{build_root}/lib:$LD_LIBRARY_PATH;" %>
version: 5.0
rev: '<%= rev=`ruby $BLT_IPV_ROOT/bin/read_revision.rb local_repository/Makefile`.chomp %>'
prepare:
  cmd: cd local_repository; make clean prepare
build:
  cmd: cd local_repository; make build install
  dependency_generator:
  - <%= set_env %> ruby gem_dependencies.rb local_repository/maia/Gemfile.prod
  - <%= set_env %> cd local_repository/maia && ruby npm_dependencies.rb
system_test:
  prepare_cmd: cd local_repository/test; make clean
  suites:
<% ['models',  'presenters', 'views', 'validations', 'features', 'lib', 'helpers', 'services', 'requests'].each do |r| %>
  - name: rspec <%= r %>
    cmd: cd local_repository/test; make rspec_test <%= test_arg %> PATTERN=spec/<%= r %>/*
<% end %>
<% ['models', 'jobs', 'helpers', 'lib', 'validations'].each do |m| %>
  - name: 'mt <%= m %>'
    cmd: cd local_repository/test; make mini_test <%= test_arg %> SUITE=<%= m %>
<% end %>