First version of devicegraph_conversions

Author: ancorgs

service/lib/agama/storage/devicegraph_conversions.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2025] 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 "agama/storage/devicegraph_conversions/to_json"
+
+module Agama
+  module Storage
+    # Conversions for the Y2Storage devicegraph
+    module DevicegraphConversion
+    end
+  end
+end

service/lib/agama/storage/devicegraph_conversions/to_json.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2025] 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 "agama/storage/devicegraph_conversions/to_json_conversions/device"
+
+module Agama
+  module Storage
+    module DevicegraphConversions
+      # Devicegraph conversion to JSON array according to schema.
+      class ToJSON
+        # @param devicegraph [Y2Storage::Devicegraph]
+        def initialize(devicegraph)
+          @devicegraph = devicegraph
+        end
+
+        # Performs the conversion to array according to the JSON schema.
+        #
+        # @return [Hash]
+        def convert
+          original_devices.map { |d| ToJSONConversions::Device.new(d).convert }
+        end
+
+      private
+
+        # @return [Y2Storage::Devicegraph]
+        attr_reader :devicegraph
+
+        # First-level devices to be included in the JSON representation.
+        #
+        # @return [Array<Y2Storage::Device>]
+        def original_devices
+          devicegraph.disk_devices +
+            devicegraph.stray_blk_devices +
+            devicegraph.software_raids +
+            devicegraph.lvm_vgs
+        end
+      end
+    end
+  end
+end

service/lib/agama/storage/devicegraph_conversions/to_json_conversions/block.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2025] 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 "agama/storage/devicegraph_conversions/to_json_conversions/section"
+require "agama/storage/device_shrinking"
+
+module Agama
+  module Storage
+    module DevicegraphConversions
+      module ToJSONConversions
+        # Section with properties for block devices.
+        class Block < Section
+          # @see Section.apply?
+          def self.apply?(storage_device)
+            storage_device.is?(:blk_device)
+          end
+
+        private
+
+          # @see Section#conversions
+          def conversions
+            {
+              start:     block_start,
+              active:    block_active,
+              encrypted: block_encrypted,
+              udevIds:   block_udev_ids,
+              udevPaths: block_udev_paths,
+              size:      block_size,
+              shrinking: block_shrinking,
+              systems:   block_systems
+            }
+          end
+
+          # Position of the first block of the region.
+          #
+          # @return [Integer]
+          def block_start
+            storage_device.start
+          end
+
+          # Whether the block device is currently active
+          #
+          # @return [Boolean]
+          def block_active
+            storage_device.active?
+          end
+
+          # Whether the block device is encrypted.
+          #
+          # @return [Boolean]
+          def block_encrypted
+            storage_device.encrypted?
+          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
+
+          # Shrinking information.
+          #
+          # @return [Hash]
+          def block_shrinking
+            shrinking = Agama::Storage::DeviceShrinking.new(storage_device)
+
+            if shrinking.supported?
+              { supported: shrinking.min_size.to_i }
+            else
+              { unsupported: shrinking.unsupported_reasons }
+            end
+          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
+        end
+      end
+    end
+  end
+end

service/lib/agama/storage/devicegraph_conversions/to_json_conversions/device.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2025] 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 "agama/storage/devicegraph_conversions/to_json_conversions/sections"
+require "y2storage/device_description"
+
+module Agama
+  module Storage
+    module DevicegraphConversions
+      module ToJSONConversions
+        # Device conversion to JSON hash according to schema.
+        class Device
+          # @param storage_device [Y2Storage::Device]
+          def initialize(storage_device)
+            @storage_device = storage_device
+          end
+
+          # Hash representing the Y2Storage device
+          #
+          # @return [Hash]
+          def convert
+            result = {
+              sid:         device_sid,
+              name:        device_name,
+              description: device_description
+            }
+            add_sections(result)
+            add_nested_devices(result)
+            result
+          end
+
+        private
+
+          # Device to convert
+          # @return [Y2Storage::Device]
+          attr_reader :storage_device
+
+          # 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, include_encryption: true).to_s
+          end
+
+          # Adds the required sub-sections according to the storage object.
+          #
+          # @param hash [Hash] the argument gets modified
+          def add_sections(hash)
+            conversions = Section.subclasses.select { |c| c.apply?(storage_device) }
+
+            conversions.each do |conversion|
+              hash.merge!(conversion.new(storage_device).convert)
+            end
+          end
+
+          # Add nested devices like partitions or LVM logical volumes
+          #
+          # @param hash [Hash] the argument gets modified
+          def add_nested_devices(hash)
+            add_partitions(hash)
+            add_logical_volumes(hash)
+          end
+
+          # @see #add_nested_devices
+          def add_partitions(hash)
+            return unless PartitionTable.apply?(storage_device)
+
+            hash[:partitions] = storage_device.partition_table.partitions.map do |part|
+              self.class.new(part).convert
+            end
+          end
+
+          # @see #add_nested_devices
+          def add_logical_volumes(hash)
+            return unless VolumeGroup.apply?(storage_device)
+
+            hash[:logicalVolumes] = storage_device.lvm_lvs.map do |lv|
+              self.class.new(lv).convert
+            end
+          end
+        end
+      end
+    end
+  end
+end