Merge pull request #1566 from Microsoft/feature_package_end_to_end

end to end hdf5 feature packages

1 files changed, 228 insertions, 95 deletions

diff --git a/toolsrc/src/commands_install.cpp b/toolsrc/src/commands_install.cpp
index 2ce5b6c62..9e37dc057 100644
--- a/toolsrc/src/commands_install.cpp
+++ b/toolsrc/src/commands_install.cpp
@@ -13,11 +13,7 @@
 
 namespace vcpkg::Commands::Install
 {
-    using Dependencies::InstallPlanAction;
-    using Dependencies::RequestType;
-    using Dependencies::InstallPlanType;
-    using Dependencies::RemovePlanAction;
-    using Dependencies::RemovePlanType;
+    using namespace Dependencies;
 
     InstallDir InstallDir::from_destination_root(const fs::path& destination_root,
                                                  const std::string& destination_subdirectory,
@@ -176,45 +172,10 @@ namespace vcpkg::Commands::Install
         return SortedVector<std::string>(std::move(installed_files));
     }
 
-    static void print_plan(const std::map<InstallPlanType, std::vector<const InstallPlanAction*>>& group_by_plan_type)
+    void install_package(const VcpkgPaths& paths, const BinaryControlFile& bcf, StatusParagraphs* status_db)
     {
-        static constexpr std::array<InstallPlanType, 3> order = {
-            InstallPlanType::ALREADY_INSTALLED, InstallPlanType::BUILD_AND_INSTALL, InstallPlanType::INSTALL};
-
-        for (const InstallPlanType plan_type : order)
-        {
-            auto it = group_by_plan_type.find(plan_type);
-            if (it == group_by_plan_type.cend())
-            {
-                continue;
-            }
-
-            std::vector<const InstallPlanAction*> cont = it->second;
-            std::sort(cont.begin(), cont.end(), &InstallPlanAction::compare_by_name);
-            const std::string as_string = Strings::join("\n", cont, [](const InstallPlanAction* p) {
-                return Dependencies::to_output_string(p->request_type, p->spec.to_string());
-            });
-
-            switch (plan_type)
-            {
-                case InstallPlanType::ALREADY_INSTALLED:
-                    System::println("The following packages are already installed:\n%s", as_string);
-                    continue;
-                case InstallPlanType::BUILD_AND_INSTALL:
-                    System::println("The following packages will be built and installed:\n%s", as_string);
-                    continue;
-                case InstallPlanType::INSTALL:
-                    System::println("The following packages will be installed:\n%s", as_string);
-                    continue;
-                default: Checks::unreachable(VCPKG_LINE_INFO);
-            }
-        }
-    }
-
-    void install_package(const VcpkgPaths& paths, const BinaryParagraph& binary_paragraph, StatusParagraphs* status_db)
-    {
-        const fs::path package_dir = paths.package_dir(binary_paragraph.spec);
-        const Triplet& triplet = binary_paragraph.spec.triplet();
+        const fs::path package_dir = paths.package_dir(bcf.core_paragraph.spec);
+        const Triplet& triplet = bcf.core_paragraph.spec.triplet();
         const std::vector<StatusParagraphAndAssociatedFiles> pgh_and_files = get_installed_files(paths, *status_db);
 
         const SortedVector<std::string> package_files =
@@ -234,7 +195,7 @@ namespace vcpkg::Commands::Install
             System::println(System::Color::error,
                             "The following files are already installed in %s and are in conflict with %s",
                             triplet_install_path.generic_string(),
-                            binary_paragraph.spec);
+                            bcf.core_paragraph.spec);
             System::print("\n    ");
             System::println(Strings::join("\n    ", intersection));
             System::println("");
@@ -242,27 +203,42 @@ namespace vcpkg::Commands::Install
         }
 
         StatusParagraph source_paragraph;
-        source_paragraph.package = binary_paragraph;
+        source_paragraph.package = bcf.core_paragraph;
         source_paragraph.want = Want::INSTALL;
         source_paragraph.state = InstallState::HALF_INSTALLED;
