Logic and implementation for members and depedency injection.

Author: sgiffinlcd

CDF-Solution/CDF-Solution.sln.DotSettings

@@ -0,0 +1,2 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+<s:Boolean x:Key="/Default/UserDictionary/Words/=Grpc/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

CDF-Solution/CommonDeliveryFramework.Net.Aspnet/ControllerBaseExtensions.cs

@@ -69,7 +69,7 @@ public static ProblemObjectResult CreateProblemResult(this ControllerBase source
  private static ProblemObjectResult CreateGenericInternalServerErrorProblemResult()
  {
  var problem = new ProblemDetails
- { Type = "https://httpstatuses.com/500", Status = 500, Title = "Internal Server Error", Detail = "An internal error has occured and the operation could not complete." };
+ { Type = "https://httpstatuses.com/500", Status = 500, Title = "Internal Server Error", Detail = "An internal error has occurred and the operation could not complete." };
 
  return new ProblemObjectResult(problem);
  }

CDF-Solution/CommonDeliveryFramework.Net.Aspnet/ManagedExceptionExtensions.cs

@@ -11,7 +11,7 @@ public static class ManagedExceptionExtensions
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/403 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 403.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to Forbidden.</param>
@@ -27,7 +27,7 @@ public static ProblemDetails GetProblemDetails(this ExternalAccessException sour
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/504 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 504.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to Gateway Timeout.</param>
@@ -43,7 +43,7 @@ public static ProblemDetails GetProblemDetails(this CommunicationException sourc
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/500 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 500.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to Internal Server Error.</param>
@@ -59,7 +59,7 @@ public static ProblemDetails GetProblemDetails(this ConfigurationException sourc
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/500 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 500.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to Internal Server Error.</param>
@@ -75,7 +75,7 @@ public static ProblemDetails GetProblemDetails(this DataException source,
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/400 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 400.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to Bad Request.</param>
@@ -91,7 +91,7 @@ public static ProblemDetails GetProblemDetails(this ValidationException source,
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/500 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 500.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to Internal Server Error.</param>
@@ -107,7 +107,7 @@ public static ProblemDetails GetProblemDetails(this LogicException source,
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/500 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 500.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to Internal Server Error.</param>
@@ -123,7 +123,7 @@ public static ProblemDetails GetProblemDetails(this ManagedException source,
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/401 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 401.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to UnAuthorized.</param>
@@ -139,7 +139,7 @@ public static ProblemDetails GetProblemDetails(this SecurityException source,
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/504 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 504.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to GatewayTimeout.</param>
@@ -155,7 +155,7 @@ public static ProblemDetails GetProblemDetails(this TimeoutException source,
  /// Extension method that generates problem details for the exception.
  /// </summary>
  /// <param name="source">The exception to map to a <see cref="ProblemDetails"/></param>
- /// <param name="controller">The base controller the exception occured in. </param>
+ /// <param name="controller">The base controller the exception occurred in. </param>
  /// <param name="type">Optional parameter that sets the URL for the human readable explanation for the status code. Default value is set to https://httpstatuses.com/500 </param>
  /// <param name="status">Optional parameter that sets the return status code for the problem. Default value is set to 500.</param>
  /// <param name="title">Optional parameter that sets the title for the problem. Default value is set to Internal Server Error.</param>

CDF-Solution/CommonDeliveryFramework.Net.Automation.Common/AspNetCoreConstants.cs

@@ -0,0 +1,64 @@
+
+namespace CommonDeliveryFramework.Net.Automation.Common
+{
+ /// <summary>
+ /// Data class that contain a number of constants that are used throughout automation with asp.net core.
+ /// </summary>
+ public static class AspNetCoreConstants
+ {
+ /// <summary>
+ /// The name of the filed that holds the logger
+ /// </summary>
+ public const string FieldNameLogger = "_logger";
+
+ /// <summary>
+ /// The full name of the library for logging.
+ /// </summary>
+ public const string MicrosoftExtensionLibraryForLoggingName = "Microsoft.Extensions.Logging.Abstractions";
+
+ /// <summary>
+ /// Library name for the Microsoft Logger abstractions library.
+ /// </summary>
+ public const string MicrosoftLoggerLibraryName = "Microsoft.Extensions.Logging.Abstractions";
+
+ /// <summary>
+ /// The default namespace for the Microsoft extensions logger implementation
+ /// </summary>
+ public const string MicrosoftLoggerNamespace = "Microsoft.Extensions.Logging";
+
+ /// <summary>
+ /// The name of the interface for the Microsoft extensions logger.
+ /// </summary>
+ public const string MicrosoftLoggerInterfaceName = "ILogger";
+
+ /// <summary>
+ /// The fully qualified name of the a aspnet core controller.
+ /// </summary>
+ public const string ControllerBaseName = "Microsoft.AspNetCore.Mvc.ControllerBase";
+
+ /// <summary>
+ /// The full namespace for the mvc namespace.
+ /// </summary>
+ public const string MvcNamespace = "Microsoft.AspNetCore.Mvc";
+
+ /// <summary>
+ /// Name for the abstract classes that support action result.
+ /// </summary>
+ public const string ActionResultClassName = "ActionResult";
+
+ /// <summary>
+ /// Name of the interface for action results.
+ /// </summary>
+ public const string ActionResultInterfaceName = "IActionResult";
+
+ /// <summary>
+ /// Namespace for tasks 
+ /// </summary>
+ public const string SystemThreadingTasksNamespace = "System.Threading.Tasks";
+
+ /// <summary>
+ /// Class name for the Task class.
+ /// </summary>
+ public const string TaskClassName = "Task";
+ }
+}

CDF-Solution/CommonDeliveryFramework.Net.Automation.Common/CommonDeliveryFramework.Net.Automation.Common.csproj

@@ -50,6 +50,11 @@
  <Reference Include="WindowsBase" />
  </ItemGroup>
  <ItemGroup>
+ <Compile Include="AspNetCoreConstants.cs" />
+ <Compile Include="CsClassExtensions.cs" />
+ <Compile Include="CsClassMemberExtensions.cs" />
+ <Compile Include="DependencyInjectionExtensions.cs" />
+ <Compile Include="GrpcConstants.cs" />
  <Compile Include="Properties\AssemblyInfo.cs" />
  </ItemGroup>
  <ItemGroup />

CDF-Solution/CommonDeliveryFramework.Net.Automation.Common/CsClassExtensions.cs

@@ -0,0 +1,136 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using CodeFactory;
+using CodeFactory.DotNet.CSharp;
+
+namespace CommonDeliveryFramework.Net.Automation.Common
+{
+ /// <summary>
+ /// Extensions class that provides common automation tasks rolled up under standard extension methods that support the <see cref="CsClass"/> model.
+ /// </summary>
+ public static class CsClassExtensions
+ {
+ /// <summary>
+ /// Extension method that determines if the class implements a logger field that supports extensions logging from Microsoft.
+ /// </summary>
+ /// <param name="source">Class model to evaluate.</param>
+ /// <param name="loggerName">The name of the logger field.</param>
+ /// <returns>Boolean flag if the field was found or not.</returns>
+ public static bool HasMicrosoftExtensionsLoggerField(this CsClass source, string loggerName)
+ {
+ //Bounds check to determine if a class model was provided.
+ if (source == null) return false;
+
+ //Bounds check to confirm a field name was provided for the logger.
+ if (String.IsNullOrEmpty(loggerName)) return false;
+
+ //Bounds check to confirm the target class has fields. 
+ if (!source.Fields.Any()) return false;
+
+ //Looking up the field definition by the variable name of the logger.
+ var field = source.Fields.FirstOrDefault(f => f.Name == loggerName);
+
+ //If the logger was not found return false.
+ if (field == null) return false;
+
+ //Confirming the fields data type is under the logger namespace.
+ if (field.DataType.Namespace != AspNetCoreConstants.MicrosoftLoggerNamespace) return false;
+
+ //Confirming the field type is the ILogger interface
+ // ReSharper disable once ConvertIfStatementToReturnStatement
+ if (field.DataType.Name != AspNetCoreConstants.MicrosoftLoggerInterfaceName) return false;
+
+ return true;
+ }
+
+ /// <summary>
+ /// Extension method that determines if the logger field is implemented in the class. If it exists will return the provided source. Otherwise will add the logging namespace and the logger field.
+ /// </summary>
+ /// <param name="source">Source class to check for the logger field.</param>
+ /// <param name="loggerName">The name of the logger field to check for.</param>
+ /// <param name="parentSourceCode">The source code the class was loaded from.</param>
+ /// <returns>The existing source code if the field is found, or the updated source code with the logging field added.</returns>
+ public static async Task<CsSource> AddMicrosoftExtensionsLoggerFieldAsync(this CsClass source, string loggerName,
+ CsSource parentSourceCode)
+ {
+ //Bounds checking
+ if (source == null) return parentSourceCode;
+ if (String.IsNullOrEmpty(loggerName)) return parentSourceCode;
+
+ //Checking to see if the logger field already exists. If it does just return the parent source code.
+ if (source.HasMicrosoftExtensionsLoggerField(loggerName)) return parentSourceCode;
+
+ //Adding the logging namespace
+ var currentSource = await parentSourceCode.AddUsingStatementAsync(AspNetCoreConstants.MicrosoftLoggerNamespace);
+
+ var currentClass = currentSource.GetModel(source.LookupPath) as CsClass;
+
+ if (currentClass == null) throw new CodeFactoryException("Cannot load class data to add the logger field.");
+
+ CodeFactory.SourceFormatter fieldSource = new CodeFactory.SourceFormatter();
+
+ fieldSource.AppendCodeLine(2, "/// <summary>");
+ fieldSource.AppendCodeLine(2, "/// Logger for all logging interactions in the class.");
+ fieldSource.AppendCodeLine(2, "/// </summary>");
+ fieldSource.AppendCodeLine(2, $"private readonly {AspNetCoreConstants.MicrosoftLoggerInterfaceName} {loggerName};");
+ fieldSource.AppendCodeLine(0);
+
+ currentSource = await currentClass.AddToBeginningAsync(fieldSource.ReturnSource());
+
+ return currentSource;
+
+ }
+
+ /// <summary>
+ /// Helper method that confirms the class model base implementation is a controller.
+ /// </summary>
+ /// <param name="classModel">The class model to confirm does not implement a base class.</param>
+ /// <returns>True if a controller, false if not.</returns>
+ public static bool IsController(this CsClass classModel)
+ {
+ var baseClass = classModel?.BaseClass;
+ if (baseClass == null) return false;
+
+ var baseClassName = $"{baseClass.Namespace}.{baseClass.Name}";
+
+ if (baseClassName == AspNetCoreConstants.ControllerBaseName) return true;
+
+ bool isBaseClass = false;
+ if (baseClass.BaseClass != null) isBaseClass = IsController(baseClass);
+ return isBaseClass;
+ }
+
+ /// <summary>
+ /// Helper method that confirms the class model is not a Grpc service implementation.
+ /// </summary>
+ /// <param name="classModel">The class model to check if it is a Grpc Service.</param>
+ /// <returns>True if a Grpc service, false if not.</returns>
+ public static bool IsGrpcService(this CsClass classModel)
+ {
+ var baseClass = classModel?.BaseClass;
+
+ if (baseClass == null) return false;
+
+ if (!baseClass.HasAttributes) return false;
+
+ if (baseClass.Attributes.Any(b =>
+ b.Type.Namespace == GrpcConstants.GrpcCoreNamespace & b.Type.Name == GrpcConstants.BindServiceAttributeName )) return true;
+
+ bool isBaseClass = false;
+ if (baseClass.BaseClass != null) isBaseClass = baseClass.BaseClass.IsGrpcService();
+ return isBaseClass;
+ }
+
+ /// <summary>
+ /// Helper method that confirms the class model is not a razor component. 
+ /// </summary>
+ /// <param name="classModel">Source class model to check.</param>
+ /// <returns>True if a component, false if not.</returns>
+ public static bool IsRazorComponent(this CsClass classModel)
+ {
+ if (classModel.SourceDocument.EndsWith("razor", StringComparison.InvariantCultureIgnoreCase)) return true;
+ return classModel.SourceDocument.EndsWith("razor.cs", StringComparison.InvariantCultureIgnoreCase);
+ }
+ }
+}