Keep policy errors parseable in list JSON

Author: PrzemyslawKlys

src/AppInstallerCLICore/Workflows/WorkflowBase.cpp

@@ -25,6 +25,7 @@
 EXTERN_C IMAGE_DOS_HEADER __ImageBase;
 
 using namespace std::string_literals;
+using namespace std::string_view_literals;
 using namespace AppInstaller::Utility::literals;
 using namespace AppInstaller::Pinning;
 using namespace AppInstaller::Repository;
@@ -813,7 +814,16 @@ namespace AppInstaller::CLI::Workflow
             {
                 auto policy = Settings::TogglePolicy::GetPolicy(e.Policy());
                 auto policyNameId = policy.PolicyName();
-                context->Reporter.Error() << Resource::String::DisabledByGroupPolicy(policyNameId) << std::endl;
+                auto message = Resource::String::DisabledByGroupPolicy(policyNameId);
+
+                if (IsJsonOutputFormat(context->Args))
+                {
+                    OutputInstalledPackagesJsonError(*context, APPINSTALLER_CLI_ERROR_BLOCKED_BY_POLICY, message);
+                }
+                else
+                {
+                    context->Reporter.Error() << message << std::endl;
+                }
             }
             return APPINSTALLER_CLI_ERROR_BLOCKED_BY_POLICY;
         }

src/AppInstallerCLITests/UpdateFlow.cpp

@@ -377,6 +377,31 @@ TEST_CASE("ListFlow_JsonOutputWithSettingsWarnings", "[ListFlow][workflow]")
     REQUIRE(json["packages"].size() == 1);
 }
 
+TEST_CASE("ListFlow_JsonOutputWinGetPolicyDisabled", "[ListFlow][workflow]")
+{
+    GroupPolicyTestOverride policies;
+    policies.SetState(TogglePolicy::Policy::WinGet, PolicyState::Disabled);
+
+    std::ostringstream listOutput;
+    TestContext context{ listOutput, std::cin };
+    auto previousThreadGlobals = context.SetForCurrentThread();
+    context.Args.AddArg(Execution::Args::Type::OutputFormat, "json"sv);
+
+    ListCommand list({});
+    context.SetExecutingCommand(&list);
+    ExecuteWithoutLoggingSuccess(context, &list);
+    INFO(listOutput.str());
+
+    Json::Value json = ConvertToJson(listOutput.str());
+    REQUIRE(json["packages"].isArray());
+    REQUIRE(json["packages"].empty());
+    REQUIRE(json["sourceFailures"].isArray());
+    REQUIRE(json["sourceFailures"].empty());
+    REQUIRE(json["error"]["code"].asString() == "0x8a15003a");
+    REQUIRE(json["error"]["message"].asString().empty() == false);
+    REQUIRE(context.GetTerminationHR() == APPINSTALLER_CLI_ERROR_BLOCKED_BY_POLICY);
+}
+
 TEST_CASE("ListFlow_JsonOutputBadSource", "[ListFlow][workflow]")
 {
     SetSetting(Stream::UserSources, R"(