[DownloadBuildArtifactsV0] Update to Node 16 using build config gen (#18751)

* Introduce Node16-225 for buildconfig

- Switched config key from Node16-219 to Node16-225
- Added overriddenDirectoryName to set generated directory postfix

* Introduce Node16-225 for buildconfig

- Added deprecation option

* Migrate task

---------

Co-authored-by: Dmitrii Bobreshev (Akvelon INC) <[email protected]>

Author: aleksandrlevochkin

Tasks/DownloadBuildArtifactsV0/_buildConfigs/Node16/FilesOverriddenForConfigGoHereREADME.txt

@@ -0,0 +1 @@
+Place files overridden for this config in this directory

Tasks/DownloadBuildArtifactsV0/_buildConfigs/Node16/package-lock.json

@@ -0,0 +1,30 @@
+{
+  "name": "downloadbuildartifacts",
+  "version": "0.1.0",
+  "description": "Download Build Artifacts Task",
+  "main": "download.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Microsoft/azure-pipelines-tasks.git"
+  },
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Microsoft/azure-pipelines-tasks/issues"
+  },
+  "homepage": "https://github.com/Microsoft/azure-pipelines-tasks#readme",
+  "dependencies": {
+    "@types/mocha": "^5.2.7",
+    "@types/node": "^16.11.39",
+    "artifact-engine": "^1.2.0",
+    "azure-devops-node-api": "^10.2.2",
+    "azure-pipelines-task-lib": "^4.4.0",
+    "decompress-zip": "0.3.3"
+  },
+  "devDependencies": {
+    "typescript": "4.0.2"
+  }
+}

Tasks/DownloadBuildArtifactsV0/_buildConfigs/Node16/package.json

