wperf-cmn-visualizer 0.1.0__tar.gz

wperf_cmn_visualizer-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Arm Limited
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

wperf_cmn_visualizer-0.1.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: wperf-cmn-visualizer
+Version: 0.1.0
+Summary: A GUI-based visualizer for Arm CMN (Coherent Mesh Network) systems using WindowsPerf backend
+License: BSD-3-Clause
+Requires-Python: >=3.12.4
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ttkbootstrap
+Requires-Dist: numpy
+Requires-Dist: pandas
+Dynamic: license-file
+
+# CMN Mesh Visualizer
+
+This is a Python project that uses WindowsPerf as a backend to provide a GUI-based visualiser for Arm CMN (Coherent Mesh Network) systems. It enables visual analysis of topology, traffic, and performance metrics using PMU data from XPs, DTCs, and related components—helping engineers identify bottlenecks and understand system behaviour across complex SoCs.
+
+## Installation
+
+To install the project locally:
+
+```bash
+pip install .
+```
+For development mode installation:
+
+```bash
+pip install -e .
+```
+
+## Project Structure
+
+```bash
+cmn-mesh-visualizer/
+├── wperf-cmn-visualizer/     # Main Python module containing *.py implementation files
+│   └── *.py
+├── tests/                    # Test suite containing *.py test files
+│   └── *.py
+└── pyproject.toml            # Project build and dependency metadata
+```
+
+## Contributing
+
+To contribute to the project follow our [Contributing Guidelines](CONTRIBUTING.md).
+
+## License
+
+All code in this repository is licensed under the [BSD 3-Clause License](LICENSE)

wperf_cmn_visualizer-0.1.0/README.md

@@ -0,0 +1,35 @@
+# CMN Mesh Visualizer
+
+This is a Python project that uses WindowsPerf as a backend to provide a GUI-based visualiser for Arm CMN (Coherent Mesh Network) systems. It enables visual analysis of topology, traffic, and performance metrics using PMU data from XPs, DTCs, and related components—helping engineers identify bottlenecks and understand system behaviour across complex SoCs.
+
+## Installation
+
+To install the project locally:
+
+```bash
+pip install .
+```
+For development mode installation:
+
+```bash
+pip install -e .
+```
+
+## Project Structure
+
+```bash
+cmn-mesh-visualizer/
+├── wperf-cmn-visualizer/     # Main Python module containing *.py implementation files
+│   └── *.py
+├── tests/                    # Test suite containing *.py test files
+│   └── *.py
+└── pyproject.toml            # Project build and dependency metadata
+```
+
+## Contributing
+
+To contribute to the project follow our [Contributing Guidelines](CONTRIBUTING.md).
+
+## License
+
+All code in this repository is licensed under the [BSD 3-Clause License](LICENSE)

wperf_cmn_visualizer-0.1.0/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "wperf-cmn-visualizer"
+version = "0.1.0"
+description = "A GUI-based visualizer for Arm CMN (Coherent Mesh Network) systems using WindowsPerf backend"
+readme = "README.md"
+license = {text = "BSD-3-Clause"}
+requires-python = ">=3.12.4"
+dependencies = [
+    "ttkbootstrap",
+    "numpy",
+    "pandas",
+]
+
+[project.scripts]
+wperf-cmn-visualizer = "wperf_cmn_visualizer.__main__:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["wperf_cmn_visualizer*"]

wperf_cmn_visualizer-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

wperf_cmn_visualizer-0.1.0/tests/test_canvas.py

