* Reuse CI detection from the telemetry part in vcpkgcmdarguments.

BillyONeal · BillyONeal · commit 6e7a1aa21c6e · 2025-01-16T01:53:57.000-08:00
* Set SECTION_NAME for GitLabCI to the alphaumericdots of the filename.
* Deduplicate some CI detection tests.
* Fix a *foo.get() pattern in create_user_troubleshooting_message.
diff --git a/include/vcpkg/base/contractual-constants.h b/include/vcpkg/base/contractual-constants.h
@@ -347,6 +347,7 @@ namespace vcpkg
     inline constexpr StringLiteral FileInclude = "include";
     inline constexpr StringLiteral FileIncomplete = "incomplete";
     inline constexpr StringLiteral FileInfo = "info";
+    inline constexpr StringLiteral FileIssueBodyMD = "issue_body.md";
     inline constexpr StringLiteral FileLicense = "LICENSE";
     inline constexpr StringLiteral FileLicenseDotTxt = "LICENSE.txt";
     inline constexpr StringLiteral FilePortfileDotCMake = "portfile.cmake";
diff --git a/include/vcpkg/base/message-data.inc.h b/include/vcpkg/base/message-data.inc.h
@@ -945,6 +945,11 @@ DECLARE_MESSAGE(ConstraintViolation, (), "", "Found a constraint violation:")
 DECLARE_MESSAGE(ContinueCodeUnitInStart, (), "", "found continue code unit in start position")
 DECLARE_MESSAGE(ControlCharacterInString, (), "", "Control character in string")
 DECLARE_MESSAGE(ControlSupportsMustBeAPlatformExpression, (), "", "\"Supports\" must be a platform expression")
+DECLARE_MESSAGE(CopyIssueBodyFromFile, (msg::path), "", "Copy issue body from {path}")
+DECLARE_MESSAGE(CopyIssueBodyFromCollapsibleSection,
+                (msg::path),
+                "",
+                "Copy issue body from collapsed section \"{path}\" in the ci log output")
 DECLARE_MESSAGE(CopyrightIsDir,
                 (),
                 "",
diff --git a/include/vcpkg/commands.build.h b/include/vcpkg/commands.build.h
@@ -94,15 +94,18 @@ namespace vcpkg
     StringLiteral to_string_locale_invariant(const BuildResult build_result);
     LocalizedString to_string(const BuildResult build_result);
     LocalizedString create_user_troubleshooting_message(const InstallPlanAction& action,
+                                                        CIKind detected_ci,
                                                         const VcpkgPaths& paths,
                                                         const std::vector<std::string>& error_logs,
-                                                        const Optional<Path>& issue_body);
+                                                        const Optional<Path>& maybe_issue_body);
     inline void print_user_troubleshooting_message(const InstallPlanAction& action,
+                                                   CIKind detected_ci,
                                                    const VcpkgPaths& paths,
                                                    const std::vector<std::string>& error_logs,
-                                                   Optional<Path>&& issue_body)
+                                                   Optional<Path>&& maybe_issue_body)
     {
-        msg::println(Color::error, create_user_troubleshooting_message(action, paths, error_logs, issue_body));
+        msg::println(Color::error,
+                     create_user_troubleshooting_message(action, detected_ci, paths, error_logs, maybe_issue_body));
     }
 
     /// <summary>
diff --git a/include/vcpkg/fwd/vcpkgcmdarguments.h b/include/vcpkg/fwd/vcpkgcmdarguments.h
@@ -20,4 +20,20 @@ namespace vcpkg
     struct VcpkgCmdArguments;
     struct FeatureFlagSettings;
     struct PortApplicableSetting;
+
+    enum class CIKind
+    {
+        None,
+        GithubActions,
+        GitLabCI,
+        AzurePipelines,
+        AppVeyor,
+        AwsCodeBuild,
+        CircleCI,
+        HerokuCI,
+        JenkinsCI,
+        TeamCityCI,
+        TravisCI,
+        Generic
+    };
 }
diff --git a/include/vcpkg/vcpkgcmdarguments.h b/include/vcpkg/vcpkgcmdarguments.h
@@ -298,7 +298,8 @@ namespace vcpkg
             f.dependency_graph = dependency_graph_enabled();
             return f;
         }