-        for (auto&& dep : source_paragraph.package.depends)
-        {
-            if (status_db->find_installed(dep, source_paragraph.package.spec.triplet()) == status_db->end())
-            {
-                Checks::unreachable(VCPKG_LINE_INFO);
-            }
-        }
+
         write_update(paths, source_paragraph);
         status_db->insert(std::make_unique<StatusParagraph>(source_paragraph));
 
+        std::vector<StatusParagraph> features_spghs;
+        for (auto&& feature : bcf.features)
+        {
+            features_spghs.emplace_back();
+
+            StatusParagraph& feature_paragraph = features_spghs.back();
+            feature_paragraph.package = feature;
+            feature_paragraph.want = Want::INSTALL;
+            feature_paragraph.state = InstallState::HALF_INSTALLED;
+
+            write_update(paths, feature_paragraph);
+            status_db->insert(std::make_unique<StatusParagraph>(feature_paragraph));
+        }
+
         const InstallDir install_dir = InstallDir::from_destination_root(
-            paths.installed, triplet.to_string(), paths.listfile_path(binary_paragraph));
+            paths.installed, triplet.to_string(), paths.listfile_path(bcf.core_paragraph));
 
         install_files_and_write_listfile(paths.get_filesystem(), package_dir, install_dir);
 
         source_paragraph.state = InstallState::INSTALLED;
         write_update(paths, source_paragraph);
         status_db->insert(std::make_unique<StatusParagraph>(source_paragraph));
+
+        for (auto&& feature_paragraph : features_spghs)
+        {
+            feature_paragraph.state = InstallState::INSTALLED;
+            write_update(paths, feature_paragraph);
+            status_db->insert(std::make_unique<StatusParagraph>(feature_paragraph));
+        }
     }
 
     using Build::BuildResult;
@@ -312,8 +288,8 @@ namespace vcpkg::Commands::Install
             }
             System::println("Building package %s... done", display_name);
 
-            const BinaryParagraph bpgh =
-                Paragraphs::try_load_cached_package(paths, action.spec).value_or_exit(VCPKG_LINE_INFO);
+            const BinaryControlFile bpgh =
+                Paragraphs::try_load_cached_control_package(paths, action.spec).value_or_exit(VCPKG_LINE_INFO);
             System::println("Installing package %s... ", display_name);
             install_package(paths, bpgh, &status_db);
             System::println(System::Color::success, "Installing package %s... done", display_name);
@@ -322,10 +298,11 @@ namespace vcpkg::Commands::Install
 
         if (plan_type == InstallPlanType::BUILD_AND_INSTALL && g_feature_packages)
         {
+            const std::string display_name_feature = action.displayname();
             if (use_head_version)
-                System::println("Building package %s from HEAD... ", display_name);
+                System::println("Building package %s from HEAD... ", display_name_feature);
             else
-                System::println("Building package %s... ", display_name);
+                System::println("Building package %s... ", display_name_feature);
 
             const Build::BuildPackageConfig build_config{
                 *action.any_paragraph.source_control_file.value_or_exit(VCPKG_LINE_INFO),
@@ -339,13 +316,13 @@ namespace vcpkg::Commands::Install
                 System::println(System::Color::error, Build::create_error_message(result.code, action.spec));
                 return result.code;
             }
-            System::println("Building package %s... done", display_name);
+            System::println("Building package %s... done", display_name_feature);
 
-            const BinaryParagraph bpgh =
-                Paragraphs::try_load_cached_package(paths, action.spec).value_or_exit(VCPKG_LINE_INFO);
-            System::println("Installing package %s... ", display_name);
-            install_package(paths, bpgh, &status_db);
-            System::println(System::Color::success, "Installing package %s... done", display_name);
+            const BinaryControlFile bcf =
+                Paragraphs::try_load_cached_control_package(paths, action.spec).value_or_exit(VCPKG_LINE_INFO);
+            System::println("Installing package %s... ", display_name_feature);
+            install_package(paths, bcf, &status_db);
+            System::println(System::Color::success, "Installing package %s... done", display_name_feature);
             return BuildResult::SUCCEEDED;
         }
 
@@ -357,7 +334,9 @@ namespace vcpkg::Commands::Install
                     System::Color::warning, "Package %s is already built -- not building from HEAD", display_name);
             }
             System::println("Installing package %s... ", display_name);
