import java.nio.file.Paths import java.nio.file.Path import groovy.json.JsonSlurperClassic abstract class GISJsonSerialised implements Serializable { def script GISJsonSerialised(script) { this.script = script } abstract LinkedHashMap serialisationdata() abstract void deserialiseJson(rawmeta) def saveJsonSerialised(String outputfile, int prettylevel = 4) { def outJson = script.readJSON text: groovy.json.JsonOutput.toJson(serialisationdata()) script.writeJSON(file: outputfile, json: outJson, pretty: prettylevel) } } class ProductInfo extends GISJsonSerialised { String productname String subcomponentname ProductInfo(script, productname = "", subcomponentname = "") { super(script) this.productname = productname this.subcomponentname = subcomponentname } void set(String productname, String subcomponentname) { // Make sure the fields can be used in git tags def int pstatus = 0 if (script.isUnix()) { pstatus = script.sh(script: "git check-ref-format --normalize \"refs/tags/${productname}\" >/dev/null 2>/dev/null", , returnStatus: true) } else { pstatus = script.bat(script: "@git check-ref-format --normalize \"refs/tags/${productname}\" > NUL 2> NUL", , returnStatus: true) } if (pstatus > 0) { script.error("The product name: ${productname} needs to be renamed as it cannot be used in a git tag name") } def int sstatus = 0 if (script.isUnix()) { sstatus = script.sh(script: "git check-ref-format --normalize \"refs/tags/${subcomponentname}\" >/dev/null 2>/dev/null", , returnStatus: true) } else { sstatus = script.bat(script: "@git check-ref-format --normalize \"refs/tags/${subcomponentname}\" > NUL 2> NUL", , returnStatus: true) } if (sstatus > 0) { script.error("The subcomponent name: ${subcomponentname} needs to be renamed as it cannot be used in a git tag name") } this.productname = productname this.subcomponentname = subcomponentname } void deserialiseJson(rawmeta) { productname = rawmeta['productname'] subcomponentname = rawmeta['subcomponentname'] } LinkedHashMap serialisationdata() { def data = [ 'productname' : productname, 'subcomponentname' : subcomponentname, ] return data } } class GitInfo extends GISJsonSerialised { private String sourcepath private String sourcerevision private String gitrevision private String remoteurl private String remoteinfo GitInfo(script, sourcepath = "", sourcerevision = "", gitrevision = "", remoteurl = "", remoteinfo = "") { super(script) this.sourcepath = sourcepath this.sourcerevision = sourcerevision this.gitrevision = gitrevision this.remoteurl = remoteurl this.remoteinfo = remoteinfo } void set(String sourcepath, String sourcerevision, String gitrevision, String remoteurl, String remoteinfo) { this.sourcepath = sourcepath this.sourcerevision = sourcerevision this.gitrevision = gitrevision this.remoteurl = remoteurl this.remoteinfo = remoteinfo } void deserialiseJson(rawmeta) { sourcepath = rawmeta['sourcepath'] sourcerevision = rawmeta['sourcerevision'] gitrevision = rawmeta['gitrevision'] remoteurl = rawmeta['remoteurl'] remoteinfo = rawmeta['remoteinfo'] } LinkedHashMap serialisationdata() { def data = [ 'sourcepath' : sourcepath, 'sourcerevision' : sourcerevision, 'gitrevision' : gitrevision, 'remoteurl' : remoteurl, 'remoteinfo' : remoteinfo, ] return data } } class JenkinsBuildInfo extends GISJsonSerialised { String buildjobname int buildnumber private String buildmachine private String builddate JenkinsBuildInfo(script, String buildjobname = "", int buildnumber = 0, String buildmachine = "", String builddate = "") { super(script) this.buildjobname = buildjobname this.buildnumber = buildnumber this.buildmachine = buildmachine this.builddate = builddate } void set(String buildjobname, int buildnumber, String buildmachine, String builddate) { this.buildjobname = buildjobname this.buildnumber = buildnumber this.buildmachine = buildmachine this.builddate = builddate } void deserialiseJson(rawmeta) { buildjobname = rawmeta['buildjobname'] buildnumber = rawmeta['buildnumber'] buildmachine = rawmeta['buildmachine'] builddate = rawmeta['builddate'] } LinkedHashMap serialisationdata() { def data = [ 'buildjobname' : buildjobname, 'buildnumber' : buildnumber, 'buildmachine' : buildmachine, 'builddate' : builddate, ] return data } } class BuildStampInfo extends GISJsonSerialised { String buildstampprefix int revision String buildstamp BuildStampInfo(script, buildstampprefix = "0.30000.0.", revision = 0, buildstamp = "0.30000.0.0") { super(script) this.buildstampprefix = buildstampprefix this.revision = revision this.buildstamp = buildstamp } void set(String buildstampprefix, int revision, String buildstamp) { this.buildstampprefix = buildstampprefix this.revision = revision this.buildstamp = buildstamp } String buildstampcommasep() { def String buildstampcommasep = buildstamp.replace(".", ",") return buildstampcommasep } void changerevision(int newrevision) { script.echo("Build stamp currently ${buildstamp}") revision = newrevision def List buildstampsplit = buildstamp.split('\\.') buildstampsplit[-1] = newrevision.toString() buildstamp = buildstampsplit.join('.') script.echo("Build stamp now ${buildstamp}") } void set(String buildstampprefix, int revision) { buildstampprefix += buildstampprefix.endsWith('.') ? '' : '.' this.buildstampprefix = buildstampprefix this.buildstamp = buildstampprefix + "0" changerevision(revision) } void set(String buildstampprefix, String revision) { set(buildstampprefix, revision.toInteger()) } void deserialiseJson(rawmeta) { buildstampprefix = rawmeta['buildstampprefix'] revision = rawmeta['revision'] buildstamp = rawmeta['buildstamp'] } LinkedHashMap serialisationdata() { def data = [ 'buildstampprefix' : buildstampprefix, 'revision' : revision, 'buildstamp' : buildstamp, ] return data } } class ReleaseInfo extends GISJsonSerialised { String releaserepoURL ArrayList releaseitems boolean released ReleaseInfo(script, String releaserepoURL = "", boolean released = false) { super(script) this.releaserepoURL = releaserepoURL this.releaseitems = new ArrayList() this.released = released } void set(String releaserepoURL = "") { this.releaserepoURL = releaserepoURL } void addReleaseItem(String releaseitem) { script.echo("Adding release item: ${releaseitem} to release items") releaseitems.add(releaseitem) } void markreleased() { this.released = true } List releaseitemssserialised() { def items = [] for (ri in releaseitems) { items.add(ri) } return items } void deserialiseJson(rawmeta) { releaserepoURL = rawmeta['releaserepoURL'] releaseitems = new ArrayList() for (rawreleaseitem in rawmeta['releaseitems']) { releaseitems.add(rawreleaseitem) } released = rawmeta['released'] ?: false } LinkedHashMap serialisationdata() { def data = [ 'releaserepoURL' : releaserepoURL, 'releaseitems' : releaseitemssserialised(), 'released' : released ] return data } } class ConfigurationInfo extends GISJsonSerialised { private String configurationname private String configurationURL private String configurationversion private String configurationSHA ConfigurationInfo(script, configurationname = "", configurationURL = "", configurationversion = "", configurationSHA = "") { super(script) this.configurationname = configurationname this.configurationURL = configurationURL this.configurationversion = configurationversion this.configurationSHA = configurationSHA } void deserialiseJson(rawmeta) { configurationname = rawmeta['configurationname'] configurationURL = rawmeta['configurationURL'] configurationversion = rawmeta['configurationversion'] configurationSHA = rawmeta['configurationSHA'] } LinkedHashMap serialisationdata() { def data = [ 'configurationname' : configurationname, 'configurationURL' : configurationURL, 'configurationversion' : configurationversion, 'configurationSHA' : configurationSHA, ] return data } } class ChecksumPair extends GISJsonSerialised { private String filepath private String sum ChecksumPair(script, String filepath = "", String sum = "") { super(script) this.filepath = filepath this.sum = sum } void deserialiseJson(rawmeta) { filepath = rawmeta['filepath'] sum = rawmeta['sum'] } LinkedHashMap serialisationdata() { def data = [ 'filepath' : filepath, 'sum' : sum, ] return data } } class ChecksumSet extends GISJsonSerialised { private String artifactpath private ArrayList checksumpairs ChecksumSet(script, artifactpath = "") { super(script) this.artifactpath = artifactpath checksumpairs = new ArrayList() } ChecksumPair addChecksumPair(String filepath, String sum) { def cp = new ChecksumPair(script, filepath, sum) checksumpairs.add(cp) return cp } List checksumpairsserialised() { def associated = [] for (cp in checksumpairs) { associated.add(cp.serialisationdata()) } return associated } void deserialiseJson(rawmeta) { artifactpath = rawmeta['artifactpath'] checksumpairs = new ArrayList() for (rawchecksumpair in rawmeta['checksumpairs']) { def csp = new ChecksumPair(script) csp.deserialiseJson(rawchecksumpair) checksumpairs.add(csp) } } LinkedHashMap serialisationdata() { def data = [ 'artifactpath' : artifactpath, 'checksumpairs' : checksumpairsserialised(), ] return data } } class ChecksumInfo extends GISJsonSerialised { private ArrayList checksumsets ChecksumInfo(script) { super(script) checksumsets = new ArrayList() } ChecksumSet addChecksumSet(String artifactpath) { def cs = new ChecksumSet(script, artifactpath) checksumsets.add(cs) return cs } List checksumsetsserialised() { def associated = [] for (cs in checksumsets) { associated.add(cs.serialisationdata()) } return associated } void deserialiseJson(rawmeta) { checksumsets = new ArrayList() for (rawchecksumset in rawmeta['checksumsets']) { def cs = new ChecksumSet(script) cs.deserialiseJson(rawchecksumset) checksumsets.add(cs) } } LinkedHashMap serialisationdata() { def data = [ 'checksumsets' : checksumsetsserialised(), ] return data } } class PublishableInfo extends GISJsonSerialised { private String filepath PublishableInfo(script, String filepath = "") { super(script) this.filepath = filepath } void deserialiseJson(rawmeta) { filepath = rawmeta['filepath'] } LinkedHashMap serialisationdata() { def data = [ 'filepath' : filepath, ] return data } } class MetaInfo extends GISJsonSerialised { private static String FORMAT = "0.1" private static String METAFOLDERNAME = "meta" private static String METAFILENAME = "info.json" private static String METAARTIFACTS = "${METAFOLDERNAME}/**" class RelatedMetaInfo extends GISJsonSerialised { String offsetpath MetaInfo meta RelatedMetaInfo(script, offsetpath = "", MetaInfo meta = null) { super(script) this.offsetpath = offsetpath this.meta = meta } void deserialiseJson(rawmeta) { offsetpath = rawmeta['offsetpath'] meta = new MetaInfo(script) meta.deserialiseJson(rawmeta['meta']) } LinkedHashMap serialisationdata() { def data = [ 'offsetpath' : offsetpath, 'meta' : meta.serialisationdata(), ] return data } } private String format = FORMAT ProductInfo productinfo GitInfo gitinfo JenkinsBuildInfo jenkinsbuildinfo BuildStampInfo buildstampinfo ReleaseInfo releaseinfo ChecksumInfo checksuminfo private ArrayList configurationinfo private ArrayList publishableinfo private LinkedHashMap custominfo private ArrayList associatedmeta MetaInfo(script) { super(script) productinfo = new ProductInfo(script) gitinfo = new GitInfo(script) jenkinsbuildinfo = new JenkinsBuildInfo(script) buildstampinfo = new BuildStampInfo(script) releaseinfo = new ReleaseInfo(script) checksuminfo = new ChecksumInfo(script) configurationinfo = new ArrayList() publishableinfo = new ArrayList() custominfo = new LinkedHashMap() associatedmeta = new ArrayList() } List getassociated() { return associatedmeta } void markreleased() { script.echo("Marking product: ${productinfo.productname} component: ${productinfo.subcomponentname} as released") releaseinfo.markreleased() for (associated in associatedmeta) { associated.meta.releaseinfo.markreleased() } } List configurationinfoserialised() { def configuration = [] for (configurationitem in configurationinfo) { configuration.add(configurationitem.serialisationdata()) } return configuration } void addPublishable(String filepath) { def PublishableInfo pi = new PublishableInfo(script, filepath) script.echo("Adding ${filepath} to publishable list") publishableinfo.add(pi) } void addConfigurationInfo(String configurationname, String configurationURL, String configurationversion, String configurationSHA) { def ConfigurationInfo ci = new ConfigurationInfo(script, configurationname, configurationURL, configurationversion, configurationSHA) script.echo("Adding configuration info: name: ${configurationname} url: ${configurationURL} version: ${configurationversion} sha: ${configurationSHA}") configurationinfo.add(ci) } void addCustomInfo(String customId, String customValue) { custominfo.put(customId.trim(), customValue) } String getCustomInfo(String customId) { return custominfo.getAt(customId.trim()) } List publishableinfoserialised() { def publishable = [] for (publishableitem in publishableinfo) { publishable.add(publishableitem.serialisationdata()) } return publishable } List associatedmetaserialised() { def associated = [] for (metaitem in associatedmeta) { associated.add(metaitem.serialisationdata()) } return associated } void deserialiseJson(rawmeta) { if (rawmeta['format'] != FORMAT) { script.error("Unsupported meta format found at ${filepath}") return } productinfo.deserialiseJson(rawmeta['productinfo']) gitinfo.deserialiseJson(rawmeta['gitinfo']) jenkinsbuildinfo.deserialiseJson(rawmeta['jenkinsbuildinfo']) buildstampinfo.deserialiseJson(rawmeta['buildstampinfo']) releaseinfo.deserialiseJson(rawmeta['releaseinfo']) checksuminfo.deserialiseJson(rawmeta['checksuminfo']) for (rawconfig in rawmeta['configuration']) { def cf = new ConfigurationInfo(script) cf.deserialiseJson(rawconfig) configurationinfo.add(cf) } for (rawpublishable in rawmeta['publishableinfo']) { def pb = new PublishableInfo(script) pb.deserialiseJson(rawpublishable) publishableinfo.add(pb) } custominfo = rawmeta['custominfo'] for (rawrelatedmeta in rawmeta['associatedmeta']) { def rm = new RelatedMetaInfo(script) rm.deserialiseJson(rawrelatedmeta) associatedmeta.add(rm) } } def deserialiseJson(String filepath) { script.echo("Deserialising JSON at file: ${filepath}") def rawmeta = script.readJSON(file: filepath) deserialiseJson(rawmeta) } def deserialiseJsonSlurper(String filepath) { File jsonfile = new File(filepath) def jsonfiletext = jsonfile.getText() def rawmeta = new JsonSlurperClassic().parseText(jsonfiletext) deserialiseJson(rawmeta) } String relativize(String mypath) { String pathRelative script.echo("Seeing if ${mypath} begins with ${script.WORKSPACE}") if (mypath.startsWith(script.WORKSPACE)) { pathRelative = mypath.minus(script.WORKSPACE) script.echo("Extracted ${pathRelative} from ${script.WORKSPACE} and ${mypath}") } else { pathRelative = mypath script.echo("Path relative is unchanged: ${pathRelative}") } // Convert \ with / pathRelative = pathRelative.tokenize('\\').join('/') // Strip leading / if any pathRelative = pathRelative.replaceAll('^/+', '') script.echo("Path relative is ${pathRelative}") return pathRelative } static String metafilepath() { return METAFOLDERNAME + "/" + METAFILENAME } MetaInfo importrelated(boolean appendtoparentmeta, String destpath, String givenRepo = 'Unknown', String givenRevision = 'Unknown', String givenSHA = 'Unknown') { MetaInfo mi = new MetaInfo(script) def String adjustedpath = relativize(destpath) def importedmetafile = adjustedpath + "/" + metafilepath() if (script.fileExists(importedmetafile)) { mi.deserialiseJson(importedmetafile) } else { script.echo("Could not deserialise meta at file: ${importedmetafile} (destpath: ${destpath})- Does not exist") mi.addConfigurationInfo('', givenRepo, givenRevision, givenSHA) } RelatedMetaInfo rmi = new RelatedMetaInfo(script, adjustedpath, mi) if (appendtoparentmeta) { associatedmeta.add(rmi) } return mi } LinkedHashMap serialisationdata() { def data = [ 'format' : format, 'productinfo' : productinfo.serialisationdata(), 'gitinfo' : gitinfo.serialisationdata(), 'jenkinsbuildinfo' : jenkinsbuildinfo.serialisationdata(), 'buildstampinfo' : buildstampinfo.serialisationdata(), 'releaseinfo' : releaseinfo.serialisationdata(), 'configuration' : configurationinfoserialised(), 'checksuminfo' : checksuminfo.serialisationdata(), 'publishableinfo' : publishableinfoserialised(), 'custominfo' : custominfo, 'associatedmeta' : associatedmetaserialised(), ] return data } static String folder() { return METAFOLDERNAME } String generateartifacts(ArrayList releasedfromhere = new ArrayList(), // These items are recorded in meta as released from here ArrayList releasedfromsubmeta = new ArrayList(), // These items are not recorded in meta as released from here String metafilepath ="${METAFOLDERNAME}/${METAFILENAME}" ) { def String artifactlist = METAARTIFACTS releaseinfo.addReleaseItem(METAARTIFACTS) for (releaseitem in releasedfromhere) { artifactlist += "," + releaseitem releaseinfo.addReleaseItem(releaseitem) } for (releaseitem in releasedfromsubmeta) { artifactlist += "," + releaseitem } saveJsonSerialised(metafilepath) return artifactlist } // Recurse tree of meta looking for release info and accumulate path - Pass by reference unavailable in Groovy/Java private ArrayList releasewalkerp(int maxdepth, ArrayList releasemetacollection, String pathsofar) { if (maxdepth > 0) { if (releaseinfo.releaserepoURL) { RelatedMetaInfo rmi = new RelatedMetaInfo(script, pathsofar, this) releasemetacollection.add(rmi) } if (pathsofar) { pathsofar += "/" } for (relatedmetainfo in associatedmeta) { MetaInfo othermeta = relatedmetainfo.meta String newpathsofar = pathsofar + relatedmetainfo.offsetpath releasemetacollection = othermeta.releasewalkerp(maxdepth - 1, releasemetacollection, newpathsofar) } } return releasemetacollection } ArrayList releasewalker(int maxdepth, String startpath = "") { ArrayList releasemetacollection = new ArrayList() releasemetacollection = releasewalkerp(maxdepth, releasemetacollection, startpath) return releasemetacollection } String componentidentifier() { return productinfo.productname + "_" + productinfo.subcomponentname } String componentversionuniqueidentifier() { return componentidentifier() + "_" + buildstampinfo.buildstamp } String globalreleasetag() { return componentversionuniqueidentifier() + "_" + jenkinsbuildinfo.buildnumber } String releasetag() { return buildstampinfo.buildstamp + "_" + jenkinsbuildinfo.buildnumber } String releasetagfordebpackage() { return buildstampinfo.buildstamp + "-" + jenkinsbuildinfo.buildnumber } Map putwithshortestoffsetpath(Map releasemetacollection, String uniquestring, RelatedMetaInfo relatedmetainfo) { if (releasemetacollection.containsKey(uniquestring)) { def existingentry = releasemetacollection[uniquestring] if (existingentry.offsetpath.size() > relatedmetainfo.offsetpath.size()) { releasemetacollection.put(uniquestring, relatedmetainfo) } } else { releasemetacollection.put(uniquestring, relatedmetainfo) } return releasemetacollection } Map releasewalkerunique(int maxdepth, String startpath = "") { def ArrayList releasemetacollection = new ArrayList() releasemetacollection = releasewalkerp(maxdepth, releasemetacollection, startpath) def Map releasemetauniquecollection = new LinkedHashMap() for (relatedmetainfo in releasemetacollection) { def String uniquestring = relatedmetainfo.meta.componentidentifier() releasemetauniquecollection = putwithshortestoffsetpath(releasemetauniquecollection, uniquestring, relatedmetainfo) } return releasemetauniquecollection } Map releasewalkerversionunique(int maxdepth, String startpath = "") { ArrayList releasemetacollection = new ArrayList() releasemetacollection = releasewalkerp(maxdepth, releasemetacollection, startpath) def Map releasemetaversionuniquecollection = new LinkedHashMap() for (relatedmetainfo in releasemetacollection) { def String uniquestring = relatedmetainfo.meta.componentversionuniqueidentifier() releasemetaversionuniquecollection = putwithshortestoffsetpath(releasemetaversionuniquecollection, uniquestring, relatedmetainfo) } return releasemetaversionuniquecollection } MetaInfo getNewMetaObject(script) { return new MetaInfo(script) } } MetaInfo metareset(script) { echo "Resetting meta folder" def mi = new MetaInfo(script) dir(mi.folder()) { deleteDir() } return mi } MetaInfo metafromfolder(String folder = "") { MetaInfo buildmeta = new MetaInfo(this) buildmeta.deserialiseJson("${folder}/${MetaInfo.metafilepath()}") return buildmeta } MetaInfo metafromfolderSlurper(String folder = "") { MetaInfo buildmeta = new MetaInfo(this) buildmeta.deserialiseJsonSlurper("${folder}/${MetaInfo.metafilepath()}") return buildmeta } return this;