Set meaning of UseGlobalMono 'auto' to 'never'

dotnet · Aug 18, 2020 · aca41f4 · aca41f4
1 parent 3601445
commit aca41f4
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,7 +14,7 @@
 * Register FixAll commands for disposal ([#3984](https://github.com/OmniSharp/omnisharp-vscode/issues/3984), PR: [#3985](https://github.com/OmniSharp/omnisharp-vscode/pull/3985))
 * Include version matched target files with minimal MSBuild (PR: [omnisharp-roslyn#1895](https://github.com/OmniSharp/omnisharp-roslyn/pull/1895))
 * Fix lack of trailing italics in quickinfo (PR: [omnisharp-roslyn#1894](https://github.com/OmniSharp/omnisharp-roslyn/pull/1894))
-* Start moving omnisharp to directly using Roslyn's completion service (PR: [omnisharp-roslyn#1877](https://github.com/OmniSharp/omnisharp-roslyn/pull/1877))
+* Set meaning of UseGlobalMono "auto" to "never" until Mono updates their MSBuild (PR: [#3998](https://github.com/OmniSharp/omnisharp-vscode/pull/3998))
 
 ## 1.23.0 (August 14, 2020)
 * Fix typo in supressBuildAssetsNotification setting name ([#3941](https://github.com/OmniSharp/omnisharp-vscode/issues/3941), PR: [#3942](https://github.com/OmniSharp/omnisharp-vscode/pull/3942))

diff --git a/README.md b/README.md
@@ -22,14 +22,15 @@ The C# extension is powered by [OmniSharp](https://github.com/OmniSharp/omnishar
 
 ## Note about using .NET Core 3.1.401 or .NET 5 Preview 8 SDKs on Mono platforms
 
-Because of the new minimum MSBuild version requirement of these new SDKs, it will be necessary to use the Mono packaged with the C# extension. You can set "omnisharp.useGlobalMono" to "never" in the VS Code settings to force the use of the included Mono.
+Because of the new minimum MSBuild version requirement of these new SDKs, it will be necessary to use the Mono packaged with the C# extension. The meaning of "omnisharp.useGlobalMono" has change to "never", this forces the use of the included Mono. To use your system
+install of Mono set the value to "always" although it may not be compatible with newer SDKs.
 
 ## What's new in 1.23.1
 -   Register FixAll commands for disposal ([#3984](https://github.com/OmniSharp/omnisharp-vscode/issues/3984), PR: [#3985](https://github.com/OmniSharp/omnisharp-vscode/pull/3985))
 -   Register FixAll commands for disposal ([#3984](https://github.com/OmniSharp/omnisharp-vscode/issues/3984), PR: [#3985](https://github.com/OmniSharp/omnisharp-vscode/pull/3985))
 -   Include version matched target files with minimal MSBuild (PR: [omnisharp-roslyn#1895](https://github.com/OmniSharp/omnisharp-roslyn/pull/1895))
 -   Fix lack of trailing italics in quickinfo (PR: [omnisharp-roslyn#1894](https://github.com/OmniSharp/omnisharp-roslyn/pull/1894))
--   Start moving omnisharp to directly using Roslyn's completion service (PR: [omnisharp-roslyn#1877](https://github.com/OmniSharp/omnisharp-roslyn/pull/1877))
+-   Set meaning of UseGlobalMono "auto" to "never" until Mono updates their MSBuild (PR: [#3998](https://github.com/OmniSharp/omnisharp-vscode/pull/3998))
 
 ## What's new in 1.23.0
 -   Fix typo in supressBuildAssetsNotification setting name ([#3941](https://github.com/OmniSharp/omnisharp-vscode/issues/3941), PR: [#3942](https://github.com/OmniSharp/omnisharp-vscode/pull/3942))

diff --git a/src/omnisharp/OmniSharpMonoResolver.ts b/src/omnisharp/OmniSharpMonoResolver.ts
@@ -45,9 +45,13 @@ export class OmniSharpMonoResolver implements IMonoResolver {
 
             return monoInfo;
         }
-        else if (options.useGlobalMono === "auto" && isValid) {
-            return monoInfo;
-        }
+
+        // While wwaiting for Mono to ship with a MSBuild version 16.7 or higher, we will treat "auto"
+        // as "Use included Mono".
+
+        // else if (options.useGlobalMono === "auto" && isValid) {
+        //     return monoInfo;
+        //}
 
         return undefined;
     }

diff --git a/test/unitTests/omnisharp/OmniSharpMonoResolver.test.ts b/test/unitTests/omnisharp/OmniSharpMonoResolver.test.ts
@@ -23,6 +23,9 @@ suite(`${OmniSharpMonoResolver.name}`, () => {
     const requiredMonoVersion = "6.4.0";
     const higherMonoVersion = "6.6.0";
 
+    // Sets the meaning of UseGlobalMono "auto". When false, "auto" means "never".
+    const autoMeansAlways = false;
+
     const getMono = (version: string) => async (env: NodeJS.ProcessEnv) => {
         getMonoCalled = true;
         environment = env;
@@ -54,7 +57,7 @@ suite(`${OmniSharpMonoResolver.name}`, () => {
         expect(monoInfo).to.be.undefined;
     });
 
-    test(`it returns the path and version if the version is greater than or equal to ${requiredMonoVersion} and getGlobalMonoInfo is always`, async () => {
+    test(`it returns the path and version if the version is greater than or equal to ${requiredMonoVersion} and useGlobalMono is always`, async () => {
         let monoResolver = new OmniSharpMonoResolver(getMono(requiredMonoVersion));
         let monoInfo = await monoResolver.getGlobalMonoInfo({
             ...options,
@@ -66,16 +69,21 @@ suite(`${OmniSharpMonoResolver.name}`, () => {
         expect(monoInfo.path).to.be.equal(monoPath);
     });
 
-    test(`it returns the path and version if the version is greater than or equal to ${requiredMonoVersion} and getGlobalMonoInfo is auto`, async () => {
+    test(`it returns the path and version if the version is greater than or equal to ${requiredMonoVersion} and useGlobalMono is auto`, async () => {
         let monoResolver = new OmniSharpMonoResolver(getMono(higherMonoVersion));
         let monoInfo = await monoResolver.getGlobalMonoInfo({
             ...options,
             useGlobalMono: "auto",
             monoPath: monoPath
         });
 
-        expect(monoInfo.version).to.be.equal(higherMonoVersion);
-        expect(monoInfo.path).to.be.equal(monoPath);
+        if (!autoMeansAlways) {
+            expect(monoInfo).to.be.undefined;
+        }
+        else {
+            expect(monoInfo.version).to.be.equal(higherMonoVersion);
+            expect(monoInfo.path).to.be.equal(monoPath);
+        }
     });
 
     test(`it throws exception if getGlobalMonoInfo is always and version<${requiredMonoVersion}`, async () => {
@@ -96,20 +104,30 @@ suite(`${OmniSharpMonoResolver.name}`, () => {
             monoPath: monoPath
         });
 
-        expect(monoInfo.env["PATH"]).to.contain(join(monoPath, 'bin'));
-        expect(monoInfo.env["MONO_GAC_PREFIX"]).to.be.equal(monoPath);
+        if (!autoMeansAlways) {
+            expect(monoInfo).to.be.undefined;
+        }
+        else {
+            expect(monoInfo.env["PATH"]).to.contain(join(monoPath, 'bin'));
+            expect(monoInfo.env["MONO_GAC_PREFIX"]).to.be.equal(monoPath);
+        }
     });
 
-    test("sets the environment with the monoPath id useGlobalMono is always", async () => {
+    test("sets the environment with the monoPath id useGlobalMono is auto", async () => {
         let monoResolver = new OmniSharpMonoResolver(getMono(requiredMonoVersion));
         let monoInfo = await monoResolver.getGlobalMonoInfo({
             ...options,
             useGlobalMono: "auto",
             monoPath: monoPath
         });
 
-        expect(monoInfo.env["PATH"]).to.contain(join(monoPath, 'bin'));
-        expect(monoInfo.env["MONO_GAC_PREFIX"]).to.be.equal(monoPath);
+        if (!autoMeansAlways) {
+            expect(monoInfo).to.be.undefined;
+        }
+        else {
+            expect(monoInfo.env["PATH"]).to.contain(join(monoPath, 'bin'));
+            expect(monoInfo.env["MONO_GAC_PREFIX"]).to.be.equal(monoPath);
+        }
     });
 
     test("doesn't set the environment with the monoPath if useGlobalMono is never", async () => {