-            install_package(paths, action.any_paragraph.binary_paragraph.value_or_exit(VCPKG_LINE_INFO), &status_db);
+            install_package(paths,
+                            BinaryControlFile{action.any_paragraph.binary_paragraph.value_or_exit(VCPKG_LINE_INFO)},
+                            &status_db);
             System::println(System::Color::success, "Installing package %s... done", display_name);
             return BuildResult::SUCCEEDED;
         }
@@ -365,72 +344,226 @@ namespace vcpkg::Commands::Install
         Checks::unreachable(VCPKG_LINE_INFO);
     }
 
+    static void print_plan(const std::vector<AnyAction>& action_plan, bool is_recursive)
+    {
+        std::vector<const RemovePlanAction*> remove_plans;
+        std::vector<const InstallPlanAction*> rebuilt_plans;
+        std::vector<const InstallPlanAction*> only_install_plans;
+        std::vector<const InstallPlanAction*> new_plans;
+
+        const bool has_non_user_requested_packages = Util::find_if(action_plan, [](const AnyAction& package) -> bool {
+                                                         if (auto iplan = package.install_plan.get())
+                                                             return iplan->request_type != RequestType::USER_REQUESTED;
+                                                         else
+                                                             return false;
+                                                     }) != action_plan.cend();
+
+        for (auto&& action : action_plan)
+        {
+            if (auto install_action = action.install_plan.get())
+            {
+                // remove plans are guaranteed to come before install plans, so we know the plan will be contained if at
+                // all.
+                auto it = Util::find_if(
+                    remove_plans, [&](const RemovePlanAction* plan) { return plan->spec == install_action->spec; });
+                if (it != remove_plans.end())
+                {
+                    rebuilt_plans.emplace_back(install_action);
+                }
+                else
+                {
+                    if (install_action->plan_type == InstallPlanType::INSTALL)
+                        only_install_plans.emplace_back(install_action);
+                    else
+                        new_plans.emplace_back(install_action);
+                }
+            }
+            else if (auto remove_action = action.remove_plan.get())
+            {
+                remove_plans.emplace_back(remove_action);
+            }
+        }
+
+        std::sort(remove_plans.begin(), remove_plans.end(), &RemovePlanAction::compare_by_name);
+        std::sort(rebuilt_plans.begin(), rebuilt_plans.end(), &InstallPlanAction::compare_by_name);
+        std::sort(only_install_plans.begin(), only_install_plans.end(), &InstallPlanAction::compare_by_name);
+        std::sort(new_plans.begin(), new_plans.end(), &InstallPlanAction::compare_by_name);
+
+        const std::string rebuilt_string = Strings::join("\n", rebuilt_plans, [](const InstallPlanAction* p) {
+            return to_output_string(p->request_type, p->displayname());
+        });
+        if (rebuilt_plans.size() > 0) System::println("The following packages will be rebuilt:\n%s", rebuilt_string);
+
+        const std::string new_string = Strings::join("\n", new_plans, [](const InstallPlanAction* p) {
+            return to_output_string(p->request_type, p->displayname());
+        });
+        if (new_plans.size() > 0)
+            System::println("The following packages will be built and installed:\n%s", new_string);
+
+        const std::string only_install_string = Strings::join("\n", only_install_plans, [](const InstallPlanAction* p) {
+            return to_output_string(p->request_type, p->displayname());
+        });
+        if (only_install_plans.size() > 0)
+            System::println("The following packages will be directly installed:\n%s", only_install_string);
+
+        if (has_non_user_requested_packages)
+            System::println("Additional packages (*) will be installed to complete this operation.");
+
+        if (remove_plans.size() > 0 && !is_recursive)
+        {
+            System::println(System::Color::warning,
+                            "If you are sure you want to rebuild the above packages, run the command with the "
+                            "--recurse option");
+            Checks::exit_fail(VCPKG_LINE_INFO);
+        }
+    }
+
     void perform_and_exit(const VcpkgCmdArguments& args, const VcpkgPaths& paths, const Triplet& default_triplet)
     {
         static const std::string OPTION_DRY_RUN = "--dry-run";
         static const std::string OPTION_USE_HEAD_VERSION = "--head";
         static const std::string OPTION_NO_DOWNLOADS = "--no-downloads";
+        static const std::string OPTION_RECURSE = "--recurse";
 
         // input sanitization
         static const std::string example =
             Commands::Help::create_example_string("install zlib zlib:x64-windows curl boost");
         args.check_min_arg_count(1, example);
 
-        const std::vector<PackageSpec> specs = Util::fmap(args.command_arguments, [&](auto&& arg) {
-            return Input::check_and_get_package_spec(arg, default_triplet, example);
+        const std::vector<FullPackageSpec> specs = Util::fmap(args.command_arguments, [&](auto&& arg) {
+            return Input::check_and_get_full_package_spec(arg, default_triplet, example);
         });
+
         for (auto&& spec : specs)
-            Input::check_triplet(spec.triplet(), paths);
+        {
+            Input::check_triplet(spec.package_spec.triplet(), paths);
+            if (!spec.features.empty() && !g_feature_packages)
+            {
+                Checks::exit_with_message(
+                    VCPKG_LINE_INFO, "Feature packages are experimentally available under the --featurepackages flag.");
+            }
+        }
 
         const std::unordered_set<std::string> options = args.check_and_get_optional_command_arguments(
-            {OPTION_DRY_RUN, OPTION_USE_HEAD_VERSION, OPTION_NO_DOWNLOADS});
+            {OPTION_DRY_RUN, OPTION_USE_HEAD_VERSION, OPTION_NO_DOWNLOADS, OPTION_RECURSE});
         const bool dryRun = options.find(OPTION_DRY_RUN) != options.cend();
         const bool use_head_version = options.find(OPTION_USE_HEAD_VERSION) != options.cend();
         const bool no_downloads = options.find(OPTION_NO_DOWNLOADS) != options.cend();
+        const bool is_recursive = options.find(OPTION_RECURSE) != options.cend();
 
         // create the plan
         StatusParagraphs status_db = database_load_check(paths);
 
-        Dependencies::PathsPortFile paths_port_file(paths);
-        std::vector<InstallPlanAction> install_plan =
-            Dependencies::create_install_plan(paths_port_file, specs, status_db);
-        Checks::check_exit(VCPKG_LINE_INFO, !install_plan.empty(), "Install plan cannot be empty");
-
-        // log the plan
-        const std::string specs_string =
-            Strings::join(",", install_plan, [](const InstallPlanAction& plan) { return plan.spec.to_string(); });
-        Metrics::track_property("installplan", specs_string);
-
-        std::map<InstallPlanType, std::vector<const InstallPlanAction*>> group_by_plan_type;
-        Util::group_by(install_plan, &group_by_plan_type, [](const InstallPlanAction& p) { return p.plan_type; });
-        print_plan(group_by_plan_type);
+        const Build::BuildPackageOptions install_plan_options = {Build::to_use_head_version(use_head_version),
+                                                                 Build::to_allow_downloads(!no_downloads)};
 
-        const bool has_non_user_requested_packages =
-            Util::find_if(install_plan, [](const InstallPlanAction& package) -> bool {
-                return package.request_type != RequestType::USER_REQUESTED;
-            }) != install_plan.cend();
+        std::vector<AnyAction> action_plan;
 
-        if (has_non_user_requested_packages)
+        if (g_feature_packages)
         {
-            System::println("Additional packages (*) will be installed to complete this operation.");
+            std::unordered_map<std::string, SourceControlFile> scf_map;
+            auto all_ports = Paragraphs::try_load_all_ports(paths.get_filesystem(), paths.ports);
+            for (auto&& port : all_ports.paragraphs)
+            {
+                scf_map[port->core_paragraph->name] = std::move(*port);
+            }
+            action_plan = create_feature_install_plan(scf_map, FullPackageSpec::to_feature_specs(specs), status_db);
+        }
+        else
+        {
+            Dependencies::PathsPortFile paths_port_file(paths);
+            auto install_plan = Dependencies::create_install_plan(
+                paths_port_file, Util::fmap(specs, [](auto&& spec) { return spec.package_spec; }), status_db);
+
+            action_plan = Util::fmap(
+                install_plan, [](InstallPlanAction& install_action) { return AnyAction(std::move(install_action)); });
         }
 
+        // install plan will be empty if it is already installed - need to change this at status paragraph part
+        Checks::check_exit(VCPKG_LINE_INFO, !action_plan.empty(), "Install plan cannot be empty");
+
+        // log the plan
+        const std::string specs_string = Strings::join(",", action_plan, [](const AnyAction& action) {
+            if (auto iaction = action.install_plan.get())
+                return iaction->spec.to_string();
+            else if (auto raction = action.remove_plan.get())
+                return "R$" + raction->spec.to_string();
+            Checks::unreachable(VCPKG_LINE_INFO);
+        });
+        Metrics::track_property("installplan", specs_string);
+
+        print_plan(action_plan, is_recursive);
+
         if (dryRun)
         {
             Checks::exit_success(VCPKG_LINE_INFO);
         }
 
-        const Build::BuildPackageOptions install_plan_options = {Build::to_use_head_version(use_head_version),
-                                                                 Build::to_allow_downloads(!no_downloads)};
-
         // execute the plan
-        for (const InstallPlanAction& action : install_plan)
+        if (g_feature_packages)
+        {
+            for (const auto& action : action_plan)
+            {
+                if (auto install_action = action.install_plan.get())
+                {
+                    const BuildResult result =
+                        perform_install_plan_action(paths, *install_action, install_plan_options, status_db);
+                    if (result != BuildResult::SUCCEEDED)
+                    {
+                        System::println(Build::create_user_troubleshooting_message(install_action->spec));
+                        Checks::exit_fail(VCPKG_LINE_INFO);
+                    }
+                }
+                else if (auto remove_action = action.remove_plan.get())
+                {
+                    static const std::string OPTION_PURGE = "--purge";
+                    static const std::string OPTION_NO_PURGE = "--no-purge";
+
+                    const bool alsoRemoveFolderFromPackages = options.find(OPTION_NO_PURGE) == options.end();
+                    if (options.find(OPTION_PURGE) != options.end() && !alsoRemoveFolderFromPackages)
+                    {
+                        // User specified --purge and --no-purge
+                        System::println(System::Color::error, "Error: cannot specify both --no-purge and --purge.");
+                        System::print(example);
+                        Checks::exit_fail(VCPKG_LINE_INFO);
+                    }
+                    const std::string display_name = remove_action->spec.to_string();
+                    switch (remove_action->plan_type)
+                    {
+                        case RemovePlanType::NOT_INSTALLED:
+                            System::println(System::Color::success, "Package %s is not installed", display_name);
+                            break;
+                        case RemovePlanType::REMOVE:
+                            System::println("Removing package %s... ", display_name);
+                            Commands::Remove::remove_package(paths, remove_action->spec, &status_db);
+                            System::println(System::Color::success, "Removing package %s... done", display_name);
+                            break;
+                        case RemovePlanType::UNKNOWN:
+                        default: Checks::unreachable(VCPKG_LINE_INFO);
+                    }
+
+                    if (alsoRemoveFolderFromPackages)
+                    {
+                        System::println("Purging package %s... ", display_name);
+                        Files::Filesystem& fs = paths.get_filesystem();
+                        std::error_code ec;
+                        fs.remove_all(paths.packages / remove_action->spec.dir(), ec);
+                        System::println(System::Color::success, "Purging package %s... done", display_name);
+                    }
+                }
+            }
+        }
+        else
         {
-            const BuildResult result = perform_install_plan_action(paths, action, install_plan_options, status_db);
-            if (result != BuildResult::SUCCEEDED)
+            for (const auto& action : action_plan)
             {
-                System::println(Build::create_user_troubleshooting_message(action.spec));
-                Checks::exit_fail(VCPKG_LINE_INFO);
+                const auto& iaction = action.install_plan.value_or_exit(VCPKG_LINE_INFO);
+                const BuildResult result = perform_install_plan_action(paths, iaction, install_plan_options, status_db);
+                if (result != BuildResult::SUCCEEDED)
+                {
+                    System::println(Build::create_user_troubleshooting_message(iaction.spec));
+                    Checks::exit_fail(VCPKG_LINE_INFO);
+                }
             }
         }