Skip to content

Commit

Permalink
SLVS-1710 Fix clang-cl compiler path
Browse files Browse the repository at this point in the history 
we add a new fallback way to get the compiler path correctly.
This fixes the `clang-cl` support, which is currently broken because the
`ClCompilerPath` property we rely on evaluates to `/clang-cl.exe`.
The new fallback method searches in the `ExecutablePath` path list for
the `ClToolExe` executable, which gives the correct answer in the case
of `clang-cl.exe`

Co-authored-by: Georgii Borovinskikh <georgii.borovinskikh@sonarsource.com>
Co-authored-by: Michael Jabbour <117195239+michael-jabbour-sonarsource@users.noreply.github.com>
  • Loading branch information
@mostafa-mohammed-sonarsource @georgii-borovinskikh-sonarsource @michael-jabbour-sonarsource
3 people authored Dec 18, 2024
1 parent 044fcb8 commit ae3904b
Show file tree
Hide file tree
Showing 4 changed files with 236 additions and 30 deletions.
14 changes: 13 additions & 1 deletion src/Integration.Vsix.UnitTests/CFamily/VcxProject/FileConfigProviderTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
using SonarLint.VisualStudio.Infrastructure.VS;
using SonarLint.VisualStudio.Integration.Vsix.CFamily.VcxProject;
using static SonarLint.VisualStudio.Integration.Vsix.CFamily.UnitTests.CFamilyTestUtility;
using System.IO.Abstractions;
using SonarLint.VisualStudio.Core.SystemAbstractions;

namespace SonarLint.VisualStudio.Integration.UnitTests.CFamily.VcxProject
{
Expand All @@ -40,11 +42,21 @@ public class FileConfigProviderTests
private DTE2 dte;
private IVsUIServiceOperation uiServiceOperation;
private FileConfigProvider testSubject;
private const string ClFilePath = "C:\\path\\cl.exe";

private static IFileSystemService CreateFileSystemWithExistingFile(string fullPath)
{
var fileSystem = Substitute.For<IFileSystemService>();
fileSystem.File.Exists(fullPath).Returns(true);
return fileSystem;
}
private static IFileSystemService CreateFileSystemWithClCompiler() => CreateFileSystemWithExistingFile(ClFilePath);

[TestMethod]
public void MefCtor_CheckIsExported() =>
MefTestHelpers.CheckTypeCanBeImported<FileConfigProvider, IFileConfigProvider>(
MefTestHelpers.CreateExport<IFileInSolutionIndicator>(),
MefTestHelpers.CreateExport<IFileSystemService>(),
MefTestHelpers.CreateExport<ILogger>(),
MefTestHelpers.CreateExport<IThreadHandling>(),
MefTestHelpers.CreateExport<IVsUIServiceOperation>());
Expand All @@ -60,7 +72,7 @@ public void TestInitialize()
dte = Substitute.For<DTE2>();
uiServiceOperation = CreateDefaultUiServiceOperation(dte);

testSubject = new FileConfigProvider(uiServiceOperation, fileInSolutionIndicator, logger, new NoOpThreadHandler());
testSubject = new FileConfigProvider(uiServiceOperation, fileInSolutionIndicator, CreateFileSystemWithClCompiler(), logger, new NoOpThreadHandler());
}

private static IFileInSolutionIndicator CreateDefaultFileInSolutionIndicator()
Expand Down
138 changes: 122 additions & 16 deletions src/Integration.Vsix.UnitTests/CFamily/VcxProject/FileConfigTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,10 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/

using System.Collections.Generic;
using System.IO.Abstractions;
using EnvDTE;
using FluentAssertions;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Microsoft.VisualStudio.VCProjectEngine;
using Moq;
using SonarLint.VisualStudio.Integration.Vsix.CFamily.VcxProject;
using SonarLint.VisualStudio.TestInfrastructure;
using static SonarLint.VisualStudio.Integration.Vsix.CFamily.UnitTests.CFamilyTestUtility;

