Configuration system

TNB uses a flexible configuration system built on Eclipse MicroProfile Config that allows you to customize behavior through system properties, environment variables, and properties files.

Configuration hierarchy

TNB loads configuration from multiple sources with the following priority (highest to lowest):

test.properties file

Properties defined in a file specified by the test.properties system property (ordinal 500)

System properties

Java system properties passed via -D flags (ordinal 400)

Environment variables

OS environment variables (ordinal 300)

Values in test.properties take precedence over all other configuration sources, including system properties defined in your POM file or command line.

Using test.properties file

The most convenient way to configure TNB is through a test.properties file:

Create test.properties

Create a file named test.properties in your project root

Add your properties

test.use.openshift=true
test.credentials.file=~/credentials.yaml
openshift.kubeconfig=~/.kube/config
tnb.mongodb.image=mongo:7.0

Run your tests

The properties file is loaded automatically if named test.properties, or specify a custom location:

mvn test -Dtest.properties=/path/to/custom.properties

Core configuration properties

Test execution

test.use.openshift

Deploy services on OpenShift instead of locally with TestContainers.Type: boolean
Default: false

test.use.openshift=true

test.use.microshift

Deploy services on MicroShift (lightweight OpenShift).Type: boolean
Default: false

test.use.microshift=true

test.wait.time

Default wait time for operations in seconds.Type: integer
Default: 60

test.wait.time=120

test.wait.kill.timeout

Timeout in minutes before forcefully killing operations.Type: integer
Default: 120

test.wait.kill.timeout=180

test.skip.teardown

Skip cleanup after tests (useful for debugging).Type: boolean
Default: false

test.skip.teardown=true

test.parallel

Enable parallel test execution.Type: boolean
Default: false

test.parallel=true

OpenShift configuration

openshift.url

OpenShift cluster URL.Type: string
Required when: test.use.openshift=true

openshift.url=https://api.cluster.example.com:6443

openshift.username

OpenShift login username.Type: string
Default: admin

openshift.username=developer

openshift.password

OpenShift login password.Type: string
Default: admin

openshift.password=mypassword

openshift.kubeconfig

Path to kubeconfig file for authentication.Type: string
Alternative to: username/password authentication

openshift.kubeconfig=~/.kube/config

openshift.namespace

Namespace to use for deployments.Type: string
Default: tnb-test-<random> (auto-generated)

openshift.namespace=my-test-namespace

openshift.namespace.autoset

Automatically set namespace based on current context.Type: boolean
Default: false

openshift.namespace.autoset=true

openshift.namespace.delete

Delete namespace after tests complete.Type: boolean
Default: false (or true if namespace is auto-generated)

openshift.namespace.delete=true

openshift.deploy.strategy

Deployment strategy for applications.Type: string
Default: jkube

openshift.deploy.strategy=jkube

openshift.deployment.label

Label used to identify deployments.Type: string
Default: app

openshift.deployment.label=application

openshift.https.proxy

HTTPS proxy for OpenShift communication.Type: string
Default: null

openshift.https.proxy=http://proxy.example.com:8080

Application configuration

test.app.group.id

Maven group ID for test applications.Type: string
Default: com.test

test.app.group.id=com.mycompany

test.app.version

Version for test applications.Type: string
Default: 1.0.0-SNAPSHOT

test.app.version=2.0.0

test.app.location

Directory where application artifacts are built.Type: string
Default: target

test.app.location=build/libs

app.template.name

Template name for generated applications.Type: string
Default: tnb-app

app.template.name=my-custom-template

tnb.app.debug

Enable debug mode for applications.Type: boolean
Default: false

tnb.app.debug=true

tnb.app.debug.port

Debug port for remote debugging.Type: integer
Default: 5005

tnb.app.debug.port=8000

Maven configuration

test.maven.repository

Maven repository URL for dependencies.Type: string

test.maven.repository=https://repository.example.com/maven2

For mirror configuration:

test.maven.repository=https://mirror.example.com/maven2@mirrorOf=*

test.maven.repository.id

Repository ID for authentication.Type: string
Default: tnb-maven-repo

test.maven.repository.id=my-repo

test.maven.settings

Path to custom Maven settings.xml file.Type: string

test.maven.settings=/path/to/settings.xml

test.maven.settings.file.name

