Matrix builds for multi-platform in Jenkins - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a matrix build in Jenkins?

A matrix build runs the same job with different combinations of parameters, like operating systems or environments, to test multiple setups automatically.

beginner

Why use matrix builds for multi-platform testing?

Matrix builds save time by running tests in parallel on different platforms, ensuring your software works everywhere without manual setup for each platform.

intermediate

How do you define axes in a Jenkins matrix build?

Axes are parameters like OS or JDK version. Jenkins runs the job for every combination of these axes values.

intermediate

What is the benefit of running matrix builds in parallel?

Running builds in parallel speeds up testing by using multiple agents at once, reducing total build time.

advanced

How can you exclude certain combinations in a Jenkins matrix build?

You can add exclusion rules in the matrix configuration to skip unwanted combinations, saving resources and time.

What does a Jenkins matrix build do?

A Deploys code automatically

B Runs a job only once

C Builds a single platform only

D Runs a job with multiple parameter combinations

Matrix builds run the same job with different parameter combinations like OS or environment.

Which Jenkins feature lets you run builds on different OS versions automatically?

A Pipeline triggers

B Matrix build axes

C Post-build actions

D Build wrappers

Axes define parameters like OS versions for matrix builds.

How can you speed up matrix builds in Jenkins?

A Disable axes

B Run builds sequentially

C Run builds in parallel

D Use only one agent

Parallel execution uses multiple agents to run builds faster.

What is an exclusion in a Jenkins matrix build?

A A rule to skip certain parameter combinations

B A build failure

C A post-build step

D A plugin

Exclusions prevent running unwanted combinations in matrix builds.

Which of these is NOT typically an axis in a matrix build?

A Build number

B Operating system

C JDK version

D Browser type

Build number is unique per build, not a parameter axis.

Explain how matrix builds help test software on multiple platforms using Jenkins.

Think about running the same job with different settings automatically.

Describe how to configure exclusions in a Jenkins matrix build and why they are useful.

Consider when you don't want to test every possible combination.

Practice

1. What is the main purpose of using a matrix build in Jenkins for multi-platform projects?

easy

A. To run the same build steps on multiple platform combinations automatically

B. To run only one build on a single platform

C. To manually select which platform to build on

D. To speed up builds by skipping tests

Solution

1. Step 1: Understand matrix build concept

   A matrix build runs the same steps on different combinations of variables like OS and architecture.

2. Step 2: Identify the purpose for multi-platform

   This allows testing and building on all required platforms automatically without manual intervention.

3. Final Answer:

   To run the same build steps on multiple platform combinations automatically -> Option A

4. Quick Check:

   Matrix build = multi-platform automatic runs [OK]

Hint: Matrix builds run all platform combos automatically [OK]

Common Mistakes:

• Thinking matrix builds run only on one platform
• Confusing matrix with manual selection
• Assuming matrix skips tests

2. Which syntax correctly defines two axes named os and arch in a Jenkins matrix build?

easy

A. matrix { axis name='os' values='linux,windows'; axis name='arch' values='x86,arm' }

B. matrix { os: ['linux', 'windows'], arch: ['x86', 'arm'] }

C. axes { axis('os', ['linux', 'windows']); axis('arch', ['x86', 'arm']) }

D. axes { axis { name 'os'; values 'linux', 'windows' } axis { name 'arch'; values 'x86', 'arm' } }

Solution

1. Step 1: Recall Jenkins matrix axes syntax

   Jenkins uses axes { axis { name '...' ; values '...' } } blocks to define axes.

2. Step 2: Match syntax with options

   axes { axis { name 'os'; values 'linux', 'windows' } axis { name 'arch'; values 'x86', 'arm' } } matches the correct syntax with two axis blocks inside axes.

3. Final Answer:

   axes { axis { name 'os'; values 'linux', 'windows' } axis { name 'arch'; values 'x86', 'arm' } } -> Option D

4. Quick Check:

   Correct axis syntax = axes { axis { name 'os'; values 'linux', 'windows' } axis { name 'arch'; values 'x86', 'arm' } } [OK]

Hint: Use axes { axis { name; values } } for matrix axes [OK]

Common Mistakes:

• Using incorrect matrix or axis syntax
• Mixing JSON-like syntax instead of Groovy
• Missing semicolons or braces

3. Given this Jenkins matrix snippet:

axes {
  axis {
    name 'os'
    values 'linux', 'windows'
  }
  axis {
    name 'arch'
    values 'x86', 'arm'
  }
}
stages {
  stage('Build') {
    steps {
      echo "Building on ${os} for ${arch}"
    }
  }
}

How many total build combinations will Jenkins run?

medium

A. 6

B. 2

C. 4

D. 8

Solution

1. Step 1: Count values in each axis

   Axis 'os' has 2 values: linux, windows. Axis 'arch' has 2 values: x86, arm.

2. Step 2: Calculate total combinations

   Total combinations = 2 (os) * 2 (arch) = 4.

3. Final Answer:

   4 -> Option C

4. Quick Check:

   2 OS * 2 arch = 4 builds [OK]

Hint: Multiply axis values count for total combinations [OK]

Common Mistakes:

• Adding instead of multiplying axis values
• Counting only one axis
• Misreading axis values count

4. You wrote this matrix build snippet but Jenkins fails with an error:

axes {
  axis {
    name 'os'
    values 'linux', 'windows'
  }
  axis {
    name 'arch'
    value 'x86', 'arm'
  }
}

What is the error and how to fix it?

medium

A. Typo: use 'values' instead of 'value' in second axis

B. Missing quotes around 'x86' and 'arm'

C. Axes block should be named 'matrix' not 'axes'

D. Use commas instead of spaces between values

Solution

1. Step 1: Identify syntax error in axis definition

   The second axis uses 'value' instead of the correct 'values' keyword.

2. Step 2: Correct the keyword

   Change 'value' to 'values' to fix the syntax error and allow multiple values.

3. Final Answer:

   Typo: use 'values' instead of 'value' in second axis -> Option A

4. Quick Check:

   Axis keyword must be 'values' [OK]

Hint: Check for 'values' keyword spelling in axes [OK]

Common Mistakes:

• Using 'value' instead of 'values'
• Forgetting commas between values
• Misnaming axes block

5. You want to run a matrix build on OS (linux, windows) and arch (x86, arm), but only run the 'arm' builds on agents labeled 'arm-node'. How do you configure the matrix to achieve this?

hard

A. Set agent { label 'arm-node' } globally for all builds

B. Use agent { label "${arch == 'arm' ? 'arm-node' : ''}" } inside the matrix

C. Add when { expression { arch == 'arm' } } to skip arm builds

D. Use exclude { axis { name 'arch'; value 'arm' } } to remove arm builds

Solution

1. Step 1: Understand agent labeling per axis value

   You want 'arm' builds to run only on 'arm-node' labeled agents, others on default.

2. Step 2: Use conditional label assignment in agent block

   Using agent { label "${arch == 'arm' ? 'arm-node' : ''}" } assigns 'arm-node' label only for arm builds.

3. Final Answer:

   Use agent { label "${arch == 'arm' ? 'arm-node' : ''}" } inside the matrix -> Option B

4. Quick Check:

   Conditional agent label = Use agent { label "${arch == 'arm' ? 'arm-node' : ''}" } inside the matrix [OK]

Hint: Use conditional label in agent block for selective platforms [OK]

Common Mistakes:

• Setting global agent label affecting all builds
• Skipping arm builds instead of assigning correct agent
• Excluding arm builds instead of targeting agent