mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-18 14:43:08 +08:00
9b034f8291
# Description Nullable reference types are now enabled once, in `common.props`, and every project in the repository builds warning-clean with them. **Configuration** - `<Nullable>enable</Nullable>` lives in `common.props`. All per-project `<Nullable>` settings are removed: 178 project files (enable, annotations, and the `disable` in the three Aot test projects). - 419 per-file `#nullable enable`/`restore` directives and the 4 `#nullable disable` directives are removed. - Kept on purpose: - The 5 `<auto-generated>` schema files (`UANodeSet.cs`, `UA Type Dictionary.cs`, `OPCBinarySchema.cs`, `SecuredApplication.cs`, `PInvokeHelper.cs`) keep `#nullable enable`. The compiler ignores the project setting in generated code, so the directive is required there. - `tests/Opc.Ua.Interop.LegacyPeer` keeps `disable`. It builds against the 1.5.378 packages and does not import the repository props. - `docs/DeveloperGuide.md` and `.github/copilot-instructions.md` now describe the central setting. **Migration** (the 43 unset and 13 annotations-only projects, roughly 10k diagnostics) - **Production code: annotated at the declarations.** Covers `tools/Opc.Ua.SourceGeneration.Core`, `src/Opc.Ua.Lds.Server` and the LDS sample. - Members, parameters and returns are nullable where null actually flows. - Null-check helpers carry `[NotNullWhen]` (`IsNull`, `IsValidXmlName`, `IsMethodTypeDesign`). - `CoreUtils.Format`, `Utils.Format`, `ITemplateWriter.WriteLine` take `params object?[]`. `Template.AddReplacement` takes `string?` (rendering already skips null replacements). - `IRegisteredServerStore.RegisterAsync` returns `Task<RegistrationEntry?>`: it returns null when a registration is removed. - Dereferences backed by an invariant (for example, the validated model) use `!`, so runtime behaviour is unchanged. - **Behavioural changes in production code** (small, deliberate): - `NodeSetToModelDesign` throws `InvalidOperationException` when the file is not a NodeSet. Before, it threw a NullReferenceException on the next line. - `ModelDesignValidator` starts its lookup tables empty instead of null. A redundant `if (m_nodes == null) return;` guard is gone. - **Test code: minimal annotations.** - `?` on values that can be null, `!` where the test asserts non-null. - `= null!` for fixture members assigned in SetUp. - `TryGetStructure<T>(out T? x)` where the inferred `T?` broke the `IEncodeable` constraint. - A few redundant `== null` checks on structs (`NodeId`, `ArrayOf<T>`) folded into the adjacent `IsNull`/`Count` checks. **Notes for reviewers** - The diff is large (~1,500 files) but almost entirely mechanical: `?`, `!` and directive removal. The non-annotation changes are listed above. - Known follow-up, not done here: `IModelDesign.Namespaces/TargetNamespace/NamespaceUris` stay non-nullable even though the validator returns null before it loads a dictionary. Making them nullable would ripple through every generator call site. ## Related Issues - Fixes #4439 ## 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. - [ ] 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. - [ ] I have addressed **all** PR feedback received. The "no new warnings" box covers net10.0 and net48: full non-incremental builds of `UA.slnx`, `tools/SourceGeneration.slnx`, `tools/MigrationAnalyzer.slnx` and the Aot test projects finished with 0 warnings and 0 errors under the repository's warnings-as-errors settings. net9.0 and net8.0 also had no nullable diagnostics, but they were not rebuilt after the final fixes. Tests have not been run locally yet. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
964 lines
32 KiB
C#
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)
|
|
{
|
|
}
|
|
}
|
|
}
|
|
}
|