Files
UA-.NETStandard/tools/Opc.Ua.MigrationAnalyzer.CodeFixer/CodeFixes/UA0022CertificateValidatorPropertyRenameCodeFix.cs
2026-07-16 06:25:54 +02:00

109 lines
4.7 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.Immutable;
using System.Composition;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CodeActions;
using Microsoft.CodeAnalysis.CodeFixes;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Opc.Ua.MigrationAnalyzer.Diagnostics;
namespace Opc.Ua.MigrationAnalyzer.CodeFixer
{
/// <summary>
/// UA0022 code fix: rewrite <c>xxx.CertificateValidator</c> as
/// <c>xxx.CertificateManager</c>. Only the property identifier is
/// renamed; downstream member access on the (now differently-typed)
/// <c>ICertificateManager</c> result may still need manual review.
/// </summary>
[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(UA0022CertificateValidatorPropertyRenameCodeFix))]
[Shared]
public sealed class UA0022CertificateValidatorPropertyRenameCodeFix : CodeFixProvider
{
private const string NewPropertyName = "CertificateManager";
public override ImmutableArray<string> FixableDiagnosticIds { get; } =
[DiagnosticIds.UA0022];
public override FixAllProvider GetFixAllProvider()
{
return WellKnownFixAllProviders.BatchFixer;
}
public override async Task RegisterCodeFixesAsync(CodeFixContext context)
{
SyntaxNode root = (await context.Document.GetSyntaxRootAsync(context.CancellationToken)
.ConfigureAwait(false))!;
foreach (Diagnostic diagnostic in context.Diagnostics)
{
SyntaxNode node = root.FindNode(diagnostic.Location.SourceSpan, getInnermostNodeForTie: true);
MemberAccessExpressionSyntax memberAccess = node.AncestorsAndSelf()
.OfType<MemberAccessExpressionSyntax>()
.FirstOrDefault();
if (memberAccess is null ||
memberAccess.Name.Identifier.ValueText != "CertificateValidator")
{
continue;
}
context.RegisterCodeFix(
CodeAction.Create(
title: "Use 'CertificateManager' property",
createChangedDocument: ct => ApplyAsync(context.Document, memberAccess, ct),
equivalenceKey: DiagnosticIds.UA0022),
diagnostic);
}
}
private static async Task<Document> ApplyAsync(
Document document,
MemberAccessExpressionSyntax memberAccess,
CancellationToken cancellationToken)
{
SyntaxToken oldIdentifier = memberAccess.Name.Identifier;
SyntaxToken newIdentifier = SyntaxFactory.Identifier(
oldIdentifier.LeadingTrivia,
NewPropertyName,
oldIdentifier.TrailingTrivia);
MemberAccessExpressionSyntax newMemberAccess = memberAccess
.WithName(SyntaxFactory.IdentifierName(newIdentifier));
SyntaxNode root = (await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false))!;
SyntaxNode newRoot = root.ReplaceNode(memberAccess, newMemberAccess);
return document.WithSyntaxRoot(newRoot);
}
}
}