d-installer 0.4.2

data/lib/dinstaller/cockpit_manager.rb

@@ -0,0 +1,176 @@
+# 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 "yast2/systemd/service"
+require "cfa/base_model"
+require "transfer/file_from_url"
+require "fileutils"
+
+Yast.import "URL"
+
+module DInstaller
+  # Cockpit configuration file representation
+  #
+  # @example Set the AllowUnencrypted option
+  #   file = CockpitConfig.new
+  #   file.load
+  #   file.web_service["AllowUnencrypted"] = "true"
+  #   file.save
+  class CockpitConfig < CFA::BaseModel
+    # Constructor
+    #
+    # @param path [String] File path
+    # @param file_handler [.read, .write] Object to read/write the file.
+    def initialize(path: DEFAULT_PATH, file_handler: nil)
+      super(CFA::AugeasParser.new("puppet.lns"), path, file_handler: file_handler)
+    end
+
+    # Returns the augeas tree for the "WebService" section
+    #
+    # If the given section does not exist, it returns an empty one
+    #
+    # @param name [String] section name
+    # @return [AugeasTree]
+    def web_service
+      data["WebService"] ||= CFA::AugeasTree.new
+    end
+  end
+
+  # Handles the Cockpit service
+  #
+  # This API offers an API to adjust Cockpit configuration and restart/reload the process. At this
+  # point, just a few options are allowed (@see #setup).
+  class CockpitManager
+    include Yast::Logger
+    include Yast::Transfer::FileFromUrl
+    include Yast::I18n
+
+    # Directory to store Cockpit certificates
+    WS_CERTS_DIR = "/etc/cockpit/ws-certs.d"
+    COCKPIT_SERVICE = "cockpit"
+    COCKPIT_CONF_PATH = "/etc/cockpit/cockpit.conf"
+
+    def initialize(logger, prefix: "/")
+      @prefix = prefix
+      @logger = logger
+    end
+
+    # Adjust Cockpit configuration and restart the process if needed
+    #
+    # If all arguments are nil, the configuration is not modified and the process is not restarted.
+    #
+    # @param config [Hash]
+    #   @option ssl [Boolean,nil] SSL is enabled
+    #   @option ssl_cert [String,nil] SSL/TLS certificate URL
+    #   @option ssl_key  [String,nil] SSL/TLS key URL
+    def setup(options)
+      return if options.values.all?(&:nil?)
+
+      enable_ssl(options["ssl"]) unless options["ssl"].nil?
+      if options["ssl_cert"]
+        copy_ssl_cert(options["ssl_cert"])
+        copy_ssl_key(options["ssl_key"]) unless options["ssl_key"].nil?
+        clear_self_signed_cert
+      end
+
+      restart_cockpit
+    end
+
+  private
+
+    attr_reader :prefix
+
+    # @return [Logger]
+    attr_reader :logger
+
+    # Enable/Disable SSL
+    #
+    # @param enabled [Boolean] Whether to enable or disable SSL
+    def enable_ssl(enabled)
+      path = File.join(prefix, COCKPIT_CONF_PATH)
+      config = CockpitConfig.new(path: path)
+      config.load if File.readable?(path)
+      config.web_service["AllowUnencrypted"] = (!enabled).to_s
+      config.save
+    end
+
+    # Copy the SSL certificate to Cockpit's certificates directory
+    #
+    # The certificate is renamed as `0-d-installer.cert`.
+    #
+    # @param location [String] Certificate location
+    def copy_ssl_cert(location)
+      logger.info "Retrieving SSL certificate from #{location}"
+      copy_file(location, File.join(prefix, WS_CERTS_DIR, "0-d-installer.cert"))
+    end
+
+    # Copy the SSL certificate key to Cockpit's certificates directory
+    #
+    # The certificate is renamed as `0-d-installer.key`.
+    #
+    # @param location [String] Certificate key location
+    def copy_ssl_key(location)
+      logger.info "Retrieving SSL key from #{location}"
+      copy_file(location, File.join(prefix, WS_CERTS_DIR, "0-d-installer.key"))
+    end
+
+    # Remove Cockpit's self signed certificates if they exist
+    def clear_self_signed_cert
+      self_signed = Dir[File.join(prefix, WS_CERTS_DIR, "0-self-signed.*")]
+      ::FileUtils.rm(self_signed)
+    end
+
+    # Copy a file from a potentially remote location
+    #
+    # @param location [String] File location. It might be an URL-like string (e.g.,
+    #   "http://example.net/example.cert").
+    # @param target [String] Path to copy the file to.
+    # @return [Boolean] Whether the file was sucessfully copied or not
+    def copy_file(location, target)
+      url = Yast::URL.Parse(location)
+
+      res = get_file_from_url(
+        scheme:    url["scheme"],
+        host:      url["host"],
+        urlpath:   url["path"],
+        localfile: target,
+        urltok:    url,
+        destdir:   "/"
+      )
+      # TODO: exception?
+      logger.error "script #{location} could not be retrieved" unless res
+      res
+    end
+
+    # Restart the Cockpit service
+    def restart_cockpit
+      logger.info "Restarting Cockpit"
+      service = Yast2::Systemd::Service.find(COCKPIT_SERVICE)
+      if service.nil?
+        logger.error "Could not found #{COCKPIT_SERVICE} service"
+        return
+      end
+
+      service.restart
+    end
+  end
+end

