Extend storage D-Bus API (#1082)

## Problem

More information is required to properly represent the storage proposal
result:

* Device description
* Filesystem label

This is a follow-up of #1071.

## Solution

Add new D-Bus interfaces `Device` , `Partition`, `LVM.LogicalVolume` and
adapt `Filesystem` interface.

This changes require yast/yast-storage-ng#1373.

NOTE: This PR goes to a feature branch instead of master.

## Testing

* Added unit tests
* Tested manually

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

@@ -33,10 +33,13 @@ module Device
 
 require "agama/dbus/storage/interfaces/device/block"
 require "agama/dbus/storage/interfaces/device/component"
+require "agama/dbus/storage/interfaces/device/device"
 require "agama/dbus/storage/interfaces/device/drive"
 require "agama/dbus/storage/interfaces/device/filesystem"
+require "agama/dbus/storage/interfaces/device/lvm_lv"
 require "agama/dbus/storage/interfaces/device/lvm_vg"
 require "agama/dbus/storage/interfaces/device/md"
 require "agama/dbus/storage/interfaces/device/multipath"
+require "agama/dbus/storage/interfaces/device/partition"
 require "agama/dbus/storage/interfaces/device/partition_table"
 require "agama/dbus/storage/interfaces/device/raid"

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

@@ -44,13 +44,6 @@ def self.apply?(storage_device)
             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
-
             # Position of the first block of the region.
             #
             # @return [Integer]
@@ -112,8 +105,7 @@ def block_systems
 
             def self.included(base)
               base.class_eval do
-                dbus_interface BLOCK_INTERFACE  do
-                  dbus_reader :block_name, "s", dbus_name: "Name"
+                dbus_interface BLOCK_INTERFACE do
                   dbus_reader :block_start, "t", dbus_name: "Start"
                   dbus_reader :block_active, "b", dbus_name: "Active"
                   dbus_reader :block_encrypted, "b", dbus_name: "Encrypted"

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright (c) [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"
+require "y2storage/device_description"
+
+module Agama
+  module DBus
+    module Storage
+      module Interfaces
+        module Device
+          # Interface for a device.
+          #
+          # @note This interface is intended to be included by {Agama::DBus::Storage::Device}.
+          module Device
+            # Whether this interface should be implemented for the given device.
+            #
+            # @note All devices implement this interface.
+            #
+            # @param _storage_device [Y2Storage::Device]
+            # @return [Boolean]
+            def self.apply?(_storage_device)
+              true
+            end
+
+            DEVICE_INTERFACE = "org.opensuse.Agama.Storage1.Device"
+            private_constant :DEVICE_INTERFACE
+
+            # sid of the device.
+            #
+            # @return [Integer]
+            def device_sid
+              storage_device.sid
+            end
+
+            # Name to represent the device.
+            #
+            # @return [String] e.g., "/dev/sda".
+            def device_name
+              storage_device.display_name || ""
+            end
+
+            # Description of the device.
+            #
+            # @return [String] e.g., "EXT4 Partition".
+            def device_description
+              Y2Storage::DeviceDescription.new(storage_device).to_s
+            end
+
+            def self.included(base)
+              base.class_eval do
+                dbus_interface DEVICE_INTERFACE do
+                  dbus_reader :device_sid, "u", dbus_name: "SID"
+                  dbus_reader :device_name, "s", dbus_name: "Name"
+                  dbus_reader :device_description, "s", dbus_name: "Description"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,7 @@
 # find current contact information at www.suse.com.
 
 require "dbus"
+require "y2storage/filesystem_label"
 
 module Agama
   module DBus
@@ -51,18 +52,26 @@ def filesystem_type
               storage_device.filesystem.type.to_s
             end
 
-            # Whether the filesystem contains the directory layout of an ESP partition.
+            # Mount path of the file system.
             #
-            # @return [Boolean]
-            def filesystem_efi?
-              storage_device.filesystem.efi?
+            # @return [String] Empty if not mounted.
+            def filesystem_mount_path
+              storage_device.filesystem.mount_path || ""
+            end
+
+            # Label of the file system.
+            #
+            # @return [String] Empty if it has no label.
+            def filesystem_label
+              Y2Storage::FilesystemLabel.new(storage_device).to_s
             end
 
             def self.included(base)
               base.class_eval do
                 dbus_interface FILESYSTEM_INTERFACE  do
                   dbus_reader :filesystem_type, "s", dbus_name: "Type"
-                  dbus_reader :filesystem_efi?, "b", dbus_name: "EFI"
+                  dbus_reader :filesystem_mount_path, "s", dbus_name: "MountPath"
+                  dbus_reader :filesystem_label, "s", dbus_name: "Label"
                 end
               end
             end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright (c) [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 LVM logical volume.
+          #
+          # @note This interface is intended to be included by {Agama::DBus::Storage::Device} if
+          #   needed.
+          module LvmLv
+            # Whether this interface should be implemented for the given device.
+            #
+            # @note LVM logical volumes implement this interface.
+            #
+            # @param storage_device [Y2Storage::Device]
+            # @return [Boolean]
+            def self.apply?(storage_device)
+              storage_device.is?(:lvm_lv)
+            end
+
+            LOGICAL_VOLUME_INTERFACE = "org.opensuse.Agama.Storage1.LVM.LogicalVolume"
+            private_constant :LOGICAL_VOLUME_INTERFACE
+
+            # LVM volume group hosting the this logical volume.
+            #
+            # @return [Array<::DBus::ObjectPath>]
+            def lvm_lv_vg
+              tree.path_for(storage_device.lvm_vg)
+            end
+
+            def self.included(base)
+              base.class_eval do
+                dbus_interface LOGICAL_VOLUME_INTERFACE do
+                  dbus_reader :lvm_lv_vg, "o", dbus_name: "VolumeGroup"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -44,13 +44,6 @@ def self.apply?(storage_device)
             VOLUME_GROUP_INTERFACE = "org.opensuse.Agama.Storage1.LVM.VolumeGroup"
             private_constant :VOLUME_GROUP_INTERFACE
 
-            # Name of the volume group
-            #
-            # @return [String] e.g., "/dev/mapper/vg0"
-            def lvm_vg_name
-              storage_device.name
-            end
-
             # Size of the volume group in bytes
             #
             # @return [Integer]
@@ -75,7 +68,6 @@ def lvm_vg_lvs
             def self.included(base)
               base.class_eval do
                 dbus_interface VOLUME_GROUP_INTERFACE do
-                  dbus_reader :lvm_vg_name, "s", dbus_name: "Name"
                   dbus_reader :lvm_vg_size, "t", dbus_name: "Size"
                   dbus_reader :lvm_vg_pvs, "ao", dbus_name: "PhysicalVolumes"
                   dbus_reader :lvm_vg_lvs, "ao", dbus_name: "LogicalVolumes"

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Copyright (c) [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 partition.
+          #
+          # @note This interface is intended to be included by {Agama::DBus::Storage::Device} if
+          #   needed.
+          module Partition
+            # Whether this interface should be implemented for the given device.
+            #
+            # @note Partitions implement this interface.
+            #
+            # @param storage_device [Y2Storage::Device]
+            # @return [Boolean]
+            def self.apply?(storage_device)
+              storage_device.is?(:partition)
+            end
+
+            PARTITION_INTERFACE = "org.opensuse.Agama.Storage1.Partition"
+            private_constant :PARTITION_INTERFACE
+
+            # Device hosting the partition table of this partition.
+            #
+            # @return [Array<::DBus::ObjectPath>]
+            def partition_device
+              tree.path_for(storage_device.partitionable)
+            end
+
+            # Whether it is a (valid) EFI System partition
+            #
+            # @return [Boolean]
+            def partition_efi
+              storage_device.efi_system?
+            end
+
+            def self.included(base)
+              base.class_eval do
+                dbus_interface PARTITION_INTERFACE do
+                  dbus_reader :partition_device, "o", dbus_name: "Device"
+                  dbus_reader :partition_efi, "b", dbus_name: "EFI"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

service/package/gem2rpm.yml

@@ -38,8 +38,7 @@
     Requires:       yast2-iscsi-client >= 4.5.7
     Requires:       yast2-network
     Requires:       yast2-proxy
-    # ProposalSettings#swap_reuse
-    Requires:       yast2-storage-ng >= 5.0.3
+    Requires:       yast2-storage-ng >= 5.0.8
     Requires:       yast2-users
     %ifarch s390 s390x
     Requires:       yast2-s390 >= 4.6.4