@@ -0,0 +1,145 @@
+# BSD 3-Clause License
+#
+# Copyright (c) 2025, Arm Limited
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from
+#    this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import tkinter as tk
+import ttkbootstrap as tb
+from unittest.mock import Mock
+from wperf_cmn_visualizer.canvas import ZoomPanCanvas
+from wperf_cmn_visualizer.config import Config
+
+
+class TestZoomPanCanvas:
+    """Tests for ZoomPanCanvas to ensure basic callbacks work"""
+    def setup_method(self):
+        """
+        Constructor Hook to set up tests. Pytest Provided
+        """
+        self.root = tb.Window()
+        self.root.withdraw()
+        self.root.update()
+        # mock redraw function and mouse hover callback function
+        self.redraw_mock = Mock()
+        self.mock_hover = Mock()
+        self.canvas = ZoomPanCanvas(self.root, redraw_callback=self.redraw_mock, width=100, height=100)
+        self.canvas.hover_callback = self.mock_hover
+
+    def teardown_method(self):
+        """
+        Destructor Hook to clean up. Pytest provided
+        """
+        self.canvas.destroy()
+        self.root.destroy()
+
+    def test_initial_state(self):
+        """
+        Test to ensure proper initialisation
+        """
+        assert self.canvas.offset_x == 0.0
+        assert self.canvas.offset_y == 0.0
+        assert self.canvas.zoom_scale == Config.DEFAULT_ZOOM
+
+    def test_pan_updates_offsets(self):
+        """
+        Test to ensure panning works.
+        Ensure redraw is called.
+        """
+        event_press = Mock(x=10, y=10)
+        self.canvas._start_pan(event_press)
+        assert self.canvas._pan_start_x == 10
+        assert self.canvas._pan_start_y == 10
+
+        event_drag = Mock(x=20, y=30)
+        self.canvas._do_pan(event_drag)
+        # Offsets should be updated by dx=10, dy=20
+        assert self.canvas.offset_x == 10
+        assert self.canvas.offset_y == 20
+        self.redraw_mock.assert_called()
+
+    def test_hover_callback_invoked(self):
+        """
+        Ensure house hover callback is called.
+        """
+        event_move = Mock(x=50, y=60)
+        self.canvas._on_mouse_move(event_move)
+
+        expected_x = (50 - self.canvas.offset_x) / self.canvas.zoom_scale
+        expected_y = (60 - self.canvas.offset_y) / self.canvas.zoom_scale
+        # redraw is not called. hover call back is responsible for this
+        self.mock_hover.assert_called_with(expected_x, expected_y)
+
+    def test_zoom_in_updates_scale(self):
+        """
+        Simulate scrolling with Mouse Wheel.
+        Check if canvas zoom scale is changed.
+        Ensure redraw is called.
+        """
+        event_zoom_in = Mock()
+        event_zoom_in.type = tk.EventType.MouseWheel
+        event_zoom_in.delta = 120
+        event_zoom_in.x = 50
+        event_zoom_in.y = 50
+
+        old_scale = self.canvas.zoom_scale
+
+        self.canvas._do_zoom(event_zoom_in)
+        assert self.canvas.zoom_scale > old_scale
+        self.redraw_mock.assert_called()
+
+    def test_zoom_out_updates_scale(self):
+        """
+        Simulate scrolling with Mouse Wheel.
+        Check if canvas zoom scale is changed.
+        Ensure redraw is called.
+        """
+        event_zoom_in = Mock()
+        event_zoom_in.type = tk.EventType.MouseWheel
+        event_zoom_in.delta = -120
+        event_zoom_in.x = 50
+        event_zoom_in.y = 50
+
+        old_scale = self.canvas.zoom_scale
+
+        self.canvas._do_zoom(event_zoom_in)
+        assert self.canvas.zoom_scale < old_scale
+        self.redraw_mock.assert_called()
+
+    def test_dynamic_grid_cell_size_scales_with_zoom(self):
+        """
+        Test that grid cell size increases with zoom scale.
+        """
+        base_size = Config.GRID_CELL_SIZE
+        self.canvas.zoom_scale = 1.0
+        size_at_1x = self.canvas.get_dynamic_grid_cell_size()
+
+        self.canvas.zoom_scale = 2.0
+        size_at_2x = self.canvas.get_dynamic_grid_cell_size()
+
+        assert size_at_1x == base_size
+        assert size_at_2x > size_at_1x

wperf_cmn_visualizer-0.1.0/tests/test_cli_args.py

@@ -0,0 +1,50 @@
+# BSD 3-Clause License
+#
+# Copyright (c) 2025, Arm Limited
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from
+#    this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from common import patch_argv
+
+from wperf_cmn_visualizer.__main__ import parse_args
+from wperf_cmn_visualizer.config import Config
+
+
+class TestArgParser:
+    """Tests for the command-line argument parser."""
+
+    def test_default_topology_file(self):
+        """Verify that the default topology file is set when no argument is provided."""
+        with patch_argv(['cmn-visualizer']):
+            args = parse_args()
+            assert args.topology == Config.DEFAULT_TOPOLOGY_FILE
+
+    def test_custom_topology_file(self):
+        """Verify that a custom topology file is correctly parsed from the CLI."""
+        with patch_argv(['cmn-visualizer', '--topology', 'my_topology.json']):
+            args = parse_args()
+            assert args.topology == 'my_topology.json'