UseDotNetV2: Support global.json files with comments (#19226)

* support global json

* reverted task-utility-common version

* updated _generated files

Author: v-mohithgc

Tasks/UseDotNetV2/Tests/L0.ts

@@ -531,6 +531,14 @@ describe('UseDotNet', function () {
             assert(tr.succeeded == true, ("Should passed."));
             assert(tr.stdout.indexOf("GlobalJsonIsEmpty") > -1, "should throw an error that no file was found.");
         }, tr, done);
-    })
-});
-
+    });
+    it("[globaljsonfetcher] run shouldn't fail if the global.json has comments.", (done) => {
+        process.env["__case__"] = "globalJsonWithComments";
+        let tr = new ttm.MockTestRunner(path.join(__dirname, "globaljsonfetcherTest.js"))
+        tr.run();
+        runValidations(() => {
+            assert(tr.succeeded == true, ("Should have passed."));
+            assert(tr.stdout.indexOf("GlobalJsonFound") > -1, "should found a global.json file");
+        }, tr, done);
+    });
+});

Tasks/UseDotNetV2/Tests/globaljsonfetcherTest.ts

@@ -15,6 +15,8 @@ const validSubDirGlobalJson = workingSubDir + "global.json";
 const subDirVersionNumber = "3.0.0-pre285754637";
 const pathToEmptyGlobalJsonDir = workingDir + "empty/";
 const pathToEmptyGlobalJson = pathToEmptyGlobalJsonDir + "global.json";
+const pathToGlobalJsonWithCommentsDir = workingDir + "comments/";
+const pathToGlobalJsonWithComments = pathToGlobalJsonWithCommentsDir + "global.json";
 
 //setup mocks
 mockery.enable({
@@ -38,6 +40,9 @@ mockery.registerMock('azure-pipelines-task-lib/task', {
         if (path == pathToEmptyGlobalJsonDir) {
             return [pathToEmptyGlobalJson];
         }
+        if (path == pathToGlobalJsonWithCommentsDir) {
+            return [pathToGlobalJsonWithComments];
+        }
         return [];
     },
     loc: function (locString, ...param: string[]) { return tl.loc(locString, param); },
@@ -58,6 +63,17 @@ mockery.registerMock('fs', {
         if (path == pathToEmptyGlobalJson) {
             return Buffer.from("");
         }
+        if (path == pathToGlobalJsonWithComments) {
+            return Buffer.from(`{
+                /*
+                  This is a mult-line comment
+                */
+                "sdk": {
+                    // This is a single-line comment
+                    "version": "${rootVersionNumber}"
+                }
+            }`);
+        }
         return Buffer.from(null);
     }
 });
@@ -133,4 +149,18 @@ if (process.env["__case__"] == "emptyGlobalJson") {
     }, err => {
         throw "GetVersions shouldn't throw an error if global.json is empty.";
     });
+}
+
+if (process.env["__case__"] == "globalJsonWithComments") {
+    let fetcher = new globalJsonFetcher(pathToGlobalJsonWithCommentsDir);
+    fetcher.GetVersions().then(versionInfos => {
+        if (versionInfos == null) {
+            throw "GetVersions shouldn't return null if the global.json has comments.";
+        }
+        if (versionInfos.length != 1) {
+            throw "GetVersions shouldn't return a arry with 0 elements if global.json has comments.";
+        }
+    }, err => {
+        throw "GetVersions shouldn't throw an error if global.json has comments.";
+    });
 }

Tasks/UseDotNetV2/globaljsonfetcher.ts

@@ -1,6 +1,7 @@
 "use strict";
 import * as fileSystem from "fs";
 import * as tl from 'azure-pipelines-task-lib/task';
+import * as JSON5 from 'json5';
 import { DotNetCoreVersionFetcher } from "./versionfetcher";
 import { VersionInfo } from "./models";
 
@@ -63,7 +64,7 @@ export class globalJsonFetcher {
                 return null;
             }
 
-            globalJson = (JSON.parse(fileContent.toString())) as { sdk: { version: string } };
+            globalJson = (JSON5.parse(fileContent.toString())) as { sdk: { version: string } };
         } catch (error) {
             // we throw if the global.json is invalid
             throw tl.loc("FailedToReadGlobalJson", path, error); // We don't throw if a global.json is invalid.

Tasks/UseDotNetV2/package-lock.json

@@ -28,9 +28,10 @@
     "@types/node": "^16.11.39",
     "@types/semver": "6.0.0",
     "azure-pipelines-task-lib": "^4.4.0",
-    "azure-pipelines-tasks-packaging-common": "^2.198.1",
+    "azure-pipelines-tasks-packaging-common": "^3.230.0",
     "azure-pipelines-tasks-utility-common": "^3.198.1",
-    "azure-pipelines-tool-lib": "^2.0.4",
+    "azure-pipelines-tool-lib": "^2.0.7",
+    "json5": "^2.2.3",
     "semver": "6.3.0",
     "typed-rest-client": "^1.8.9"
   },

Tasks/UseDotNetV2/package.json

@@ -13,8 +13,8 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 2,
-    "Minor": 230,
-    "Patch": 2
+    "Minor": 231,
+    "Patch": 0
   },
   "satisfies": [
     "DotNetCore"

Tasks/UseDotNetV2/task.json

@@ -13,8 +13,8 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 2,
-    "Minor": 230,
-    "Patch": 2
+    "Minor": 231,
+    "Patch": 0
   },
   "satisfies": [
     "DotNetCore"

Tasks/UseDotNetV2/task.loc.json

@@ -1,2 +1,2 @@
-Default|2.230.2
-Node20_229_3|2.230.4
+Default|2.231.0
+Node20_229_3|2.231.1