{"id":5904,"date":"2024-05-06T07:00:56","date_gmt":"2024-05-06T14:00:56","guid":{"rendered":"http:\/\/writeasync.net\/?p=5904"},"modified":"2024-05-05T23:19:23","modified_gmt":"2024-05-06T06:19:23","slug":"testing-static_assert-msbuild","status":"publish","type":"post","link":"http:\/\/writeasync.net\/?p=5904","title":{"rendered":"Testing static_assert (MSBuild)"},"content":{"rendered":"

Now that we’ve gotten a handle on testing static_assert for CMake<\/a>, let’s turn our focus to MSBuild<\/a>. We will use a nearly identical project structure as what was established in the CMake stassert<\/code> sample project<\/a> but with all the of the, uh, “beauty” of .vcxproj<\/a> and .sln<\/a> files. (For good measure, we have also switched to VSTest for C++ unit tests<\/a>.) Here is the result: StaticAssertSample – initial port from CMake<\/a><\/p>\n

As before with CMake, we now need to cobble together a compiler command that would test each static_assert<\/code> based on a conditional compilation symbol, for example:<\/p>\n

\r\n#ifdef STASSERT_NAME_HAS_WRONG_TYPE\r\n        struct WrongType\r\n        {\r\n            std::string name{};\r\n        };\r\n\r\n        TEST_METHOD(name_has_wrong_type)\r\n        {\r\n            WrongType val{};\r\n\r\n            Example<WrongType> hello{ val };\r\n        }\r\n#endif\r\n<\/pre>\n
It turns out that, in this department, we are in luck — sort of. During a C++ project build, the compiler commands are indeed recorded, though mainly for the benefit of incremental build<\/a>. The only drawback, as clearly laid out in the documentation for .tlog files<\/a> (the underlying file format for tracking build inputs and outputs) is that command-line .tlog file contents are not specifically documented and “determined by the MSBuild task that produces them.”<\/p>\n
However, it is pretty clear that the format is nearly identical to that of the “read” and “write” .tlog files which are<\/em> documented and presumably stable. A typical command-line file might look like this (example adapted from the CL.command.1.tlog<\/code> for the StaticAssertTest project):<\/p>\n
\r\n^D:\\SOME\\PATH\\PROJECTS\\STATICASSERTSAMPLE\\TEST\\EXAMPLE_TEST.CPP\r\n\/c \/I..\\INC \/I"C:\\PROGRAM FILES\\MICROSOFT VISUAL STUDIO\\2022\\ENTERPRISE\\VC\\UNITTEST\\INCLUDE" \/I"D:\\OTHER\\PATH\\CPP\\VCPKG\\INSTALLED\\X64-WINDOWS\\INCLUDE" \/ZI \/JMC \/nologo \/W3 \/WX- \/diagnostics:column \/sdl \/Od \/D _DEBUG \/D _WINDLL \/D _UNICODE \/D UNICODE \/Gm- \/EHsc \/RTC1 \/MDd \/GS \/fp:precise \/Zc:wchar_t \/Zc:forScope \/Zc:inline \/std:c++20 \/Fo"X64\\DEBUG\\\\" \/Fd"X64\\DEBUG\\VC143.PDB" \/external:W3 \/Gd \/TP \/FC D:\\SOME\\PATH\\PROJECTS\\STATICASSERTSAMPLE\\TEST\\EXAMPLE_TEST.CPP\r\n<\/pre>\n
The first line is a caret (^) followed by the full path the .cpp source file. The second line is the full argument list for CL.exe. While it may not be contractual, it seems simple enough to throw together a prototype where we assume this format. So let’s press on!<\/p>\n
At the end of our test project, we can add some custom items and an associated targets import:<\/p>\n
\r\n  <ItemGroup>\r\n    <StaticAssertTest Include="STASSERT_NAME_HAS_WRONG_TYPE">\r\n      <TestFile>example_test.cpp<\/TestFile>\r\n      <Pattern>Type must have 'name' field of type `const char\\*`<\/Pattern>\r\n    <\/StaticAssertTest>\r\n    <StaticAssertTest Include="STASSERT_NAME_HAS_WRONG_SIZE">\r\n      <TestFile>example_test.cpp<\/TestFile>\r\n      <Pattern>Type must not have size of 16<\/Pattern>\r\n    <\/StaticAssertTest>\r\n  <\/ItemGroup>\r\n  <Import Project="StaticAssertTest.targets" \/>\r\n<\/pre>\n
The items lay out a series of tests that we want to perform. The Include<\/code> (the “identity” metadata component<\/a>) is the #define<\/code> symbol; exactly one of these defines a unique test. The metadata items TestFile<\/code> and Pattern<\/code> specify the related information for the test — which source file it is associated with and the expected static_assert<\/code> error pattern, respectively. Now we need our custom .targets file:<\/p>\n
\r\n<Project>\r\n  <Target Name="StaticAssertTest" AfterTargets="ClCompile">\r\n    <ItemGroup>\r\n      <CLCommandFile Include="$(TLogLocation)CL.command.*.tlog" \/>\r\n      <StaticAssertTestCommand Include="@(StaticAssertTest)">\r\n        <Args>-Symbol "%(Identity)" -Pattern "%(Pattern)" -TestFile "%(TestFile)"<\/Args>\r\n      <\/StaticAssertTestCommand>\r\n    <\/ItemGroup>\r\n    <Exec Command="powershell.exe -File Test-StaticAssert.ps1 -ClExe &quot;$(ClCompilerPath)&quot; %(StaticAssertTestCommand.Args) -CommandFile &quot;@(CLCommandFile->'%(fullpath)', '&quot;,&quot;')&quot;" \/>\r\n  <\/Target>\r\n<\/Project>\r\n<\/pre>\n
This file defines one StaticAssertTest target which runs after the C++ compiler (ClCompile) target<\/a>. It uses an item wildcard<\/a> to select all the possible .tlog command files and another item to build up the script arguments we will need to run the test. We then simply hand off to powershell.exe<\/code> to run our Test-StaticAssert.ps1<\/code> script to do the real work:<\/p>\n
\r\n[CmdletBinding()]\r\nparam(\r\n    [Parameter(Mandatory=$true)]\r\n    [string]$ClExe,\r\n    [Parameter(Mandatory=$true)]\r\n    [string]$Symbol,\r\n    [Parameter(Mandatory=$true)]\r\n    [string]$Pattern,\r\n    [Parameter(Mandatory=$true)]\r\n    [string[]]$CommandFile,\r\n    [Parameter(Mandatory=$true)]\r\n    [string]$TestFile\r\n)\r\n\r\nFunction Exit-Task($errorText) {\r\n    Write-Host "$($PSCommandPath): error : $errorText"\r\n    Exit 1\r\n}\r\n\r\n$clArgs = ''\r\n$outPath = ''\r\nforeach ($file in $CommandFile) {\r\n    if (!(Test-Path $file)) {\r\n        Exit-Task "Command file '$file' not found"\r\n    }\r\n\r\n    $lines = Get-Content $file\r\n    # First line has the following format:\r\n    # ^X:\\SOME\\FULL\\PATH\\FILE.CPP\r\n    $cppFile = Split-Path ($lines[0].Substring(1)) -Leaf\r\n    if ($cppFile -eq $TestFile) {\r\n        # Second line has actual args to CL.exe\r\n        $clArgs = $lines[1]\r\n        break\r\n    }\r\n}\r\n\r\nif (!$clArgs) {\r\n    Exit-Task "Could not find CL args for test file '$TestFile'"\r\n}\r\n\r\n$clArgs += " \/D$Symbol"\r\n$cmdText = "`"$ClExe`" $clArgs"\r\nWrite-Host $cmdText\r\n# The CL.exe path (and possibly some arguments) will be quoted. This causes\r\n# trouble for invoking the expression directly, so invoke via cmd.exe.\r\n$output = & cmd.exe \/c $cmdText\r\nif ($LASTEXITCODE -eq 0) {\r\n    Exit-Task "Compilation unexpectedly succeeded for '$Symbol'"\r\n}\r\n\r\n$matched = $false\r\n$output | Select-String -Pattern $Pattern | ForEach-Object {\r\n    $matched = $true\r\n    Write-Host "Found matching output line for '$Symbol': $_"\r\n}\r\n\r\nif (!$matched) {\r\n    $output | Write-Host\r\n    Exit-Task "Did not find output line for '$Symbol' matching '$Pattern'"\r\n}\r\n<\/pre>\n
The script is not too different from the one we built for CMake, though with some MSBuild adaptations. For one, it tries to produce an error output that would be understood better by MSBuild<\/a> which helps highlight the actual problem when something goes wrong. Also, since these command lines can have paths with spaces, there is a lot of argument quoting needed. This is somewhat of a minefield in PowerShell<\/a> but I found success by just passing off to a “cmd.exe \/c” expression<\/a> via the call operator (&<\/code>)<\/a>.<\/p>\n
The end result is a set of post-build static_assert<\/code> “tests” that run equally well on the msbuild.exe command line or in the Visual Studio IDE. A failing test has an output like the following:<\/p>\n
\r\n"D:\\some\\path\\projects\\StaticAssertSample\\StaticAssertSample.sln" (default target) (1) ->\r\n"D:\\some\\path\\projects\\StaticAssertSample\\test\\StaticAssertTest.vcxproj" (default target) (4) ->\r\n(StaticAssertTest target) ->\r\n  D:\\some\\path\\projects\\StaticAssertSample\\INC\\example.h(13,33): error C2338: static_assert failed: 'Type must not have size of 16' [D:\\some\\path\\projects\\StaticAssertSample\\test\\StaticAssertTest.vcxproj]\r\n  D:\\some\\path\\projects\\StaticAssertSample\\test\\Test-StaticAssert.ps1 : error : Did not find output line for 'STASSERT_NAME_HAS_WRONG_SIZE' matching 'Type must not have size of 99' [D:\\some\\path\\projects\r\n\\StaticAssertSample\\test\\StaticAssertTest.vcxproj]\r\n  D:\\some\\path\\projects\\StaticAssertSample\\test\\StaticAssertTest.targets(9,5): error MSB3073: The command "powershell.exe -File Test-StaticAssert.ps1 -ClExe "C:\\Program Files\\Microsoft Visual Studio\\2022\\Enterprise\\VC\\Tools\\MSVC\\14.39.33519\\bin\\HostX64\\x64\\cl.exe" -Symbol "STASSERT_NAME_HAS_WRONG_SIZE" -Pattern "Type must not have size of 16" -TestFile "example_test.cpp" -CommandFile "some\\path\\projects\\StaticAssertSample\\test\\x64\\Debug\\StaticAssertTest.tlog\\CL.command.1.tlog"" exited with code 1. [D:\\some\\path\\projects\\StaticAssertSample\\test\\StaticAssertTest.vcxproj]\r\n<\/pre>\n
Yes, it’s somewhat lengthy, but the error condition is front and center.<\/p>\n
If you have a need for static_assert<\/code> validation and<\/em> you use Visual Studio with .vcxproj files, this might be a good starting point (no promises, though!). All of the code for this sample can be found here: StaticAssertSample on GitHub<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Now that we’ve gotten a handle on testing static_assert for CMake, let’s turn our focus to MSBuild. We will use a nearly identical project structure as what was established in the CMake stassert sample project but with all the of… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[108,101],"tags":[],"class_list":["post-5904","post","type-post","status-publish","format-standard","hentry","category-build","category-native"],"_links":{"self":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5904","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5904"}],"version-history":[{"count":3,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5904\/revisions"}],"predecessor-version":[{"id":5907,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5904\/revisions\/5907"}],"wp:attachment":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5904"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5904"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5904"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}