namespace SonarLint.VisualStudio.Integration.UnitTests.CFamily.VcxProject
Expand All @@ -34,6 +30,25 @@ namespace SonarLint.VisualStudio.Integration.UnitTests.CFamily.VcxProject
public class FileConfigTests
{
private readonly TestLogger testLogger = new TestLogger();
private const string ClFilePath = "C:\\path\\cl.exe";
private const string ClangClFilePath = "C:\\path\\clang-cl.exe";

private static IFileSystem CreateFileSystemWithNoFiles()
{
var fileSystem = Substitute.For<IFileSystem>();
fileSystem.File.Exists(Arg.Any<string>()).Returns(false);
return fileSystem;
}

private static IFileSystem CreateFileSystemWithExistingFile(string fullPath)
{
var fileSystem = Substitute.For<IFileSystem>();
fileSystem.File.Exists(fullPath).Returns(true);
return fileSystem;
}

private static IFileSystem CreateFileSystemWithClCompiler() => CreateFileSystemWithExistingFile(ClFilePath);
private static IFileSystem CreateFileSystemWithClangClCompiler() => CreateFileSystemWithExistingFile(ClangClFilePath);

[TestMethod]
public void TryGet_NoVCProject_ReturnsNull()
Expand All @@ -45,7 +60,7 @@ public void TryGet_NoVCProject_ReturnsNull()
dteProjectItemMock.Setup(x => x.Object).Returns(Mock.Of<VCFile>());
dteProjectItemMock.Setup(x => x.ContainingProject).Returns(dteProjectMock.Object);

FileConfig.TryGet(testLogger, dteProjectItemMock.Object, "c:\\path")
FileConfig.TryGet(testLogger, dteProjectItemMock.Object, "c:\\path", CreateFileSystemWithClCompiler())
.Should().BeNull();
}

Expand All @@ -59,7 +74,7 @@ public void TryGet_NoVCFile_ReturnsNull()
dteProjectItemMock.Setup(x => x.Object).Returns(null);
dteProjectItemMock.Setup(x => x.ContainingProject).Returns(dteProjectMock.Object);

FileConfig.TryGet(testLogger, dteProjectItemMock.Object, "c:\\path")
FileConfig.TryGet(testLogger, dteProjectItemMock.Object, "c:\\path", CreateFileSystemWithClCompiler())
.Should().BeNull();
}

Expand All @@ -71,7 +86,7 @@ public void TryGet_UnsupportedItemType_ReturnsNull()
var projectItemMock = CreateMockProjectItem("c:\\foo\\xxx.vcxproj", projectItemConfig);

// Act
var fileConfig = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp");
var fileConfig = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithClCompiler());

// Assert
fileConfig.Should().BeNull();
Expand All @@ -86,7 +101,7 @@ public void TryGet_UnsupportedConfigurationType_ReturnsNull()
var projectItemMock = CreateMockProjectItem("c:\\foo\\xxx.vcxproj", projectItemConfig);

// Act
var fileConfig = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp");
var fileConfig = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithClCompiler());

// Assert
fileConfig.Should().BeNull();
Expand All @@ -101,7 +116,7 @@ public void TryGet_UnsupportedCustomBuild_ReturnsNull()
var projectItemMock = CreateMockProjectItem("c:\\foo\\xxx.vcxproj", projectItemConfig);

// Act
var fileConfig = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp");
var fileConfig = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithClCompiler());

// Assert
fileConfig.Should().BeNull();
Expand Down Expand Up @@ -134,7 +149,7 @@ public void TryGet_Full_Cmd()
var projectItemMock = CreateMockProjectItem("c:\\foo\\xxx.vcxproj", projectItemConfig);

// Act
var request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp");
var request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithClCompiler());

// Assert
request.Should().NotBeNull();
Expand Down Expand Up @@ -170,7 +185,7 @@ public void TryGet_HeaderFileOptions_ReturnsValidConfig()
var projectItemMock = CreateMockProjectItem("c:\\foo\\xxx.vcxproj", projectItemConfig);

// Act
var request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.h");
var request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.h", CreateFileSystemWithClCompiler());

// Assert
request.Should().NotBeNull();
Expand All @@ -183,7 +198,7 @@ public void TryGet_HeaderFileOptions_ReturnsValidConfig()
projectItemConfig.FileConfigProperties["ForcedIncludeFiles"] = "FHeader.h";

// Act
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.h");
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.h", CreateFileSystemWithClCompiler());

// Assert
Assert.AreEqual("\"C:\\path\\cl.exe\" /FI\"FHeader.h\" /Yu\"pch.h\" /EHsc /RTCu /TC \"c:\\dummy\\file.h\"", request.CDCommand);
Expand All @@ -194,7 +209,7 @@ public void TryGet_HeaderFileOptions_ReturnsValidConfig()
projectItemConfig.FileConfigProperties["CompileAs"] = "CompileAsCpp";

