Refactor/scaffold by ryanmccann1024 · Pull Request #106 · SDNNetSim/FUSION

ryanmccann1024 · 2025-07-23T19:01:18Z

📝 Description

This pull request completes a comprehensive refactor of the FUSION project, addressing code quality, architectural improvements, and bug fixes. The changes build upon the previous CLI architectural refactor and focus on stabilizing the codebase while removing deprecated functionality.

Key Changes:

🔧 Code Quality & Bug Fixes

Fixed critical metrics processing issues: Resolved duplicate link processing, division by zero errors, and normalization problems in the metrics module
Resolved RL workflow issues: Fixed environment reset logic that was causing unnecessary resets after trial completion
Fixed all pylint violations: Cleaned up import organization, removed unused parameters, and improved code structure in test files

🧹 Code Cleanup & Maintenance

Removed deprecated run scripts: Eliminated run_gui.py, run_ml_sim.py, run_rl_sim.py, and run_sim.py as these have been fully replaced by the new CLI structure
Improved test structure: Refactored test comparison script to follow better patterns with extracted helper functions
Enhanced code organization: Moved imports to proper locations and eliminated code duplication

🏗️ Architectural Improvements

Consolidated CLI functionality: All application entry points now use the unified fusion CLI structure
Improved modularity: Enhanced separation of concerns in metrics processing and RL workflows
Better error handling: Added safeguards for edge cases in statistical calculations

Fixes: Issues with code quality violations and deprecated script usage

🧐 Type of Change

🐛 Bug fix (non-breaking change which fixes an issue)
✨ New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
💅 UI/UX change (improves the user interface or experience)
📚 Documentation update
⚙️ Chore (refactoring, dependency updates, etc.)

💥 Impact of Breaking Change

This PR contains moderate breaking changes related to the removal of deprecated scripts.

What will stop working?

Direct execution of the removed run scripts (run_gui.py, run_ml_sim.py, run_rl_sim.py, run_sim.py) will no longer work
Any external automation or scripts that directly invoke these files will fail

Migration Path for Users:

For simulation runs: Use python -m fusion.cli run_sim instead of python run_sim.py
For RL training: Use python -m fusion.cli train instead of python run_rl_sim.py
For GUI: Use python -m fusion.cli gui instead of python run_gui.py
For ML workflows: Use the appropriate fusion CLI commands for ML functionality

All core functionality remains available through the unified CLI interface.

🧪 How Has This Been Tested?

Code Quality Validation

Pylint compliance: All pylint errors in tests/run_comparison.py have been resolved
Import organization: Verified all imports are properly organized at module top-level
Function structure: Extracted helper functions to improve readability and maintainability

Functional Testing

Metrics processing: Validated that duplicate processing fixes don't break existing functionality
RL workflows: Confirmed environment reset logic works correctly for multi-trial scenarios
Test suite: All existing tests continue to pass with the refactored code structure

Integration Testing

CLI functionality: Verified that all removed script functionality is accessible through CLI
Configuration loading: Confirmed config loading works correctly with the new structure
Module imports: Validated that all internal imports use correct new paths

Test Configuration:

Operating System: MacOS
Python version: 3.11+
Dependencies: All existing project dependencies maintained

📈 Performance Impact

Improved efficiency: Fixed duplicate processing in metrics reduces computational overhead
Memory optimization: Eliminated redundant data processing and normalization
Code maintenance: Cleaner code structure improves development velocity

🔍 Code Review Focus Areas

Verify metrics calculations produce expected results
Confirm RL environment reset logic works for various trial configurations
Check that CLI provides equivalent functionality to removed scripts
Validate import organization follows project standards
Review extracted helper functions for clarity and reusability

✅ Final Checklist

📋 Additional Notes

This PR represents the completion of the architectural refactor phase, focusing on code quality and stability. The removal of deprecated scripts finalizes the transition to the unified CLI architecture, providing a cleaner and more maintainable codebase for future development.

The metrics fixes address several edge cases that could cause runtime errors in production scenarios, particularly around division by zero and duplicate data processing. The RL workflow improvements ensure more robust training procedures.

- Moved all argument registration scripts from arg_scripts/ to fusion/cli/args/ - config_args.py → run_sim_args.py - parse_args.py → main_parser.py - setup_config.py → config_setup.py - Added __init__.py to cli/ and cli/args/ with docstrings and import structure - Deleted legacy arg_scripts/ directory - Established CLI entrypoint structure for run_sim.py, run_train.py, run_gui.py (empty or stubbed for now) - Ready for Phase 1 test coverage: CLI parsing, config resolution

… correct subdirs

- Replaced legacy flat argument parsing with subcommand-based parser - Implemented register_run_sim_args to handle all COMMAND_LINE_PARAMS under 'run_sim' - Stubbed setup_config_from_cli to return vars(args) for now - Verified that parsed CLI args pass through to config successfully - Commented out unimplemented CLI modules in cli/args/__init__.py - Validated CLI end-to-end via: python -m fusion.cli.run_sim run_sim --erlang_start 100 --run_id test123

