#80/streamline user scenario testing workflow #89
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds logic to build_sumo_executables.ps1 that: - Patches tools/build_config/templates.py before building to fix escape issues - Restores templates.py to upstream state after build completes - Handles restoration in error cases Also updates cav_casestudy submodule and adds CLAUDE.md project instructions.
Creates tests/UserScenarios/ with workflow for handling user-provided scenarios: - Folder structure tracked via .gitkeep (exists in all branches) - README.md documents workflow from OneDrive portal to debugging - All scenario contents gitignored (maintains privacy) - Enables full IDE/debugging access without committing proprietary files This establishes a standardized process for receiving user scenarios via OneDrive file request, creating issue-specific branches, debugging locally, and cleaning up after resolution. Addresses Task 1 of #80
Adds intelligent config file discovery to streamline debugging without manual VS project settings changes: **Auto-discovery logic:** 1. Check TrafficLayer/.active_config for explicit path 2. Auto-discover single YAML in tests/UserScenarios/ 3. Error with guidance if multiple YAMLs or none found 4. Always allows -f override **Implementation:** - Cross-platform file discovery (WIN32 and POSIX) - C++11 compatible (no std::filesystem dependency for discovery) - Works when working directory is repo root (VS debugging scenario) - Deployed executables still require explicit -f flag **Changes:** - Add findYamlFiles() with platform-specific implementations - Remove hardcoded LocalDebuggerCommandArguments from .vcxproj.user - Update UserScenarios/README.md with new workflow - Gitignore TrafficLayer/.active_config (per-worktree) **Usage:** - Single scenario: Just F5 in VS - Multiple scenarios: echo path/to/config.yaml > TrafficLayer/.active_config - Deployment: TrafficLayer.exe -f path/to/config.yaml Part of #80 (Task 2)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Implements a complete workflow for handling user-provided proprietary scenarios and streamlines Visual Studio debugging configuration to eliminate manual project settings changes.
Related Issues / Tasks
Closes #80
Type of Change
Affected Modules / Components
tests/UserScenarios/- New directory structure for proprietary user scenariosTrafficLayer/TrafficLayer/mainTrafficLayer.cpp- Auto-discovery logic for config filesTrafficLayer/TrafficLayer/TrafficLayer.vcxproj.user- Removed hardcoded debug arguments.gitignore- Added patterns for UserScenarios and .active_configtests/UserScenarios/README.md- Workflow documentationChanges
Task 1: User Scenario Integration Workflow
tests/UserScenarios/with.gitkeep(tracked across branches)tests/UserScenarios/issue_X_description/tests/UserScenarios/README.mdTask 2: VS Debugging Configuration
Auto-discovery logic:
TrafficLayer/.active_configfor explicit config pathtests/UserScenarios/-fflag overrideImplementation highlights:
-fflagWorkflow:
echo path/to/config.yaml > TrafficLayer/.active_configTrafficLayer.exe -f path/to/config.yamlTest Cases
Manual testing required:
tests/UserScenarios/.active_config-fflagEnvironment
Testing environment:
Checklist
Additional Notes
This PR establishes the foundation for the user scenario debugging workflow referenced in issue #80. Both
TrafficLayer/.active_configandtests/UserScenarios/*contents are gitignored to maintain privacy and per-worktree flexibility.