d-installer 0.4.2

data/lib/dinstaller/dbus/software.rb

@@ -0,0 +1,31 @@
+# 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 DBus
+    # Name space for software D-Bus classes
+    module Software
+    end
+  end
+end
+
+require "dinstaller/dbus/software/manager"
+require "dinstaller/dbus/software/proposal"

data/lib/dinstaller/dbus/software_service.rb

@@ -0,0 +1,86 @@
+# 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 "dbus"
+require "dinstaller/dbus/software"
+require "dinstaller/software"
+
+module DInstaller
+  module DBus
+    # D-Bus service (org.opensuse.DInstaller.Software)
+    #
+    # It connects to the system D-Bus and answers requests on objects below
+    # `/org/opensuse/DInstaller/Software`.
+    class SoftwareService
+      SERVICE_NAME = "org.opensuse.DInstaller.Software"
+      private_constant :SERVICE_NAME
+
+      # D-Bus connection
+      #
+      # @return [::DBus::Connection]
+      attr_reader :bus
+
+      # @param config [Config] Configuration object
+      # @param logger [Logger]
+      def initialize(config, logger = nil)
+        @logger = logger || Logger.new($stdout)
+        @bus = ::DBus::SystemBus.instance
+        @backend = DInstaller::Software.new(config, logger)
+        @backend.on_progress_change { dispatch }
+      end
+
+      # Exports the software object through the D-Bus service
+      def export
+        dbus_objects.each { |o| service.export(o) }
+        paths = dbus_objects.map(&:path).join(", ")
+        logger.info "Exported #{paths} objects"
+      end
+
+      # Call this from some main loop to dispatch the D-Bus messages
+      def dispatch
+        bus.dispatch_message_queue
+      end
+
+    private
+
+      # @return [Logger]
+      attr_reader :logger, :backend
+
+      # @return [::DBus::Service]
+      def service
+        @service ||= bus.request_service(SERVICE_NAME)
+      end
+
+      # @return [Array<::DBus::Object>]
+      def dbus_objects
+        @dbus_objects ||= [
+          dbus_software_manager,
+          DInstaller::DBus::Software::Proposal.new(logger)
+        ]
+      end
+
+      # @return [DInstaller::DBus::Software::Manager]
+      def dbus_software_manager
+        @dbus_software_manager ||= DInstaller::DBus::Software::Manager.new(@backend, logger)
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/storage/proposal.rb

@@ -0,0 +1,170 @@
+# 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 "dbus"
+require "dinstaller/dbus/base_object"
+require "dinstaller/dbus/with_service_status"
+require "dinstaller/dbus/interfaces/service_status"
+require "dinstaller/storage/proposal"
+
+module DInstaller
+  module DBus
+    module Storage
+      # D-Bus object to manage a storage proposal
+      class Proposal < BaseObject
+        include WithServiceStatus
+        include Interfaces::ServiceStatus
+
+        PATH = "/org/opensuse/DInstaller/Storage/Proposal1"
+        private_constant :PATH
+
+        # Constructor
+        #
+        # @param backend [DInstaller::Storage::Proposal]
+        # @param logger [Logger]
+        def initialize(backend, logger)
+          super(PATH, logger: logger)
+          @backend = backend
+
+          register_callbacks
+          register_service_status_callbacks
+        end
+
+        STORAGE_PROPOSAL_INTERFACE = "org.opensuse.DInstaller.Storage.Proposal1"
+        private_constant :STORAGE_PROPOSAL_INTERFACE
+
+        dbus_interface STORAGE_PROPOSAL_INTERFACE do
+          dbus_reader :lvm, "b", dbus_name: "LVM"
+
+          dbus_reader :candidate_devices, "as"
+
+          # The first string is the name of the device (as expected by #Calculate for
+          # the setting CandidateDevices), the second one is the label to represent that device in
+          # the UI when further information is needed.
+          #
+          # TODO: this representation is a temporary solution. In the future we should likely
+          # return more complex structures, probably with an interface similar to
+          # com.redhat.Blivet0.Device or org.freedesktop.UDisks2.Block.
+          dbus_reader :available_devices, "a(ssa{sv})"
+
+          # result: 0 success; 1 error
+          dbus_method :Calculate, "in settings:a{sv}, out result:u" do |settings|
+            success = busy_while do
+              backend.calculate(to_proposal_properties(settings))
+            end
+
+            success ? 0 : 1
+          end
+
+          dbus_reader :actions, "aa{sv}"
+        end
+
+        # List of disks available for installation
+        #
+        # Each device is represented by an array containing id and UI label. See the documentation
+        # of the available_devices DBus reader.
+        #
+        # @see DInstaller::Storage::Proposal
+        #
+        # @return [Array<Array>]
+        def available_devices
+          backend.available_devices.map do |dev|
+            [dev.name, backend.device_label(dev), {}]
+          end
+        end
+
+        # @see DInstaller::Storage::Proposal
+        def lvm
+          backend.lvm?
+        rescue DInstaller::Storage::Proposal::NoProposalError
+          false
+        end
+
+        # @see DInstaller::Storage::Proposal
+        def candidate_devices
+          backend.candidate_devices
+        rescue DInstaller::Storage::Proposal::NoProposalError
+          []
+        end
+
+        # List of sorted actions in D-Bus format
+        #
+        # @see #to_dbus
+        #
+        # @return [Array<Hash>]
+        def actions
+          backend.actions.all.map { |a| action_to_dbus(a) }
+        end
+
+      private
+
+        # @return [DInstaller::Storage::Proposal]
+        attr_reader :backend
+
+        # @return [Logger]
+        attr_reader :logger
+
+        # Equivalence between properties names in D-Bus and backend.
+        PROPOSAL_PROPERTIES = {
+          "LVM"              => "use_lvm",
+          "CandidateDevices" => "candidate_devices"
+        }.freeze
+        private_constant :PROPOSAL_PROPERTIES
+
+        # Registers callback to be called when properties change
+        def register_callbacks
+          backend.add_on_change_listener do
+            dbus_properties_changed(STORAGE_PROPOSAL_INTERFACE, { "LVM" => lvm,
+              "CandidateDevices" => candidate_devices,
+              "AvailableDevices" => available_devices,
+              "Actions" => actions }, [])
+          end
+        end
+
+        # Converts settings from D-Bus to backend names
+        #
+        # @example
+        #   settings = { "LVM" => true, "CandidateDevices" => ["/dev/sda"] }
+        #   to_proposal_settings(settings) #=>
+        #     { "use_lvm" => true, "candidate_devices" => ["/dev/sda"] }
+        #
+        # @param settings [Hash]
+        def to_proposal_properties(settings)
+          settings.each_with_object({}) do |e, h|
+            h[PROPOSAL_PROPERTIES[e.first]] = e.last
+          end
+        end
+
+        # Converts an action to D-Bus format
+        #
+        # @param action [Y2Storage::CompoundAction]
+        # @return [Hash]
+        def action_to_dbus(action)
+          {
+            "Text"   => action.sentence,
+            "Subvol" => action.device_is?(:btrfs_subvolume),
+            "Delete" => action.delete?
+          }
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/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
+  module DBus
+    # Namespace for storage D-Bus classes
+    module Storage
+    end
+  end
+end
+
+require "dinstaller/dbus/storage/proposal"

data/lib/dinstaller/dbus/users.rb

@@ -0,0 +1,132 @@
+# 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 "dbus"
+require "dinstaller/users"
+require "dinstaller/dbus/base_object"
+require "dinstaller/dbus/with_service_status"
+require "dinstaller/dbus/interfaces/service_status"
+
+module DInstaller
+  module DBus
+    # YaST D-Bus object (/org/opensuse/DInstaller/Users1)
+    class Users < BaseObject
+      include WithServiceStatus
+      include Interfaces::ServiceStatus
+
+      PATH = "/org/opensuse/DInstaller/Users1"
+      private_constant :PATH
+
+      # Constructor
+      #
+      # @param backend [DInstaller::Users]
+      # @param logger [Logger]
+      def initialize(backend, logger)
+        super(PATH, logger: logger)
+        @backend = backend
+        register_service_status_callbacks
+      end
+
+      USERS_INTERFACE = "org.opensuse.DInstaller.Users1"
+      private_constant :USERS_INTERFACE
+
+      FUSER_SIG = "in FullName:s, in UserName:s, in Password:s, in AutoLogin:b, in data:a{sv}"
+      private_constant :FUSER_SIG
+
+      # rubocop:disable Metrics/BlockLength
+      dbus_interface USERS_INTERFACE do
+        dbus_reader :root_password_set, "b"
+
+        dbus_reader :root_ssh_key, "s", dbus_name: "RootSSHKey"
+
+        dbus_reader :first_user, "(ssba{sv})"
+
+        dbus_method :SetRootPassword,
+          "in Value:s, in Encrypted:b, out result:u" do |value, encrypted|
+          logger.info "Setting Root Password"
+          backend.assign_root_password(value, encrypted)
+
+          dbus_properties_changed(USERS_INTERFACE, { "RootPasswordSet" => !value.empty? }, [])
+          0
+        end
+
+        dbus_method :RemoveRootPassword, "out result:u" do
+          logger.info "Clearing the root password"
+          backend.remove_root_password
+
+          dbus_properties_changed(USERS_INTERFACE, { "RootPasswordSet" => backend.root_password? },
+            [])
+          0
+        end
+
+        dbus_method :SetRootSSHKey, "in Value:s, out result:u" do |value|
+          logger.info "Setting Root ssh key"
+          backend.root_ssh_key = (value)
+
+          dbus_properties_changed(USERS_INTERFACE, { "RootSSHKey" => value }, [])
+          0
+        end
+
+        dbus_method :SetFirstUser,
+          FUSER_SIG + ", out result:u" do |full_name, user_name, password, auto_login, data|
+          logger.info "Setting first user #{full_name}"
+          backend.assign_first_user(full_name, user_name, password, auto_login, data)
+
+          dbus_properties_changed(USERS_INTERFACE, { "FirstUser" => first_user }, [])
+          0
+        end
+
+        dbus_method :RemoveFirstUser, "out result:u" do
+          logger.info "Removing the first user"
+          backend.remove_first_user
+
+          dbus_properties_changed(USERS_INTERFACE, { "FirstUser" => first_user }, [])
+          0
+        end
+
+        dbus_method :Write, "out result:u" do
+          logger.info "Writting users"
+
+          backend.write
+          0
+        end
+      end
+      # rubocop:enable Metrics/BlockLength
+
+      def root_ssh_key
+        backend.root_ssh_key
+      end
+
+      def first_user
+        backend.first_user
+      end
+
+      def root_password_set
+        backend.root_password?
+      end
+
+    private
+
+      # @return [DInstaller::Users]
+      attr_reader :backend
+    end
+  end
+end

data/lib/dinstaller/dbus/users_service.rb

@@ -0,0 +1,92 @@
+# 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 "dbus"
+require "dinstaller/dbus/users"
+require "dinstaller/users"
+
+module DInstaller
+  module DBus
+    # D-Bus service (org.opensuse.DInstaller.Users)
+    #
+    # It connects to the system D-Bus and answers requests on objects below
+    # `/org/opensuse/DInstaller/Users1`.
+    class UsersService
+      # Service name
+      #
+      # @return [String]
+      SERVICE_NAME = "org.opensuse.DInstaller.Users"
+      private_constant :SERVICE_NAME
+
+      # System D-Bus
+      #
+      # @return [::DBus::Connection]
+      attr_reader :bus
+
+      # @param config [Config] Configuration object
+      # @param logger [Logger]
+      def initialize(_config, logger = nil)
+        @logger = logger || Logger.new($stdout)
+        @bus = ::DBus::SystemBus.instance
+      end
+
+      # Exports the installer object through the D-Bus service
+      def export
+        dbus_objects.each { |o| service.export(o) }
+
+        paths = dbus_objects.map(&:path).join(", ")
+        logger.info "Exported #{paths} objects"
+      end
+
+      # Call this from some main loop to dispatch the D-Bus messages
+      def dispatch
+        bus.dispatch_message_queue
+      end
+
+    private
+
+      # @return [Logger]
+      attr_reader :logger
+
+      # @return [::DBus::Service]
+      def service
+        @service ||= bus.request_service(SERVICE_NAME)
+      end
+
+      # @return [Array<::DBus::Object>]
+      def dbus_objects
+        @dbus_objects ||= [
+          users_dbus
+        ]
+      end
+
+      # @return [DInstaller::DBus::Users]
+      def users_dbus
+        @users_dbus ||= DInstaller::DBus::Users.new(users_backend(logger), logger)
+      end
+
+      # @return [DInstaller::Users]
+      def users_backend(logger)
+        @users_backend ||= DInstaller::Users.new(logger)
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/with_service_status.rb

@@ -0,0 +1,48 @@
+# 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/dbus/service_status"
+
+module DInstaller
+  module DBus
+    # Mixin to be included by D-Bus objects that needs to register a service status
+    module WithServiceStatus
+      # Service status
+      #
+      # @return [ServiceStatus]
+      def service_status
+        @service_status ||= ServiceStatus.new.idle
+      end
+
+      # Sets the service status to busy meanwhile the given block is running
+      #
+      # @param block [Proc]
+      # @return [Object] the result of the given block
+      def busy_while(&block)
+        service_status.busy
+        result = block.call
+        service_status.idle
+
+        result
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/y2dir/manager/modules/Package.rb

@@ -0,0 +1,51 @@
+# 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"
+
+# :nodoc:
+module Yast
+  # Replacement for the Yast::Package module
+  #
+  # @see https://github.com/yast/yast-yast2/blob/b8cd178b7f341f6e3438782cb703f4a3ab0529ed/library/packages/src/modules/Package.rb
+  class PackageClass < Module
+    def main
+      puts "Loading mocked module #{__FILE__}"
+    end
+
+    # Determines whether the package is available
+    #
+    # @see https://github.com/yast/yast-yast2/blob/b8cd178b7f341f6e3438782cb703f4a3ab0529ed/library/packages/src/modules/Package.rb#L72
+    # @todo Perform a real D-Bus call.
+    def Available(_package_name)
+      true
+    end
+
+    # Determines whether the package is available
+    #
+    # @see https://github.com/yast/yast-yast2/blob/b8cd178b7f341f6e3438782cb703f4a3ab0529ed/library/packages/src/modules/Package.rb#L121
+    # @todo Perform a real D-Bus call.
+    def Installed(_package_name, target: nil)
+      false
+    end
+  end
+
+  Package = PackageClass.new
+  Package.main
+end