[rocprofiler-sdk][CI] Add formatting for counter_defs.yaml file

Author: MythreyaK

.github/workflows/rocprofiler-sdk-formatting.yml

@@ -175,3 +175,35 @@ jobs:
           cat ${OUTFILE}
           exit 1
         fi
+
+  counter_defs:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        sparse-checkout: projects/rocprofiler-sdk
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install ruamel.yaml
+
+    - name: Ensure counter_defs.yaml is formatted
+      working-directory: projects/rocprofiler-sdk
+      run: |
+        python source/scripts/format-deps.py --counter-defs
+        if [ $(git diff -- source/share/rocprofiler-sdk/counter_defs.yaml | wc -l) -ne 0 ]; then
+          echo ""
+          echo "::error::YAML file is not properly formatted. Run the following command to fix:"
+          echo ""
+          echo "  cd projects/rocprofiler-sdk && python source/scripts/format-deps.py --counter-defs"
+          echo ""
+          git diff -- source/share/rocprofiler-sdk/counter_defs.yaml
+          exit 1
+        fi

projects/rocprofiler-sdk/source/scripts/format-deps.py

@@ -24,8 +24,12 @@
 
 
 import argparse
+import io
 import os
 import sys
+from pathlib import Path
+
+from ruamel.yaml import YAML
 
 
 class FormatSource(argparse.Action):
@@ -64,6 +68,23 @@ def __call__(self, parser, namespace, values, option_string=None):
         exit(0)
 
 
+class FormatYAML(argparse.Action):
+    def __call__(self, parser, namespace, values, option_string=None):
+        yaml = YAML()
+        yaml.preserve_quotes = True
+        yaml.width = 120
+        yaml.indent(mapping=2, sequence=4, offset=2)
+        counter_defs = (
+            Path(os.path.dirname(__file__))
+            / "../../source/share/rocprofiler-sdk/counter_defs.yaml"
+        ).resolve()
+        data = yaml.load(counter_defs.read_text())
+        stream = io.StringIO()
+        yaml.dump(data, stream)
+        counter_defs.write_text(stream.getvalue())
+        exit(0)
+
+
 class FormatAll(argparse.Action):
     def __call__(self, parser, namespace, values, option_string=None):
         os.system(
@@ -87,6 +108,7 @@ def __call__(self, parser, namespace, values, option_string=None):
             + "/../../external/*\" | egrep 'CMakeLists.txt|\.cmake$')"
         )
         os.system("black " + os.path.dirname(__file__) + "/../..")
+        FormatYAML.__call__(FormatYAML, parser, namespace, values, option_string)
         exit(0)
 
 
@@ -118,6 +140,9 @@ def __call__(self, parser, namespace, values, option_string=None):
     "-p", "--python", nargs=0, help="format python files", action=FormatPython
 )
 parser.add_argument(
-    "-a", "--all", nargs=0, help="format cmake, source and python files", action=FormatAll
+    "-cd", "--counter-defs", nargs=0, help="format counter_defs.yaml", action=FormatYAML
+)
+parser.add_argument(
+    "-a", "--all", nargs=0, help="format cmake, source, python, and yaml files", action=FormatAll
 )
 parser.parse_args()