- Moved NetworkSimulator into fusion/sim/network_simulator.py - Updated imports (e.g., src.engine → fusion.core.engine) - Updated CLI run_sim.py to use new run_simulation entrypoint

- Connected build_parser → setup_config → run_simulation - Added print to confirm parsed config - Early test run parsing support

- Integrated argparse-based command parsing into fusion.cli.run_sim - Fixed config loading for INI files using setup_config_from_cli() - Added support for relative and user-specified config paths - Ensured proper simulation launch via fusion.sim.run_simulation() - Verified successful end-to-end execution with parsed config

- Integrated multiprocessing.Event() to support graceful shutdowns - Updated fusion/cli/run_sim.py to create and pass stop_flag to simulation runner - Ensures clean process termination and future compatibility with GUI/interactive use

- Updated `create_input()` and `save_input()` in setup_helpers.py to resolve all paths via PROJECT_ROOT - Prevented accidental writes to cli/data by enforcing top-level FUSION/data/ - Ensured proper file flushing and syncing for input JSON reliability - Added fallback logic to find project root via .git or run_sim.py

- Consolidated training CLI through run_train.py to support both RL and ML pipelines. - Introduced ConfigManager in fusion/cli/config_setup.py for centralized configuration loading and parsing. - Added modular argument parsing functions (e.g., add_run_sim_args, add_routing_args, etc.) in the CLI args modules. - Stubbed train_pipeline.py (RL) and ml_pipeline.py (ML) to verify proper dispatch based on agent type. - Ensured multi-threaded config support (e.g., s1, s2 sections) is maintained across pipelines.

- Replaced legacy CLI logic in run_gui.py with standardized main_parser and ConfigManager usage. - Added gui_args.py with support for --config_path and --run_id flags. - Stubbed launch_gui() in fusion/gui/runner.py for future GUI logic integration. - Verified end-to-end CLI parsing, config validation, and stub dispatch.

ryanmccann1024 · 2025-08-07T14:40:06Z

This Unit Test passes locally, interesting. Any ideas @bozo-bud ?

bozo-bud · 2025-08-07T14:42:45Z

I think test get start time has an issue where the times will sometimes not match. I haven't been able to replicate it or get it to happen consistently though.

ryanmccann1024 · 2025-08-07T14:45:38Z

This could either be a fluke or the error that happens on Unity at times. If a user submits hundreds of jobs sometimes they write over each other...

Maybe there is a start time consistency issue

The RL pipeline is not working properly with the new refactor including: - Input/Output results - Config files

…/scaffold # Conflicts: # fusion/helper_scripts/sim_helpers.py

Moved files to more scalable directories. Changed naming conventions to be more consistent and readable. Broke up multi-class files into multiple single class files. Added skeleton files for future refactor.

… correlate to new run function.

…button images.

Refactor/rl cli

Refactor/sim-core

…efactor/helpers

Refactor/helpers

…/scaffold_gui # Conflicts: # fusion/sim/utils.py

Refactor/scaffold gui

ryanmccann1024 · 2025-08-13T14:03:14Z

The failure is on the pull request target and passes on this PR.

Will ignore for now.

- Prevent duplicate link processing in _get_link_usage_summary - Fix division by zero in bit_rate_blocking_prob calculation - Prevent duplicate modulation statistics processing - Add safeguards for block_reasons_dict normalization - Improve debug logging and code formatting 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

- Only reset environment if trials are not yet completed - Prevents unnecessary resets after all trials are finished 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

- Move all imports to top level to resolve import-outside-toplevel warnings - Remove unused 'is_testing' parameter from run_rl_simulation function - Extract helper functions to reduce statement count in _run_single_case - Resolve all reimport and unused-import warnings 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

- Remove run_gui.py, run_ml_sim.py, run_rl_sim.py, and run_sim.py - These scripts have been replaced by the new CLI structure - Functionality has been migrated to fusion module 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

ryanmccann1024 added 11 commits July 23, 2025 09:18

Finalize fusion/ package layout: move RL, sb3, and excel modules into…

d6c0c2f

… correct subdirs

Add support for --config_path to load INI fallback into CLI config

8271f18

refactor(sim): migrate run_sim to new modular structure under fusion.sim

05f195b

- Moved NetworkSimulator into fusion/sim/network_simulator.py - Updated imports (e.g., src.engine → fusion.core.engine) - Updated CLI run_sim.py to use new run_simulation entrypoint

feat(cli): wire CLI run_sim entrypoint to use new run_simulation module

58f27c1

- Connected build_parser → setup_config → run_simulation - Added print to confirm parsed config - Early test run parsing support

ryanmccann1024 requested a review from bozo-bud July 23, 2025 19:01

ryanmccann1024 added 18 commits July 24, 2025 11:51

fix test_config_args.py for new fusion package

9b65323

fix test_engine.py for new fusion package

f8e4430

fix test_generate_data.py for new fusion package

5513a39

fix test_os_helpers.py for new fusion package