// Act
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.h");
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.h", CreateFileSystemWithClCompiler());

// Assert
Assert.AreEqual("\"C:\\path\\cl.exe\" /FI\"FHeader.h\" /Yu\"pch.h\" /EHsc /RTCu /TP \"c:\\dummy\\file.h\"", request.CDCommand);
Expand All @@ -220,7 +235,7 @@ public void TryGet_CompilerName_VS2017()
var projectItemMock = CreateMockProjectItem("c:\\foo\\xxx.vcxproj", projectItemConfig);

// Act
var request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp");
var request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithExistingFile("C:\\path\\x86\\cl.exe"));

// Assert
request.Should().NotBeNull();
Expand All @@ -230,12 +245,103 @@ public void TryGet_CompilerName_VS2017()
projectItemConfig.PlatformName = "x64";
projectItemMock = CreateMockProjectItem("c:\\foo\\xxx.vcxproj", projectItemConfig);
// Act
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp");
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithExistingFile("C:\\path\\x64\\cl.exe"));

// Assert
request.Should().NotBeNull();
Assert.IsTrue(request.CDCommand.StartsWith("\"C:\\path\\x64\\cl.exe\""));
}

[TestMethod]
public void TryGet_CompilerName_ClangCL()
{
// Arrange
var projectItemConfig = new ProjectItemConfig
{
ProjectConfigProperties = new Dictionary<string, string>
{
["ClCompilerPath"] = null,
["IncludePath"] = "C:\\path\\includeDir1;C:\\path\\includeDir2;C:\\path\\includeDir3;",
["ExecutablePath"] = "C:\\path\\no-compiler\\;C:\\path",
["CLToolExe"] = "clang-cl.exe",
["VC_ExecutablePath_x86"] = "C:\\path\\x86",
["VC_ExecutablePath_x64"] = "C:\\path\\x64",
}
};

var projectItemMock = CreateMockProjectItem("c:\\foo\\xxx.vcxproj", projectItemConfig);

// Act
var request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithClangClCompiler());

// Assert
request.Should().NotBeNull();
Assert.IsTrue(request.CDCommand.StartsWith("\"C:\\path\\clang-cl.exe\""));

// Arrange
projectItemConfig.ProjectConfigProperties["ClCompilerPath"] = "\\clang-cl.exe";

// Act
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithClangClCompiler());

// Assert
request.Should().NotBeNull();
Assert.IsTrue(request.CDCommand.StartsWith("\"C:\\path\\clang-cl.exe\""));

// Act
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithNoFiles());

// Assert
request.Should().BeNull();
testLogger.AssertOutputStringExists("Compiler is not supported.");

// Arrange
projectItemConfig.ProjectConfigProperties["ClToolExe"] = null;

// Act
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithExistingFile("C:\\path\\x86\\cl.exe"));

// Assert
request.Should().NotBeNull();
Assert.IsTrue(request.CDCommand.StartsWith("\"C:\\path\\x86\\cl.exe\""));

// Arrange
projectItemConfig.ProjectConfigProperties["ClToolExe"] = null;

// Act
request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithNoFiles());

// Assert
request.Should().BeNull();
testLogger.AssertOutputStringExists("Compiler is not supported.");
}

[TestMethod]
public void TryGet_CompilerName_CL_No_ClCompilerPath_NoCLToolExe()
{
// Arrange
var projectItemConfig = new ProjectItemConfig
{
ProjectConfigProperties = new Dictionary<string, string>
{
["ClCompilerPath"] = null,
["IncludePath"] = "C:\\path\\includeDir1;C:\\path\\includeDir2;C:\\path\\includeDir3;",
["ExecutablePath"] = "C:\\path\\no-compiler\\;C:\\path",
["CLToolExe"] = null,
["VC_ExecutablePath_x86"] = "C:\\path\\x86",
["VC_ExecutablePath_x64"] = "C:\\path\\x64",
}
};

var projectItemMock = CreateMockProjectItem("c:\\foo\\xxx.vcxproj", projectItemConfig);

// Act
var request = FileConfig.TryGet(testLogger, projectItemMock.Object, "c:\\dummy\\file.cpp", CreateFileSystemWithClCompiler());

// Assert
request.Should().NotBeNull();
Assert.IsTrue(request.CDCommand.StartsWith("\"C:\\path\\cl.exe\""));
}

}
}
Loading

0 comments on commit ae3904b

Please sign in to comment.