
# Copyright (C) 2018 Red Hat, Inc. Jake Hunsaker <jhunsake@redhat.com>

# This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.

from sos.report.plugins import Plugin, RedHatPlugin, PluginOpt


class Fibrechannel(Plugin, RedHatPlugin):

    short_desc = 'Collect information on fibrechannel devices'

    plugin_name = 'fibrechannel'
    profiles = ('hardware', 'storage', 'system')
    files = ('/sys/class/fc_host', '/sys/class/fc_remote_ports')
    option_list = [
        PluginOpt('debug', default=True, desc='collect debugging logs')
    ]

    # vendor specific debug paths
    debug_paths = [
        '/sys/kernel/debug/qla2*/',
        '/sys/kernel/debug/fnic/',
    ]

    def setup(self):
        self.add_device_cmd("udevadm info -a %(dev)s", devices='fibre')
        if self.get_option('debug'):
            self.add_copy_spec(self.debug_paths)

        self.add_cmd_output([
            "hbacmd listhbas",
            "hbacmd ServerAttributes"
        ])

        # collect Hbaattributes and Portattributes of WWN
        listhbas = self.collect_cmd_output("hbacmd listhbas")
        if listhbas['status'] == 0:
            for line in listhbas['output'].splitlines():
                if 'Port WWN' in line:
                    dev = line.split()[3]
                    self.add_cmd_output([
                        f"hbacmd HbaAttributes {dev}",
                        f"hbacmd PortAttributes {dev}",
                        f"hbacmd GetXcvrData {dev}",
                    ])
# vim: set et ts=4 sw=4 :