data/lib/dinstaller/config.rb

@@ -0,0 +1,128 @@
+# 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 "yaml"
+require "dinstaller/config_reader"
+
+module DInstaller
+  # Class responsible for getting current configuration.
+  # It is smarter then just plain yaml reader as it also evaluates
+  # conditions in it, so it is result of all conditions in file.
+  # This also means that config needs to be re-evaluated if conditions
+  # data change, like if user pick different distro to install.
+  class Config
+    # @return [Hash] configuration data
+    attr_accessor :pure_data
+
+    class << self
+      attr_accessor :current, :base
+
+      # Loads base and current config reading configuration from the system
+      def load(logger = Logger.new($stdout))
+        @base = ConfigReader.new(logger: logger).config
+        @current = @base&.copy
+      end
+
+      # It resets the configuration internal state
+      def reset
+        @base = nil
+        @current = nil
+      end
+
+      # Load the configuration from a given file
+      #
+      # @param path [String|Pathname] File path
+      def from_file(path)
+        new(YAML.safe_load(File.read(path.to_s)))
+      end
+    end
+
+    # Constructor
+    #
+    # @param config_data [Hash] configuration data
+    def initialize(config_data = nil)
+      @pure_data = config_data
+    end
+
+    # parse loaded yaml file, so it properly applies conditions
+    # with default options it load file without conditions
+    def parse_file(_arch = nil, _distro = nil)
+      # TODO: move to internal only. public one should be something
+      # like evaluate or just setter for distro and arch
+      # logger.info "parse file with #{arch} and #{distro}"
+      # TODO: do real evaluation of conditions
+      data
+    end
+
+    def data
+      return @data if @data
+
+      @data = @pure_data.dup || {}
+      pick_product(@data["products"].keys.first) if @data["products"]
+      @data
+    end
+
+    def pick_product(product)
+      data.merge!(data[product])
+    end
+
+    # Whether there are more than one product
+    #
+    # @return [Boolean] false if there is only one product; true otherwise
+    def multi_product?
+      data["products"].size > 1
+    end
+
+    # Returns a copy of this Object
+    #
+    # @return [Config]
+    def copy
+      Marshal.load(Marshal.dump(self))
+    end
+
+    # Returns a new {Config} with the merge of the given ones
+    #
+    # @params config [Config, Hash]
+    # @return [Config] new Configuration with the merge of the given ones
+    def merge(config)
+      Config.new(simple_merge(data, config.data))
+    end
+
+  private
+
+    # Simple deep merge
+    #
+    # @param a_hash       [Hash] Default values
+    # @param another_hash [Hash] Pillar data
+    # @return [Hash]
+    def simple_merge(a_hash, another_hash)
+      a_hash.reduce({}) do |all, (k, v)|
+        next all.merge(k => v) if another_hash[k].nil?
+
+        if v.is_a?(Hash)
+          all.merge(k => simple_merge(a_hash[k], another_hash[k]))
+        else
+          all.merge(k => another_hash[k])
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/config_reader.rb