-        const Optional<StringLiteral>& detected_ci_environment() const { return m_detected_ci_environment; }
+        const Optional<StringLiteral>& detected_ci_environment_name() const { return m_detected_ci_environment_name; }
+        CIKind detected_ci() const { return m_detected_ci_environment_type; }
 
         const std::string& get_command() const noexcept { return command; }
 
@@ -333,7 +334,8 @@ namespace vcpkg
 
         std::string command;
 
-        Optional<StringLiteral> m_detected_ci_environment;
+        Optional<StringLiteral> m_detected_ci_environment_name;
+        CIKind m_detected_ci_environment_type;
 
         friend LocalizedString usage_for_command(const CommandMetadata& command_metadata);
         CmdParser parser;
diff --git a/locales/messages.json b/locales/messages.json
@@ -546,6 +546,10 @@
   "ContinueCodeUnitInStart": "found continue code unit in start position",
   "ControlCharacterInString": "Control character in string",
   "ControlSupportsMustBeAPlatformExpression": "\"Supports\" must be a platform expression",
+  "CopyIssueBodyFromCollapsibleSection": "Copy issue body from collapsed section \"{path}\" in the ci log output",
+  "_CopyIssueBodyFromCollapsibleSection.comment": "An example of {path} is /foo/bar.",
+  "CopyIssueBodyFromFile": "Copy issue body from {path}",
+  "_CopyIssueBodyFromFile.comment": "An example of {path} is /foo/bar.",
   "CopyrightIsDir": "this port sets ${{CURRENT_PACKAGES_DIR}}/share/${{PORT}}/copyright to a directory, but it should be a file. Consider combining separate copyright files into one using vcpkg_install_copyright. To suppress this message, add set(VCPKG_POLICY_SKIP_COPYRIGHT_CHECK enabled)",
   "CorruptedDatabase": "vcpkg's installation database corrupted. This is either a bug in vcpkg or something else has modified the contents of the 'installed' directory in an unexpected way. You may be able to fix this by deleting the 'installed' directory and reinstalling what you want to use. If this problem happens consistently, please file a bug at https://github.com/microsoft/vcpkg .",
   "CorruptedInstallTree": "Your vcpkg 'installed' tree is corrupted.",
diff --git a/src/vcpkg/commands.build.cpp b/src/vcpkg/commands.build.cpp
@@ -207,7 +207,7 @@ namespace vcpkg
                     msg::print(Color::warning, warnings);
                 }
                 msg::println_error(create_error_message(result, spec));
-                msg::print(create_user_troubleshooting_message(*action, paths, {}, nullopt));
+                msg::print(create_user_troubleshooting_message(*action, args.detected_ci(), paths, {}, nullopt));
                 return 1;
             }
             case BuildResult::Excluded:
@@ -1702,115 +1702,113 @@ namespace vcpkg
                                Strings::percent_encode(body));
     }
 
