d-installer 0.4.2

data/lib/dinstaller/storage/callbacks/activate.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "storage"
+require "y2storage/callbacks/issues_callback"
+require "dinstaller/storage/callbacks/activate_multipath"
+require "dinstaller/storage/callbacks/activate_luks"
+
+module DInstaller
+  module Storage
+    module Callbacks
+      # Callbacks to manage devices activation
+      class Activate < ::Storage::ActivateCallbacksLuks
+        include Y2Storage::Callbacks::IssuesCallback
+
+        # Constructor
+        #
+        # @param questions_manager [QuestionsManager]
+        # @param logger [Logger]
+        def initialize(questions_manager, logger)
+          super()
+
+          @questions_manager = questions_manager
+          @logger = logger
+          @issues = Y2Issues::List.new
+        end
+
+        # Messages are ignored to not bother the user
+        #
+        # See Storage::Callbacks#message in libstorage-ng
+        def message(_message); end
+
+        # Decides whether multipath should be activated
+        #
+        # @see ActivateMultipath
+        #
+        # @param looks_like_real_multipath [Boolean] true if the system seems to contain a multipath
+        #   device.
+        # @return [Boolean]
+        def multipath(looks_like_real_multipath)
+          callback = ActivateMultipath.new(questions_manager, logger)
+
+          callback.call(looks_like_real_multipath)
+        end
+
+        # Decides whether a LUKS device should be activated
+        #
+        # @see ActivateLuks
+        #
+        # @param info [Storage::LuksInfo]
+        # @param attempt [Numeric]
+        #
+        # @return [Storage::PairBoolString] Whether to activate the device and the password
+        def luks(info, attempt)
+          callback = ActivateLuks.new(questions_manager, logger)
+
+          activate, password = callback.call(info, attempt)
+
+          ::Storage::PairBoolString.new(activate, password || "")
+        end
+
+      private
+
+        # @return [QuestionsManager]
+        attr_reader :questions_manager
+
+        # @return [Logger]
+        attr_reader :logger
+
+        # Mixin Y2Storage::Callbacks::IssuesCallback expects a #log method
+        alias_method :log, :logger
+      end
+    end
+  end
+end

data/lib/dinstaller/storage/callbacks/activate_luks.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "dinstaller/luks_activation_question"
+require "dinstaller/can_ask_question"
+require "y2storage/disk_size"
+
+module DInstaller
+  module Storage
+    module Callbacks
+      # Callbacks for LUKS activation
+      class ActivateLuks
+        include CanAskQuestion
+
+        # Constructor
+        #
+        # @param questions_manager [QuestionsManager]
+        # @param logger [Logger]
+        def initialize(questions_manager, logger)
+          @questions_manager = questions_manager
+          @logger = logger
+        end
+
+        # Asks whether to activate a LUKS device
+        #
+        # @note The process waits until the question is answered.
+        #
+        # @param info [Storage::LuksInfo]
+        # @param attempt [Numeric]
+        #
+        # @return [Array(Boolean, String)] The first value is whether to activate the device, and
+        #   the second one is the LUKS password. Note that the password would only be considered
+        #   when the first value is true.
+        def call(info, attempt)
+          question = question(info, attempt)
+
+          ask(question) do |q|
+            logger.info("#{q.text} #{q.answer}")
+
+            activate = q.answer == :decrypt
+            password = q.password
+
+            [activate, password]
+          end
+        end
+
+      private
+
+        # @return [QuestionsManager]
+        attr_reader :questions_manager
+
+        # @return [Logger]
+        attr_reader :logger
+
+        # Question to ask for LUKS activation
+        #
+        # @return [LuksActivationQuestion]
+        def question(info, attempt)
+          LuksActivationQuestion.new(info.device_name,
+            label:   info.label,
+            size:    formatted_size(info.size),
+            attempt: attempt)
+        end
+
+        # Generates a formatted representation of the size
+        #
+        # @param size [Y2Storage::DiskSize]
+        # @return [String]
+        def formatted_size(value)
+          Y2Storage::DiskSize.new(value).to_human_string
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/storage/callbacks/activate_multipath.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "dinstaller/question"
+require "dinstaller/can_ask_question"
+
+module DInstaller
+  module Storage
+    module Callbacks
+      # Callbacks for multipath activation
+      class ActivateMultipath
+        include CanAskQuestion
+
+        # Constructor
+        #
+        # @param questions_manager [QuestionsManager]
+        # @param logger [Logger]
+        def initialize(questions_manager, logger)
+          @questions_manager = questions_manager
+          @logger = logger
+        end
+
+        # Asks whether to activate multipath devices
+        #
+        # @note The process waits until the question is answered.
+        #
+        # @param looks_like_real_multipath [Boolean] see {Callbacks::Activate#multipath}.
+        # @return [Boolean]
+        def call(looks_like_real_multipath)
+          return false unless looks_like_real_multipath
+
+          ask(question) do |q|
+            logger.info("#{q.text} #{q.answer}")
+
+            q.answer == :yes
+          end
+        end
+
+      private
+
+        # @return [QuestionsManager]
+        attr_reader :questions_manager
+
+        # @return [Logger]
+        attr_reader :logger
+
+        # Question to ask for multipath activation
+        #
+        # @return [Question]
+        def question
+          text = "The system seems to have multipath hardware. " \
+                 "Do you want to activate multipath?"
+
+          Question.new(text, options: [:yes, :no])
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/storage/callbacks.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+module DInstaller
+  module Storage
+    # Module for callbacks related to storage actions
+    module Callbacks
+    end
+  end
+end
+
+require "dinstaller/storage/callbacks/activate"

