Always use <vcpkg-test/util.h> rather than <catch2/catch.hpp>. (#1252)

This ensures the StringMakers in util.h are always available for better console output.

.clang-format

@@ -59,6 +59,8 @@ IncludeCategories:
     Priority: -1
   - Regex: '^<catch2/catch\.hpp>$'
     Priority: 1
+  - Regex: '^<vcpkg-test/util\.h>$'
+    Priority: 1
   - Regex: '^<vcpkg/base/fwd/.*\.h>$'
     Priority: 2
   - Regex: '^<vcpkg/fwd/.*\.h>$'

include/vcpkg-test/util.h

@@ -84,6 +84,12 @@ namespace Catch
             return "{\"" + value.first.native() + "\", \"" + value.second.native() + "\"}";
         }
     };
+
+    template<>
+    struct StringMaker<vcpkg::Version>
+    {
+        static const std::string convert(const vcpkg::Version& value) { return value.to_string(); }
+    };
 }
 
 namespace vcpkg

src/vcpkg-test/archives.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/archives.h>
 

src/vcpkg-test/arguments.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/strings.h>
 

src/vcpkg-test/binarycaching.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/files.h>
 #include <vcpkg/base/xmlserializer.h>
@@ -13,8 +13,6 @@
 
 #include <string>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 
 struct KnowNothingBinaryProvider : IReadBinaryProvider

src/vcpkg-test/bundlesettings.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/format.h>
 #include <vcpkg/base/strings.h>

src/vcpkg-test/cache.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/cache.h>
 #include <vcpkg/base/stringview.h>

src/vcpkg-test/catch.cpp

@@ -1,5 +1,5 @@
 #define CATCH_CONFIG_RUNNER
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/checks.h>
 #include <vcpkg/base/messages.h>

src/vcpkg-test/cgroup-parser.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/files.h>
 #include <vcpkg/base/optional.h>

src/vcpkg-test/chrono.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/chrono.h>
 

src/vcpkg-test/ci-baseline.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/checks.h>
 #include <vcpkg/base/parse.h>
@@ -10,8 +10,6 @@
 #include <ostream>
 #include <utility>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 
 namespace vcpkg

src/vcpkg-test/cmd-parser.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/cmd-parser.h>
 #include <vcpkg/base/files.h>

src/vcpkg-test/coffilereader.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/cofffilereader.h>
 

src/vcpkg-test/commands.dependinfo.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/commands.depend-info.h>
 #include <vcpkg/vcpkgcmdarguments.h>

src/vcpkg-test/commands.export.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/export.ifw.h>
 #include <vcpkg/export.prefab.h>

src/vcpkg-test/commands.extract.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/files.h>
 
@@ -8,8 +8,6 @@
 
 #include <limits.h>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 
 #if defined(_WIN32)

src/vcpkg-test/commands.install.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/commands.install.h>
 

src/vcpkg-test/configmetadata.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/json.h>
 #include <vcpkg/base/jsonreader.h>
@@ -7,8 +7,6 @@
 #include <vcpkg/configuration.h>
 #include <vcpkg/registries.h>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 
 static constexpr StringLiteral KIND = "kind";

src/vcpkg-test/configparser.cpp

@@ -1,11 +1,9 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/util.h>
 
 #include <vcpkg/binarycaching.h>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 
 #if defined(_WIN32)

src/vcpkg-test/dependencies.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/fwd/packagespec.h>
 
@@ -17,7 +17,6 @@
 #include <vector>
 
 #include <vcpkg-test/mockcmakevarprovider.h>
-#include <vcpkg-test/util.h>
 
 using namespace vcpkg;
 

src/vcpkg-test/dependinfo-graphs.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/commands.depend-info.h>
 

src/vcpkg-test/downloads.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/downloads.h>
 #include <vcpkg/base/expected.h>

src/vcpkg-test/expected.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/expected.h>
 

src/vcpkg-test/files.cpp

@@ -1,6 +1,6 @@
 #include <vcpkg/base/system-headers.h>
 
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/files.h>
 #include <vcpkg/base/strings.h>
@@ -9,8 +9,6 @@
 #include <random>
 #include <vector>
 
-#include <vcpkg-test/util.h>
-
 #if !defined(_WIN32)
 #include <sys/stat.h>
 #endif // ^^^ !_WIN32

src/vcpkg-test/git.parse.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/git.h>
 

src/vcpkg-test/hash.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/hash.h>
 

src/vcpkg-test/integrate.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/commands.install.h>
 

