firmware_tools/autobuild/Common_scripts/packaging/jsclient.groovy
2023-01-08 14:01:08 +00:00

265 lines
12 KiB
Groovy

pipeline {
agent { label AGENT_LABEL }
stages {
stage('Initial setup') {
steps {
script {
if (env.RELEASE_REPO_VARIANT_SUFFIX) {
meta = load("${WORKSPACE}/autobuild/Common_scripts/autobuilder.groovy").startbuild(
this,
PRODUCT_NAME,
SUBCOMPONENT_NAME,
RELEASE_REPO,
RELEASE_REPO_VARIANT_SUFFIX
)
} else {
meta = load("${WORKSPACE}/autobuild/Common_scripts/autobuilder.groovy").startbuild(
this,
PRODUCT_NAME,
SUBCOMPONENT_NAME,
RELEASE_REPO
)
}
}
}
}
stage('Checkout dependencies') {
steps {
script {
configurationhelper = autobuilder.configurationhelper()
importer = load("${autobuilder.commonscripts()}/import/importer.groovy")
}
}
}
stage('Checkout source') {
steps {
script {
ESWDIR = 'esw'
SOURCEREVISION = SOURCE_REVISION.trim()
SOURCENAME = 'embedded software'
configurationhelper.gitCheckoutAndRegister(meta, SOURCENAME, SOURCE_REPO, SOURCEREVISION, ESWDIR, '', 0, false)
COREDIR = 'core'
CORESOURCEREVISION = CORE_SOURCE_REVISION.trim()
CORESOURCENAME = 'core software'
configurationhelper.gitCheckoutAndRegister(meta, CORESOURCENAME, CORE_SOURCE_REPO, CORESOURCEREVISION, COREDIR, '', 0, false)
}
}
}
stage('Clean exports') {
steps {
script {
env.EXPORT = 'devjsclient'
cleanfolders = [
EXPORT,
]
cleaner = load("${autobuilder.commonscripts()}/clean/clean.groovy")
cleaner.clean(cleanfolders)
}
}
}
stage('Generating version info') {
steps {
script {
version = load("${autobuilder.commonscripts()}/versionnumbering/generate.groovy")
version.generate(meta, SOURCE_REVISION, ESWDIR)
}
}
}
stage('Version stamp files') {
steps {
script {
convertdetails = [
// File to convert Pattern to replace New string
]
versionnumbering = load("${autobuilder.commonscripts()}/versionnumbering/do.groovy")
versionnumbering.stamp(convertdetails)
}
}
}
stage('Build package') {
steps {
script {
def absexportpath = "${WORKSPACE}/${EXPORT}"
plainzipname = 'export.zip'
if (env.RELEASE_REPO_VARIANT_SUFFIX) {
jsclientzipname = "${PRODUCT_NAME}_${RELEASE_REPO_VARIANT_SUFFIX}_${meta.buildstampinfo.buildstamp}_${plainzipname}"
} else {
jsclientzipname = "${PRODUCT_NAME}_${meta.buildstampinfo.buildstamp}_${plainzipname}"
}
// This is required to deal with cases such as HMB-FD-HV-SG600/SG1024
combined_auto_json_file = "${WORKSPACE}/${ESWDIR}/HAL_Generator/combined_auto.json"
if (env.RELEASE_REPO_VARIANT_SUFFIX) {
combined_auto_json_file = "${WORKSPACE}/${ESWDIR}/HAL_Generator/${RELEASE_REPO_VARIANT_SUFFIX}/combined_auto.json"
}
// Another special case? This value is set in DHB-KM-XI (at least) for historical reasons.
// else if (env.PRINTHEAD_SOFTWARE_VARIANT) {
// combined_auto_json_file = "${WORKSPACE}/${ESWDIR}/HAL_Generator/${PRINTHEAD_SOFTWARE_VARIANT}/combined_auto.json"
// }
// Some jiggery pokers to manufacture devjsclient folder for distribution.
if (isUnix()) {
def DEVJSDIR = "${WORKSPACE}/${ESWDIR}/devjsclient"
sh """
#!bin/bash --verbose
# Preserve the contents of devjsclient so that unmodified products are unaffected.
# Recreate the folder so that we can populate it from the source folders.
if [ -d "${WORKSPACE}/${ESWDIR}/devjsclient" ]
then
echo "INF: Moving existing devjsclient folder to devjsclient_org"
mv ${WORKSPACE}/${ESWDIR}/devjsclient ${WORKSPACE}/${ESWDIR}/devjsclient_org
else
echo "INF: No existing devjsclient folder to preserve"
fi
mkdir ${WORKSPACE}/${ESWDIR}/devjsclient
# Copy in the common Javascript and related files which live in the core repo.
if [ -d "${WORKSPACE}/${COREDIR}/client/javascript" ]
then
echo "INF: Copying core javascript files to devjsclient"
cp -r ${WORKSPACE}/${COREDIR}/client/javascript/* ${WORKSPACE}/${ESWDIR}/devjsclient
else
echo "ERR: Core javascript files don't exist!!!"
fi
# Copy over the product-specific Javascript and related files. This may overwrite
# some or all of the core files, as well as adding new ones.
if [ -d "${WORKSPACE}/${ESWDIR}/client/javascript" ]
then
echo "INF: Copying product-specific javascript files over devjsclient"
cp -r ${WORKSPACE}/${ESWDIR}/client/javascript/* ${WORKSPACE}/${ESWDIR}/devjsclient
else
echo "INF: No product-specific javascript files to copy over devjsclient"
fi
# Create (or overwrite) registers.js in the JS folder using the FPGA register definitions
# from the product repository. We also copy combined_auto.json (elsewhere) into the product
# distribution to go on the board, so dumptruck can download it.
echo "fpga_registers =" > ${DEVJSDIR}/registers.js
if [ -e ${combined_auto_json_file} ]
then
cat ${combined_auto_json_file} >> ${DEVJSDIR}/registers.js
else
# Fall back to default if variant subfolder does not exist (e.g. AHB-KM1024a).
cat ${WORKSPACE}/${ESWDIR}/HAL_Generator/combined_auto.json >> ${DEVJSDIR}/registers.js
fi
echo ";" >> ${DEVJSDIR}/registers.js
# Restore the original devjsclient files, if it existed. This may overwrite some or all of the
# files from the previous steps. This included so the script will work for both
# modified and unmodified product repos. We can gradually trim out files which
# are duplicates of those in core, and also move files at some point to
# product/client/javascript
if [ -d "${WORKSPACE}/${ESWDIR}/devjsclient_org" ]
then
echo "INF: Copying original devjsclient files over recreated devjsclient"
cp -r ${WORKSPACE}/${ESWDIR}/devjsclient_org/* ${WORKSPACE}/${ESWDIR}/devjsclient
fi
"""
}
else {
bat """
echo "Cannot be built on windows at the moment"
exit 1
"""
}
dir(ESWDIR) {
if (isUnix()) {
sh """#!/bin/bash -v
mkdir "${absexportpath}"
if [ \$? -ne 0 ]; then exit 1; fi
zip -r "${absexportpath}/${plainzipname}" -P "${ZIP_PASSWORD}" devjsclient
if [ \$? -ne 0 ]; then exit 1; fi
zip -r "${absexportpath}/${jsclientzipname}" -P "${ZIP_PASSWORD}" devjsclient
if [ \$? -ne 0 ]; then exit 1; fi
"""
}
else {
bat """
echo "Cannot be built on windows at the moment"
exit 1
"""
}
}
dir(EXPORT) {
if (isUnix()) {
sh """#!/bin/bash -v
md5sum "${plainzipname}" > "${absexportpath}/${plainzipname}.md5"
if [ \$? -ne 0 ]; then exit 1; fi
sha256sum "${plainzipname}" > "${absexportpath}/${plainzipname}.sha256"
if [ \$? -ne 0 ]; then exit 1; fi
md5sum "${jsclientzipname}" > "${absexportpath}/${jsclientzipname}.md5"
if [ \$? -ne 0 ]; then exit 1; fi
sha256sum "${jsclientzipname}" > "${absexportpath}/${jsclientzipname}.sha256"
if [ \$? -ne 0 ]; then exit 1; fi
"""
}
else {
bat """
echo "Cannot be built on windows at the moment"
exit 1
"""
}
}
}
}
}
stage('Checksum artifacts') {
steps {
script {
def checksummable = [
"${EXPORT}/${plainzipname}",
"${EXPORT}/${plainzipname}.zip.md5",
"${EXPORT}/${plainzipname}.zip.sha256",
"${EXPORT}/${jsclientzipname}",
"${EXPORT}/${jsclientzipname}.zip.md5",
"${EXPORT}/${jsclientzipname}.zip.sha256",
]
checksumutils = load("${autobuilder.commonscripts()}/checksum/utils.groovy")
checksumutils.generatelist(meta, checksummable)
}
}
}
stage('Classifying publishable artifacts') {
steps {
script {
def publishable = [
"${EXPORT}/**"
]
publishutils = load("${autobuilder.commonscripts()}/publishing/utils.groovy")
publishutils.generatelist(meta, publishable)
}
}
}
stage('Archiving artifacts') {
steps {
script {
def artifacts = [
"${EXPORT}/**"
]
def artifactlist = meta.generateartifacts(artifacts)
artifactarchiver = load("${autobuilder.commonscripts()}/artifacts/archiver.groovy")
artifactarchiver.archive(meta, artifactlist)
}
}
}
}
post {
always {
echo 'Post-build'
}
failure {
echo 'Failed build'
}
unstable {
echo 'Unstable build'
}
success {
echo 'Succeeded build'
}
}
}