data/lib/dinstaller/storage/manager.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "yast"
+require "y2storage/storage_manager"
+require "dinstaller/storage/proposal"
+require "dinstaller/storage/callbacks"
+
+Yast.import "PackagesProposal"
+
+module DInstaller
+  module Storage
+    # Manager to handle storage configuration
+    class Manager
+      def initialize(logger, config)
+        @logger = logger
+        @config = config
+      end
+
+      # Probes storage devices and performs an initial proposal
+      #
+      # @param questions_manager [QuestionsManager]
+      def probe(questions_manager)
+        # TODO: Add progress once this is moved to its own service
+        logger.info "Probing storage and performing proposal"
+        activate_devices(questions_manager)
+        probe_devices
+        proposal.calculate
+      end
+
+      # Prepares the partitioning to install the system
+      def install
+        add_packages
+        Yast::WFM.CallFunction("inst_prepdisk", [])
+      end
+
+      # Umounts the target file system
+      def finish
+        Yast::WFM.CallFunction("umount_finish", ["Write"])
+      end
+
+      # Storage proposal manager
+      #
+      # @return [Storage::Proposal]
+      def proposal
+        @proposal ||= Proposal.new(logger, config)
+      end
+
+    private
+
+      PROPOSAL_ID = "storage_proposal"
+      private_constant :PROPOSAL_ID
+
+      # @return [Logger]
+      attr_reader :logger
+
+      # @return [Config]
+      attr_reader :config
+
+      # Activates the devices, calling activation callbacks if needed
+      #
+      # @param questions_manager [QuestionsManager]
+      def activate_devices(questions_manager)
+        callbacks = Callbacks::Activate.new(questions_manager, logger)
+
+        Y2Storage::StorageManager.instance.activate(callbacks)
+      end
+
+      # Probes the devices
+      def probe_devices
+        # TODO: probe callbacks
+        Y2Storage::StorageManager.instance.probe
+      end
+
+      # Adds the required packages to the list of resolvables to install
+      def add_packages
+        devicegraph = Y2Storage::StorageManager.instance.staging
+        packages = devicegraph.used_features.pkg_list
+        return if packages.empty?
+
+        logger.info "Selecting these packages for installation: #{packages}"
+        Yast::PackagesProposal.SetResolvables(PROPOSAL_ID, :package, packages)
+      end
+    end
+  end
+end

