more URL support and using newer cloc by default:

be able to use file protocol as a download url, or a file path
using cloc 1.82 by default

Author: jkanczler

DETAILS.md

@@ -45,14 +45,24 @@ By default the cloc CLI is running in the root of the repository, you can modify
 
 ![Working folder is the path, where the cloc CLI will run](https://raw.githubusercontent.com/Dealogic/cloc-vsts-extension/master/screenshots/WorkingFolder.png)
 
-By default the cloc CLI is downloaded from the url: `https://github.com/AlDanial/cloc/releases/download/1.80/cloc-1.80.exe`:
+By default the cloc CLI is downloaded from the url: `https://github.com/AlDanial/cloc/releases/download/1.82/cloc-1.82.exe`:
 
 ![The download URL of the cloc-cli tool](https://raw.githubusercontent.com/Dealogic/cloc-vsts-extension/master/screenshots/ClocCliDownloadURL.png)
 
+But now file shares and local files are supported to such as:
+```
+file://my-file-share/public/software/cloc-1.82.exe
+```
+or
+```
+./cloc.1.82.exe
+```
+
 ## <a id="release-notes"></a>Release Notes
 
-* 1.2.0 (18/06/2019)
+* 1.2.1 (19/06/2019)
     * New build/deployment badge on README page. (as build and deployment are on travis-ci.org)
+    * File URLs are supported such as `file://my-file-share/public/software/cloc-1.82.exe` or local file path as `./cloc.1.82.exe`
 * 1.1.2 (13/12/2018)
     * Display name of the task will be used as title for the summary on build summary page
     * Option to modify the cloc-cli download URL

README.md

@@ -45,14 +45,24 @@ By default the cloc CLI is running in the root of the repository, you can modify
 
 ![Working folder is the path, where the cloc CLI will run](https://raw.githubusercontent.com/Dealogic/cloc-vsts-extension/master/screenshots/WorkingFolder.png)
 
-By default the cloc CLI is downloaded from the url: `https://github.com/AlDanial/cloc/releases/download/1.80/cloc-1.80.exe`:
+By default the cloc CLI is downloaded from the url: `https://github.com/AlDanial/cloc/releases/download/1.82/cloc-1.82.exe`:
 
 ![The download URL of the cloc-cli tool](https://raw.githubusercontent.com/Dealogic/cloc-vsts-extension/master/screenshots/ClocCliDownloadURL.png)
 
+But now file shares and local files are supported to such as:
+```
+file://my-file-share/public/software/cloc-1.82.exe
+```
+or
+```
+./cloc.1.82.exe
+```
+
 ## <a id="release-notes"></a>Release Notes
 
-* 1.2.0 (18/06/2019)
+* 1.2.1 (19/06/2019)
     * New build/deployment badge on README page. (as build and deployment are on travis-ci.org)
+    * File URLs are supported such as `file://my-file-share/public/software/cloc-1.82.exe` or local file path as `./cloc.1.82.exe`
 * 1.1.2 (13/12/2018)
     * Display name of the task will be used as title for the summary on build summary page
     * Option to modify the cloc-cli download URL

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloc-vsts-extension",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "cloc Visual Studio Team System (VTST) extension",
   "main": "index.js",
   "scripts": {

tasks/cloc-build-task/clocCliDownloader.ts

@@ -1,21 +1,34 @@
-import * as https from "https";
-import * as http from "http";
 import * as fs from "fs";
+import * as download from "download";
+import * as url from "url";
 
-const downloadClocCli = (clocExeDownloadUrl: string, downloadFinishedCallback: () => void) => {
-    const clocExeFilename = "cloc.exe";
-    const clocExeFile = fs.createWriteStream(clocExeFilename);
+const downloadClocCli = (clocExeDownloadUrl: string, downloadFinishedCallback: (error?: Error) => void) => {
+    try {
+        const clocExeFilename = "cloc.exe";
+        const downloadUrl = url.parse(clocExeDownloadUrl);
 
-    console.log(`Downloading cloc.exe from '${clocExeDownloadUrl}'`);
-    https.get(clocExeDownloadUrl, (clocExeDownloadResponse: http.IncomingMessage) => {
-        https.get(clocExeDownloadResponse.headers["location"].toString(), (redirectionResponse: http.IncomingMessage) => {
-            const stream = redirectionResponse.pipe(clocExeFile);
-            stream.on("close", () => {
-                console.log(`Download is completed.`);
-                downloadFinishedCallback();
-            });
-        });
-    });
+        console.log(`Downloading cloc.exe from:`);
+        console.log(downloadUrl);
+
+        switch (downloadUrl.protocol) {
+            case "file:":
+                const downloadPath = url.fileURLToPath ? url.fileURLToPath(downloadUrl.href) : downloadUrl.href.slice(5);
+
+                console.log(`Copying file from '${downloadPath}'`);
+                fs.copyFile(downloadPath, clocExeFilename, (err) => downloadFinishedCallback(err));
+                break;
+            case "http:":
+            case "https:":
+                download(downloadUrl.href).then((data) => fs.writeFile(clocExeFilename, data, (err) => downloadFinishedCallback(err)));
+                break;
+            default:
+                console.log(`Copying file from '${downloadUrl.href}'`);
+                fs.copyFile(downloadUrl.href, clocExeFilename, (err) => downloadFinishedCallback(err));
+                break;
+        }
+    } catch (err) {
+        downloadFinishedCallback(err);
+    }
 };
 
 export default downloadClocCli;

tasks/cloc-build-task/index.ts

@@ -31,7 +31,11 @@ async function run(): Promise<void> {
     try {
         downloadClocCli(
             clocCliDownloadUrl,
-            () => {
+            (error) => {
+                if (error) {
+                    throw error;
+                }
+
                 executeClocCli(taskDisplayName, clocCliArguments);
             });
     } catch (err) {

tasks/cloc-build-task/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloc-build-task",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "cloc Visual Studio Team System (VTST) extension",
   "main": "index.js",
   "scripts": {},
@@ -12,7 +12,10 @@
   "author": "Dealogic",
   "license": "MIT",
   "dependencies": {
-    "azure-pipelines-task-lib": "2.7.7"
+    "azure-pipelines-task-lib": "2.7.7",
+    "download": "7.1.0"
   },
-  "devDependencies": {}
+  "devDependencies": {
+    "@types/download": "6.2.4"
+  }
 }

tasks/cloc-build-task/task.json

@@ -17,7 +17,7 @@
     "version": {
         "Major": 1,
         "Minor": 2,
-        "Patch": 0
+        "Patch": 1
     },
     "minimumAgentVersion": "1.95.0",
     "groups": [
@@ -42,7 +42,7 @@
             "name": "clocCliDownloadUrl",
             "type": "string",
             "label": "Download url of cloc-cli",
-            "defaultValue": "https://github.com/AlDanial/cloc/releases/download/1.80/cloc-1.80.exe",
+            "defaultValue": "https://github.com/AlDanial/cloc/releases/download/1.82/cloc-1.82.exe",
             "required": true,
             "helpMarkDown": "Download URL of cloc-cli. Default value: https://github.com/AlDanial/cloc/releases/download/1.80/cloc-1.80.exe",
             "groupName": "advanced"

tasks/cloc-build-task/tests/mockRunnerDefinitions/shared/testTaskRunner.ts

@@ -16,7 +16,7 @@ const runTestTask = (testRunConfiguration: ITestRunConfiguration) => {
     }
 
     if (!testRunConfiguration.clocCliDownloadUrl) {
-        testRunConfiguration.clocCliDownloadUrl = "https://github.com/AlDanial/cloc/releases/download/1.80/cloc-1.80.exe";
+        testRunConfiguration.clocCliDownloadUrl = "https://github.com/AlDanial/cloc/releases/download/1.82/cloc-1.82.exe";
     }
 
     if (!testRunConfiguration.clocCliArguments) {

tasks/cloc-build-task/tests/mockRunnerDefinitions/shouldProduceClocResultMdFile.ts renamed to tasks/cloc-build-task/tests/mockRunnerDefinitions/shouldWorkWithHttpDownload.ts

@@ -0,0 +1,5 @@
+import runTestTask from "./shared/testTaskRunner";
+
+runTestTask({
+    clocCliDownloadUrl: "./cloc-1.82.exe"
+});

tasks/cloc-build-task/tests/mockRunnerDefinitions/shouldWorkWithLocalCloc.ts

@@ -10,7 +10,7 @@ export function executeTest(done: MochaDone): void {
     // tslint:disable-next-line:no-invalid-this
     this.timeout(30000);
 
-    const testPath = path.join(__dirname, mockRunnerDefinitions, "shouldProduceClocResultMdFile.js");
+    const testPath = path.join(__dirname, mockRunnerDefinitions, "shouldWorkWithHttpDownload.js");
     const testRunner = new MockTestRunner(testPath);
 
     testRunner.run();

tasks/cloc-build-task/tests/shouldProduceClocResultMdFile.ts renamed to tasks/cloc-build-task/tests/shouldWorkWithHttpDownload.ts

@@ -0,0 +1,28 @@
+import * as path from "path";
+import { MockTestRunner } from "azure-pipelines-task-lib/mock-test";
+import { assert } from "chai";
+import * as fs from "fs";
+import * as os from "os";
+
+const mockRunnerDefinitions = "mockRunnerDefinitions";
+
+export function executeTest(done: MochaDone): void {
+    // tslint:disable-next-line:no-invalid-this
+    this.timeout(30000);
+
+    const testPath = path.join(__dirname, mockRunnerDefinitions, "shouldWorkWithLocalCloc.js");
+    const testRunner = new MockTestRunner(testPath);
+
+    testRunner.run();
+
+    const testRunnerOutput = `${os.EOL}Test Runner output:${os.EOL}${testRunner.stdout}`;
+
+    assert.isTrue(fs.existsSync("tests/cloc.result.md"), testRunnerOutput);
+    const clocResultMdFileContent = fs.readFileSync("tests/cloc.result.md", {
+        encoding: "utf8"
+    });
+
+    assert.include(clocResultMdFileContent, "SUM:|2|0|1|2", testRunnerOutput);
+
+    done();
+}

tasks/cloc-build-task/tests/shouldWorkWithLocalCloc.ts

@@ -1,8 +1,9 @@
 import * as fs from "fs";
-import * as shouldProduceClocResultMdFile from "./shouldProduceClocResultMdFile";
+import * as shouldWorkWithHttpDownload from "./shouldWorkWithHttpDownload";
+import * as shouldWorkWithLocalCloc from "./shouldWorkWithLocalCloc";
 
 describe("cloc build task", () => {
-    after((done: MochaDone) => {
+    afterEach((done: MochaDone) => {
         const filesToDelete = [
             "tests/cloc.exe",
             "tests/cloc.result.md"
@@ -18,6 +19,10 @@ describe("cloc build task", () => {
     });
 
     it(
-        "should produce cloc.result.md file",
-        shouldProduceClocResultMdFile.executeTest);
+        "should work with http download url",
+        shouldWorkWithHttpDownload.executeTest);
+
+    it(
+        "should work with local file download url",
+        shouldWorkWithLocalCloc.executeTest);
 });