Files
UA-.NETStandard/tests/Opc.Ua.ISA95.Tests/Common/Isa95CommonTestContext.cs
Copilot d7dd1b0369 Fix telemetry component assembly identification (#4490)
# Description

Telemetry extensions resolved meters and activity sources as
`Opc.Ua.Types`, with results dependent on helper inlining. This
prevented reliable attribution to the emitting component.

- **Existing telemetry contract**: Add `CreateMeter(Assembly)` and
`GetActivitySource(Assembly)` directly to `ITelemetryContext`. The
separate `IAssemblyTelemetryContext` interface has been removed.
- **Reliable component attribution**: Capture the caller assembly in
non-inlined `CreateMeter`, `GetActivitySource`, and `StartActivity`
extensions, then forward it to the existing telemetry context.
- **Call-site routing and fallback**: Keep non-null meter calls on
`telemetry.CreateMeter()`. Use explicit
`TelemetryExtensions.CreateMeter(telemetry)` for nullable-context
fallback. Preserve default meter/activity-source fallback when a context
returns null.
- **Coverage and documentation**: Cover caller-assembly naming,
direct-context and extension routing, activity creation, and null-result
fallback. Update diagnostics examples, OpenTelemetry filters, and
migration guidance.

**Compatibility:** Direct implementations of `ITelemetryContext` must
implement the two new assembly-aware members. `TelemetryContextBase`
supplies both. This interface addition is documented in the 2.0
migration guide; legacy implementer compatibility is not claimed.

## Local validation

The Release build and focused `TelemetryExtensionsTests` fixture pass on
both target frameworks:

| Target | Result |
| --- | --- |
| net10.0 | Passed: 6, Failed: 0, Skipped: 0 |
| net48 | Passed: 6, Failed: 0, Skipped: 0 |

Both builds emit existing CA5394 warnings in
`NodeStateChildNameIndexTests.cs`, which is unchanged by this PR. The
full solution test suite was not run during this feedback pass.

## Related Issues

## Checklist

- [ ] 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.
- [x] 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.
- [x] 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.
- [x] I have addressed **all** PR feedback received.

<!-- START COPILOT CODING AGENT SUFFIX -->

- Fixes #4483

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: marcschier <11168470+marcschier@users.noreply.github.com>
Co-authored-by: Marc Schier <marcschier@users.noreply.github.com>
2026-09-16 11:07:17 +02:00

153 lines
5.4 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2026 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
using System.Diagnostics;
using System.Diagnostics.Metrics;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Opc.Ua.ISA95.Server.Builders;
namespace Opc.Ua.ISA95.Tests.Common
{
/// <summary>
/// Lightweight system context, NodeId factory and root node used to exercise
/// the ISA-95 common-model builder without a full server.
/// </summary>
internal sealed class Isa95CommonTestContext
{
public Isa95CommonTestContext()
{
NamespaceUris = new NamespaceTable();
InstanceNamespaceIndex =
NamespaceUris.GetIndexOrAppend("urn:test:isa95:instance");
NamespaceUris.GetIndexOrAppend(Namespaces.ISA95);
Context = new SystemContext(new StubTelemetry())
{
NamespaceUris = NamespaceUris,
NodeIdFactory = new ChildNodeIdFactory()
};
Root = new FolderState(null)
{
NodeId = new NodeId("Root", InstanceNamespaceIndex),
BrowseName = new QualifiedName("Root", InstanceNamespaceIndex),
DisplayName = new LocalizedText("Root"),
TypeDefinitionId = Ua.ObjectTypeIds.FolderType
};
}
public SystemContext Context { get; }
public NamespaceTable NamespaceUris { get; }
public ushort InstanceNamespaceIndex { get; }
public FolderState Root { get; }
public int RegisterCount { get; private set; }
public int RemoveCount { get; private set; }
public Isa95ModelBuilder CreateBuilder(bool withRemove = false)
{
return new Isa95ModelBuilder(
Context,
Root,
InstanceNamespaceIndex,
RegisterAsync,
withRemove ? RemoveAsync : null);
}
public NodeId Resolve(ExpandedNodeId referenceTypeId)
{
return ExpandedNodeId.ToNodeId(referenceTypeId, NamespaceUris);
}
public NodeId ExpectedChildId(string name)
{
return new NodeId("Root_" + name, InstanceNamespaceIndex);
}
private ValueTask RegisterAsync(NodeState node, CancellationToken cancellationToken)
{
RegisterCount++;
return new ValueTask();
}
private ValueTask RemoveAsync(NodeState node, CancellationToken cancellationToken)
{
RemoveCount++;
return new ValueTask();
}
private sealed class ChildNodeIdFactory : INodeIdFactory
{
public NodeId New(ISystemContext context, NodeState node)
{
if (!node.NodeId.IsNull)
{
return node.NodeId;
}
if (node is BaseInstanceState instance && instance.Parent != null)
{
string name = instance.SymbolicName ?? instance.BrowseName.Name ?? "Node";
return new NodeId(
instance.Parent.NodeId.IdentifierAsString + "_" + name,
instance.Parent.NodeId.NamespaceIndex);
}
return node.NodeId;
}
}
private sealed class StubTelemetry : ITelemetryContext
{
public Meter CreateMeter()
{
return new Meter("Opc.Ua.ISA95.Tests");
}
public Meter CreateMeter(System.Reflection.Assembly assembly)
{
return CreateMeter();
}
public ILoggerFactory LoggerFactory => NullLoggerFactory.Instance;
public ActivitySource ActivitySource { get; } =
new ActivitySource("Opc.Ua.ISA95.Tests");
public ActivitySource GetActivitySource(System.Reflection.Assembly assembly)
{
return ActivitySource;
}
}
}
}