zFCP D-Bus API

[joseivanlopez]

Problem

The storage service already provides a D-Bus API for managing iSCSI and DASD devices, but zFCP is not supported yet.

Solution

Add D-Bus API for managing zFCP devices (requires yast/yast-s390#105).

Show API

s390vsl111:~ # busctl --address unix:path=/run/agama/bus tree org.opensuse.Agama.Storage1
└─/org
  └─/org/opensuse
    └─/org/opensuse/Agama
      └─/org/opensuse/Agama/Storage1
        ├─/org/opensuse/Agama/Storage1/zfcp_controllers
        │ ├─/org/opensuse/Agama/Storage1/zfcp_controllers/1
        │ └─/org/opensuse/Agama/Storage1/zfcp_controllers/2
        └─/org/opensuse/Agama/Storage1/zfcp_disks
          ├─/org/opensuse/Agama/Storage1/zfcp_disks/1
          └─/org/opensuse/Agama/Storage1/zfcp_disks/2

s390vsl111:~ # busctl --address unix:path=/run/agama/bus introspect org.opensuse.Agama.Storage1 /org/opensuse/Agama/Storage1 org.opensuse.Agama.Storage1.ZFCP.Manager
NAME                                     TYPE      SIGNATURE RESULT/VALUE FLAGS
.Probe                                   method    -         -            -

s390vsl111:~ # busctl --address unix:path=/run/agama/bus introspect org.opensuse.Agama.Storage1 /org/opensuse/Agama/Storage1/zfcp_controllers/1 org.opensuse.Agama.Storage1.ZFCP.Controller
NAME                                        TYPE      SIGNATURE RESULT/VALUE FLAGS
.Activate                                   method    -         u            -
.ActivateDisk                               method    ss        u            -
.DeactivateDisk                             method    ss        u            -
.GetLUNs                                    method    s         as           -
.GetWWPNs                                   method    -         as           -
.Active                                     property  b         true         emits-change
.Channel                                    property  s         "0.0.fa00"   emits-change

s390vsl111:~ # busctl --address unix:path=/run/agama/bus introspect org.opensuse.Agama.Storage1 /org/opensuse/Agama/Storage1/zfcp_disks/1 org.opensuse.Agama.Storage1.ZFCP.Disk
NAME                                  TYPE      SIGNATURE RESULT/VALUE         FLAGS
.Channel                              property  s         "0.0.fa00"           emits-change
.LUN                                  property  s         "0x0005000000000000" emits-change
.Name                                 property  s         "/dev/sdb"           emits-change
.WWPN                                 property  s         "0x500507630708d3b3" emits-change

Follow-up:

• zFCP and auto_lun_scan #604
• Simplify code for DASD and iSCSI D-Bus trees  #605

zFCP controller deactivation

Directly deactivating a zFCP controller (e.g. chzdev -d 0.0.fa00) does not deactive its LUNs immediately. It takes some time (minutes) until its LUNs are deactivated (independently on the auto-lun-scan option).

That behaviour has some impact in YaST and Agama. For example:

• If a storage probing is done before the zFCP disks are deactivated, then the zFCP disks will be available for the installation.
• If zFCP probing is done before the zFCP disks are deactivated, then the zFCP disks will be visible in the D-Bus tree.

The YaST module for managing zFCP devices does not offer an option for deactivating a zFCP controller. For now, the Agama D-Bus API will not offer it neither. Lacking of a deativate option has some implications if auto-lun-scan is active. With auto-lun-scan, the zFCP disks cannot be deactivated. So, after activating a controller, there is no way of undoing the disks activation.

Testing

• Added new unit tests
• Tested manually

[coveralls]

Pull Request Test Coverage Report for Build 5245607799

• 276 of 297 (92.93%) changed or added relevant lines in 12 files are covered.
• 1 unchanged line in 1 file lost coverage.
• Overall coverage increased (+0.6%) to 76.826%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
service/lib/agama/dbus/storage/interfaces/dasd_manager.rb	3	4	75.0%
service/lib/agama/dbus/storage/zfcp_controller.rb	42	44	95.45%
service/lib/agama/dbus/base_tree.rb	39	42	92.86%
service/lib/agama/dbus/storage/interfaces/zfcp_manager.rb	21	27	77.78%
service/lib/agama/storage/zfcp.rb	0	9	0.0%

Files with Coverage Reduction	New Missed Lines	%
service/lib/agama/dbus/storage/manager.rb	1	81.94%

Totals
Change from base Build 5244994145:	0.6%
Covered Lines:	5626
Relevant Lines:	7080

---

💛 - Coveralls

[mvidner]

Just nitpicks so far

[mvidner]

This part is about the specific info that I miss in the API docs.

BTW, writing it in the ruby code where I commented it will unfortunately not make it visible at https://opensuse.github.io/agama/dbus/ , maybe I should add some dbus_annotation DSL to ruby-dbus (or even YARDoc comment conversion?)

[joseivanlopez]

This part is about the specific info that I miss in the API docs.

BTW, writing it in the ruby code where I commented it will unfortunately not make it visible at https://opensuse.github.io/agama/dbus/ , maybe I should add some dbus_annotation DSL to ruby-dbus (or even YARDoc comment conversion?)

Yes, ideally I would like to write the documentation directly in the ruby code. Right now there is some duplication because I write some doc in ruby code and also in *.doc.xml. And sometimes I am not sure what to write in one place and the other.

[mvidner]

Thank you, LGTM!