Jenkins pipeline files for building OpenJDK

Eclipse Adoptium makes use of these scripts to build binaries on the build farm at https://ci.adoptopenjdk.net

Repository contents

This repository contains several useful scripts in order to build OpenJDK personally or at build farm scale.

The docs folder contains images and utility scripts to produce up to date documentation.
The pipelines folder contains the Groovy pipeline scripts for Jenkins (e.g. build | test | checksum | release).
The tools folder contains pipelines/ analysis scripts that deliever success/failure trends and build scripts for code-tool dependancies for the build and test process (e.g. asmtools | jcov | jtharness | jtreg | sigtest).

Configuration Files

The pipelines/jobs/configurations directory contains two categories of configuration files that our jenkins pipelines use (Nicknamed #Build Configs and #Nightly Configs for short).

To ensure both configurations are not overridden in a race condition scenario by another job, the job generators ensure they remain in the sync with the repository.

Generally, any new parameters/configurations that effect the jenkins environment directly should be implemented here. If this is not the case, it would likely be better placed in openjdk-build/platform-specific-configurations (for OS or make-adopt-build-farm.sh specific use cases) or openjdk-build/build.sh (for anyone, including end users and jenkins pipelines).

Build

The build config files are the ones that follow the format jdkxx(u)_pipeline_config.groovy with xx being the version number and an optional u if the Java source code is pulled from an update repository. Each is a groovy class with a single Map<String, Map<String, ?>> property containing node labels, tests and other jenkins parameters/constants that are crucial for allowing different parts of the build pipeline to mesh together.

Each architecture/platform has it's own entry similar to the one below (for JDK8 x64 mac builds). The pipelines use the parent map key (e.g. x64Mac) to retrieve the data. See #Data Fields for the currently available fields you can utilise.

x64Mac        : [
    os                   : 'mac',
    arch                 : 'x64',
    additionalNodeLabels : [
            hotspot  : 'macos10.14',
            corretto : 'build-macstadium-macos1010-1',
            openj9   : 'macos10.14'
    ],
    test                 : 'default'
]

Data fields

NOTE: When the type field implies a map, the String key of the inner map is the variant for that field. E.g:

                additionalNodeLabels : [
                        hotspot : 'xlc13&&aix710',
                        openj9 :  'xlc13&&aix715'
                ],

Name	Required?	Type	Description
os	✅	`String`	Operating system tag that will identify the job on jenkins and determine which platforms configs to pull from openjdk-build. E.g. `windows`, `solaris`
arch	✅	`String`	Architecture tag that will identify the job on jenkins and determine which build params to use. E.g. `x64`, `sparcv9`, `x86-32`
test	❌	`String` OR `Map<String, List>` OR `Map<String, List or Map<String, List>>`	Case one: Tests to run against the binary after the build has completed. A `default` tag indicates that you want to run whatever the default test nightly/release list is. Case two: You can also specify your own list for that particular platform (not variant). Case three: Or you can even specify the list for that particular platform per variant. The list could be specific one `sanity.openjdk` or `default` (similar to the first case) or a map per nightly or release (similar to case two).
testDynamic	❌	`Boolean` OR `Map<String, ?>`	PARALLEL=Dynamic parameter setting. False : no Parallel. Or you can set the parameters with or without variant.
dockerImage	❌	`String` OR `Map<String, String>`	Builds the JDK inside a docker container. Should be a DockerHub identifier to pull from in case dockerFile is not specified. E.g. `adoptopenjdk/centos6_build_image`
dockerFile	❌	`String` OR `Map<String, String>`	Builds the JDK inside a docker container using the locally stored image file. Used in conjunction with dockerImage to specify a particular variant to build or pull. E.g. `pipelines/build/dockerFiles/cuda.dockerfile`
dockerNode	❌	`String` OR `Map<String, String>`	Specifies a specific jenkins docker node label to shift into to build the JDK. E.g. `sw.config.uid1000`
dockerRegistry	❌	`String` OR `Map<String, String>`	Used for Docker login when pulling dockerImage from a custom Docker registry. Used in conjunction with dockerImage. Default (blank) will be DockerHub. Must also use dockerCredential.
dockerCredential	❌	`String` OR `Map<String, String>`	Used for Docker login when pulling a dockerImage. Value is the Jenkins credential ID for the username and password of the dockerRegistry. Used in conjunction with dockerImage. Can use with custom dockerRegistry or default DockerHub. Must use this if using a non-default registry.
additionalNodeLabels	❌	`String` OR `Map<String, String>`	Appended to the default constructed jenkins node label (often used to lock variants or build configs to specific machines). Jenkins will additionally search for a node with this tag as well as the default node label. E.g. `build-macstadium-macos1010-1`, `macos10.14`
additionalTestLabels	❌	`String` OR `Map<String, String>`	Used by aqa-tests to lock specific tests to specific machine nodes (in the same manner as additionalNodeLabels) E.g. `!(centos6\|\|rhel6)`, `dragonwell`
configureArgs	❌	`String` OR `Map<String, String>`	Configuration arguments that will ultimately be passed to OpenJDK's `./configure` E.g. `--enable-unlimited-crypto --with-jvm-variants=server --with-zlib=system`
buildArgs	❌	`String` OR `Map<String, String>`	Build arguments that will ultimately be passed to openjdk-build's ./makejdk-any-platform.sh script E.g. `--enable-unlimited-crypto --with-jvm-variants=server --with-zlib=system`
additionalFileNameTag	❌	`String`	Commonly used when building large heap versions of the binary, this tag will also be included in the jenkins job name and binary file name. Include this parameter if you have an "extra" variant that requires a different tagname E.g. `linuxXL`
crossCompile	❌	`String` OR `Map<String, String>`	Used when building on a cross compiled system, informing jenkins to treat it differently when retrieving the version and producing the binary. This value is also used to create the jenkins node label alongside the arch (similarly to additionalNodeLabels) E.g. `x64`
bootJDK	❌	`String`	JDK version number to specify to openjdk-build's `make-adopt-build-farm.sh` script, informing it to utilise a predefined location of a boot jdk E.g. `8`, `11`
platformSpecificConfigPath	❌	`String`	openjdk-build repository path to pull the operating system configurations from inside openjdk-build's set-platform-specific-configurations.sh. Do not include the repo name or branch as this is prepended automatically. E.g. `pipelines/TestLocation/platform-specific-configurations`
codebuild	❌	`Boolean`	Setting this field will tell jenkins to spin up an Azure or AWS cloud machine, allowing the build to retrieve a machine not normally available on the Jenkins server. It does this by appending a `codebuild` flag to the jenkins label.
cleanWorkspaceAfterBuild	❌	`Boolean`	Setting this field will tell jenkins to clean down the workspace after the build has completed. Particularly useful for AIX where disk space can be limited.

Nightly

The nightly config files are the ones that follow the format jdkxx(u).groovy with xx being the version number and an optional u if the Java source code is pulled from an update repository. Each is a simple groovy script that's contents can be loaded in and accessed by another script.

targetConfigurations

A single Map<String, Map<String, String>> variable containing what platforms and variants will be run in the nightly builds and releases (by default, this can be altered in jenkins parameters before executing a user build). If you are creating your own nightly config, you will need to ensure the key values of the upper map are the same as the key values in the corresponding build config file.

targetConfigurations = [
        "x64Mac"        : [
                "hotspot",
                "openj9"
        ],
        "x64Linux"      : [
                "hotspot",
                "openj9",
                "corretto",
                "dragonwell"
        ],
        "x32Windows"    : [
                "hotspot",
                "openj9"
        ],
        "x64Windows"    : [
                "hotspot",
                "openj9",
                "dragonwell"
        ],
        "ppc64Aix"      : [
                "hotspot",
                "openj9"
        ],
        "ppc64leLinux"  : [
                "hotspot",
                "openj9"
        ],
        "s390xLinux"    : [
                "hotspot",
                "openj9"
        ],
        "aarch64Linux"  : [
                "hotspot",
                "openj9",
                "dragonwell"
        ],
        "arm32Linux"  : [
                "hotspot"
        ],
        "sparcv9Solaris": [
                "hotspot"
        ]
]

disableJob

If this is present, the jenkins generators will still create the top-level pipeline and downstream jobs but will set them as disabled.

disableJob = true

triggerSchedule_nightly / triggerSchedule_weekly

Cron expression that defines when (and how often) nightly and weekly builds will be executed

triggerSchedule_nightly="TZ=UTC\n05 18 * * 1,3,5"
triggerSchedule_weekly="TZ=UTC\n05 12 * * 6"

weekly_release_scmReferences

Source control references (e.g. tags) to use in the weekly release builds

weekly_release_scmReferences = [
        "hotspot"        : "jdk8u282-b07",
        "openj9"         : "v0.24.0-release",
        "corretto"       : "",
        "dragonwell"     : ""
]

Metadata

Alongside the built assets a metadata file will be created with info about the build. This will be a JSON document of the form:

{
    "vendor": "Eclipse Foundation",
    "os": "mac",
    "arch": "x64",
    "variant": "openj9",
    "variant_version": {
        "major": "0",
        "minor": "22",
        "security": "0",
        "tags": "m2"
    },
    "version": {
        "minor": 0,
        "security": 0,
        "pre": null,
        "adopt_build_number": 0,
        "major": 15,
        "version": "15+29-202007070926",
        "semver": "15.0.0+29.0.202007070926",
        "build": 29,
        "opt": "202007070926"
    },
    "scmRef": "<output of git describe OR buildConfig.SCM_REF>",
    "buildRef": "<build-repo-name/build-commit-sha>",
    "version_data": "jdk15",
    "binary_type": "debugimage",
    "sha256": "<shasum>",
    "full_version_output": "<output of java --version>",
    "configure_arguments": "<output of bash configure>"
}

The Metadata class is contained in the Metadata.groovy file and the Json is constructed and written in the openjdk_build_pipeline.groovy file.

It is worth noting the additional tags on the semver is the adopt build number.

Below are all of the keys contained in the metadata file and some example values that can be present.

vendor: Example values: [Temurin, Alibaba]

This tag is used to identify the vendor of the JDK being built, this value is set in the build.sh file and defaults to "Temurin".

os: Example values: [windows, mac, linux, aix, solaris]

This tag identifies the operating system the JDK has been built on (and should be used on).

arch: Example values: [aarch64, ppc64, s390x, x64, x86-32, arm]

This tag identifies the architecture the JDK has been built on and it intended to run on.

variant: Example values: [hotspot, openj9, corretto, dragonwell]

This tag identifies the JVM being used by the JDK, "dragonwell" itself is not a JVM but is currently considered a variant in its own right.

variant_version:

This tag is used to identify a version number of the variant being built, it currently is exclusively used by OpenJ9 and has the following keys:

major: Example values: [0, 1]
minor: Example values: [22, 23, 24]
security: Example values: [0, 1]
tags: Example values: [m1, m2]

version:

This tag contains the full version information of the JDK built, it uses the VersionInfo.groovy class and the ParseVersion.groovy class.

It contains the following keys:

minor: Example values: [0]
security: Example Values: [0, 9, 252 272]
pre: Example values: [null]
adopt_build_number: Example values: [0] If the ADOPT_BUILD_NUMBER parameter is used to build te JDK that value will appear here, otherwise a default value of 0 appears.
major: Example values: [8, 11, 15, 16]
version: Example values: [1.8.0_272-202010111709-b09, 11.0.9+10-202010122348, 14.0.2+11-202007272039, 16+19-202010120348]
semver: Example values: [8.0.202+8.0.202008210941, 11.0.9+10.0.202010122348, 14.0.2+11.0.202007272039, 16.0.0+19.0.202010120339] Formed from the major, minor, security, and build number by the formSemver() function.
build: Example values: [6, 9, 18] The OpenJDK build number for the JDK being built.
opt: Example values: [202008210941, 202010120348, 202007272039]

scmRef: Example values: [dragonwell-8.4.4_jdk8u262-b10, jdk-16+19_adopt-61198-g59e3baa94ac, jdk-11.0.9+10_adopt-197-g11f44f68c5, 23f997ca1]

A reference the the base JDK repository being build, usually including a Github commit reference, i.e. jdk-16+19_adopt-61198-g59e3baa94ac links to https://github.com/adoptium/jdk/commit/59e3baa94ac via the commit SHA 59e3baa94ac.

Values that only contain a commit reference such as 23f997ca1 are OpenJ9 commits on their respective JDK repositories, for example 23f997ca1 links to the commit https://github.com/ibmruntimes/openj9-openjdk-jdk14/commit/23f997ca1.

buildRef: Example values: [openjdk-build/fe0f2dba, openjdk-build/f412a523] A reference to the build tools repository used to create the JDK, uses the format repository-name/commit-SHA.

version_data: Example values: [jdk8u, jdk11u, jdk14u, jdk]

binary_type: Example values: [jdk, jre, debugimage, testimage]

sha256: Example values: [20278aa9459e7636f6237e85fcd68deec1f42fa90c6c541a2dfa127f4156d3e2, 2f9700bd75a807614d6d525fbd8d016c609a9ea71bf1ffd5d4839f3c1c8e4b8e] A SHA to verify the contents of the JDK.

full_version_output: Example values:

openjdk version \"1.8.0_252\"\nOpenJDK Runtime Environment (Alibaba Dragonwell 8.4.4) (build 1.8.0_252-202010111720-b06)\nOpenJDK 64-Bit Server VM (Alibaba Dragonwell 8.4.4) (build 25.252-b06, mixed mode)\n`

The full output of the command java -version for the JDK.

configure_arguments: The full output generated by configure.sh for the JDK built.

Build status

Table generated with generateBuildMatrix.sh

Platform	Java 8	Java 11	Java 15	Java 16	Java HEAD
aix-ppc64-hotspot
aix-ppc64-openj9
freebsd-x64-hotspot
jdk-aix-ppc64-hotspot
jdk-aix-ppc64-openj9
jdk-alpine-linux-x64-hotspot
jdk-linux-aarch64-hotspot
jdk-linux-aarch64-openj9
jdk-linux-aarch64-openj9-linuxXL
jdk-linux-arm-hotspot
jdk-linux-ppc64le-hotspot
jdk-linux-ppc64le-openj9
jdk-linux-ppc64le-openj9-linuxXL
jdk-linux-s390x-hotspot
jdk-linux-s390x-openj9
jdk-linux-s390x-openj9-linuxXL
jdk-linux-x64-hotspot
jdk-linux-x64-openj9
jdk-linux-x64-openj9-linuxXL
jdk-mac-x64-hotspot
jdk-mac-x64-openj9
jdk-mac-x64-openj9-macosXL
jdk-windows-aarch64-hotspot
jdk-windows-x64-hotspot
jdk-windows-x64-openj9
jdk-windows-x64-openj9-windowsXL
jdk-windows-x86-32-hotspot
linux-aarch64-dragonwell
linux-aarch64-hotspot
linux-aarch64-openj9
linux-aarch64-openj9-linuxXL
linux-arm-hotspot
linux-ppc64le-hotspot
linux-ppc64le-openj9
linux-ppc64le-openj9-linuxXL
linux-riscv64-bisheng
linux-riscv64-openj9
linux-s390x-hotspot
linux-s390x-openj9
linux-s390x-openj9-linuxXL
linux-x64-corretto
linux-x64-dragonwell
linux-x64-hotspot
linux-x64-hotspot-linuxXL
linux-x64-openj9
linux-x64-openj9-linuxXL
mac-x64-corretto
mac-x64-hotspot
mac-x64-openj9
mac-x64-openj9-macosXL
solaris-sparcv9-hotspot
solaris-x64-hotspot
windows-x64-dragonwell
windows-x64-hotspot
windows-x64-openj9
windows-x64-openj9-windowsXL
windows-x86-32-hotspot
windows-x86-32-openj9

Name		Name	Last commit message	Last commit date
Latest commit History 2,135 Commits
.github		.github
docs		docs
pipelines		pipelines
tools		tools
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
FAQ.md		FAQ.md
LICENSE		LICENSE
NOTICE		NOTICE
README.md		README.md
SECURITY.md		SECURITY.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Jenkins pipeline files for building OpenJDK

Repository contents

Configuration Files

Build

Data fields

Nightly

targetConfigurations

disableJob

triggerSchedule_nightly / triggerSchedule_weekly

weekly_release_scmReferences

Metadata

Build status

About

Releases

Packages

Languages

License

AdamBrousseau/ci-jenkins-pipelines

Folders and files

Latest commit

History

Repository files navigation

Jenkins pipeline files for building OpenJDK

Repository contents

Configuration Files

Build

Data fields

Nightly

targetConfigurations

disableJob

triggerSchedule_nightly / triggerSchedule_weekly

weekly_release_scmReferences

Metadata

Build status

About

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages