d-installer 0.4.2

data/lib/dinstaller/dbus/clients/manager.rb

@@ -0,0 +1,76 @@
+# 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/clients/base"
+require "dinstaller/dbus/clients/with_service_status"
+require "dinstaller/dbus/clients/with_progress"
+require "dinstaller/dbus/manager"
+require "dinstaller/installation_phase"
+
+module DInstaller
+  module DBus
+    module Clients
+      # D-Bus client for manager service
+      class Manager < Base
+        include WithServiceStatus
+        include WithProgress
+
+        def initialize
+          super
+
+          @dbus_object = service["/org/opensuse/DInstaller/Manager1"]
+          @dbus_object.introspect
+        end
+
+        def service_name
+          @service_name ||= "org.opensuse.DInstaller"
+        end
+
+        def probe
+          dbus_object.Probe
+        end
+
+        # Starts the installation
+        def commit
+          dbus_object.Commit
+        end
+
+        def current_installation_phase
+          dbus_phase = dbus_object["org.opensuse.DInstaller.Manager1"]["CurrentInstallationPhase"]
+
+          case dbus_phase
+          when DBus::Manager::STARTUP_PHASE
+            InstallationPhase::STARTUP
+          when DBus::Manager::CONFIG_PHASE
+            InstallationPhase::CONFIG
+          when DBus::Manager::INSTALL_PHASE
+            InstallationPhase::INSTALL
+          end
+        end
+
+      private
+
+        # @return [::DBus::Object]
+        attr_reader :dbus_object
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/clients/software.rb

@@ -0,0 +1,185 @@
+# 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/clients/base"
+require "dinstaller/dbus/clients/with_service_status"
+require "dinstaller/dbus/clients/with_progress"
+
+module DInstaller
+  module DBus
+    module Clients
+      # D-Bus client for software configuration
+      class Software < Base
+        include WithServiceStatus
+        include WithProgress
+
+        TYPES = [:package, :pattern].freeze
+        private_constant :TYPES
+
+        def initialize
+          super
+
+          @dbus_object = service["/org/opensuse/DInstaller/Software1"]
+          @dbus_object.introspect
+
+          @dbus_proposal = service["/org/opensuse/DInstaller/Software/Proposal1"]
+          @dbus_proposal.introspect
+        end
+
+        # @return [String]
+        def service_name
+          @service_name ||= "org.opensuse.DInstaller.Software"
+        end
+
+        # Available products for the installation
+        #
+        # @return [Array<Array<String, String>>] name and display name of each product
+        def available_products
+          dbus_object["org.opensuse.DInstaller.Software1"]["AvailableBaseProducts"].map do |l|
+            l[0..1]
+          end
+        end
+
+        # Product selected to install
+        #
+        # @return [String] name of the product
+        def selected_product
+          dbus_object["org.opensuse.DInstaller.Software1"]["SelectedBaseProduct"]
+        end
+
+        # Selects the product to install
+        #
+        # @param name [String]
+        def select_product(name)
+          dbus_object.SelectProduct(name)
+        end
+
+        # Starts the probing process
+        #
+        # If a block is given, the method returns immediately and the probing is performed in an
+        # asynchronous way.
+        #
+        # @param done [Proc] Block to execute once the probing is done
+        def probe(&done)
+          dbus_object.Probe(&done)
+        end
+
+        # Performs the packages installation
+        def install
+          dbus_object.Install
+        end
+
+        # Makes the software proposal
+        def propose
+          dbus_object.Propose
+        end
+
+        # Finishes the software installation
+        def finish
+          dbus_object.Finish
+        end
+
+        # Determine whether the given tag are provided by the selected packages
+        #
+        # @param tag [String] Tag to search for (package names, requires/provides, or file
+        #   names)
+        # @return [Boolean] true if it is provided; false otherwise
+        def provision_selected?(tag)
+          dbus_object.ProvisionSelected(tag)
+        end
+
+        # Determine whether the given tags are provided by the selected packages
+        #
+        # @param tags [Array<String>] Tags to search for (package names, requires/provides, or file
+        #   names)
+        # @return [Array<Boolean>] An array containing whether each tag is selected or not
+        def provisions_selected?(tags)
+          dbus_object.ProvisionsSelected(tags)
+        end
+
+        # Add the given list of resolvables to the packages proposal
+        #
+        # @param unique_id [String] Unique identifier for the resolvables list
+        # @param type [Symbol] Resolvables type (:package or :pattern)
+        # @param resolvables [Array<String>] Resolvables to add
+        # @param [Boolean] optional True for optional list, false (the default) for
+        #   the required list
+        def add_resolvables(unique_id, type, resolvables, optional: false)
+          dbus_proposal.AddResolvables(unique_id, TYPES.index(type), resolvables, optional)
+        end
+
+        # Returns a list of resolvables
+        #
+        # @param unique_id [String] Unique identifier for the resolvables list
+        # @param type [Symbol] Resolvables type (:package or :pattern)
+        # @param [Boolean] optional True for optional list, false (the default) for
+        #   the required list
+        # @return [Array<String>] Resolvables
+        def get_resolvables(unique_id, type, optional: false)
+          dbus_proposal.GetResolvables(unique_id, TYPES.index(type), optional).first
+        end
+
+        # Replace a list of resolvables in the packages proposal
+        #
+        # @param unique_id [String] Unique identifier for the resolvables list
+        # @param type [Symbol] Resolvables type (:package or :pattern)
+        # @param resolvables [Array<String>] List of resolvables
+        # @param [Boolean] optional True for optional list, false (the default) for
+        #   the required list
+        def set_resolvables(unique_id, type, resolvables, optional: false)
+          dbus_proposal.SetResolvables(unique_id, TYPES.index(type), resolvables, optional)
+        end
+
+        # Remove resolvables from a list
+        #
+        # @param unique_id [String] Unique identifier for the resolvables list
+        # @param type [Symbol] Resolvables type (:package or :pattern)
+        # @param resolvables [Array<String>] Resolvables to remove
+        # @param [Boolean] optional True for optional list, false (the default) for
+        #   the required list
+        def remove_resolvables(unique_id, type, resolvables, optional: false)
+          dbus_proposal.RemoveResolvables(unique_id, TYPES.index(type), resolvables, optional)
+        end
+
+        # Registers a callback to run when the product changes
+        #
+        # @note Signal subscription is done only once. Otherwise, the latest subscription overrides
+        #   the previous one.
+        #
+        # @param block [Proc] Callback to run when a product is selected
+        def on_product_selected(&block)
+          on_properties_change(dbus_object) do |_, changes, _|
+            base_product = changes["SelectedBaseProduct"]
+            block.call(base_product) unless base_product.nil?
+          end
+        end
+
+      private
+
+        # @return [::DBus::Object]
+        attr_reader :dbus_object
+
+        # @return [::DBus::Object]
+        attr_reader :dbus_proposal
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/clients/users.rb

@@ -0,0 +1,112 @@
+# 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/clients/base"
+require "dinstaller/dbus/clients/with_service_status"
+
+module DInstaller
+  module DBus
+    module Clients
+      # D-Bus client for users configuration
+      class Users < Base
+        include WithServiceStatus
+
+        def initialize
+          super
+
+          @dbus_object = service["/org/opensuse/DInstaller/Users1"]
+          @dbus_object.introspect
+        end
+
+        # @return [String]
+        def service_name
+          @service_name ||= "org.opensuse.DInstaller.Users"
+        end
+
+        # Configuration of the first user to create during the installation
+        #
+        # @return [Array<String, String, Boolean>] full name, name and autologin
+        def first_user
+          dbus_object["org.opensuse.DInstaller.Users1"]["FirstUser"][0..2]
+        end
+
+        # Configures the first user to create during the installation
+        #
+        # @param name [String]
+        # @param fullname [String, nil]
+        # @param password [String, nil]
+        # @param autologin [Boolean]
+        def create_first_user(name, fullname: nil, password: nil, autologin: false)
+          dbus_object.SetFirstUser(fullname.to_s, name, password.to_s, !!autologin, {})
+        end
+
+        # Removes the configuration of the first user
+        def remove_first_user
+          dbus_object.RemoveFirstUser
+        end
+
+        # SSH key for root
+        #
+        # @return [String] empty if no SSH key set
+        def root_ssh_key
+          dbus_object["org.opensuse.DInstaller.Users1"]["RootSSHKey"]
+        end
+
+        # Sets the SSH key for root
+        #
+        # @param value [String]
+        def root_ssh_key=(value)
+          dbus_object.SetRootSSHKey(value)
+        end
+
+        # Whether the root password is set
+        #
+        # @return [Boolean]
+        def root_password?
+          dbus_object["org.opensuse.DInstaller.Users1"]["RootPasswordSet"]
+        end
+
+        # Sets the root password
+        #
+        # @param value [String]
+        def root_password=(value)
+          dbus_object.SetRootPassword(value, false)
+        end
+
+        # Removes the SSH key and password for root
+        def remove_root_info
+          dbus_object.RemoveRootPassword
+          dbus_object.SetRootSSHKey("")
+        end
+
+        # Commit the changes
+        def write
+          dbus_object.Write
+        end
+
+      private
+
+        # @return [::DBus::Object]
+        attr_reader :dbus_object
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/clients/with_progress.rb

@@ -0,0 +1,56 @@
+# 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/interfaces/progress"
+
+module DInstaller
+  module DBus
+    module Clients
+      # Mixin for clients of services that define the Progress D-Bus interface
+      #
+      # Provides methods to interact with the API of the Progress interface.
+      #
+      # @note This mixin is expected to be included in a class inherited from {Clients::Base} and
+      #   it requires a #dbus_object method that returns a {::DBus::Object} implementing the
+      #   Progress interface.
+      module WithProgress
+        # Registers a callback to run when the progress changes
+        #
+        # @param block [Proc]
+        # @yieldparam total_steps [Integer]
+        # @yieldparam current_step [Integer]
+        # @yieldparam message [String]
+        # @yieldparam finished [Boolean]
+        def on_progress_change(&block)
+          on_properties_change(dbus_object) do |interface, changes, _|
+            if interface == Interfaces::Progress::PROGRESS_INTERFACE
+              total_steps = changes["TotalSteps"]
+              current_step = changes["CurrentStep"][0]
+              message = changes["CurrentStep"][1]
+              finished = changes["Finished"]
+              block.call(total_steps, current_step, message, finished)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/clients/with_service_status.rb

@@ -0,0 +1,75 @@
+# 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/service_status"
+require "dinstaller/dbus/interfaces/service_status"
+
+module DInstaller
+  module DBus
+    module Clients
+      # Mixin for clients of services that define the ServiceStatus D-Bus interface
+      #
+      # Provides methods to interact with the API of the ServiceStatus interface.
+      #
+      # @note This mixin is expected to be included in a class inherited from {Clients::Base} and
+      #   it requires a #dbus_object method that returns a {::DBus::Object} implementing the
+      #   ServiceStatus interface.
+      module WithServiceStatus
+        # Current value of the service status
+        #
+        # @see Interfaces::ServiceStatus
+        #
+        # @return [ServiceStatus::IDLE, ServiceStatus::BUSY]
+        def service_status
+          dbus_status = dbus_object[Interfaces::ServiceStatus::SERVICE_STATUS_INTERFACE]["Current"]
+          to_service_status(dbus_status)
+        end
+
+        # Registers a callback to run when the current status property changes
+        #
+        # @param block [Proc]
+        # @yieldparam service_status [ServiceStatus::IDLE, ServiceStatus::BUSY]
+        def on_service_status_change(&block)
+          on_properties_change(dbus_object) do |interface, changes, _|
+            if interface == Interfaces::ServiceStatus::SERVICE_STATUS_INTERFACE
+              service_status = to_service_status(changes["Current"])
+              block.call(service_status)
+            end
+          end
+        end
+
+        # Converts the D-Bus status value to the equivalent service status value
+        #
+        # @param dbus_status [Integer]
+        # @return [ServiceStatus::IDLE, ServiceStatus::BUSY]
+        def to_service_status(dbus_status)
+          case dbus_status
+          when Interfaces::ServiceStatus::SERVICE_STATUS_IDLE
+            ServiceStatus::IDLE
+          when Interfaces::ServiceStatus::SERVICE_STATUS_BUSY
+            ServiceStatus::BUSY
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/clients.rb

@@ -0,0 +1,34 @@
+# 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 Clients for DBus API.
+    # It provides API to be called from other services.
+    # E.g. Users class is used from other services to call Users DBus API.
+    module Clients
+    end
+  end
+end
+
+require "dinstaller/dbus/clients/dinstaller"
+require "dinstaller/dbus/clients/software"
+require "dinstaller/dbus/clients/users"

data/lib/dinstaller/dbus/interfaces/progress.rb

@@ -0,0 +1,113 @@
+# 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"
+
+module DInstaller
+  module DBus
+    module Interfaces
+      # Mixin to define the Progress D-Bus interface
+      #
+      # @note This mixin is expected to be included in a class inherited from {DBus::BaseObject}
+      #   class and it requires a #backend method that returns an instance of a class including the
+      #   {DInstaller::WithProgress} mixin.
+      #
+      # @example
+      #   class Backend
+      #     include DInstaller::WithProgress
+      #   end
+      #
+      #   class Demo < DInstaller::DBus::BaseObject
+      #     include DInstaller::DBus::Interfaces::Progress
+      #
+      #     def initialize
+      #       super("org.test.Demo")
+      #       register_progress_callbacks
+      #     end
+      #
+      #     def backend
+      #       @backend ||= Backend.new
+      #     end
+      #   end
+      module Progress
+        PROGRESS_INTERFACE = "org.opensuse.DInstaller.Progress1"
+
+        # Total number of steps of the progress
+        #
+        # @return [Integer] 0 if no progress defined
+        def progress_total_steps
+          return 0 unless backend.progress
+
+          backend.progress.total_steps
+        end
+
+        # Current step data
+        #
+        # @return [Array(Number,String)] Step id and description
+        def progress_current_step
+          current_step = backend.progress&.current_step
+          return [0, ""] unless current_step
+
+          [current_step.id, current_step.description]
+        end
+
+        # Whether the progress has finished
+        #
+        # @return [Boolean]
+        def progress_finished
+          return true unless backend.progress
+
+          backend.progress.finished?
+        end
+
+        # D-Bus properties of the Progress interface
+        #
+        # @return [Hash]
+        def progress_properties
+          interfaces_and_properties[PROGRESS_INTERFACE]
+        end
+
+        # Registers callbacks to be called when the progress changes or finishes
+        #
+        # @note This method is expected to be called in the constructor.
+        def register_progress_callbacks
+          backend.on_progress_change do
+            dbus_properties_changed(PROGRESS_INTERFACE, progress_properties, [])
+          end
+
+          backend.on_progress_finish do
+            dbus_properties_changed(PROGRESS_INTERFACE, progress_properties, [])
+          end
+        end
+
+        def self.included(base)
+          base.class_eval do
+            dbus_interface PROGRESS_INTERFACE do
+              dbus_reader :progress_total_steps, "u", dbus_name: "TotalSteps"
+              dbus_reader :progress_current_step, "(us)", dbus_name: "CurrentStep"
+              dbus_reader :progress_finished, "b", dbus_name: "Finished"
+            end
+          end
+        end
+      end
+    end
+  end
+end