CBS script enhancements to manage packages lifecycle and ability to fetch external dependencies

Pipeline/PackageBuildOutputs/ArtifactRepositoryHelpers.groovy

@@ -44,6 +44,7 @@ def <T> CompletableFuture<HttpResponse<T>>
 
 run(args)
 
+// public methods
 def upload(String url, String fileName, String user, String password, boolean verbose, String httpClientVersion) throws IOException {
 	System.setProperty("jdk.httpclient.allowRestrictedHeaders", "Connection")
     println( "** ArtifactRepositoryHelper started for upload of $fileName to $url" );
@@ -66,15 +67,15 @@ def upload(String url, String fileName, String user, String password, boolean ve
 //  }
 
     HttpClient httpClient = httpClientBuilder.build();
-    
+
     // build http request
     HttpRequest.Builder httpRequestBuilder = HttpRequest.newBuilder()
     .uri(URI.create("$url"))
     .header("Content-Type", "binary/octet-stream")
 	.header("Connection","Keep-Alive")
     .PUT(BodyPublishers.ofFile(Paths.get(fileName)));
 
-    // set http client version if set
+	// set http client version if set
     if (httpClientVersion) {
         def httpVer = HttpClient.Version.valueOf(httpClientVersion)
         if (httpVer) {
@@ -90,9 +91,10 @@ def upload(String url, String fileName, String user, String password, boolean ve
 
 	HttpResponse.BodyHandler<String> handler = HttpResponse.BodyHandlers.ofString();
     // submit request
+
 	CompletableFuture<HttpResponse<String>> response = httpClient.sendAsync(request, handler).thenComposeAsync(r -> tryResend(httpClient, request, handler, 1, r));
 	HttpResponse finalResponse = response.get()
-    
+
     if (verbose)
 		println("** Response: " + finalResponse);
 
@@ -104,6 +106,7 @@ def upload(String url, String fileName, String user, String password, boolean ve
     else {
         println("*! Upload failed.");
     }
+	return rc
 }
 
 def download(String url, String fileName, String user, String password, boolean verbose) throws IOException  {
@@ -154,8 +157,18 @@ def download(String url, String fileName, String user, String password, boolean
     } else {
         println("*! Download failed.");
     }
+
+	return rc
+}
+
+// Method directly accessed by PackageBuildOutputs and Common Backend script functionality
+def computeArchiveUrl(Properties props) {
+	def String remotePath = (props.versionName) ? (props.versionName + "/" + props.tarFileName) : (props.tarFileLabel + "/" + props.tarFileName)
+	def url = new URI(props.get('artifactRepository.url') + "/" + props.get('artifactRepository.repo') + "/" + (props.get('artifactRepository.directory') ? "${props.get('artifactRepository.directory')}/" : "") + remotePath).normalize().toString() // Normalized URL
+	return url
 }
 
+// private methods
 def evaluateHttpResponse (HttpResponse response, String action, boolean verbose) {
     int rc = 0
     def statusCode = response.statusCode()
@@ -173,29 +186,76 @@ def evaluateHttpResponse (HttpResponse response, String action, boolean verbose)
 //Parsing the command line
 def run(String[] cliArgs) {
     def cli = new CliBuilder(usage: "ArtifactRepositoryHelpers.groovy [options]", header: '', stopAtNonOption: false)
+	def Properties props = new Properties()
     cli.h(longOpt:'help', 'Prints this message')
-    cli.u(longOpt:'url', args:1, required:true, 'Artifactory file uri location')
+    cli.u(longOpt:'url', args:1,'Absolute artifact repository url location to store package')
     cli.fU(longOpt:'fileToUpload', args:1, 'The full path of the file to upload')
     cli.fD(longOpt:'fileToDownload', args:1, 'The full path of the file to download')
-    cli.U(longOpt:'user', args:1, required:true, 'Artifactory user id')
-    cli.P(longOpt:'password', args:1, required:true, 'Artifactory password')
+    cli.U(longOpt:'user', args:1,'Artifact repository user id or token')
+    cli.P(longOpt:'password', args:1, 'Artifact repository password')
 	cli.ht(longOpt:'httpClientVersion', args:1, 'HTTP Client protocol version')
     cli.v(longOpt:'verbose', 'Flag to turn on script trace')
+
+	// recompute options
+	// Compute Flag to recompute url
+
+    cli.c(longOpt:'computeArchiveUrl', 'Action Flag to identify to recompute the uri of a given package')
+	cli.t(longOpt:'tarFileName', args:1, argName:'filename', 'Name of the package tar file. (Optional unless using --buildReportOrder or --buildReportOrderFile)')
+	cli.aRU(longOpt:'artifactRepositoryUrl', args:1, 'Artifact repository url')
+	cli.aRN(longOpt:'artifactRepositoryName', args:1, 'Artifact repository name')
+	cli.aRD(longOpt:'artifactRepositoryDirectory', args:1, 'Artifact repository directory')
+	cli.aVN(longOpt:'versionName', args:1, argName:'versionName', 'Name of the version/package folder on the Artifact repository server.')
+
     def opts = cli.parse(cliArgs)
 
     // if opt parsing fails, exit
     if (opts == null || !opts) {
         System.exit(1)
     }
+
+	if (opts.c) props.computeArchiveUrl = true
+	if (opts.t) props.tarFileName = opts.t
+	if (opts.aRU) props.put('artifactRepository.url', opts.aRU)
+	if (opts.aRN) props.put('artifactRepository.repo', opts.aRN)
+	if (opts.aRD) props.put('artifactRepository.directory', opts.aRD)
+	if (opts.aVN) props.versionName = opts.aVN
+
+
 
     if (opts.h) {
         cli.usage()
         System.exit(0)
     }
 
     if ( opts.fU) {
+		// assert required CLI options for upload
+		assert opts.u : "Missing option: Absolute artifact repository url location to store package"
+		assert opts.U : "Missing option: Artifact repository user id or token"
+		assert opts.P : "Missing option: Artifactory password"
         upload(opts.u, opts.fU, opts.U, opts.P, opts.v)
-    } else {
+    } else if (opts.fD) {
+		// assert required CLI options for download
+		assert opts.u : "Missing option: Absolute artifact repository url location to store package"
+		assert opts.U : "Missing option: Artifact repository user id or token"
+		assert opts.P : "Missing option: Artifactory password"
         download(opts.u, opts.fD, opts.U, opts.P, opts.v)
-    }
-}
+    } else if (props.computeArchiveUrl){
+
+		// invoke processing
+		if (props.computeArchiveUrl && props.computeArchiveUrl.toBoolean()) {
+			// check requires cli arguments for this operation
+			assert props.tarFileName : "Missing option tarFileName (--tarFileName)"
+			assert props.versionName : "Missing option versionName (--versionName)"
+			assert props.get('artifactRepository.url') : "Missing option artifactRepository.url (--artifactRepositoryUrl)"
+			assert props.get('artifactRepository.repo'): "Missing option artifactRepository.repo (--artifactRepositoryName)"
+			assert props.get('artifactRepository.directory'): "Missing option artifactRepository.directory (--artifactRepositoryDirectory)"
+
+			// load script	
+			archiveUrl = computeArchiveUrl(props)
+			// the println is used in a script by the CBS to grep the url
+			println "url=$archiveUrl"
+		} else 		
+		println("** No action has been specified for the ArtifactoryHelpers (available action triggers 'fileToUpload' or 'fileToDownload' or 'computeArchiveUrl') ");
+	}
+}
+