14ef62c

Rework test_parse_args.py for new cli structure

f767849

fix test_plot_helpers.py for new fusion package

8922698

fix test_plot_stats.py for new fusion package

439b969

fix random_helpers.py for new fusion package

4dbeae0

fix test_request_generator.py for new fusion package

c26d5fa

fix test_routing.py for new fusion package

4ffbc92

fix test_routing_helpers.py for new fusion package

ffe55da

fix test_sdn_controller.py for new fusion package

fbc1ed1

Refactor test_setup_config.py for new cli package

33a8ca6

Refactor test_setup_helpers.py for new cli package

eda0b3c

Refactor test_sim_helpers.py for new cli package

917e9bc

Refactor test_snr_measurements.py for new cli package

9183f37

Refactor test_spectrum_assignment.py for new cli package

bc2b394

Refactor test_spectrum_helpers.py for new cli package

8991ff9

Fix tests and lint top level tests directory

3fc2c0a

ryanmccann1024 force-pushed the refactor/scaffold branch from 3c119bb to 3fc2c0a Compare August 7, 2025 14:28

Remove batch runner logic

81101aa

ryanmccann1024 and others added 5 commits August 7, 2025 11:46

Refactor RL pipeline and workflow

529ffbd

The RL pipeline is not working properly with the new refactor including: - Input/Output results - Config files

Merge remote-tracking branch 'origin/refactor/scaffold' into refactor…

ec887ba

…/scaffold # Conflicts: # fusion/helper_scripts/sim_helpers.py

Refactored Gui.

6144516

Moved files to more scalable directories. Changed naming conventions to be more consistent and readable. Broke up multi-class files into multiple single class files. Added skeleton files for future refactor.

Added runner functionality. Fixed import statements. Fixed Buttons to…

35b4736

… correlate to new run function.

Fixed process arguments for simulation start. Fixed file pathing for …

2230903

…button images.

arashr88 approved these changes Aug 12, 2025

View reviewed changes

ryanmccann1024 and others added 9 commits August 12, 2025 11:38

Merge pull request #109 from SDNNetSim/refactor/rl-cli

bd4dedc

Refactor/rl cli

Merge pull request #108 from SDNNetSim/refactor/sim-core

bd79a32

Refactor/sim-core

Resolve merge conflicts

82f8456

Merge branch 'refactor/helpers' of github.com:SDNNetSim/FUSION into r…

12ce2aa

…efactor/helpers

Merge pull request #107 from SDNNetSim/refactor/helpers

20d86c9

Refactor/helpers

Merge remote-tracking branch 'origin/refactor/scaffold' into refactor…

f2e3fc1

…/scaffold_gui # Conflicts: # fusion/sim/utils.py

Fixed code to better comply with pylint standards.

3a7482e

Merge pull request #110 from SDNNetSim/refactor/scaffold_gui

195eb3e

Refactor/scaffold gui

Lint fusion module

5c1db09

ryanmccann1024 and others added 4 commits August 13, 2025 10:34

Fix environment reset issue in RL workflow runner

42d4059

- Only reset environment if trials are not yet completed - Prevents unnecessary resets after all trials are finished 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

ryanmccann1024 merged commit c450fbb into release/6.0.0 Aug 13, 2025
12 checks passed

ryanmccann1024 added a commit that referenced this pull request Aug 14, 2025

feat: merge pull request #106

822a8c6

ryanmccann1024 mentioned this pull request Aug 27, 2025

refactor(interfaces): implement abstract interfaces and complete modular architecture migration #113

Merged

89 tasks

ryanmccann1024 deleted the refactor/scaffold branch January 19, 2026 19:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor/scaffold#106

Refactor/scaffold#106
ryanmccann1024 merged 82 commits intorelease/6.0.0from
refactor/scaffold

ryanmccann1024 commented Jul 23, 2025 •

edited

Loading

Uh oh!

ryanmccann1024 commented Aug 7, 2025 •

edited

Loading

Uh oh!

bozo-bud commented Aug 7, 2025

Uh oh!

ryanmccann1024 commented Aug 7, 2025

Uh oh!

ryanmccann1024 commented Aug 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

ryanmccann1024 commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Description

Key Changes:

🔧 Code Quality & Bug Fixes

🧹 Code Cleanup & Maintenance

🏗️ Architectural Improvements

🧐 Type of Change

💥 Impact of Breaking Change

What will stop working?

Migration Path for Users:

🧪 How Has This Been Tested?

Code Quality Validation

Functional Testing

Integration Testing

Test Configuration:

📈 Performance Impact

🔍 Code Review Focus Areas

✅ Final Checklist

📋 Additional Notes

Uh oh!

ryanmccann1024 commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bozo-bud commented Aug 7, 2025

Uh oh!

ryanmccann1024 commented Aug 7, 2025

Uh oh!

ryanmccann1024 commented Aug 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ryanmccann1024 commented Jul 23, 2025 •

edited

Loading

ryanmccann1024 commented Aug 7, 2025 •

edited

Loading