Add test suite

Author: user

.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Tests
+
+on: 
+  - push
+  - pull_request
+  - workflow_dispatch  # Running workflow manually
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.11"
+        cache: 'pip'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .
+        pip install pytest pytest-mock pytest-cov ipython
+    
+    - name: Run tests with coverage
+      run: |
+        pytest --cov=jumper_extension --cov-report=xml tests/
+    
+    - name: Generate coverage badge
+      uses: tj-actions/coverage-badge-py@v2
+      with:
+        output: coverage.svg
+    
+    - name: Commit coverage badge
+      run: |
+        git config --local user.email "action@github.com"
+        git config --local user.name "GitHub Action"
+        git add coverage.svg
+        git diff --staged --quiet || git commit -m "Update coverage badge"
+        git push 

.gitignore

@@ -1 +1,6 @@
-__pycache__/
+__pycache__/
+*.egg-info/
+.coverage
+htmlcov/
+.pytest_cache/
+coverage.xml

README.md

@@ -1,5 +1,7 @@
 # JUmPER Extension
 
+![Coverage](./coverage.svg)
+
 This is JUmPER IPython extension for real-time performance monitoring in IPython environments and Jupyter notebooks. It allows you to gather performance data on CPU usage, memory consumption, GPU utilization, and I/O operations for individual cells and present it in the notebook/IPython session either as text report or as a plot. The extension can be naturally integrated with [JUmPER Jupyter kernel](https://github.com/score-p/scorep_jupyter_kernel_python/) for most comprehensive analysis of notebook.
 
 ## Installation

tests/conftest.py

@@ -0,0 +1,59 @@
+import pytest
+import os
+import tempfile
+from unittest.mock import Mock, patch
+from IPython.testing.globalipapp import get_ipython
+
+@pytest.fixture
+def ipython():
+    # Try to get actual IPython instance, fallback to mock if not available
+    ip = get_ipython()
+    if ip is not None:
+        return ip
+    
+    # Create a mock IPython instance with required attributes  
+    from IPython.testing import decorators
+    from IPython import InteractiveShell
+    
+    # Create a basic InteractiveShell instance for testing
+    shell = InteractiveShell.instance()
+    shell.events = Mock()
+    shell.register_magics = Mock()
+    shell.events.register = Mock()
+    shell.events.unregister = Mock()
+    
+    return shell
+
+@pytest.fixture
+def temp_dir():
+    with tempfile.TemporaryDirectory() as tmpdir:
+        yield tmpdir
+
+@pytest.fixture
+def mock_cpu_only():
+    """Mock system with 1 CPU (4 cores) and no GPU"""
+    with patch('psutil.cpu_count', return_value=4), \
+         patch('psutil.cpu_percent', return_value=[25.0, 30.0, 20.0, 35.0]), \
+         patch('psutil.virtual_memory') as mock_mem, \
+         patch('psutil.Process') as mock_proc, \
+         patch('jumper_extension.performance_monitor.PYNVML_AVAILABLE', False):
+        mock_mem.return_value.total = 8 * 1024**3
+        mock_mem.return_value.available = 4 * 1024**3
+        mock_proc.return_value.cpu_affinity.return_value = [0, 1, 2, 3]
+        mock_proc.return_value.io_counters.return_value = Mock(read_count=100, write_count=50, read_bytes=1024, write_bytes=512)
+        yield
+
+@pytest.fixture
+def mock_cpu_gpu(mock_cpu_only):
+    """Mock system with 1 CPU (4 cores) and 1 GPU"""
+    with patch('jumper_extension.performance_monitor.PYNVML_AVAILABLE', True), \
+         patch('pynvml.nvmlInit'), \
+         patch('pynvml.nvmlDeviceGetCount', return_value=1), \
+         patch('pynvml.nvmlDeviceGetHandleByIndex', return_value=Mock()), \
+         patch('pynvml.nvmlDeviceGetName', return_value=b'NVIDIA GeForce RTX 3080'), \
+         patch('pynvml.nvmlDeviceGetMemoryInfo') as mock_mem, \
+         patch('pynvml.nvmlDeviceGetUtilizationRates') as mock_util, \
+         patch('pynvml.nvmlDeviceGetTemperature', return_value=65):
+        mock_mem.return_value = Mock(total=10*1024**3, used=2*1024**3, free=8*1024**3)
+        mock_util.return_value = Mock(gpu=75, memory=20)
+        yield 

tests/test_data_handling.py

@@ -0,0 +1,51 @@
+import os
+import pandas as pd
+from jumper_extension.performance_data import PerformanceData
+from jumper_extension.cell_history import CellHistory
+
+def test_performance_data(temp_dir):
+    """Test all PerformanceData functionality"""
+    # Test initialization and empty dataframe
+    data = PerformanceData(num_cpus=2, num_gpus=0)
+    assert data.num_cpus == 2 and data.num_gpus == 0 and len(data.data) == 0
+    assert len(data.to_dataframe()) == 0
+    
+    # Test add_sample and to_dataframe
+    data.add_sample(1234567890, [25.0, 30.0], 4.0, [], [], [], [100, 50, 1024, 512])
+    assert len(data.data) == 1
+    df = data.to_dataframe()
+    assert len(df) == 1 and df['cpu_util_avg'].iloc[0] == 27.5
+    
+    # Test CSV export
+    csv_file = os.path.join(temp_dir, "test.csv")
+    data.export(csv_file)
+    assert os.path.exists(csv_file) and len(pd.read_csv(csv_file)) == 1
+
+def test_performance_data_gpu():
+    """Test GPU functionality and slicing"""
+    data = PerformanceData(num_cpus=2, num_gpus=1)
+    data.add_sample(1234567890, [25.0, 30.0], 4.0, [75.0], [20.0], [60.0], [100, 50, 1024, 512])
+    data.add_sample(1234567891, [35.0, 40.0], 5.0, [80.0], [25.0], [65.0], [200, 60, 2048, 1024])
+    
+    df = data.to_dataframe()
+    assert len(df) == 2 and all(col in df.columns for col in ['gpu_util_avg', 'gpu_band_avg', 'gpu_mem_avg'])
+    assert len(data.to_dataframe(slice_=(0, 0))) == 1
+
+def test_cell_history(capsys, temp_dir):
+    """Test all CellHistory functionality"""
+    history = CellHistory()
+    
+    # Test start/end cell
+    history.start_cell("print('hello')")
+    assert history.current_cell['number'] == 0
+    history.end_cell(None)
+    assert len(history.cells) == 1 and len(history.cell_timestamps) == 1
+    
+    # Test print method
+    history.print()
+    assert "Cell #0" in capsys.readouterr().out
+    
+    # Test export
+    json_file = os.path.join(temp_dir, "history.json")
+    history.export(json_file)
+    assert os.path.exists(json_file) 

tests/test_magic_commands.py

@@ -0,0 +1,183 @@
+import pytest
+from jumper_extension.perfmonitor_magics import perfmonitorMagics, load_ipython_extension, unload_ipython_extension
+from unittest.mock import Mock, patch
+import pandas as pd
+
+def test_initialization_and_basic_operations(ipython, mock_cpu_only):
+    """Test initialization, start/stop, and basic operations"""
+    magics = perfmonitorMagics(ipython)
+    assert magics.monitor is None
+    assert not magics.print_perfreports
+    
+    # Test start/stop cycle with valid interval parsing
+    magics.perfmonitor_start("0.5")
+    assert magics.monitor.interval == 0.5
+    magics.perfmonitor_stop("")
+    
+    # Test already running
+    magics.perfmonitor_start("")
+    magics.perfmonitor_start("")  # Already running
+    magics.perfmonitor_stop("")
+    
+    # Test invalid interval (no monitor running)
+    magics.perfmonitor_start("invalid")  # Invalid interval
+
+def test_no_monitor_error_cases(ipython, mock_cpu_only):
+    """Test all commands that require active monitor"""
+    magics = perfmonitorMagics(ipython)
+    magics.perfmonitor_stop("")
+    magics.perfmonitor_resources("")
+    magics.perfmonitor_plot("")
+    magics.perfmonitor_perfreport("")
+    magics.perfmonitor_export_perfdata("")
+
+def test_resources_and_gpu(ipython, mock_cpu_gpu):
+    """Test resources display with GPU"""
+    magics = perfmonitorMagics(ipython)
+    magics.perfmonitor_start("")
+    magics.perfmonitor_resources("")
+    magics.perfmonitor_stop("")
+
+def test_cell_operations(ipython, mock_cpu_only):
+    """Test cell history and reports"""
+    magics = perfmonitorMagics(ipython)
+    
+    # Test cell history tracking and command
+    cell_info = type('Info', (), {'raw_cell': 'test'})()
+    magics.pre_run_cell(cell_info)
+    result = type('Result', (), {'result': None})()
+    magics.post_run_cell(result)
+    
+    with patch.object(magics.cell_history, 'print'):
+        perfmonitorMagics.cell_history(magics, "")
+    
+    # Test auto-reports
+    magics.perfmonitor_start("")
+    magics.perfmonitor_enable_perfreports("")
+    with patch.object(magics, '_perfreport'):
+        magics.post_run_cell(result)
+    magics.perfmonitor_disable_perfreports("")
+    magics.perfmonitor_stop("")
+
+def test_parse_cell_number(ipython, mock_cpu_only):
+    """Test all cell number parsing scenarios"""
+    magics = perfmonitorMagics(ipython)
+    assert magics._parse_cell_number("") is None
+    assert magics._parse_cell_number("invalid") is False
+    assert magics._parse_cell_number("999") is False
+    
+    # Add valid cell for testing
+    cell_info = type('Info', (), {'raw_cell': 'test'})()
+    magics.pre_run_cell(cell_info)
+    result = type('Result', (), {'result': None})()
+    magics.post_run_cell(result)
+    assert magics._parse_cell_number("0") is not None
+
+def test_plot_scenarios(ipython, mock_cpu_only):
+    """Test plotting with various data scenarios"""
+    magics = perfmonitorMagics(ipython)
+    magics.perfmonitor_start("")
+    
+    # Test invalid cell
+    magics.perfmonitor_plot("invalid")
+    
+    # Test empty data
+    with patch.object(magics.monitor.data, 'to_dataframe', return_value=pd.DataFrame(columns=['time'])):
+        magics.perfmonitor_plot("")
+    
+    # Test with data
+    df = pd.DataFrame({'time': [1.0, 2.0], 'cpu_util_avg': [50.0, 60.0]})
+    with patch.object(magics.monitor.data, 'to_dataframe', return_value=df), \
+         patch.object(magics.visualizer, 'plot'), \
+         patch.object(magics.monitor, 'start_time', 0.0):
+        magics.perfmonitor_plot("")
+    
+    # Test with cell filter
+    with patch('time.time', side_effect=[1.0, 2.0]):
+        cell_info = type('Info', (), {'raw_cell': 'test'})()
+        magics.pre_run_cell(cell_info)
+        magics.post_run_cell(type('Result', (), {'result': None})())
+    
+    with patch.object(magics.monitor.data, 'to_dataframe', return_value=df), \
+         patch.object(magics.visualizer, 'plot'), \
+         patch.object(magics.monitor, 'start_time', 0.0):
+        magics.perfmonitor_plot("0")
+    
+    magics.perfmonitor_stop("")
+
+def test_perfreport_scenarios(ipython, mock_cpu_only):
+    """Test performance reporting scenarios"""
+    magics = perfmonitorMagics(ipython)
+    
+    # Test no monitor
+    magics._perfreport()
+    
+    magics.perfmonitor_start("")
+    
+    # Test invalid cell for perfreport command
+    magics.perfmonitor_perfreport("invalid")
+    
+    # Add cell to history
+    with patch('time.time', side_effect=[1.0, 2.0]):
+        cell_info = type('Info', (), {'raw_cell': 'test'})()
+        magics.pre_run_cell(cell_info)
+        magics.post_run_cell(type('Result', (), {'result': None})())
+    
+    # Test empty data
+    with patch.object(magics.monitor.data, 'to_dataframe', return_value=pd.DataFrame(columns=['time'])):
+        magics._perfreport()
+    
+    # Test with full data
+    df = pd.DataFrame({
+        'time': [1.0, 2.0], 'cpu_util_avg': [50.0, 60.0], 'memory_usage_gb': [4.0, 4.5],
+        'gpu_util_avg': [30.0, 40.0], 'gpu_mem_avg': [2.0, 2.5]
+    })
+    with patch.object(magics.monitor.data, 'to_dataframe', return_value=df):
+        magics._perfreport()
+        magics._perfreport((1.0, 2.0))  # Custom cell marks
+        magics.perfmonitor_perfreport("0")  # Via command
+    
+    # Test with missing columns
+    df_partial = pd.DataFrame({'time': [1.0, 2.0], 'cpu_util_avg': [50.0, 60.0], 'memory_usage_gb': [4.0, 4.5]})
+    with patch.object(magics.monitor.data, 'to_dataframe', return_value=df_partial):
+        magics._perfreport()
+    
+    magics.perfmonitor_stop("")
+
+def test_export_and_help(ipython, mock_cpu_only):
+    """Test export functions and help"""
+    magics = perfmonitorMagics(ipython)
+    
+    # Test exports without monitor
+    magics.perfmonitor_export_perfdata("")
+    
+    # Test exports with monitor
+    magics.perfmonitor_start("")
+    with patch.object(magics.monitor.data, 'export'):
+        magics.perfmonitor_export_perfdata("")
+        magics.perfmonitor_export_perfdata("custom.csv")
+    magics.perfmonitor_stop("")
+    
+    # Test cell history export
+    with patch.object(magics.cell_history, 'export'):
+        magics.perfmonitor_export_cell_history("")
+        magics.perfmonitor_export_cell_history("custom.json")
+    
+    # Test help
+    magics.perfmonitor_help("")
+
+def test_extension_lifecycle(ipython, mock_cpu_only):
+    """Test IPython extension load/unload"""
+    with patch.object(ipython.events, 'register'), patch.object(ipython, 'register_magics'):
+        load_ipython_extension(ipython)
+    
+    # Test unload with monitor
+    from jumper_extension.perfmonitor_magics import _perfmonitor_magics
+    _perfmonitor_magics.perfmonitor_start("")
+    with patch.object(ipython.events, 'unregister'):
+        unload_ipython_extension(ipython)
+    
+    # Test unload without magics
+    from jumper_extension import perfmonitor_magics
+    perfmonitor_magics._perfmonitor_magics = None
+    unload_ipython_extension(ipython)