@@ -0,0 +1,164 @@
+# 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 "yaml"
+require "logger"
+require "dinstaller/config"
+require "dinstaller/cmdline_args"
+require "transfer/file_from_url"
+
+Yast.import "URL"
+Yast.import "Directory"
+
+module DInstaller
+  # This class is responsible for reading DInstaller configuration from different locations
+  # including kernel cmdline options
+  class ConfigReader
+    include Yast::Transfer::FileFromUrl
+    include Yast::I18n
+
+    # Default DInstaller configuration which should define all the possible values
+    SYSTEM_PATH = "/etc/d-installer.yaml"
+    GIT_PATH = File.expand_path("#{__dir__}/../../etc/d-installer.yaml")
+    REMOTE_BOOT_CONFIG = "d-installer_boot.yaml"
+
+    PATHS = [
+      "/usr/lib/d-installer.d",
+      "/etc/d-installer.d",
+      "/run/d-installer.d"
+    ].freeze
+
+    attr_reader :logger
+    attr_reader :workdir
+
+    # Constructor
+    #
+    # @param logger [Logger]
+    # @param workdir [String] Root directory to read the configuration from
+    def initialize(logger: nil, workdir: "/")
+      @logger = logger || ::Logger.new($stdout)
+      @workdir = workdir
+    end
+
+    # loads correct yaml file
+    def config_from_file(path = nil)
+      raise "Missing config file at #{path}" unless File.exist?(path)
+
+      Config.from_file(path)
+    end
+
+    # Return an {Array} with the different {Config} objects read from the different locations
+    #
+    # TODO: handle precedence correctly
+    #
+    # @returm [Array<Config>] an array with all the configurations read from the system
+    def configs
+      return @configs if @configs
+
+      @configs = config_paths.map { |path| config_from_file(path) }
+      @configs << remote_config if remote_config
+      @configs << cmdline_config if cmdline_config
+      @configs
+    end
+
+    # Return a {Config} oject
+    # @return [Config] resultant Config after merging all the configurations
+    def config
+      config = configs.first || Config.new
+      (configs[1..-1] || []).each { |c| config = config.merge(c) }
+      config
+    end
+
+  private
+
+    # Copy a file from a potentially remote location
+    #
+    # @param location [String] File location. It might be an URL-like string (e.g.,
+    #   "http://example.net/example.yml").
+    # @param target [String] Path to copy the file to.
+    # @return [Boolean] Whether the file was sucessfully copied or not
+    def copy_file(location, target)
+      url = Yast::URL.Parse(location)
+
+      res = get_file_from_url(
+        scheme:    url["scheme"],
+        host:      url["host"],
+        urlpath:   url["path"],
+        localfile: target,
+        urltok:    url,
+        destdir:   "/"
+      )
+
+      # TODO: exception?
+      logger.error "script #{location} could not be retrieved" unless res
+      res
+    end
+
+    # @return [CmdlineArgs]
+    def cmdline_args
+      @cmdline_args ||= CmdlineArgs.read_from(File.join(workdir, "/proc/cmdline"))
+    end
+
+    # return [Config]
+    def cmdline_config
+      Config.new(cmdline_args.data)
+    end
+
+    # return [Config]
+    def remote_config
+      return unless cmdline_args.config_url
+
+      file_path = File.join(Yast::Directory.tmpdir, REMOTE_BOOT_CONFIG)
+      logger.info "Copying boot config to #{file_path}"
+
+      copy_file(cmdline_args.config_url, file_path)
+      config_from_file(file_path)
+    end
+
+    def default_path
+      File.exist?(GIT_PATH) ? GIT_PATH : SYSTEM_PATH
+    end
+
+    def config_paths
+      paths = PATHS.each_with_object([]) do |path, all|
+        all.concat(file_paths_in(File.join(workdir, path)))
+      end
+
+      paths.uniq! { |f| File.basename(f) }
+      # Sort files lexicographic
+      paths.sort_by! { |f| File.basename(f) }
+      paths.prepend(default_path)
+
+      paths
+    end
+
+    def file_paths_in(path)
+      if File.file?(path)
+        [path]
+      elsif File.directory?(path)
+        Dir.glob("#{path}/*.{yml,yaml}")
+      else
+        []
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/base_object.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2021] 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
+    # Base class for DBus objects
+    class BaseObject < ::DBus::Object
+      # Constructor
+      #
+      # @param path [::DBus::ObjectPath]
+      # @param logger [Logger, nil]
+      def initialize(path, logger: nil)
+        @logger = logger || Logger.new($stdout)
+        super(path)
+      end
+
+      # Generates information about interfaces and properties of the object
+      #
+      # Returns a hash containing interfaces names as keys. Each value is the same hash that would
+      # be returned by the org.freedesktop.DBus.Properties.GetAll() method for that combination of
+      # object path and interface. If an interface has no properties, the empty hash is returned.
+      #
+      # @return [Hash]
+      def interfaces_and_properties
+        get_all_method = self.class.make_method_name("org.freedesktop.DBus.Properties", :GetAll)
+
+        intfs.keys.each_with_object({}) do |interface, hash|
+          hash[interface] = public_send(get_all_method, interface).first
+        end
+      end
+
+    private
+
+      # @return [Logger]
+      attr_reader :logger
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# 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 "abstract_method"
+
+module DInstaller
+  module DBus
+    module Clients
+      # Base class for D-Bus clients
+      class Base
+        # @!method service_name
+        #   Name of the D-Bus service
+        #   @return [String]
+        abstract_method :service_name
+
+        # D-Bus service
+        #
+        # @return [::DBus::Service]
+        def service
+          @service ||= bus.service(service_name)
+        end
+
+      private
+
+        # Registers callback to be called when the properties of the given object changes
+        #
+        # @note Signal subscription is done only once. Otherwise, the latest subscription overrides
+        #   the previous one.
+        #
+        # @param dbus_object [::DBus::Object]
+        # @param block [Proc]
+        def on_properties_change(dbus_object, &block)
+          @on_properties_change_callbacks ||= {}
+          @on_properties_change_callbacks[dbus_object.path] ||= []
+          @on_properties_change_callbacks[dbus_object.path] << block
+
+          return if @on_properties_change_callbacks[dbus_object.path].size > 1
+
+          dbus_properties = dbus_object["org.freedesktop.DBus.Properties"]
+          dbus_properties.on_signal("PropertiesChanged") do |interface, changes, invalid|
+            callbacks = @on_properties_change_callbacks[dbus_object.path]
+            callbacks.each { |c| c.call(interface, changes, invalid) }
+          end
+        end
+
+        def bus
+          @bus ||= ::DBus::SystemBus.instance
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/clients/language.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 "dinstaller/dbus/clients/base"
+
+module DInstaller
+  module DBus
+    module Clients
+      # D-Bus client for language configuration
+      class Language < Base
+        def initialize
+          super
+
+          @dbus_object = service.object("/org/opensuse/DInstaller/Language1")
+          @dbus_object.introspect
+        end
+
+        def service_name
+          @service_name ||= "org.opensuse.DInstaller.Language"
+        end
+
+        # Available languages for the installation
+        #
+        # @return [Array<Array<String, String>>] id and name of each language
+        def available_languages
+          dbus_object["org.opensuse.DInstaller.Language1"]["AvailableLanguages"].map { |l| l[0..1] }
+        end
+
+        # Languages selected to install
+        #
+        # @return [Array<String>] ids of the languages
+        def selected_languages
+          dbus_object["org.opensuse.DInstaller.Language1"]["MarkedForInstall"]
+        end
+
+        # Selects the languages to install
+        #
+        # @param ids [Array<String>]
+        def select_languages(ids)
+          dbus_object.ToInstall(ids)
+        end
+
+        # Finishes the language installation
+        def finish
+          dbus_object.Finish
+        end
+
+        # Registers a callback to run when the language changes
+        #
+        # @note Signal subscription is done only once. Otherwise, the latest subscription overrides
+        #   the previous one.
+        #
+        # @param block [Proc] Callback to run when a language is selected
+        def on_language_selected(&block)
+          on_properties_change(dbus_object) do |_, changes, _|
+            languages = changes["MarkedForInstall"]
+            block.call(languages)
+          end
+        end
+
+      private
+
+        # @return [::DBus::Object]
+        attr_reader :dbus_object
+      end
+    end
+  end
+end