-    enum class CIType
+    static bool is_collapsible_ci_kind(CIKind kind)
     {
-        GithubActions,
-        GitLabCi,
-        Azure,
-    };
-
-    static Optional<CIType> detect_ci_type()
-    {
-        if (get_environment_variable(EnvironmentVariableGitHubActions).has_value())
-        {
-            return CIType::GithubActions;
-        }
-        if (get_environment_variable(EnvironmentVariableGitLabCI).has_value())
-        {
-            return CIType::GitLabCi;
-        }
-        if (get_environment_variable(EnvironmentVariableTfBuild).has_value())
+        switch (kind)
         {
-            return CIType::Azure;
+            case CIKind::GithubActions:
+            case CIKind::GitLabCI:
+            case CIKind::AzurePipelines: return true;
+            default: return false;
         }
-        return {};
     }
 
     static void append_file_collapsible(LocalizedString& output,
-                                        CIType type,
+                                        CIKind kind,
                                         const ReadOnlyFilesystem& fs,
                                         const Path& file)
     {
-        auto title = file.filename();
-        // starting tag
-        if (type == CIType::GithubActions)
+        if (!is_collapsible_ci_kind(kind))
         {
-            // https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#grouping-log-lines
-            output.append_raw("::group::").append_raw(title).append_raw('\n');
+            Checks::unreachable(VCPKG_LINE_INFO);
         }
-        else if (type == CIType::GitLabCi)
-        {
-            // https://docs.gitlab.com/ee/ci/jobs/job_logs.html#custom-collapsible-sections
-            using namespace std::chrono;
-            const auto timestamp = duration_cast<seconds>(system_clock::now().time_since_epoch()).count();
-            output.append_raw(fmt::format("\\e[0Ksection_start:{}:SECTION_NAME[collapsed=true]\r\\e[0K", timestamp))
-                .append_raw(title)
-                .append_raw('\n');
-        }
-        else if (type == CIType::Azure)
-        {
-            output.append_raw("##vso[task.uploadfile]").append_raw(fs.absolute(file, VCPKG_LINE_INFO)).append_raw('\n');
-            // https://learn.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#formatting-commands
-            output.append_raw("##[group]").append_raw(title).append_raw('\n');
-        }
-
-        // output real file
-        output.append_raw(fs.read_contents(file, VCPKG_LINE_INFO));
 
-        // end tag
-        if (type == CIType::GithubActions)
-        {
-            output.append_raw("::endgroup::\n");
-        }
-        else if (type == CIType::GitLabCi)
-        {
-            using namespace std::chrono;
-            const auto timestamp = duration_cast<seconds>(system_clock::now().time_since_epoch()).count();
-            output.append_raw(fmt::format("\\e[0Ksection_end:{}:SECTION_NAME\r\\e[0K\n", timestamp));
-        }
-        else if (type == CIType::Azure)
-        {
-            output.append_raw("##[endgroup]\n");
+        auto title = file.filename();
+        auto contents = fs.read_contents(file, VCPKG_LINE_INFO);
+        switch (kind)
+        {
+            case CIKind::GithubActions:
+                // https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#grouping-log-lines
+                output.append_raw("::group::")
+                    .append_raw(title)
+                    .append_raw('\n')
+                    .append_raw(contents)
+                    .append_raw("::endgroup::\n");
+                break;
+            case CIKind::GitLabCI:
+            {
+                // https://docs.gitlab.com/ee/ci/jobs/job_logs.html#custom-collapsible-sections
+                using namespace std::chrono;
+                std::string section_name;
+                std::copy_if(title.begin(), title.end(), std::back_inserter(section_name), [](char c) {
+                    return c == '.' || ParserBase::is_alphanum(c);
+                });
+                const auto timestamp = duration_cast<seconds>(system_clock::now().time_since_epoch()).count();
+                output
+                    .append_raw(
+                        fmt::format("\\e[0Ksection_start:{}:{}[collapsed=true]\r\\e[0K", timestamp, section_name))
+                    .append_raw(title)
+                    .append_raw('\n')
+                    .append_raw(contents)
+                    .append_raw(fmt::format("\\e[0Ksection_end:{}:{}\r\\e[0K\n", timestamp, section_name));
+            }
+            break;
+            case CIKind::AzurePipelines:
+                // https://learn.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#formatting-commands
+                output.append_raw("##vso[task.uploadfile]")
+                    .append_raw(file)
+                    .append_raw('\n')
+                    .append_raw("##[group]")
+                    .append_raw(title)
+                    .append_raw('\n')
+                    .append_raw(contents)
+                    .append_raw("##[endgroup]\n");
+                break;
         }
     }
 
     LocalizedString create_user_troubleshooting_message(const InstallPlanAction& action,
+                                                        CIKind detected_ci,
                                                         const VcpkgPaths& paths,
                                                         const std::vector<std::string>& error_logs,
-                                                        const Optional<Path>& issue_body)
+                                                        const Optional<Path>& maybe_issue_body)
     {
         const auto& spec_name = action.spec.name();
         const auto& triplet_name = action.spec.triplet().to_string();
         LocalizedString result = msg::format(msgBuildTroubleshootingMessage1).append_raw('\n');
         result.append_indent().append_raw(make_gh_issue_search_url(spec_name)).append_raw('\n');
         result.append(msgBuildTroubleshootingMessage2).append_raw('\n');
 
-        if (issue_body.has_value())
+        if (auto issue_body = maybe_issue_body.get())
         {
-            auto ci = detect_ci_type();
-            const auto path = issue_body.get()->generic_u8string();
+            auto& fs = paths.get_filesystem();
+            const auto path = issue_body->generic_u8string();
+            const bool collapsible = is_collapsible_ci_kind(detected_ci);
             const auto body =
-                ci.map([&](auto) {
-                      return fmt::format("Copy issue body from collapsed section \"{}\" in the ci log output",
-                                         issue_body.get()->filename());
-                  }).value_or(Strings::concat("Copy issue body from ", path));
+                collapsible ? msg::format(msgCopyIssueBodyFromCollapsibleSection, msg::path = issue_body->filename())
+                            : msg::format(msgCopyIssueBodyFromFile, msg::path = path);
+
             result.append_indent().append_raw(make_gh_issue_open_url(spec_name, triplet_name, body)).append_raw('\n');
-            if (!ci && !paths.get_filesystem().find_from_PATH("gh").empty())
+            if (collapsible)
             {
-                Command gh("gh");
-                gh.string_arg("issue").string_arg("create").string_arg("-R").string_arg("microsoft/vcpkg");
-                gh.string_arg("--title").string_arg(fmt::format("[{}] Build failure on {}", spec_name, triplet_name));
-                gh.string_arg("--body-file").string_arg(path);
-
-                result.append(msgBuildTroubleshootingMessageGH).append_raw('\n');
-                result.append_indent().append_raw(gh.command_line());
+                append_file_collapsible(result, detected_ci, fs, *issue_body);
+                for (Path error_log_path : error_logs)
+                {
+                    append_file_collapsible(result, detected_ci, fs, error_log_path);
+                }
             }
-            if (ci)
+            else
             {
-                append_file_collapsible(result, *ci.get(), paths.get_filesystem(), *issue_body.get());
-                for (Path error_log_path : error_logs)
+                auto gh_path = fs.find_from_PATH("gh");
+                if (!gh_path.empty())
                 {
-                    append_file_collapsible(result, *ci.get(), paths.get_filesystem(), error_log_path);
+                    Command gh(gh_path[0]);
+                    gh.string_arg("issue").string_arg("create").string_arg("-R").string_arg("microsoft/vcpkg");
+                    gh.string_arg("--title").string_arg(
+                        fmt::format("[{}] Build failure on {}", spec_name, triplet_name));
+                    gh.string_arg("--body-file").string_arg(path);
+                    result.append(msgBuildTroubleshootingMessageGH).append_raw('\n');
+                    result.append_indent().append_raw(gh.command_line());
                 }
             }
         }
diff --git a/src/vcpkg/commands.install.cpp b/src/vcpkg/commands.install.cpp
@@ -604,8 +604,12 @@ namespace vcpkg
             {
                 this_install.print_elapsed_time();
                 print_user_troubleshooting_message(
-                    action, paths, result.error_logs, result.stdoutlog.then([&](auto&) -> Optional<Path> {
-                        auto issue_body_path = paths.installed().root() / "vcpkg" / "issue_body.md";
+                    action,
+                    args.detected_ci(),
+                    paths,
+                    result.error_logs,
+                    result.stdoutlog.then([&](auto&) -> Optional<Path> {
+                        auto issue_body_path = paths.installed().root() / FileVcpkg / FileIssueBodyMD;
                         paths.get_filesystem().write_contents(
                             issue_body_path,
                             create_github_issue(args, result, paths, action, include_manifest_in_github_issue),
diff --git a/src/vcpkg/commands.z-print-config.cpp b/src/vcpkg/commands.z-print-config.cpp
@@ -48,7 +48,7 @@ namespace vcpkg
         obj.insert(JsonIdHostTriplet, host_triplet.canonical_name());
         obj.insert(JsonIdVcpkgRoot, paths.root.native());
         obj.insert(JsonIdTools, paths.tools.native());
-        if (auto ci_env = args.detected_ci_environment().get())
+        if (auto ci_env = args.detected_ci_environment_name().get())
         {
             obj.insert(JsonIdDetectedCIEnvironment, *ci_env);
         }
diff --git a/src/vcpkg/vcpkgcmdarguments.cpp b/src/vcpkg/vcpkgcmdarguments.cpp

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ namespace vcpkg`
`48`	`48`	`obj.insert(JsonIdHostTriplet, host_triplet.canonical_name());`
`49`	`49`	`obj.insert(JsonIdVcpkgRoot, paths.root.native());`
`50`	`50`	`obj.insert(JsonIdTools, paths.tools.native());`
`51`		`- if (auto ci_env = args.detected_ci_environment().get())`
	`51`	`+ if (auto ci_env = args.detected_ci_environment_name().get())`
`52`	`52`	`{`
`53`	`53`	`obj.insert(JsonIdDetectedCIEnvironment, *ci_env);`
`54`	`54`	`}`