Name for generated Maven settings file.Type: string
Default: tnb-maven-settings.xml

test.maven.settings.file.name=custom-settings.xml

test.maven.extra.args

Additional Maven command-line arguments.Type: string
Default: “ (empty)

test.maven.extra.args=-X -DskipTests

test.maven.transfer.progress

Show Maven transfer progress.Type: boolean
Default: false

test.maven.transfer.progress=true

Additional properties

tnb.user

User identifier for test tracking.Type: string
Default: Current system user

tnb.user=jenkins-ci

stream.logs

Stream container/pod logs to console.Type: boolean
Default: false

stream.logs=true

odo.path

Path to odo CLI binary.Type: string
Default: Auto-detected from PATH

odo.path=/usr/local/bin/odo

kamelets.version

Apache Camel Kamelets version to use.Type: string

kamelets.version=0.9.0

test.report.portal.enabled

Enable ReportPortal integration.Type: boolean
Default: false

test.report.portal.enabled=true

Service-specific properties

Each System-X service can be configured using properties in the format tnb.<service>.<property>. These are covered in detail in the Docker images section.

Reading configuration in code

Access configuration values programmatically:

import software.tnb.common.config.TestConfiguration;

// Get boolean property
boolean useOpenshift = TestConfiguration.isOpenshift();

// Get string property
String credentialsFile = TestConfiguration.credentialsFile();

// Get duration property
Duration waitTime = TestConfiguration.testWaitTime();

Example configurations

Local testing
OpenShift testing
CI/CD pipeline

# Use TestContainers locally
test.use.openshift=false

# Load credentials
test.credentials.file=~/tnb-credentials.yaml

# Override specific service image
tnb.mongodb.image=mongo:7.0
tnb.kafka.image=confluentinc/cp-kafka:7.5.0

# Enable log streaming
stream.logs=true

# Use OpenShift deployment
test.use.openshift=true

# OpenShift cluster config
openshift.kubeconfig=~/.kube/config
openshift.namespace=my-test-namespace
openshift.namespace.delete=true

# Credentials from Vault
test.credentials.use.vault=true
test.credentials.vault.token=${VAULT_TOKEN}
test.credentials.vault.address=https://vault.company.com
test.credentials.vault.path.pattern=/secret/services/%s/credentials

# Pipeline configuration
test.use.openshift=true
test.parallel=true
test.skip.teardown=false

# Namespace management
openshift.namespace.autoset=false
openshift.namespace.delete=true

# Maven settings
test.maven.repository=https://nexus.company.com/repository/maven-public
test.maven.settings=/opt/maven/settings.xml

# Reporting
test.report.portal.enabled=true

# User tracking
tnb.user=jenkins-pipeline

Best practices

Use test.properties

Keep all configuration in a test.properties file instead of command-line arguments for better maintainability.

Environment-specific files

Create separate properties files for different environments (local, staging, production).

Version control

Add test.properties to .gitignore if it contains sensitive values. Use a test.properties.template as a reference.

Environment variables

Use environment variables for secrets in CI/CD pipelines instead of hardcoding in properties files.

Never commit credentials or sensitive information to version control. Use Vault, environment variables, or local credentials files that are gitignored.

Get Started

Core Concepts

System-X Services

Camel Integration Testing

Advanced Usage

Contributing

Configuration system

Configuration hierarchy

Using test.properties file

Core configuration properties

Test execution

OpenShift configuration

Application configuration

Maven configuration

Additional properties

Service-specific properties

Reading configuration in code

Example configurations

Best practices

Use test.properties

Environment-specific files

Version control

Environment variables

Build docs developers (and LLMs) love

Get Started

Core Concepts

System-X Services

Camel Integration Testing

Advanced Usage

Contributing

​Configuration hierarchy

​Using test.properties file

​Core configuration properties

​Test execution

​OpenShift configuration

​Application configuration

​Maven configuration

​Additional properties

​Service-specific properties

​Reading configuration in code

​Example configurations

​Best practices

Use test.properties

Environment-specific files

Version control

Environment variables

Build docs developers (and LLMs) love

Configuration hierarchy

Using test.properties file

Core configuration properties

Test execution

OpenShift configuration

Application configuration

Maven configuration

Additional properties

Service-specific properties

Reading configuration in code

Example configurations

Best practices