Files
romanett 442889cba5 Fix source generator audit findings; conform structure-field matrices and type metadata to OPC UA 1.05 (#4569)
# Description

This PR fixes a bug audit of the source generation projects
(`tools/Opc.Ua.SourceGeneration*`: model loading, NodeSet import, all
emitters, the Roslyn hosts and packaging). It also fixes a max-effort
code review of those fixes, and a check of every spec-relevant change
against the OPC UA 1.05 text.

- **Scope:** about 85 audit findings, 48 review findings and 32
spec-grounding items were addressed. Each fix has a regression test that
fails without it.
- **Wire change:** it includes one deliberate, stack-wide wire change:
**structure-field matrices now follow OPC 10000-6 5.2.5 Table 28**.

Most changes are internal correctness fixes. The sections below list
every change a user can observe: wire formats, generated code and API,
generated address-space content, diagnostics and runtime behaviour.

## Behaviour / user-facing changes

### Wire format (encoders)
- **Binary inline matrices** (OPC 10000-6 5.2.5 Table 28).
- **Layout:** a multi-dimensional *structure field* is encoded as
`Int32[] Dimensions`, then the values **without a length prefix**, with
at least 2 dimensions.
- **Empty and null:** any dimension <= 0 means no values follow, and a
null matrix is `-1`. An empty matrix is written as `[0,0]`.
- **Compatibility:** this is **not compatible with earlier builds of
this SDK** for matrix fields. It applies to generated types,
`[DataType]` types, `Structure`, client ComplexTypes and
`WriteEncodeableMatrix`.
  - **Unchanged:** Variant matrices (5.2.2.16) keep their old encoding.
- **Declared rank decides matrix vs array.** A 1-D `MatrixOf<T>` in an
array field or a Variable value is written as an array again.
Matrix-declared fields go through the new public
`EncoderExtensions.WriteInlineMatrixValue`, which generated code also
uses. A non-empty 1-D value in a matrix field throws `BadEncodingError`.
- **Decoder hardening:**
- Before allocating, the decoder bounds all matrix dimensions against
overflow, `MaxArrayLength` and the remaining message length.
  - The decoder rejects:
    - a matrix with fewer than 2 dimensions;
- a populated matrix whose rank differs from the field's declared rank;
    - a union SwitchField greater than the number of fields;
    - an EncodingMask with unassigned bits set.
- **Encoder `MaxArrayLength`:** the encoder enforces `MaxArrayLength`
for inline matrices, as it already did for arrays.
- **XML structure fields** (5.3.1, 5.3.4, 5.3.5).
- **Fields:** `Structure` and client ComplexTypes write fields like
typed fields (`<A>1</A>`, array elements directly) instead of a Variant
body.
- **Matrix fields:** `Dimensions` and `Elements` go directly inside the
field element, with no `<Matrix>` wrapper.
- **Empty matrices:** written as nil, because XML dimensions must be
greater than 0.
  - **Compatibility:** decoders still accept the old shapes.
- **Enum fixes:** enum array elements with value 0 are no longer
dropped, and enum array element names are fixed.
- **Other encoding fixes:**
- A null `DiagnosticInfo` structure field writes `0x00` instead of
nothing.
- A null scalar field in a runtime `Structure` is written as its default
instead of zero bytes, which used to shift every following field.
- A Variant holding an empty matrix encodes as an empty array instead of
throwing.
  - `Variant.Copy` keeps the matrix identity of null and empty matrices.
- **NodeSet export and the DataContract surrogate** write Variable
values with the Variant rules again. A null or empty `MatrixOf` variable
no longer produces invalid XML or unreadable NodeSets.
- **`JsonEncoder.CanOmitFields`** is `true` only for Compact encoding.
Verbose and RawData JSON include default-valued fields.

### `[DataType]` source-generated types
- **Default-value handling** (OPC 10000-6 5.4.1, Table 1).
- **Encode:** a field is omitted only when its value *and* its declared
default are the type's default (0, false, null). Fields with a
non-default initializer or constructor default, and empty strings, are
always written, so configuration files get slightly larger.
- **JSON decode:** a field missing from JSON decodes to the type
default.
- **XML decode:** a field missing from XML keeps its declared default,
which older configuration files rely on.
- **Why:** this fixes silent round-trip loss, for example
`SamplingInterval = 0` read back as `-1`.
- **Nested `[DataType]` types:** they are now generated inside their
containing types. Without an explicit id, their default TypeId and
XmlName are qualified (e.g. `s=Outer.Foo`); **wire identity change** for
nested types. Colliding activator names get a `_2` suffix.
- **Activators:** they are `internal` when the type, or any containing
type, is not public (was CS0060).
- **Matrix properties:**
  - `MatrixOf<T>` properties use the inline matrix encoding.
- Matrices of non-sealed structures, or with
`StructureHandling.ExtensionObject`, are written as ExtensionObjects.
- Their published ValueRank is 2, because the rank can't be known from
`MatrixOf<T>`.
- **Published StructureDefinitions:**
  - They include base-class fields.
  - Nullable properties are no longer marked optional.
  - Inline structure fields name their concrete type.
- **`[Flags]` enums:** they are published as plain enumerations with
their member values, which matches how they are encoded.
- **Other generated code:**
- `Clone` deep-copies arrays and matrices of structures, Variants,
ExtensionObjects and DataValues.
- `IsEqual` and `GetHashCode` are consistent: EncodingMask, active union
member and NaN handling agree.
- Pooled `Reuse()` restores the freshly constructed state through the
new `protected virtual ResetForReuse()`, and returns an instance to its
runtime type's pool.
- **Enum capture:** enum member values are captured culture-invariantly.
Negative values were lost on cultures that use U+2212 as the minus sign.

### Model-driven generator: generated code, API and file names
- **Removed API:** generated `*_Placeholder` proxy accessors (e.g.
`PowerTrainTypeClient.GetMotorIdentifier_PlaceholderAsync`) and fluent
`X_Placeholder()` accessors are removed; they could never resolve
anything.
- Proxy accessors now look children up by BrowseName with the right
namespace.
- `RoboticsClient` finds motors and gears by type and drives via
`IsDrivenBy`. Its topology snapshots used to be empty.
- **Renamed files:** generated files for a bound `[NodeManager]` are now
named `{Namespace}.{Class}.NodeManager.g.cs` (also `.Factory` and
`.FluentBuilders`).
- **Generated NodeState code:**
- Attributes are set through `baseState`/`nodeState` locals, so children
named like base attributes (e.g. `DataType`, `EventNotifier`) compile.
- Children that hide base members are declared `public new`, using names
reflected from the runtime.
  - `global::` qualification is used throughout.
- **Proxies and fluent builders:** a proxy whose supertype is excluded
(e.g. Draft) derives from the nearest emitted ancestor. Fluent wrappers
and NodeState factories fall back the same way; they used to fail with
CS0246.
- **Derived structures:**
  - The optional-field `EncodingMask` continues across inheritance.
- A derived structure over a base type from another model no longer
relies on `base.ResetForReuse`.
- **Default values:**
- NodeId, QualifiedName and ExpandedNodeId defaults resolve by namespace
URI (`context.NamespaceUris.GetIndexOrAppend`) and server URI.
- StatusCode, negative enum, `double`/`float` (shortest round-trip
literal) and escaped string defaults now compile.
- **Event records:**
- Vendor event records have `Decoder.GetStandardFields(NamespaceTable)`,
and their browse paths use the model's namespace.
- A field whose namespace is unknown to the session no longer matches a
namespace-0 field.
  - Companion `StandardFields` is `[Obsolete]`.
- Vendor simple subtypes such as `Percent : Double` map to their
built-in type.
- **Other fixes:**
- `MethodState.CallAsync` passes the real `objectId` to synchronous
`OnCallMethod2` handlers; it used to pass `NodeId.Null`.
- Enumeration fields with an explicit `Identifier` keep it, instead of
taking a trailing `_<digits>`.
  - Explicit NumericIds are no longer reused by automatic numbering.
  - Dependencies are loaded in topological order.

### Generated address-space content
- **Arguments:**
- Methods without arguments no longer get empty
`InputArguments`/`OutputArguments` properties (OPC 10000-3 5.7).
- About 2,660 automatically assigned namespace-0 NodeIds of 15000 and
above shift. Every NodeId in `StandardTypes.csv` is unchanged.
- **Permissions:** type nodes and method declarations on types now carry
the model's `RolePermissions`/`AccessRestrictions`.
- **Restored nodes:** NodeSet import keeps nodes that were silently
dropped before:
- `NamespaceMetadata` objects and the NodeSet's own TypeDictionary
variables;
  - ISA95 placeholders linked only non-hierarchically;
  - instances whose parent is in another namespace.
- **Import details:**
  - ValueRank > 1 without ArrayDimensions keeps its rank.
  - `svr=` indexes map correctly.
  - Invalid MinimumSamplingInterval values import as -1, not 0.
  - Localized texts prefer the invariant or English translation.
- **StructureDefinitions:**
- They include inherited fields, including for subtypes without their
own fields (e.g. `AnonymousIdentityToken` now publishes PolicyId).
  - The StructureType kind covers inherited AllowSubTypes fields.
  - Unions ignore IsOptional.
- StructureFields never publish ValueRank 0; a OneOrMoreDimensions field
without dimensions becomes rank 2.
- Fields with ValueRank -2/-3 are published as scalar BaseDataType,
which is what is on the wire.
- **OptionSets:**
  - Implicit fields get the next free bit.
- `OptionSetValues` uses null for undefined bits instead of "Reserved",
and structure OptionSets publish all their bits (no 32/96-bit cap).
- Numeric OptionSets are limited to their base type's width, and UInt64
bit 63 works.
- **Schemas:**
- Structures with inline-matrix fields are left out of the `.bsd`
(5.2.5).
- In the BSD, Variant-encoded and non-structure subtyped fields are
described as `ua:Variant`.
- In the `.xsd`, matrix fields are typed `ua:Matrix` with
`Dimensions`/`Elements`, and `EncodingMask` is required.

### NodeSet / model input handling
- **Model selection:**
- The newest NodeSet of a model is chosen by `ModelVersion` (SemVer 2.0
precedence), then PublicationDate. The `Version` attribute, which Annex
F says is not for comparison, is only a tie-break.
- The order is total and does not depend on input order; referenced
assemblies use the same rule.
- **Default names:**
- Invalid default Name/Prefix values are repaired (`201301ISA95` becomes
`_201301ISA95`, `class` becomes `class_`).
  - Valid names are unchanged.
  - Sanitising no longer depends on the OS.
- **`ModelUri` metadata** that doesn't match the NodeSet raises a
warning instead of silently losing the model.
- **Input detection:**
- Only XML files whose root is `ModelDesign` or `UANodeSet` are treated
as models.
- A malformed NodeSet stays a NodeSet input, so it no longer breaks the
ModelDesign pass.
- **`IdentifierFile` paths:** they are normalized (`./`, `../`), and the
suffix match requires a folder boundary.
- **Dependency payloads** (`ModelDependencyV1`) carry field IsOptional,
AllowSubTypes, ArrayDimensions and the producer's namespace tables in
skippable trailers, so old and new readers stay compatible.

### Roslyn host, diagnostics, packaging
- **New diagnostics:**
- MODELGEN036: `[NodeManager]` target not supported (nested, generic,
file-local or global namespace).
- MODELGEN037: `[DataType]` target not supported (struct, generic,
abstract, file-local or global namespace).
- MODELGEN038: the definition of an encodeable base type can't be found.
- **New validator errors:**
- a structure with both optional and subtyped fields (OPC 10000-6 F.13);
  - multi-bit or duplicate OptionSet masks.
- **Diagnostic locations:** `[DataType]`/`[NodeManager]` diagnostics
point at real source locations again, so `#pragma` and `.editorconfig`
apply. MODELGEN010 is the exception.
- **Incremental caching:** pipeline values compare by value, so
unrelated edits no longer regenerate the whole model or all
`[DataType]`s.
- **`ModelSourceGeneratorIgnore`** on a ModelDesign input is honoured;
the design still resolves as a dependency.
- **Cancellation:** a cancelled generation run propagates
`OperationCanceledException` instead of reporting a MODELGEN003 error.
- **Stack package:** the `Stack` NuGet package now ships
`build/OPCFoundation.NetStandard.Opc.Ua.SourceGeneration.Stack.props`,
so `StackSourceGeneratorMode` and `StackSourceGeneratorExclude` reach
the compiler.

## Related Issues

- No tracking issue. The audit, review and spec-grounding reports are
available on request. Contains the matrix wire-format change discussed
for D-5 (OPC 10000-6 5.2.5 Table 28).

## 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.
(`docs/SourceGeneratedDataTypes.md`, `docs/NodeManagers.md`, generator
readme)
- [x] I have verified that my changes do not introduce (new) build or
analyzer warnings. (`UA.slnx` 0 warnings / 0 errors on net48 and
net10.0)
- [ ] I ran **all** tests locally using the **UA.slnx** solution against
at least .net **framework** and .net **10**, and all passed. The
affected suites were run on net10.0: SourceGeneration Core/Roslyn/Stack,
Types, Core.Encoders, Encoders.Fuzz, Client, Client.ComplexTypes,
PubSub, Core, Server, GDS, Configuration, Di, Robotics, ISA95,
Positioning, OpenUsd, XRegistry. net48 was built; its test legs, and the
post-rebase verification, run in CI.
- [ ] I fixed **all** failing and flaky tests in the CI pipelines and
**all** CodeQL warnings.
- [ ] I have addressed **all** PR feedback received.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-29 00:47:40 +02:00

964 lines
32 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2025 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.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.Text;
using Microsoft.Extensions.Logging.Abstractions;
using NUnit.Framework;
namespace Opc.Ua.SourceGeneration.Tests
{
[TestFixture]
[Category("SourceGeneration")]
[SetCulture("en-us")]
[SetUICulture("en-us")]
public class ExtensionsTests
{
[Test]
public void GetBoolReturnsTrueWhenValueIsTrue()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyFlag".ToLowerInvariant()] = "true"
});
bool result = options.GetBool("MyFlag");
Assert.That(result, Is.True);
}
[Test]
public void GetBoolReturnsTrueWhenValueIsTrueCaseInsensitive()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyFlag".ToLowerInvariant()] = "True"
});
bool result = options.GetBool("MyFlag");
Assert.That(result, Is.True);
}
[Test]
public void GetBoolReturnsFalseWhenValueIsFalse()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyFlag".ToLowerInvariant()] = "false"
});
bool result = options.GetBool("MyFlag");
Assert.That(result, Is.False);
}
[Test]
public void GetBoolReturnsFalseWhenKeyMissing()
{
var options = new AnalyzerOptions([]);
bool result = options.GetBool("NonExistent");
Assert.That(result, Is.False);
}
[Test]
public void GetStringReturnsValueWhenPresent()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyString".ToLowerInvariant()] = "hello"
});
string result = options.GetString("MyString");
Assert.That(result, Is.EqualTo("hello"));
}
[Test]
public void GetStringReturnsEmptyStringWhenKeyMissing()
{
var options = new AnalyzerOptions([]);
string result = options.GetString("NonExistent");
Assert.That(result, Is.EqualTo(string.Empty));
}
[Test]
public void GetIntegerReturnsValueWhenPresent()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyInt".ToLowerInvariant()] = "42"
});
int result = options.GetInteger("MyInt");
Assert.That(result, Is.EqualTo(42));
}
[Test]
public void GetIntegerReturnsZeroWhenKeyMissing()
{
var options = new AnalyzerOptions([]);
int result = options.GetInteger("NonExistent");
Assert.That(result, Is.Zero);
}
[Test]
public void GetIntegerReturnsZeroWhenValueIsNotANumber()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyInt".ToLowerInvariant()] = "notanumber"
});
int result = options.GetInteger("MyInt");
Assert.That(result, Is.Zero);
}
[Test]
public void GetStringsSplitsSemicolonDelimited()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyList".ToLowerInvariant()] = "a;b;c"
});
IReadOnlyList<string> result = options.GetStrings("MyList");
Assert.That(result, Has.Count.EqualTo(3));
Assert.That(result, Does.Contain("a"));
Assert.That(result, Does.Contain("b"));
Assert.That(result, Does.Contain("c"));
}
[Test]
public void GetStringsSplitsCommaDelimited()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyList".ToLowerInvariant()] = "x,y,z"
});
IReadOnlyList<string> result = options.GetStrings("MyList");
Assert.That(result, Has.Count.EqualTo(3));
Assert.That(result, Does.Contain("x"));
Assert.That(result, Does.Contain("y"));
Assert.That(result, Does.Contain("z"));
}
[Test]
public void GetStringsSplitsPlusDelimited()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyList".ToLowerInvariant()] = "a+b"
});
IReadOnlyList<string> result = options.GetStrings("MyList");
Assert.That(result, Has.Count.EqualTo(2));
}
[Test]
public void GetStringsReturnsEmptyListWhenKeyMissing()
{
var options = new AnalyzerOptions([]);
IReadOnlyList<string> result = options.GetStrings("NonExistent");
Assert.That(result, Is.Empty);
}
[Test]
public void GetStringsTrimsWhitespace()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyList".ToLowerInvariant()] = " a ; b ; c "
});
IReadOnlyList<string> result = options.GetStrings("MyList");
Assert.That(result, Has.Count.EqualTo(3));
Assert.That(result, Does.Contain("a"));
Assert.That(result, Does.Contain("b"));
Assert.That(result, Does.Contain("c"));
}
[Test]
public void GetStringsFiltersEmptyEntries()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyList".ToLowerInvariant()] = "a;;b"
});
IReadOnlyList<string> result = options.GetStrings("MyList");
Assert.That(result, Has.Count.EqualTo(2));
}
[Test]
public void GetValueWithBuildMetadataPrefix()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_metadata.AdditionalFiles.{SourceGenerator.Name}MyProp".ToLowerInvariant()] = "val"
});
string result = options.GetString("MyProp", buildProperty: false);
Assert.That(result, Is.EqualTo("val"));
}
[Test]
public void GetBoolWithBuildMetadataPrefix()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_metadata.AdditionalFiles.{SourceGenerator.Name}IsEnabled".ToLowerInvariant()] = "true"
});
bool result = options.GetBool("IsEnabled", buildProperty: false);
Assert.That(result, Is.True);
}
[Test]
public void GetIntegerWithBuildMetadataPrefix()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_metadata.AdditionalFiles.{SourceGenerator.Name}Count".ToLowerInvariant()] = "7"
});
int result = options.GetInteger("Count", buildProperty: false);
Assert.That(result, Is.EqualTo(7));
}
[Test]
public void ToNodeSetOptionsWithNullReturnsDefaults()
{
NodesetFileOptions result = Extensions.ToNodeSetOptions(null);
Assert.That(result, Is.Not.Null);
Assert.That(result.Ignore, Is.False);
Assert.That(result.Prefix, Is.Null);
Assert.That(result.Version, Is.Null);
Assert.That(result.Name, Is.Null);
Assert.That(result.ModelUri, Is.Null);
}
[Test]
public void ToNodeSetOptionsWithValidOptionsPopulatesAllProperties()
{
string prefix = $"build_metadata.AdditionalFiles.{SourceGenerator.Name}";
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"{prefix}Ignore".ToLowerInvariant()] = "true",
[$"{prefix}Prefix".ToLowerInvariant()] = "MyPrefix",
[$"{prefix}Version".ToLowerInvariant()] = "1.0",
[$"{prefix}Name".ToLowerInvariant()] = "MyName",
[$"{prefix}ModelUri".ToLowerInvariant()] = "http://test.org"
});
NodesetFileOptions result = options.ToNodeSetOptions();
Assert.That(result.Ignore, Is.True);
Assert.That(result.Prefix, Is.EqualTo("MyPrefix"));
Assert.That(result.Version, Is.EqualTo("1.0"));
Assert.That(result.Name, Is.EqualTo("MyName"));
Assert.That(result.ModelUri, Is.EqualTo("http://test.org"));
}
[Test]
public void ToNodeSetOptionsWithEmptyOptionsSetsDefaults()
{
var options = new AnalyzerOptions([]);
NodesetFileOptions result = options.ToNodeSetOptions();
Assert.That(result.Ignore, Is.False);
Assert.That(result.Prefix, Is.EqualTo(string.Empty));
Assert.That(result.Version, Is.EqualTo(string.Empty));
Assert.That(result.Name, Is.EqualTo(string.Empty));
Assert.That(result.ModelUri, Is.EqualTo(string.Empty));
}
[Test]
public void GetFullNamespaceReturnsNamespaceForType()
{
const string code = @"
namespace My.Test.Namespace
{
public class TestClass { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("My.Test.Namespace.TestClass");
Assert.That(symbol, Is.Not.Null);
Assert.That(symbol.GetFullNamespace(), Is.EqualTo("My.Test.Namespace"));
}
[Test]
public void GetFullNamespaceReturnsEmptyForGlobalNamespace()
{
const string code = "public class GlobalClass { }";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("GlobalClass");
Assert.That(symbol, Is.Not.Null);
Assert.That(symbol.GetFullNamespace(), Is.EqualTo(string.Empty));
}
[Test]
public void GetFullNamespaceReturnsSingleSegmentNamespace()
{
const string code = @"
namespace Single
{
public class TestClass { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Single.TestClass");
Assert.That(symbol, Is.Not.Null);
Assert.That(symbol.GetFullNamespace(), Is.EqualTo("Single"));
}
[Test]
public void GetFullyQualifiedTypeNameReturnsGlobalPrefixed()
{
const string code = @"
namespace My.Namespace
{
public class MyType { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("My.Namespace.MyType");
Assert.That(symbol, Is.Not.Null);
string result = symbol.GetFullyQualifiedTypeName();
Assert.That(result, Does.StartWith("global::"));
Assert.That(result, Does.Contain("My.Namespace.MyType"));
}
[Test]
public void ImplementsInterfaceReturnsTrueWhenImplemented()
{
const string code = @"
namespace Test
{
public interface IMyInterface { }
public class MyClass : IMyInterface { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
Assert.That(symbol, Is.Not.Null);
Assert.That(symbol.ImplementsInterface("IMyInterface"), Is.True);
}
[Test]
public void ImplementsInterfaceReturnsFalseWhenNotImplemented()
{
const string code = @"
namespace Test
{
public interface IMyInterface { }
public class MyClass { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
Assert.That(symbol, Is.Not.Null);
Assert.That(symbol.ImplementsInterface("IMyInterface"), Is.False);
}
[Test]
public void HasAttributeReturnsFalseWhenAbsent()
{
const string code = @"
namespace Test
{
public class MyClass { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
Assert.That(symbol, Is.Not.Null);
Assert.That(symbol.HasAttribute("ObsoleteAttribute"), Is.False);
}
[Test]
public void AttributeDataGetValueReturnsNullForNullAttribute()
{
AttributeData attr = null;
string result = attr.GetValue("SomeName");
Assert.That(result, Is.Null);
}
[Test]
public void AttributeDataGetValueReturnsNullWhenNameNotFound()
{
const string code = """
using System;
namespace Test
{
[Obsolete("reason")]
public class MyClass { }
}
""";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
AttributeData attr = symbol.GetAttributes().First();
string result = attr.GetValue("NonExistentName");
Assert.That(result, Is.Null);
}
#if NET8_0_OR_GREATER
[Test]
public void AttributeDataGetValueReturnsStringValueWhenFound()
{
const string code = """
using System;
using System.ComponentModel;
namespace Test
{
[DefaultValue(Name = "hello")]
public class MyClass { }
[AttributeUsage(AttributeTargets.Class)]
public class DefaultValueAttribute : Attribute
{
public string Name { get; set; }
}
}
""";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
AttributeData attr = symbol.GetAttributes()
.First(a => a.AttributeClass?.Name == "DefaultValueAttribute");
string result = attr.GetValue("Name");
Assert.That(result, Is.EqualTo("hello"));
}
[Test]
public void AttributeDataGetIntegerReturnsValueWhenFound()
{
const string code = @"
using System;
namespace Test
{
[MyAttr(Count = 7)]
public class MyClass { }
[AttributeUsage(AttributeTargets.Class)]
public class MyAttrAttribute : Attribute
{
public int Count { get; set; }
}
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
AttributeData attr = symbol.GetAttributes()
.First(a => a.AttributeClass?.Name == "MyAttrAttribute");
int result = attr.GetInteger("Count");
Assert.That(result, Is.EqualTo(7));
}
[Test]
public void HasAttributeReturnsTrueWhenPresent()
{
const string code = @"
using System;
namespace Test
{
[Obsolete]
public class MyClass { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
Assert.That(symbol, Is.Not.Null);
Assert.That(symbol.HasAttribute("ObsoleteAttribute"), Is.True);
}
#endif
[Test]
public void AttributeDataGetIntegerReturnsDefaultForNullAttribute()
{
AttributeData attr = null;
int result = attr.GetInteger("SomeName", 42);
Assert.That(result, Is.EqualTo(42));
}
[Test]
public void AttributeDataGetIntegerReturnsDefaultWhenNameNotFound()
{
const string code = """
using System;
namespace Test
{
[Obsolete("reason")]
public class MyClass { }
}
""";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
AttributeData attr = symbol.GetAttributes().First();
int result = attr.GetInteger("NonExistent", 99);
Assert.That(result, Is.EqualTo(99));
}
[Test]
public void AttributeDataGetIntegerReturnsDefaultValueOfZero()
{
AttributeData attr = null;
int result = attr.GetInteger("SomeName");
Assert.That(result, Is.Zero);
}
[Test]
public void GetValueWithCustomConverterAppliesConverter()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyProp".ToLowerInvariant()] = "42"
});
int result = options.GetValue(
"MyProp",
s => int.Parse(s, System.Globalization.CultureInfo.InvariantCulture));
Assert.That(result, Is.EqualTo(42));
}
[Test]
public void GetValueWithMissingKeyPassesNullToConverter()
{
var options = new AnalyzerOptions([]);
string result = options.GetValue("Missing", s => s ?? "default");
Assert.That(result, Is.EqualTo("default"));
}
[Test]
public void GetValueWithBuildMetadataPrefixUsesCorrectKey()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_metadata.AdditionalFiles.{SourceGenerator.Name}Prop".ToLowerInvariant()] = "val"
});
string result = options.GetValue("Prop", s => s, buildProperty: false);
Assert.That(result, Is.EqualTo("val"));
}
[Test]
public void GetStringsMixedDelimitersParseCorrectly()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}Items".ToLowerInvariant()] = "a;b,c+d"
});
IReadOnlyList<string> result = options.GetStrings("Items");
Assert.That(result, Has.Count.EqualTo(4));
Assert.That(result, Does.Contain("a"));
Assert.That(result, Does.Contain("b"));
Assert.That(result, Does.Contain("c"));
Assert.That(result, Does.Contain("d"));
}
[Test]
public void ImplementsInterfaceWithInheritedInterfaceReturnsTrue()
{
const string code = @"
namespace Test
{
public interface IBase { }
public interface IDerived : IBase { }
public class MyClass : IDerived { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
Assert.That(symbol, Is.Not.Null);
Assert.That(symbol.ImplementsInterface("IBase"), Is.True);
Assert.That(symbol.ImplementsInterface("IDerived"), Is.True);
}
[Test]
public void GetFullNamespaceWithDeeplyNestedNamespace()
{
const string code = @"
namespace A.B.C.D.E
{
public class DeepClass { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("A.B.C.D.E.DeepClass");
Assert.That(symbol, Is.Not.Null);
Assert.That(symbol.GetFullNamespace(), Is.EqualTo("A.B.C.D.E"));
}
[Test]
public void GetFullyQualifiedTypeNameOmitsGlobalNamespace()
{
const string code = @"
namespace Test
{
public class SimpleType { }
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.SimpleType");
Assert.That(symbol, Is.Not.Null);
string result = symbol.GetFullyQualifiedTypeName();
Assert.That(result, Is.EqualTo("global::Test.SimpleType"));
}
[Test]
public void AttributeDataGetValueReturnsNullForNonStringNamedArgument()
{
const string code = @"
using System;
namespace Test
{
[MyAttr(Count = 5)]
public class MyClass { }
[AttributeUsage(AttributeTargets.Class)]
public class MyAttrAttribute : Attribute
{
public int Count { get; set; }
}
}
";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
AttributeData attr = symbol.GetAttributes()
.First(a => a.AttributeClass?.Name == "MyAttrAttribute");
string result = attr.GetValue("Count");
Assert.That(result, Is.Null);
}
[Test]
public void AttributeDataGetIntegerReturnsDefaultForNonIntegerNamedArgument()
{
const string code = """
using System;
namespace Test
{
[MyAttr(Name = "hello")]
public class MyClass { }
[AttributeUsage(AttributeTargets.Class)]
public class MyAttrAttribute : Attribute
{
public string Name { get; set; }
}
}
""";
CSharpCompilation compilation = CSharpCompilation.Create("TestAssembly")
.AddReferences(CompilerUtils.TrustedReferences)
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(code));
INamedTypeSymbol symbol = compilation.GetTypeByMetadataName("Test.MyClass");
AttributeData attr = symbol.GetAttributes()
.First(a => a.AttributeClass?.Name == "MyAttrAttribute");
int result = attr.GetInteger("Name", 99);
Assert.That(result, Is.EqualTo(99));
}
[Test]
public void ToNodeSetOptionsIgnoreFieldFromBuildMetadata()
{
string prefix = $"build_metadata.AdditionalFiles.{SourceGenerator.Name}";
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"{prefix}Ignore".ToLowerInvariant()] = "false"
});
NodesetFileOptions result = options.ToNodeSetOptions();
Assert.That(result.Ignore, Is.False);
}
[Test]
public void IsDesignOrNodeset2FileReturnsTrueForXml()
{
var text = EmbeddedAdditionalText.Create("file.xml");
Assert.That(text.IsDesignOrNodeset2File(), Is.True);
}
[TestCase("<opc:ModelDesign xmlns:opc=\"http://opcfoundation.org/UA/ModelDesign.xsd\" />", true)]
[TestCase("<?xml version=\"1.0\"?>\n<!-- c -->\n<UANodeSet xmlns=\"http://opcfoundation.org/UA/2011/03/UANodeSet.xsd\" />", true)]
[TestCase("<linker><assembly fullname=\"A\" /></linker>", false)]
[TestCase("<ModelDesign xmlns=\"http://example.org/other\" />", false)]
[TestCase("<ModelDesign", true)]
public void IsDesignOrNodeset2FileSniffsTheRootElement(string content, bool expected)
{
// Only a ModelDesign or UANodeSet root is a model input; a file
// that cannot be parsed stays one so the model pipeline reports it.
var text = EmbeddedAdditionalText.Create("file.xml", content);
Assert.That(text.IsDesignOrNodeset2File(), Is.EqualTo(expected));
}
[Test]
public void GetStringsComparesByContent()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_property.{SourceGenerator.Name}MyList".ToLowerInvariant()] = "a;b"
});
// The options records carry this list; a fresh list per evaluation
// must still compare equal or the incremental cache never hits.
IReadOnlyList<string> first = options.GetStrings("MyList");
IReadOnlyList<string> second = options.GetStrings("MyList");
Assert.That(ReferenceEquals(first, second), Is.False);
Assert.That(
EqualityComparer<IReadOnlyList<string>>.Default.Equals(first, second),
Is.True,
"a record's generated equality compares the member this way");
Assert.That(
EqualityComparer<IReadOnlyList<string>>.Default.GetHashCode(first),
Is.EqualTo(EqualityComparer<IReadOnlyList<string>>.Default.GetHashCode(second)));
}
[Test]
public void IsDesignOrNodeset2FileReturnsFalseForCsv()
{
var text = EmbeddedAdditionalText.Create("file.csv");
Assert.That(text.IsDesignOrNodeset2File(), Is.False);
}
[Test]
public void IsIdentifierFileReturnsTrueForCsv()
{
var text = EmbeddedAdditionalText.Create("ids.csv", "Name,1,ObjectType");
Assert.That(text.IsIdentifierFile(), Is.True);
}
[Test]
public void IsIdentifierFileReturnsFalseForXml()
{
var text = EmbeddedAdditionalText.Create("ids.xml");
Assert.That(text.IsIdentifierFile(), Is.False);
}
[TestCase("test.XML", true)]
[TestCase("test.Xml", true)]
[TestCase("test.txt", false)]
public void HasFileExtensionIsCaseInsensitive(
string path, bool expected)
{
var text = EmbeddedAdditionalText.Create(path);
Assert.That(text.HasFileExtension("xml"), Is.EqualTo(expected));
}
[Test]
public void GetStringsWithBuildMetadataPrefix()
{
var options = new AnalyzerOptions(new Dictionary<string, string>
{
[$"build_metadata.AdditionalFiles.{SourceGenerator.Name}Items".ToLowerInvariant()] = "a;b"
});
IReadOnlyList<string> result = options.GetStrings("Items", buildProperty: false);
Assert.That(result, Has.Count.EqualTo(2));
Assert.That(result, Does.Contain("a"));
Assert.That(result, Does.Contain("b"));
}
[Test]
public void ToNodeSetFileCollectionWithEmptyArrayReturnsCollection()
{
#pragma warning disable IDE0301 // Simplify collection initialization
ImmutableArray<(AdditionalText, NodesetFileOptions)> files =
ImmutableArray<(AdditionalText, NodesetFileOptions)>.Empty;
#pragma warning restore IDE0301 // Simplify collection initialization
using var fileSystem = new VirtualFileSystem();
var telemetry = new NullTelemetry();
NodesetFileCollection collection = files.ToNodeSetFileCollection(
[],
fileSystem,
telemetry);
Assert.That(collection, Is.Not.Null);
}
private sealed class EmbeddedAdditionalText : AdditionalText
{
private EmbeddedAdditionalText(string path, string content)
{
Path = path;
m_text = SourceText.From(content);
}
public override string Path { get; }
public override SourceText GetText(
System.Threading.CancellationToken cancellationToken = default)
{
return m_text;
}
public static EmbeddedAdditionalText Create(
string path,
string content = "")
{
return new EmbeddedAdditionalText(path, content);
}
private readonly SourceText m_text;
}
private sealed class NullTelemetry : TelemetryContextBase
{
public NullTelemetry()
: base(NullLoggerFactory.Instance)
{
}
}
}
}