WinCC OA CTRL Test Framework

VS Code extension for running and managing WinCC OA CTRL TestFramework tests directly from the editor.

Features

Test Explorer Integration

Three different views to explore and run your tests:

• Flat View — Simple list of all TEST_RUN_IDs for quick access
• Tree View — Hierarchical view showing parent-child relationships between test runs
• Suite Folder View — Physical folder structure based on testSuite*.config locations

Run Tests From Anywhere

• Test Explorer — Click the play button on any test item
• Context Menu — Right-click on testRuns.config, testSuite*.config, or test suite folders
• Command Palette — Ctrl+Shift+P → "WinCC OA TestFramework: Start..."

Live Test Results

• Automatic detection of test result JSON files in Results/Partly/
• Pass/fail status icons (✓/✗) displayed on test items
• Statistics: passed, failed, crashed counts

Project Selection

• Quick pick UI to select the WinCC OA project for running tests
• Status bar indicator showing the currently selected project
• Supports all runnable WinCC OA projects

Quick Start

1. Open a workspace containing testRuns.config in a WinCC_OA_Test directory
2. Select a TestRunner project: Ctrl+Shift+P → "Select TestRunner Project"
3. Run tests from the Test Explorer sidebar or via context menu

Commands

Command	Description
WinCC OA TestFramework: Create Default TestFramework Workspace	Scaffold a default WinCC OA test workspace (WinCC_OA_Test)
WinCC OA TestFramework: Start TestRunner	Run a test by TEST_RUN_ID (from testRuns.config)
WinCC OA TestFramework: Select TestRunner Project	Choose the WinCC OA project for test execution
WinCC OA TestFramework: Start Test Suite	Run tests from a testSuite.config file or folder
WinCC OA TestFramework: Scan Test Results	Rescan Results/Partly and refresh Problems/tests

Settings

Setting	Default	Description
winccoaCtrlTestFramework.testWorkspaceRoot	WinCC_OA_Test	Relative path to the test workspace root directory containing testRuns.config
winccoaCtrlTestFramework.knownBugAsWarning	true	Report KnownBug failures as warnings in Problems
winccoaCtrlTestFramework.bugTrackerUrlTemplate	""	URL template for KnownBug links (use {id} placeholder)
winccoaCtrlTestFramework.promptForBugTrackerUrlTemplateOnStartup	true	Prompt on activation to set the bug tracker URL template (Yes/No/Never)

Extension Dependencies

This extension requires:

• WinCC OA Project Admin (RichardJanisch.winccoa-project-admin)

Development

npm install
npm run compile
npm run test:unit

Run locally in VS Code:

• Press F5 to open an Extension Development Host

Development Scripts

Script	Description
npm run compile	Build the extension
npm run watch	Build in watch mode
npm run lint	Run ESLint
npm run format	Format code with Prettier
npm run test	Run all tests
npm run test:unit	Run unit tests only
npm run test:integration	Run integration tests
npm run test:coverage	Run tests with coverage

Branching Model (GitFlow)

• develop is the default branch (day-to-day work)
• main is the stable branch (releases)
• feature/* / bugfix/* target develop
• release/vX.Y.Z and hotfix/vX.Y.Z target main

More details: docs/automation/GITFLOW_WORKFLOW.md

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT License. See LICENSE.

Disclaimer

WinCC OA and Siemens are trademarks of Siemens AG. This is a community project and is not affiliated with Siemens AG.

---

Quick Links

• 📦 VS Code Marketplace
• 🐛 Report Issues
• 📋 Project Board

---

Made with ❤️ for and by the WinCC OA community