data/lib/dinstaller/storage/proposal.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "y2storage/storage_manager"
+require "y2storage/guided_proposal"
+require "y2storage/proposal_settings"
+require "y2storage/dialogs/guided_setup/helpers/disk"
+
+module DInstaller
+  module Storage
+    # Backend class to calculate a storage proposal
+    class Proposal
+      class NoProposalError < StandardError; end
+
+      # Constructor
+      #
+      # @param logger [Logger]
+      # @param config [Config]
+      def initialize(logger, config)
+        @logger = logger
+        @config = config
+        @listeners = []
+      end
+
+      def add_on_change_listener(&block)
+        @listeners << block
+      end
+
+      def changed!
+        @listeners.each(&:call)
+      end
+
+      # Available devices for installation
+      #
+      # @return [Array<Y2Storage::Device>]
+      def available_devices
+        disk_analyzer.candidate_disks
+      end
+
+      # Label that should be used to represent the given disk in the UI
+      #
+      # NOTE: this is likely a temporary solution. The label should not be calculated in the backend
+      # in the future. See the note about available_devices at {DBus::Storage::Proposal}.
+      #
+      # The label has the form: "NAME, SIZE, [USB], INSTALLED_SYSTEMS".
+      #
+      # Examples:
+      #
+      #   "/dev/sda, 250.00 GiB, Windows, OpenSUSE"
+      #   "/dev/sdb, 8.00 GiB, USB"
+      #
+      # @param device [Y2Storage::Device]
+      # @return [String]
+      def device_label(device)
+        disk_helper.label(device)
+      end
+
+      # Name of devices where to perform the installation
+      #
+      # @raise [NoProposalError] if no proposal yet
+      #
+      # @return [Array<String>]
+      def candidate_devices
+        raise NoProposalError unless proposal
+
+        proposal.settings.candidate_devices
+      end
+
+      # Whether the proposal should create LVM devices
+      #
+      # @raise [NoProposalError] if no proposal yet
+      #
+      # @return [Boolean]
+      def lvm?
+        raise NoProposalError unless proposal
+
+        proposal.settings.use_lvm
+      end
+
+      # Calculates a new proposal
+      #
+      # @param settings [Hash] settings to calculate the proposal
+      #   (e.g., { "use_lvm" => true, "candidate_devices" => ["/dev/sda"]}). Note that keys should
+      #   match with a public setter.
+      #
+      # @return [Boolean] whether the proposal was correctly calculated
+      def calculate(settings = {})
+        proposal_settings = generate_proposal_settings(settings)
+
+        @proposal = Y2Storage::GuidedProposal.initial(
+          settings:      proposal_settings,
+          devicegraph:   probed_devicegraph,
+          disk_analyzer: disk_analyzer
+        )
+        save
+        changed!
+
+        !proposal.failed?
+      end
+
+      # Storage actions manager
+      #
+      # @fixme this method should directly return the actions
+      #
+      # @return [Storage::Actions]
+      def actions
+        # FIXME: this class could receive the storage manager instance
+        @actions ||= Actions.new(logger)
+      end
+
+    private
+
+      # @return [Logger]
+      attr_reader :logger
+
+      # @return [Config]
+      attr_reader :config
+
+      # @return [Y2Storage::InitialGuidedProposal]
+      attr_reader :proposal
+
+      # Generates proposal settings from the given values
+      #
+      # @param settings [Hash]
+      # @return [Y2Storage::ProposalSettings]
+      def generate_proposal_settings(settings)
+        proposal_settings = Y2Storage::ProposalSettings.new_for_current_product
+
+        config_volumes = read_config_volumes
+        # If no volumes are specified, just leave the default ones (hardcoded at Y2Storage)
+        proposal_settings.volumes = config_volumes unless config_volumes.empty?
+
+        settings.each { |k, v| proposal_settings.public_send("#{k}=", v) }
+
+        proposal_settings
+      end
+
+      # Reads the list of volumes from the D-Installer configuration
+      #
+      # @return [Array<Y2Storage::VolumeSpecification>]
+      def read_config_volumes
+        vols = config.data.fetch("storage", {}).fetch("volumes", [])
+        vols.map { |v| Y2Storage::VolumeSpecification.new(v) }
+      end
+
+      # Saves the proposal or restores initial devices if a proposal was not calculated
+      def save
+        if proposal.failed?
+          storage_manager.staging = probed_devicegraph.dup
+        else
+          storage_manager.proposal = proposal
+        end
+      end
+
+      # @return [Y2Storage::DiskAnalyzer]
+      def disk_analyzer
+        storage_manager.probed_disk_analyzer
+      end
+
+      # Helper to generate a disk label
+      #
+      # @return [Y2Storage::Dialogs::GuidedSetup::Helpers::Disk]
+      def disk_helper
+        @disk_helper ||= Y2Storage::Dialogs::GuidedSetup::Helpers::Disk.new(disk_analyzer)
+      end
+
+      # Devicegraph representing the system
+      #
+      # @return [Y2Storage::Devicegraph]
+      def probed_devicegraph
+        storage_manager.probed
+      end
+
+      def storage_manager
+        Y2Storage::StorageManager.instance
+      end
+    end
+  end
+end

data/lib/dinstaller/storage.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+module DInstaller
+  # Namespace for storage backend
+  module Storage
+  end
+end
+
+require "dinstaller/storage/manager"
+require "dinstaller/storage/proposal"
+require "dinstaller/storage/actions"