@@ -9,8 +9,8 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 0,
-    "Minor": 225,
-    "Patch": 0
+    "Minor": 226,
+    "Patch": 1
   },
   "groups": [
     {

Tasks/DownloadBuildArtifactsV0/task.json

@@ -0,0 +1,2 @@
+Default|0.226.1
+Node16-225|0.226.0

Tasks/DownloadBuildArtifactsV0/task.loc.json

@@ -0,0 +1,73 @@
+import { IBaseHandlerConfig } from './HandlerConfigs';
+import { handlerCheckDownloadedFiles } from '../download_helper';
+import { ArtifactEngine } from 'artifact-engine/Engine';
+import { IArtifactProvider, ArtifactDownloadTicket } from 'artifact-engine/Models';
+import * as tl from 'azure-pipelines-task-lib/task';
+
+/**
+ * Base class for artifact download handlers
+ */
+export abstract class DownloadHandler {
+    /**
+     * @member {IBaseHandlerConfig} - contains info for generate source and destination providers
+     * @access protected
+     */
+    protected config: IBaseHandlerConfig;
+
+    constructor(handlerConfig: IBaseHandlerConfig) {
+        this.config = handlerConfig;
+    }
+
+    /**
+     * Pure abstract method for getting Source Provider.
+     * Source Provider is an object that contains info about from where we will download the artifact.
+     * @access protected
+     * @returns {IArtifactProvider} Objects that implement the IArtifactProvider interface
+    */
+    protected abstract getSourceProvider(): IArtifactProvider;
+
+    /**
+     * Pure abstract method for getting Destination Provider.
+     * Destination Provider is an object that contains info about where we will download artifacts.
+     * @access protected
+     * @returns {IArtifactProvider} Objects that implement the IArtifactProvider interface
+    */
+    protected abstract getDestinationProvider(): IArtifactProvider;
+
+    /**
+     * Method to download Build Artifact.
+     * Since the logic for downloading builds artifacts is the same for all
+     * types of source and destination providers, we will implement this logic in the base class.
+     * @access public
+     * @returns {Promise<Array<ArtifactDownloadTicket>>} an array of Download Tickets
+    */
+    public async downloadResources(): Promise<Array<ArtifactDownloadTicket>> {
+        const downloader: ArtifactEngine = new ArtifactEngine();
+        const sourceProvider: IArtifactProvider = this.getSourceProvider();
+        const destinationProvider: IArtifactProvider = this.getDestinationProvider();
+
+        const downloadPromise: Promise<Array<ArtifactDownloadTicket>> = new Promise<Array<ArtifactDownloadTicket>>(async (downloadComplete, downloadFailed) => {
+            try {
+                // First attempt to download artifact
+                const downloadTickets: Array<ArtifactDownloadTicket> = await downloader.processItems(sourceProvider, destinationProvider, this.config.downloaderOptions);
+
+                // We will proceed with the files check only if the "Check download files" option enabled
+                if (this.config.checkDownloadedFiles && Array.isArray(downloadTickets)) {
+                    try {
+                        // Launch the files check, if all files are fully downloaded no exceptions will be thrown.
+                        handlerCheckDownloadedFiles(downloadTickets);
+                        downloadComplete(downloadTickets);
+                    } catch (error) {
+                        downloadFailed(error);
+                    }
+                } else {
+                    downloadComplete(downloadTickets);
+                }
+            } catch (error) {
+                downloadFailed(error);
+            }
+        });
+
+        return downloadPromise;
+    }
+}

_generated/DownloadBuildArtifactsV0.versionmap.txt

@@ -0,0 +1,62 @@
+import { DownloadHandler } from './DownloadHandler';
+import { IContainerHandlerConfig } from './HandlerConfigs';
+import { WebProvider, FilesystemProvider } from 'artifact-engine/Providers';
+import * as tl from 'azure-pipelines-task-lib/task';
+
+/**
+ * Handler for download artifact from related container resource.
+ * Build Artifact will be downloaded via `_apis/resources/Containers/` resource.
+ * @extends DownloadHandler
+ * @example
+ * const config: IContainerHandlerConfig = {...};
+ * const downloadHandler: IContainerHandlerConfig = new IContainerHandlerConfig(config);
+ * downloadHandler.downloadResources();
+ */
+export class DownloadHandlerContainer extends DownloadHandler {
+    protected config: IContainerHandlerConfig;
+
+    constructor(handlerConfig: IContainerHandlerConfig) {
+        super(handlerConfig);
+    }
+
+    /**
+     * To download artifact from container resource we will use `WebProvider` as source provider
+     * @access protected
+     * @returns {WebProvider} Configured Web Provider
+    */
+    protected getSourceProvider(): WebProvider {
+        console.log(tl.loc('DownloadingContainerResource', this.config.artifactInfo.resource.data));
+        const containerParts: Array<string> = this.config.artifactInfo.resource.data.split('/');
+
+        if (containerParts.length < 3) {
+            throw new Error(tl.loc('FileContainerInvalidArtifactData'));
+        }
+
+        const containerId: number = parseInt(containerParts[1]);
+        let containerPath: string = containerParts.slice(2, containerParts.length).join('/');
+
+        if (containerPath === '/') {
+            //container REST api oddity. Passing '/' as itemPath downloads the first file instead of returning the meta data about the all the files in the root level.
+            //This happens only if the first item is a file.
+            containerPath = '';
+        }
+
+        const variables = {};
+        const itemsUrl: string = `${this.config.endpointUrl}/_apis/resources/Containers/${containerId}?itemPath=${encodeURIComponent(containerPath)}&isShallow=true&api-version=4.1-preview.4`;
+
+        console.log(tl.loc('DownloadArtifacts', this.config.artifactInfo.name, itemsUrl));
+
+        const provider: WebProvider = new WebProvider(itemsUrl, this.config.templatePath, variables, this.config.handler);
+        return provider;
+    }
+
+    /**
+     * Since we download artifact to local storage we will use a `FilesystemProvider` as destination provider
+     * @access protected
+     * @returns {FilesystemProvider} Configured Filesystem Provider
+    */
+    protected getDestinationProvider(): FilesystemProvider {
+        const provider: FilesystemProvider = new FilesystemProvider(this.config.downloadPath);
+        return provider;
+    }
+}

_generated/DownloadBuildArtifactsV0/DownloadHandlers/DownloadHandler.ts

@@ -0,0 +1,121 @@
+import { DownloadHandler } from './DownloadHandler';
+import { IContainerHandlerZipConfig } from './HandlerConfigs';
+import { FilesystemProvider, ZipProvider } from 'artifact-engine/Providers';
+import * as tl from 'azure-pipelines-task-lib/task';
+import * as path from 'path';
+import * as DecompressZip from 'decompress-zip';
+
+/**
+ * Handler for download artifact via build API
+ * Build Artifact will be downloaded as zip archive via `/_apis/build/builds/` resource.
+ * This handler was designed to work only on windows system.
+ * @extends DownloadHandler
+ * @example
+ * const config: IContainerHandlerZipConfig = {...};
+ * const downloadHandler: DownloadHandlerContainerZip = new DownloadHandlerContainerZip(config);
+ * downloadHandler.downloadResources();
+ */
+export class DownloadHandlerContainerZip extends DownloadHandler {
+    protected config: IContainerHandlerZipConfig;
+    private readonly archiveUrl: string;
+    private readonly zipLocation: string;
+
+    constructor(handlerConfig: IContainerHandlerZipConfig) {
+        super(handlerConfig);
+        this.archiveUrl = `${this.config.endpointUrl}/${this.config.projectId}/_apis/build/builds/${this.config.buildId}/artifacts?artifactName=${encodeURIComponent(this.config.artifactInfo.name)}&$format=zip`;
+        this.zipLocation = path.join(this.config.downloadPath, `${this.config.artifactInfo.name}.zip`);
+    }
+
+    /**
+     * Unpack an archive with an artifact
+     * @param unzipLocation path to the target artifact
+     * @access private
+     * @returns {Promise<void>} promise that will be resolved once the archive will be unpacked
+    */
+    private unzipContainer(unzipLocation: string): Promise<void> {
+        const unZipPromise: Promise<void> = new Promise<void>((resolve, reject) => {
+            if (!tl.exist(this.zipLocation)) {
+                return resolve();
+            }
+
+            tl.debug(`Extracting ${this.zipLocation} to ${unzipLocation}`);
+
+            const unzipper = new DecompressZip(this.zipLocation);
+
+            unzipper.on('error', err => {
+                return reject(tl.loc('ExtractionFailed', err));
+            });
+
+            unzipper.on('extract', log => {
+                tl.debug(`Extracted ${this.zipLocation} to ${unzipLocation} successfully`);
+                return resolve();
+            });
+
+            unzipper.extract({
+                path: unzipLocation
+            });
+
+        });
+
+        return unZipPromise;
+    }
+
+    /**
+     * Get zip provider.
+     * Since we will download archived artifact we will use `ZipProvider` as source provider.
+     * @access protected
+     * @returns {ZipProvider} Configured Zip Provider
+    */
+    protected getSourceProvider(): ZipProvider {
+        console.log(tl.loc('DownloadArtifacts', this.config.artifactInfo.name, this.archiveUrl));
+        const provider: ZipProvider = new ZipProvider(this.archiveUrl, this.config.handler);
+        return provider;
+    }
+
+    /**
+     * Get filesystem provider.
+     * Since we download artifact to local storage we will use a `FilesystemProvider` as destination provider.
+     * @access protected
+     * @returns {FilesystemProvider} Configured Filesystem Provider
+    */
+    protected getDestinationProvider(): FilesystemProvider {
+        const provider: FilesystemProvider = new FilesystemProvider(this.zipLocation);
+        return provider;
+    }
+
+    /**
+     * Download and unpack an archive with an artifact.
+     * @access public
+    */
+    public downloadResources(): Promise<any> {
+        const downloadProcess: Promise<any> = new Promise((resolve, reject) => {
+            tl.debug('Starting downloadZip action');
+
+            if (tl.exist(this.zipLocation)) {
+                tl.rmRF(this.zipLocation);
+            }
+
+            super.downloadResources().then(() => {
+                tl.debug(`Successfully downloaded from ${this.archiveUrl}`);
+
+                this.unzipContainer(this.config.downloadPath).then(() => {
+                    tl.debug(`Successfully extracted ${this.zipLocation}`);
+
+                    if (tl.exist(this.zipLocation)) {
+                        tl.rmRF(this.zipLocation);
+                    }
+
+                    resolve();
+
+                }).catch((error) => {
+                    reject(error);
+                });
+
+            }).catch((error) => {
+                reject(error);
+            });
+        });
+
+        return downloadProcess;
+    }
+}

_generated/DownloadBuildArtifactsV0/DownloadHandlers/DownloadHandlerContainer.ts

@@ -0,0 +1,48 @@
+import { DownloadHandler } from './DownloadHandler';
+import { FilesystemProvider } from 'artifact-engine/Providers';
+import * as tl from 'azure-pipelines-task-lib/task';
+import * as fs from 'fs';
+import * as path from 'path';
+
+/**
+ * Handler for download artifact via local file share
+ * @extends DownloadHandler
+ * @example
+ * const config: IBaseHandlerConfig = {...};
+ * const downloadHandler: DownloadHandlerFilePath = new DownloadHandlerFilePath(config);
+ * downloadHandler.downloadResources();
+ */
+export class DownloadHandlerFilePath extends DownloadHandler {
+    /**
+     * Get source provider with source folder.
+     * Since we will work with local files we use `Filesystem Provider` as source provider.
+     * @access protected
+     * @returns {FilesystemProvider} Configured Filesystem Provider
+     */
+    protected getSourceProvider(): FilesystemProvider {
+        const downloadUrl = this.config.artifactInfo.resource.data;
+        const artifactName = this.config.artifactInfo.name.replace('/', '\\');
+        let artifactLocation = path.join(downloadUrl, artifactName);
+
+        console.log(tl.loc('DownloadArtifacts', artifactName, artifactLocation));
+
+        if (!fs.existsSync(artifactLocation)) {
+            console.log(tl.loc('ArtifactNameDirectoryNotFound', artifactLocation, downloadUrl));
+            artifactLocation = downloadUrl;
+        }
+
+        const provider: FilesystemProvider = new FilesystemProvider(artifactLocation, artifactName);
+        return provider;
+    }
+
+    /**
+     * Get destination provider with destination folder.
+     * Since we will work with local files we use `Filesystem Provider` as source provider.
+     * @access protected
+     * @returns {FilesystemProvider} Configured Filesystem Provider
+     */
+    protected getDestinationProvider(): FilesystemProvider {
+        const provider: FilesystemProvider = new FilesystemProvider(this.config.downloadPath);
+        return provider;
+    }
+}