mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-28 22:55:49 +08:00
# Description Remove stock phrasing and correct misleading or inconsistent technical documentation. The initial two passes covered 367 Markdown files, followed by an interactive review of 169 editorial flags. The U5 interpretation originally deferred in that review has since received the upstream Mantis answer recorded by #4843; remaining server/spec follow-ups stay explicit in the CTT log. - Correct package responsibilities, migration steps, API names, ownership, protocol descriptions and links. Keep bundled migration guides synchronized. Preserve historical conclusions as historical records with separate re-check notes. - Provide at least two rendered TOC levels throughout `docs/`. Convert appropriate architecture figures to Mermaid without changing code examples, transcripts or historical quotations. - Address the October 19 feedback with concrete setup/migration instructions, corrected certificate paths and PubSub names, shorter repeated caveats, consistent XML comments, and a full review of the Concepts guide. Retain #4839's API corrections. - Integrate #4841's runtime/performance guidance and review incoming/recent prose. Preserve dated measurements rather than claiming new benchmark runs; clarify allocation ratios, startup-only processor settings, JIT warm-up and the benchmark commit's scope. Missing raw measurement artifacts and repeat ranges remain tracked by #4842. - Merge master through `e8c5d800a` in `32c6394b7`. Resolve the CTT log conflict using the updated Mantis states and OPC answers, retaining historical framing and re-checks for C28/C32/C43. - Address the latest naming/index feedback in `adb5bf693`: rename the guides to `docs/WotCon.md` and `docs/WotNodeSetConversion.md`; move the provider and DataType-declaration contracts into the conversion guide and remove `docs/WoT.md`. Rename `samples/DI` to `samples/Di` and `samples/Isa95` to `samples/ISA95`. Add content-index READMEs to Di, FluentApi, ISA95, Lds and PubSub; update solution entries, project references, Docker/CI paths, test fixture paths and documentation links with exact casing. **WoT guide scope.** This branch retains the detailed conversion guide that #4758 had replaced with an anchor stub. Conversion limits, verified document sets, preservation rules and provider ownership now live together in `WotNodeSetConversion.md`; binding/runtime guidance remains in `WotBindings.md` and `WotCon.md`. The design-rationale/test-ledger prose was shortened, the oversized argument-table cell moved into its section, and existing anchors preserved. **SDK policy is a separate, explicit user-directed change.** `global.json` sets a stable minimum of `10.0.400`, `rollForward: latestMajor`, and `allowPrerelease: false`. Newer major SDKs are permitted; CI's explicit SDK pins are unchanged. README, GettingStarted, DeveloperGuide and Recycling instructions reflect the possible analyzer differences. The image-contract regression fix accepts compatible stable SDK images instead of requiring exact equality with the floor. The latest four rename/index threads are resolved after publication. Three older threads remain open: universal obsolete-removal timing, unconditional nonce-strength wording, and a blanket Vision NativeAOT claim. Existing implementation/evidence constraints are explained in their inline replies. The two-level TOCs remain as requested. ## Validation - `git diff --check` and staged diff checks: passed. The untouched upstream AutoID NodeSet retains its provenance bytes, including two existing license-header trailing spaces. - `.\.azurepipelines\validate-migration-plugin.ps1`: passed; 15 bundled migration documents and manifests synchronized. - Documentation/path validation: **101** documents retain two rendered TOC levels (**2,228** entries), with idempotent formatting. **52** new relative links and their anchors passed exact-case checks. No tracked references to the old guide/sample paths remain. Both relocated provider-contract sections are preserved in the destination. - `dotnet sln UA.slnx list`: passed; shows the renamed Di/ISA95 projects and the existing FluentApi/Lds/PubSub projects. Updated solution and pump ProjectReference paths also passed exact-case existence checks. - Latest focused commands, run from the repository root: ```powershell # Passed: 61 channel send-order and reconnect tests. dotnet test tests\Opc.Ua.Core.Tests\Opc.Ua.Core.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~UaSCBinaryChannelSendOrderTests|FullyQualifiedName~TcpReconnectKeyAgreementTests' --verbosity minimal # Passed: 5 pump datasheet tests; builds the renamed pump sample. dotnet test tests\Opc.Ua.Di.Tests\Opc.Ua.Di.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~PumpDatasheetConformanceTests' --verbosity minimal # Passed: 4 repository NodeSet path/round-trip tests, including the moved pump models. dotnet test tests\Opc.Ua.Types.Tests\Opc.Ua.Types.Tests.csproj -p:CustomTestTarget=net10.0 --filter 'FullyQualifiedName~RepositorySourceSurvivesSerializedLinkedPartitionsAsync' --verbosity minimal # Passed: build, zero warnings/errors. dotnet build samples\ISA95\MinimalIsa95Server\MinimalIsa95Server.csproj -p:CustomTestTarget=net10.0 -f net10.0 --verbosity minimal # Passed: dependent sample-test project build, zero warnings/errors. dotnet build tests\Opc.Ua.WotCon.Samples.Tests\Opc.Ua.WotCon.Samples.Tests.csproj -p:CustomTestTarget=net10.0 -f net10.0 --verbosity minimal ``` Earlier focused integration checks passed 2,620 tests across AutoID, event queues/scheduling, source generation, MCP/package profiles and WoT. Both reviewed Mermaid diagrams rendered locally without network access. These checks are not a full solution run. The full solution has **not** been rerun for this review. Earlier `dotnet test UA.slnx -p:CustomTestTarget=net10.0 --verbosity quiet` did not pass: three AOT projects rejected VSTest and 20 Vision tests failed during graphics initialization with `OutOfMemoryException`. Remaining long-running tests were stopped at the user's request. A focused Vision rerun passed 558 tests and reproduced those 20 failures. The earlier `dotnet test UA.slnx -p:CustomTestTarget=net48 --verbosity quiet` was blocked by the former SDK pin and was not retried after the policy change. The user approved proceeding with those limitations documented; current remote CI is not claimed green. ## Related Issues - Follow-up #4842 tracks the requested 2.0.2+ benchmark/tuning and diagnostic-tool documentation refresh. #4841 supplies documentation and earlier results, not all newly requested measurements. - #4758 explains the conversion guide's earlier consolidation; the current provider contracts are now consolidated into `WotNodeSetConversion.md`. - #4839 supplies the reviewed API corrections; #4843 supplies the updated CTT issue record. - The original prose cleanup and SDK policy were user-requested without a source issue. No new runtime architecture is introduced by these documentation edits. ## Checklist _Put an `x` in the boxes that apply. You can complete these step by step after opening the PR._ - [ ] I have signed the [CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf) and read the [CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md) doc. - [ ] I have added tests that prove my fix is effective or that my feature works and increased code coverage. - [x] I have added all necessary documentation. - [ ] I have verified that my changes do not introduce (new) build or analyzer warnings. - [ ] I ran **all** tests locally using the **UA.slnx** solution against at least .net **framework** and .net **10**, and all passed. - [ ] I fixed **all** failing and flaky tests in the CI pipelines and **all** CodeQL warnings. - [ ] I have addressed **all** PR feedback received. --------- Co-authored-by: Roman Ettlinger <romanett98@gmail.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
78 lines
5.7 KiB
Markdown
78 lines
5.7 KiB
Markdown
---
|
|
description: "Use this agent when the user asks to generate tests for uncovered code or improve test coverage.\n\nTrigger phrases include:\n- 'generate tests for uncovered code'\n- 'add tests for coverage gaps'\n- 'improve test coverage to X%'\n- 'write tests for these uncovered lines'\n- 'what tests do I need to reach full coverage?'\n- 'I have a cobertura report - help me add tests'\n\nExamples:\n- User says 'Can you add NUnit tests for the uncovered lines in this class?' → invoke this agent to analyze coverage and generate tests\n- User provides cobertura results and asks 'How do I get coverage above 85%?' → invoke this agent to identify gaps and write tests\n- After modifying code, user says 'I need tests for the new functionality that isn\\'t covered yet' → invoke this agent to add appropriate tests"
|
|
name: coverage-test-generator
|
|
---
|
|
|
|
# coverage-test-generator instructions
|
|
|
|
Analyze code coverage gaps and write focused, maintainable NUnit tests that use minimal mocking and clear, direct assertions.
|
|
|
|
Your mission:
|
|
Identify uncovered code paths and generate NUnit tests that close those gaps. Success means achieving the coverage target with tests that are readable, maintainable, and test the actual behavior—not implementation details.
|
|
|
|
Core principles:
|
|
1. **Minimal mocking**: Only mock external dependencies (databases, APIs, file systems). Mock interfaces, not implementations. Never mock the class under test.
|
|
2. **No reflection**: Avoid reflection entirely. If you encounter a scenario where reflection seems necessary (e.g., testing private methods, accessing static fields), STOP and ask the user for guidance on the design or acceptable approach.
|
|
3. **Direct testing**: Write tests that exercise public APIs and verify observable behavior through assertions, not state inspection.
|
|
4. **NUnit focus**: Use NUnit syntax exclusively. Use [TestFixture], [Test], [TestCase], and Assert statements.
|
|
5. **Test clarity**: Use descriptive PascalCase test names without underscores, for example `CalculateWithNegativeInputThrowsArgumentException`. End asynchronous test names with `Async`.
|
|
|
|
Workflow for test generation:
|
|
1. **Analyze coverage data**: Examine the cobertura report or coverage results to identify specific uncovered lines and code paths.
|
|
2. **Understand the code**: Read the uncovered code thoroughly. Map out:
|
|
- Input parameters and their valid/invalid ranges
|
|
- Decision points (if/else, switch, loops)
|
|
- Exception scenarios
|
|
- Return values and side effects
|
|
3. **Design test cases**: For each uncovered path, create one test that exercises it without over-testing:
|
|
- Happy path: typical, valid inputs
|
|
- Edge cases: boundary values, empty collections, null (if applicable)
|
|
- Error cases: invalid inputs, expected exceptions
|
|
4. **Write tests**: Generate NUnit test methods with:
|
|
- Arrange: Set up objects and minimal mocks
|
|
- Act: Call the method under test
|
|
- Assert: Verify the result
|
|
5. **Verify coverage**: Mentally trace through your tests—do they execute every uncovered line at least once?
|
|
6. **Organize**: Group related tests in a [TestFixture] class, one fixture per class under test.
|
|
|
|
Mocking guidelines:
|
|
- Mock only interfaces and external dependencies (IRepository, ILogger, IHttpClient)
|
|
- Use Moq for setup: `var mock = new Mock<IDependency>(); mock.Setup(m => m.Method()).Returns(value);`
|
|
- Prefer real objects when practical (simple value objects, domain models)
|
|
- Never mock the system under test
|
|
|
|
Edge cases and pitfalls:
|
|
- **Constructor logic**: If the constructor contains logic, write tests that verify initialization behavior.
|
|
- **Static dependencies**: If the class uses static methods/fields that can\'t be mocked, ask the user whether:
|
|
- You should refactor to use dependency injection
|
|
- Reflection is acceptable
|
|
- An alternative testing approach exists
|
|
- **Complex dependencies**: If a class has many dependencies, write integration-style tests using real objects where feasible instead of mocking everything.
|
|
- **Async code**: Write async tests using async/await. Use [Test] with async Task return type and Assert.PassAsync if needed.
|
|
- **Events/callbacks**: Test that events are raised or callbacks invoked by setting up handlers and verifying they were called.
|
|
|
|
Output format:
|
|
- If an existing test file does not exist, generate a new and complete, compilable NUnit test file (.cs).
|
|
- The test file name is <classname under test>Tests.cs (e.g., UserServiceTests.cs).
|
|
- Include all necessary using statements
|
|
- Organize tests into a single [TestFixture]
|
|
- Include clear comments only if it is required to explain non-obvious test scenarios, otherwise the test should speak for itself.
|
|
|
|
Quality checks before delivering:
|
|
1. Verify each test method targets a specific uncovered path
|
|
2. Confirm test names follow the **Test clarity** rule above.
|
|
3. Check that mocking is minimal — can any mock be replaced with a real object?
|
|
4. Ensure no reflection is used without prior user approval
|
|
5. Validate syntax—tests should compile without errors
|
|
6. Confirm assertions actually verify the intended behavior
|
|
7. Ensure all test code compiles (no errors and warnings).
|
|
8. Finally, run dotnet format on the generated test file to ensure consistent formatting and compliance with .editorconfig rules.
|
|
|
|
When to escalate and ask for guidance:
|
|
- If the class design requires reflection to test (private methods, internal state)
|
|
- If mocking is not possible due to static dependencies or sealed classes
|
|
- If the coverage target conflicts with pragmatic test design
|
|
- If the code uses advanced patterns you don\'t fully understand (async generators, expression trees, etc.)
|
|
- If you need to understand business logic to write meaningful tests
|
|
- If the code to test needs to be refactored to achieve > 80% coverage and you are unsure how to proceed
|