Find space section

service/lib/agama/dbus/storage/device.rb

@@ -21,12 +21,7 @@
 
 require "dbus"
 require "agama/dbus/base_object"
-require "agama/dbus/storage/interfaces/drive"
-require "agama/dbus/storage/interfaces/raid"
-require "agama/dbus/storage/interfaces/multipath"
-require "agama/dbus/storage/interfaces/md"
-require "agama/dbus/storage/interfaces/block"
-require "agama/dbus/storage/interfaces/partition_table"
+require "agama/dbus/storage/interfaces/device"
 
 module Agama
   module DBus
@@ -76,40 +71,14 @@ def storage_device=(value)
         # @return [DevicesTree]
         attr_reader :tree
 
-        # Adds the required interfaces according to the storage object
-        def add_interfaces # rubocop:disable Metrics/CyclomaticComplexity
-          interfaces = []
-          interfaces << Interfaces::Drive if drive?
-          interfaces << Interfaces::Raid if storage_device.is?(:dm_raid)
-          interfaces << Interfaces::Md if storage_device.is?(:md)
-          interfaces << Interfaces::Multipath if storage_device.is?(:multipath)
-          interfaces << Interfaces::Block if storage_device.is?(:blk_device)
-          interfaces << Interfaces::PartitionTable if partition_table?
+        # Adds the required interfaces according to the storage object.
+        def add_interfaces
+          interfaces = Interfaces::Device.constants
+            .map { |c| Interfaces::Device.const_get(c) }
+            .select { |c| c.is_a?(Module) && c.respond_to?(:apply?) && c.apply?(storage_device) }
 
           interfaces.each { |i| singleton_class.include(i) }
         end
-
-        # Whether the storage device is a drive
-        #
-        # Drive and disk device are very close concepts, but there are subtle differences. For
-        # example, a MD RAID is never considered as a drive.
-        #
-        # TODO: Revisit the defintion of drive. Maybe some MD devices could implement the drive
-        #   interface if hwinfo provides useful information for them.
-        #
-        # @return [Boolean]
-        def drive?
-          storage_device.is?(:disk, :dm_raid, :multipath, :dasd) && storage_device.is?(:disk_device)
-        end
-
-        # Whether the storage device has a partition table
-        #
-        # @return [Boolean]
-        def partition_table?
-          storage_device.is?(:blk_device) &&
-            storage_device.respond_to?(:partition_table?) &&
-            storage_device.partition_table?
-        end
       end
     end
   end

service/lib/agama/dbus/storage/interfaces.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) [2023] SUSE LLC
+# Copyright (c) [2023-2024] SUSE LLC
 #
 # All Rights Reserved.
 #
@@ -22,17 +22,13 @@
 module Agama
   module DBus
     module Storage
-      # Module for storage specific D-Bus interfaces
+      # Module for D-Bus interfaces of storage.
       module Interfaces
       end
     end
   end
 end
 
-require "agama/dbus/storage/interfaces/drive"
-require "agama/dbus/storage/interfaces/raid"
-require "agama/dbus/storage/interfaces/multipath"
-require "agama/dbus/storage/interfaces/md"
-require "agama/dbus/storage/interfaces/block"
-require "agama/dbus/storage/interfaces/partition_table"
 require "agama/dbus/storage/interfaces/dasd_manager"
+require "agama/dbus/storage/interfaces/device"
+require "agama/dbus/storage/interfaces/zfcp_manager"

service/lib/agama/dbus/storage/interfaces/raid.rb → service/lib/agama/dbus/storage/interfaces/device.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) [2023] SUSE LLC
+# Copyright (c) [2024] SUSE LLC
 #
 # All Rights Reserved.
 #
@@ -19,37 +19,23 @@
 # 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 Agama
   module DBus
     module Storage
       module Interfaces
-        # Interface for DM RAID devices
-        #
-        # @note This interface is intended to be included by {Device} if needed.
-        module Raid
-          RAID_INTERFACE = "org.opensuse.Agama.Storage1.RAID"
-          private_constant :RAID_INTERFACE
-
-          # Devices used by the DM RAID
-          #
-          # TODO: return object paths
-          #
-          # @return [Array<String>]
-          def raid_devices
-            storage_device.parents.map(&:name)
-          end
-
-          def self.included(base)
-            base.class_eval do
-              dbus_interface RAID_INTERFACE do
-                dbus_reader :raid_devices, "as", dbus_name: "Devices"
-              end
-            end
-          end
+        # Module for D-Bus interfaces of a device.
+        module Device
         end
       end
     end
   end
 end
+
+require "agama/dbus/storage/interfaces/device/block"
+require "agama/dbus/storage/interfaces/device/component"
+require "agama/dbus/storage/interfaces/device/drive"
+require "agama/dbus/storage/interfaces/device/filesystem"
+require "agama/dbus/storage/interfaces/device/md"
+require "agama/dbus/storage/interfaces/device/multipath"
+require "agama/dbus/storage/interfaces/device/partition_table"
+require "agama/dbus/storage/interfaces/device/raid"

service/lib/agama/dbus/storage/interfaces/device/block.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2023-2024] 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 Agama
+  module DBus
+    module Storage
+      module Interfaces
+        module Device
+          # Interface for block devices.
+          #
+          # @note This interface is intended to be included by {Agama::DBus::Storage::Device} if
+          #   needed.
+          module Block
+            # Whether this interface should be implemented for the given device.
+            #
+            # @note Block devices implement this interface.
+            #
+            # @param storage_device [Y2Storage::Device]
+            # @return [Boolean]
+            def self.apply?(storage_device)
+              storage_device.is?(:blk_device)
+            end
+
+            BLOCK_INTERFACE = "org.opensuse.Agama.Storage1.Block"
+            private_constant :BLOCK_INTERFACE
+
+            # Name of the block device
+            #
+            # @return [String] e.g., "/dev/sda"
+            def block_name
+              storage_device.name
+            end
+
+            # Whether the block device is currently active
+            #
+            # @return [Boolean]
+            def block_active
+              storage_device.active?
+            end
+
+            # Name of the udev by-id links
+            #
+            # @return [Array<String>]
+            def block_udev_ids
+              storage_device.udev_ids
+            end
+
+            # Name of the udev by-path links
+            #
+            # @return [Array<String>]
+            def block_udev_paths
+              storage_device.udev_paths
+            end
+
+            # Size of the block device in bytes
+            #
+            # @return [Integer]
+            def block_size
+              storage_device.size.to_i
+            end
+
+            # Size of the space that could be theoretically reclaimed by shrinking the device.
+            #
+            # @return [Integer]
+            def block_recoverable_size
+              storage_device.recoverable_size.to_i
+            end
+
+            # Name of the currently installed systems
+            #
+            # @return [Array<String>]
+            def block_systems
+              return @systems if @systems
+
+              filesystems = storage_device.descendants.select { |d| d.is?(:filesystem) }
+              @systems = filesystems.map(&:system_name).compact
+            end
+
+            def self.included(base)
+              base.class_eval do
+                dbus_interface BLOCK_INTERFACE  do
+                  dbus_reader :block_name, "s", dbus_name: "Name"
+                  dbus_reader :block_active, "b", dbus_name: "Active"
+                  dbus_reader :block_udev_ids, "as", dbus_name: "UdevIds"
+                  dbus_reader :block_udev_paths, "as", dbus_name: "UdevPaths"
+                  dbus_reader :block_size, "t", dbus_name: "Size"
+                  dbus_reader :block_recoverable_size, "t", dbus_name: "RecoverableSize"
+                  dbus_reader :block_systems, "as", dbus_name: "Systems"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end