merging master to official 202.5 RC #4388
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| # Ginger Automation AI Coding Agent Guide | ||
|
|
||
| ## Project Overview | ||
| Ginger is a comprehensive automation IDE supporting multiple platforms (Web, Mobile, APIs, Java, Windows, PowerBuilder, Linux/Unix, Mainframe). It uses a drag-and-drop approach enabling users with or without coding skills to create automation flows. | ||
|
|
||
| ## Core Architecture Concepts | ||
|
|
||
| ### 1. Execution Hierarchy | ||
| The fundamental execution structure follows this hierarchy: | ||
| ``` | ||
| Solution → RunSet → Runner → BusinessFlow → Activity → Action (Act) | ||
| ``` | ||
|
|
||
| - **BusinessFlow**: Top-level test scenario container (`GingerCoreCommon/Repository/BusinessFlowLib/BusinessFlow.cs`) | ||
| - **Activity**: Group of related actions within a BusinessFlow (`GingerCoreCommon/Repository/BusinessFlowLib/Activity.cs`) | ||
| - **Act/Action**: Individual executable step (`GingerCoreCommon/Actions/Act.cs`) | ||
| - **Agent**: Driver wrapper that connects to target applications (`GingerCoreCommon/RunLib/Agent.cs`) | ||
|
|
||
| ### 2. Key Project Structure | ||
| - **Ginger/**: Main WPF application (UI) | ||
| - **GingerCoreCommon/**: Shared models and base classes | ||
| - **GingerCoreNET/**: .NET execution engine and CLI components | ||
| - **GingerRuntime/**: Console application entry point | ||
| - **GingerCore/**: Legacy core components (being migrated to GingerCoreNET) | ||
|
|
||
| ### 3. Driver Architecture | ||
| Each platform has dedicated drivers under `GingerCore/Drivers/`: | ||
| - `SeleniumDriver` for web automation | ||
| - `JavaDriver` for Java applications | ||
| - `ConsoleDriverLib` for command-line interfaces | ||
| - `WindowsAutomation` for Windows applications | ||
| - Agents (`Agent.cs`) act as wrappers providing unified interface | ||
|
|
||
| ## Development Workflows | ||
|
|
||
| ### Building & Testing | ||
| ```powershell | ||
| # Main build (Windows) | ||
| dotnet build Ginger/Ginger.sln | ||
|
|
||
| # Run tests | ||
| ./TestDotNetFramework.ps1 # Framework tests | ||
| ./CLITests.ps1 # CLI functionality tests | ||
|
|
||
| # Console execution | ||
| cd Ginger/GingerRuntime/bin/Release/net8.0/publish/ | ||
| dotnet GingerConsole.dll run -s "path/to/solution" -e "Environment" -r "RunSet" | ||
| ``` | ||
|
|
||
| ### CLI Commands | ||
| **Windows:** | ||
| - `ginger.exe help` or `dotnet ginger.dll help` - Show CLI help | ||
| - `ginger.exe run -s <solution> -e <env> -r <runset>` - Execute automation | ||
| - `ginger.exe analyze -s <solution>` - Analyze solution | ||
| - `ginger.exe grid --port <port>` - Start grid mode | ||
|
|
||
| **Linux:** | ||
| - `dotnet gingerruntime.dll help` - Show CLI help | ||
| - `dotnet gingerruntime.dll run -s <solution> -e <env> -r <runset>` - Execute automation | ||
| - `dotnet gingerruntime.dll analyze -s <solution>` - Analyze solution | ||
| - `dotnet gingerruntime.dll grid --port <port>` - Start grid mode | ||
|
|
||
| ## Project Conventions | ||
|
|
||
| ### 1. File Organization | ||
| - Actions inherit from `Act` class and implement platform-specific logic | ||
| - Repository objects use `[IsSerializedForLocalRepository]` attribute for persistence | ||
| - Test files end with `Test.cs` and use MSTest framework with `[TestClass]` and `[TestMethod]` | ||
|
|
||
| ### 2. Naming Patterns | ||
| - Actions: `Act{PlatformType}{ActionType}` (e.g., `ActBrowserElement`, `ActConsoleCommand`) | ||
| - Drivers: `{Platform}Driver` (e.g., `SeleniumDriver`, `JavaDriver`) | ||
| - Pages/Windows: `{Feature}Page` or `{Feature}Window` | ||
|
|
||
| ### 3. Error Handling | ||
| - Use `Reporter.ToLog(eLogLevel.ERROR, message)` for logging | ||
| - Actions set `act.Error` and `act.Status = eRunStatus.Failed` on failure | ||
| - Execution continues based on `Activity.ActionRunOption` setting | ||
|
|
||
| ## Integration Points | ||
|
|
||
| ### 1. Solution Structure | ||
| Solutions are XML-based with this folder structure: | ||
| ``` | ||
| Solution/ | ||
| ├── BusinessFlows/ # Test scenarios | ||
| ├── Activities/ # Reusable activity groups | ||
| ├── Actions/ # Shared actions | ||
| ├── Agents/ # Driver configurations | ||
| ├── Environments/ # Environment settings | ||
| ├── DataSources/ # Test data | ||
| └── Applications/ # Target application definitions | ||
| ``` | ||
|
|
||
| ### 2. Execution Engine | ||
| - `RunsetExecutor` orchestrates execution (`GingerCoreNET/Run/RunsetExecutor.cs`) | ||
| - `GingerExecutionEngine` handles individual runner execution | ||
| - Execution logging via `ExecutionLogger` implementations | ||
| - Supports parallel execution across multiple agents | ||
|
|
||
| ### 3. Plugin Architecture | ||
| - Legacy drivers implement `DriverBase` | ||
| - New plugins use `Agent.eAgentType.Service` with `PluginId`/`ServiceId` | ||
| - External integrations via `ALM` (Application Lifecycle Management) connectors | ||
| - Plugin packages defined by `Ginger.PluginPackage.json` manifest | ||
| - Managed through `PluginsManager` (`GingerCoreNET/PlugInsLib/PluginsManager.cs`) | ||
|
|
||
| ## Critical Development Notes | ||
|
|
||
| - **Target Framework**: .NET 8.0 with Windows 10.0.17763.0 compatibility | ||
| - **WPF Dependencies**: Main UI uses WPF; console components are cross-platform | ||
| - **XML Serialization**: Repository objects serialize to XML using custom attributes | ||
| - **Multi-Threading**: Execution engine supports parallel runners; use thread-safe patterns | ||
| - **Memory Management**: Dispose drivers properly; avoid memory leaks in long-running executions | ||
|
|
||
| ## Testing Strategy | ||
| - Unit tests in `*Test.cs` files use dependency injection patterns | ||
| - Integration tests use `TestResources/Solutions/` for test data | ||
| - CLI tests verify command-line interface functionality | ||
| - Use `mConsoleMessages` pattern for testing CLI output capture | ||
|
|
||
| When working with this codebase, focus on the execution hierarchy and understand how Actions flow through Activities within BusinessFlows, executed by Agents that wrap platform-specific drivers. | ||
|
Comment on lines
+1
to
+122
Contributor
There was a problem hiding this comment. Fix Markdown formatting to comply with style guide. The file has systematic formatting violations that should be corrected before merge:
🔎 Proposed fixes for Markdown formattingAdd blank lines before all headings and major sections, specify language identifiers, and add trailing newline. Example pattern: -## Project Overview
-Ginger is a comprehensive automation IDE...
+
+## Project Overview
+
+Ginger is a comprehensive automation IDE...For code blocks without a language: -```
-Solution → RunSet → Runner → BusinessFlow → Activity → Action (Act)
-```
+
+```
+Solution → RunSet → Runner → BusinessFlow → Activity → Action (Act)
+```Apply these patterns consistently throughout lines 1–122 and ensure the file ends with a newline.
🧰 Tools🪛 markdownlint-cli2 (0.18.1)3-3: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 8-8: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 10-10: Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) 10-10: Fenced code blocks should have a language specified (MD040, fenced-code-language) 19-19: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 26-26: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 36-36: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 37-37: Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) 50-50: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 65-65: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 70-70: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 75-75: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 82-82: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 84-84: Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) 84-84: Fenced code blocks should have a language specified (MD040, fenced-code-language) 95-95: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 101-101: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 116-116: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 122-122: Files should end with a single newline character (MD047, single-trailing-newline) 🤖 Prompt for AI Agents |
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| # For most projects, this workflow file will not need changing; you simply need | ||
| # to commit it to your repository. | ||
| # | ||
| # You may wish to alter this file to override the set of languages analyzed, | ||
| # or to provide custom queries or build logic. | ||
| # | ||
| # ******** NOTE ******** | ||
| # We have attempted to detect the languages in your repository. Please check | ||
| # the `language` matrix defined below to confirm you have the correct set of | ||
| # supported CodeQL languages. | ||
| # | ||
| name: "CodeQL Security Scan" | ||
|
|
||
|
|
||
| on: | ||
| push: | ||
| branches: [ master, Features/Linux-Migration, Releases/*, Releases/*/*] | ||
| pull_request: | ||
| branches: [ master ] | ||
| schedule: | ||
| - cron: '0 0 * * 0' | ||
|
|
||
| jobs: | ||
| analyze: | ||
| name: CodeQL - ${{ matrix.language }} - ${{ matrix.os }} | ||
| runs-on: ${{ matrix.os }} | ||
| permissions: | ||
| actions: read | ||
| contents: read | ||
| security-events: write | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| language: [ 'csharp', 'javascript' ] | ||
| os: [windows-latest] | ||
|
|
||
| # ------------------------------------------------------------------------------------------------------ | ||
| # Checkout Ginger Repository | ||
| # ------------------------------------------------------------------------------------------------------ | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| # ------------------------------------------------------------------------------------------------------ | ||
| # Initialize CodeQL | ||
| # ------------------------------------------------------------------------------------------------------ | ||
|
|
||
| - name: Initialize CodeQL | ||
| uses: github/codeql-action/init@v3 | ||
| with: | ||
| languages: ${{ matrix.language }} | ||
| config-file: ./.github/workflows/codeql-config.yml | ||
|
|
||
| # ------------------------------------------------------------------------------------------------------ | ||
| # Install .Net core SDK 8.0.100 | ||
| # ------------------------------------------------------------------------------------------------------ | ||
|
|
||
| - name: Install .NET 8 | ||
| uses: actions/setup-dotnet@v3 | ||
| with: | ||
| dotnet-version: '8.0.100' | ||
|
|
||
| # ------------------------------------------------------------------------------------------------------ | ||
| # Install Mono - for Ubuntu & macOS as pre-requisite for building Ginger | ||
| # ------------------------------------------------------------------------------------------------------ | ||
|
|
||
| - name: Install Mono - Linux | ||
| if: runner.os == 'Linux' | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y mono-complete | ||
|
|
||
| - name: 'Install Mono - macOS' | ||
| if: runner.os == 'macOS' | ||
| run: brew install mono | ||
|
|
||
| # ------------------------------------------------------------------------------------------------------ | ||
| # Build && Publish Ginger Solution | ||
| # ------------------------------------------------------------------------------------------------------ | ||
|
|
||
| - name: Setup Nuget | ||
| uses: Nuget/setup-nuget@v1.0.5 | ||
|
|
||
| - name: Restore Nuget Packages | ||
| run: nuget restore ./Ginger/Ginger.sln | ||
|
|
||
| - name: Add msbuild to PATH | ||
| if: runner.os == 'windows' | ||
| uses: microsoft/setup-msbuild@v1.0.2 | ||
|
|
||
| - name: Build Windows Ginger Solution | ||
| if: runner.os == 'windows' | ||
| run: msbuild ./Ginger/Ginger.sln /p:DebugSymbols=true /p:DebugType=full /p:Configuration=Release | ||
|
|
||
| - name: Publish GingerRuntime - Linux | ||
| if: runner.os == 'Linux' | ||
| run: dotnet publish ./Ginger/GingerRuntime/GingerRuntime.csproj --runtime linux-x64 --self-contained true -c Release | ||
|
|
||
| - name: Publish GingerRuntime - macOS | ||
| if: runner.os == 'macOS' | ||
| run: dotnet publish ./Ginger/GingerRuntime/GingerRuntime.csproj --runtime osx-x64 --self-contained true -c Release | ||
|
|
||
| # ------------------------------------------------------------------------------------------------------ | ||
| # Security Scan with CodeQL | ||
| # ------------------------------------------------------------------------------------------------------ | ||
|
|
||
| - name: Perform CodeQL Analysis | ||
| uses: github/codeql-action/analyze@v3 | ||
| with: | ||
| category: "/language:${{ matrix.language }}" |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| name: "CodeQL Config" | ||
|
|
||
| paths: | ||
| - 'Ginger' # Only scan the Ginger directory for CodeQL | ||
|
|
||
| paths-ignore: | ||
|
|
||
| # ignore build outputs | ||
| - '**/bin/**' | ||
| - '**/obj/**' | ||
| - '**/Release/**' | ||
| - '**/Debug/**' | ||
|
|
||
| # ignore test projects | ||
| - 'Ginger/GingerAutoPilotTest/**' | ||
| - 'Ginger/GingerConsoleTest/**' | ||
| - 'Ginger/GingerCoreCommonTest/**' | ||
| - 'Ginger/GingerCoreNETUnitTest/**' | ||
| - 'Ginger/GingerCoreTest/**' | ||
| - 'Ginger/GingerPluginCoreTest/**' | ||
| - 'Ginger/GingerTest/**' | ||
| - 'Ginger/GingerUtilsTest/**' | ||
| - 'Ginger/GingerWPFDriverWindowTest/**' | ||
|
|
||
| # more optional files to ignore | ||
| # - '**/*.Designer.cs' # Auto-generated designer files | ||
| # - '**/*.g.cs' # Auto-generated files | ||
| # - '**/*.g.i.cs' # Auto-generated intermediate files | ||
| # - '**/AssemblyInfo.cs' # Assembly info files | ||
| # - '**/packages/**' # NuGet packages | ||
| # - '**/node_modules' # JavaScript dependencies | ||
| # - '**/*.min.js' # Minified JavaScript | ||
| # - '**/*.min.css' # Minified CSS |
Binary file not shown.
Binary file not shown.
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: Ginger-Automation/Ginger
Length of output: 2062
🏁 Script executed:
Repository: Ginger-Automation/Ginger
Length of output: 733
🏁 Script executed:
Repository: Ginger-Automation/Ginger
Length of output: 498
🏁 Script executed:
Repository: Ginger-Automation/Ginger
Length of output: 325
🏁 Script executed:
Repository: Ginger-Automation/Ginger
Length of output: 156
🏁 Script executed:
Repository: Ginger-Automation/Ginger
Length of output: 225
🏁 Script executed:
Repository: Ginger-Automation/Ginger
Length of output: 611
🏁 Script executed:
Repository: Ginger-Automation/Ginger
Length of output: 5791
Update driver paths to reflect actual post-refactoring locations.
Lines 27–32 reference driver locations that are now outdated. SeleniumDriver and ConsoleDriver implementations have been migrated to GingerCoreNET:
SeleniumDriveris located inGingerCoreNET/Drivers/CoreDrivers/Web/Selenium/, notGingerCore/Drivers/DOSConsoleDriver,UnixShellDriver) are located inGingerCoreNET/Drivers/CoreDrivers/Console/, not underGingerCore/Drivers/ConsoleDriverLibJavaDriverremains inGingerCore/Drivers/JavaDriverLib/(accurate)WindowsAutomationtoWindowsDriverfor consistency with actual class names and the{Platform}Drivernaming pattern🤖 Prompt for AI Agents