feat: New parser for /usr/bin/od -An -t d /dev/cpu_dma_latency (#3353)

* New parser for /usr/bin/hexdump -C /dev/cpu_dma_latency command Signed-off-by: Akshay Ghodake <[email protected]> * Updated command from hexdump to od Signed-off-by: Akshay Ghodake <[email protected]>
RedHatInsights · Mar 17, 2022 · fe6ecf4 · fe6ecf4
1 parent 3c98505
commit fe6ecf4
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 0 deletions.
diff --git a/docs/shared_parsers_catalog/od_cpu_dma_latency.rst b/docs/shared_parsers_catalog/od_cpu_dma_latency.rst
@@ -0,0 +1,3 @@
+.. automodule:: insights.parsers.od_cpu_dma_latency
+   :members:
+   :show-inheritance:
diff --git a/insights/parsers/od_cpu_dma_latency.py b/insights/parsers/od_cpu_dma_latency.py
@@ -0,0 +1,36 @@
+"""
+OdCpuDmaLatency - command ``/usr/bin/od -An -t d /dev/cpu_dma_latency``
+=======================================================================
+
+This module provides the class ``OdCpuDmaLatency`` which processes
+``/usr/bin/od -An -t d /dev/cpu_dma_latency`` command output.
+"""
+from insights import parser, CommandParser
+from insights.specs import Specs
+from insights.parsers import SkipException
+
+
+@parser(Specs.od_cpu_dma_latency)
+class OdCpuDmaLatency(CommandParser):
+    """
+    Class for parsing the output of `/usr/bin/od -An -t d /dev/cpu_dma_latency` command.
+
+    Typical output of is::
+
+      2000000000
+
+    Attributes:
+        force_latency(int): A integer containing the value of force_latency.
+
+    Examples:
+        >>> type(cpu_dma_latency)
+        <class 'insights.parsers.od_cpu_dma_latency.OdCpuDmaLatency'>
+        >>> cpu_dma_latency.force_latency
+        2000000000
+    """
+
+    def parse_content(self, content):
+        if content and content[0].isdigit():
+            self.force_latency = int(content[0])
+        else:
+            raise SkipException('Nothing to parse.')
diff --git a/insights/parsers/tests/test_od_cpu_dma_latency.py b/insights/parsers/tests/test_od_cpu_dma_latency.py
@@ -0,0 +1,27 @@
+import doctest
+import pytest
+from insights.parsers import od_cpu_dma_latency
+from insights.parsers.od_cpu_dma_latency import OdCpuDmaLatency
+from insights.tests import context_wrap
+from insights.parsers import SkipException
+
+
+CONTENT_OD_CPU_DMA_LATENCY = """
+  2000000000
+"""
+
+CONTENT_OD_CPU_DMA_LATENCY_EMPTY = ""
+
+
+def test_doc_examples():
+    env = {'cpu_dma_latency': OdCpuDmaLatency(context_wrap(CONTENT_OD_CPU_DMA_LATENCY))}
+    failed, total = doctest.testmod(od_cpu_dma_latency, globs=env)
+    assert failed == 0
+
+
+def test_OdCpuDmaLatency():
+    d = OdCpuDmaLatency(context_wrap(CONTENT_OD_CPU_DMA_LATENCY))
+    assert d.force_latency == 2000000000
+
+    with pytest.raises(SkipException):
+        OdCpuDmaLatency(context_wrap(CONTENT_OD_CPU_DMA_LATENCY_EMPTY))
diff --git a/insights/specs/__init__.py b/insights/specs/__init__.py
@@ -465,6 +465,7 @@ class Specs(SpecSet):
     oc_get_service = RegistryPoint()
     oc_get_configmap = RegistryPoint()
     octavia_conf = RegistryPoint(filterable=True)
+    od_cpu_dma_latency = RegistryPoint()
     odbc_ini = RegistryPoint(filterable=True)
     odbcinst_ini = RegistryPoint()
     open_vm_tools_stat_raw_text_session = RegistryPoint()

diff --git a/insights/specs/default.py b/insights/specs/default.py
@@ -507,6 +507,7 @@ def md5chk_file_list(broker):
     nvme_core_io_timeout = simple_file("/sys/module/nvme_core/parameters/io_timeout")
     oc_get_clusterrole_with_config = simple_command("/usr/bin/oc get clusterrole --config /etc/origin/master/admin.kubeconfig")
     oc_get_clusterrolebinding_with_config = simple_command("/usr/bin/oc get clusterrolebinding --config /etc/origin/master/admin.kubeconfig")
+    od_cpu_dma_latency = simple_command("/usr/bin/od -An -t d /dev/cpu_dma_latency")
     odbc_ini = simple_file("/etc/odbc.ini")
     odbcinst_ini = simple_file("/etc/odbcinst.ini")
     open_vm_tools_stat_raw_text_session = simple_command("/usr/bin/vmware-toolbox-cmd stat raw text session")

diff --git a/insights/specs/insights_archive.py b/insights/specs/insights_archive.py
@@ -190,6 +190,7 @@ class InsightsArchiveSpecs(Specs):
     numeric_user_group_name = simple_file("insights_commands/grep_-c_digit_.etc.passwd_.etc.group")
     oc_get_clusterrole_with_config = simple_file("insights_commands/oc_get_clusterrole_--config_.etc.origin.master.admin.kubeconfig")
     oc_get_clusterrolebinding_with_config = simple_file("insights_commands/oc_get_clusterrolebinding_--config_.etc.origin.master.admin.kubeconfig")
+    od_cpu_dma_latency = simple_file("insights_commands/od_-An_-t_d_.dev.cpu_dma_latency")
     open_vm_tools_stat_raw_text_session = simple_file("insights_commands/vmware-toolbox-cmd_stat_raw_text_session")
     openvswitch_other_config = simple_file("insights_commands/ovs-vsctl_-t_5_get_Open_vSwitch_._other_config")
     ovs_vsctl_list_bridge = simple_file("insights_commands/ovs-vsctl_list_bridge")