src/vcpkg-test/json.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/files.h>
 #include <vcpkg/base/json.h>

src/vcpkg-test/manifests.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/fwd/message_sinks.h>
 
@@ -10,8 +10,6 @@
 #include <vcpkg/vcpkgcmdarguments.h>
 #include <vcpkg/vcpkgpaths.h>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 using namespace vcpkg::Paragraphs;
 using namespace vcpkg::Test;

src/vcpkg-test/messages.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/json.h>
 #include <vcpkg/base/setup-messages.h>

src/vcpkg-test/metrics.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/metrics.h>
 

src/vcpkg-test/new.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/json.h>
 

src/vcpkg-test/optional.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/lineinfo.h>
 #include <vcpkg/base/optional.h>

src/vcpkg-test/paragraph.cpp

@@ -1,11 +1,9 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/strings.h>
 
 #include <vcpkg/paragraphs.h>
 
-#include <vcpkg-test/util.h>
-
 namespace Strings = vcpkg::Strings;
 using vcpkg::Paragraph;
 

src/vcpkg-test/plan.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/graphs.h>
 
@@ -12,7 +12,6 @@
 #include <vector>
 
 #include <vcpkg-test/mockcmakevarprovider.h>
-#include <vcpkg-test/util.h>
 
 using namespace vcpkg;
 

src/vcpkg-test/registries.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/jsonreader.h>
 #include <vcpkg/base/strings.h>

src/vcpkg-test/spdx.cpp

@@ -1,8 +1,8 @@
+#include <vcpkg-test/util.h>
+
 #include <vcpkg/dependencies.h>
 #include <vcpkg/spdx.h>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 
 TEST_CASE ("spdx maximum serialization", "[spdx]")

src/vcpkg-test/specifier.cpp

@@ -1,11 +1,9 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/util.h>
 
 #include <vcpkg/packagespec.h>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 
 TEST_CASE ("specifier conversion", "[specifier]")

src/vcpkg-test/statusparagraphs.cpp

@@ -1,12 +1,10 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/util.h>
 
 #include <vcpkg/paragraphs.h>
 #include <vcpkg/statusparagraphs.h>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 using namespace vcpkg::Paragraphs;
 using namespace vcpkg::Test;

src/vcpkg-test/strings.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/api-stable-format.h>
 #include <vcpkg/base/expected.h>

src/vcpkg-test/stringview.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/stringview.h>
 

src/vcpkg-test/system.cpp

@@ -1,6 +1,6 @@
 #include <vcpkg/base/system-headers.h>
 
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/optional.h>
 #include <vcpkg/base/strings.h>

src/vcpkg-test/system.mac.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/span.h>
 #include <vcpkg/base/stringview.h>

src/vcpkg-test/system.process.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/strings.h>
 #include <vcpkg/base/system.process.h>

src/vcpkg-test/tools.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/expected.h>
 
@@ -7,8 +7,6 @@
 
 #include <array>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 
 TEST_CASE ("parse_tool_version_string", "[tools]")

src/vcpkg-test/uint128.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/uint128.h>
 

src/vcpkg-test/update.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/sortedvector.h>
 
@@ -6,8 +6,6 @@
 #include <vcpkg/portfileprovider.h>
 #include <vcpkg/statusparagraphs.h>
 
-#include <vcpkg-test/util.h>
-
 using namespace vcpkg;
 using namespace vcpkg::Test;
 

src/vcpkg-test/util-tests.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/util.h>
 

src/vcpkg-test/util.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/base/checks.h>
 #include <vcpkg/base/system.h>
@@ -15,8 +15,6 @@
 #include <set>
 #include <vector>
 
-#include <vcpkg-test/util.h>
-
 namespace vcpkg::Test
 {
     const Triplet ARM64_WINDOWS = Triplet::from_canonical_name("arm64-windows");

src/vcpkg-test/versionplan.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/dependencies.h>
 #include <vcpkg/paragraphparser.h>
@@ -6,7 +6,6 @@
 #include <vcpkg/sourceparagraph.h>
 
 #include <vcpkg-test/mockcmakevarprovider.h>
-#include <vcpkg-test/util.h>
 
 using namespace vcpkg;
 

src/vcpkg-test/xunitwriter.cpp

@@ -1,4 +1,4 @@
-#include <catch2/catch.hpp>
+#include <vcpkg-test/util.h>
 
 #include <vcpkg/commands.build.h>
 #include <vcpkg/xunitwriter.h>