test(fitness): add architecture fitness tests

src/Joba.IBM.RPA/Account/RedHatOpenshiftOidcAuthenticator.cs → src/Joba.IBM.RPA.Cli/AccountAuthenticatorFactory.cs

@@ -1,8 +1,44 @@
 using Joba.IBM.RPA.Server;
 using System.Net.Http.Json;
 
-namespace Joba.IBM.RPA
+namespace Joba.IBM.RPA.Cli
 {
+    internal class AccountAuthenticatorFactory : IAccountAuthenticatorFactory
+    {
+        private readonly IRpaClientFactory clientFactory;
+        private readonly IRpaHttpClientFactory httpFactory;
+
+        public AccountAuthenticatorFactory(IRpaClientFactory clientFactory, IRpaHttpClientFactory httpFactory)
+        {
+            this.clientFactory = clientFactory;
+            this.httpFactory = httpFactory;
+        }
+
+        IAccountAuthenticator IAccountAuthenticatorFactory.Create(DeploymentOption deployment, AuthenticationMethod authenticationMethod, Region region, PropertyOptions properties)
+        {
+            if (deployment == DeploymentOption.OCP && authenticationMethod == AuthenticationMethod.OIDC)
+            {
+                var cloudPakAddress = properties[PropertyOptions.CloudPakConsoleAddress];
+                return cloudPakAddress == null
+                    ? throw new NotSupportedException($"Since the server is deployed in the CloudPak cluster, the CloudPak Console URL is required and it was not provided. More information https://ibm.github.io/ibm-rpa-cli/#/guide/environment?id=red-hat®-openshift®-support-with-single-sign-on.")
+                    : (IAccountAuthenticator)new RedHatOpenshiftOidcAuthenticator(httpFactory, region, new Uri(cloudPakAddress));
+            }
+
+            var client = clientFactory.CreateFromRegion(region);
+            return new WdgAuthenticator(client.Account);
+        }
+    }
+
+    class WdgAuthenticator : IAccountAuthenticator
+    {
+        private readonly IAccountResource resource;
+
+        public WdgAuthenticator(IAccountResource resource) => this.resource = resource;
+
+        async Task<CreatedSession> IAccountAuthenticator.AuthenticateAsync(AccountCredentials credentials, CancellationToken cancellation) =>
+            await resource.AuthenticateAsync(credentials.TenantCode, credentials.UserName, credentials.Password, cancellation);
+    }
+
     class RedHatOpenshiftOidcAuthenticator : IAccountAuthenticator
     {
         private readonly IRpaHttpClientFactory httpFactory;

src/Joba.IBM.RPA.Cli/Client/RpaClientFactory.cs

@@ -2,7 +2,7 @@
 
 namespace Joba.IBM.RPA.Cli
 {
-    public class RpaClientFactory : IRpaClientFactory
+    internal class RpaClientFactory : IRpaClientFactory
     {
         private readonly IConsole console;
         private readonly IRpaHttpClientFactory httpFactory;

src/Joba.IBM.RPA.Cli/Client/RpaHttpClientFactory.cs

@@ -7,6 +7,12 @@
 
 namespace Joba.IBM.RPA.Cli
 {
+    internal interface IRpaHttpClientFactory
+    {
+        HttpClient Create(Uri address);
+        HttpClient Create(Uri address, IRenewExpiredSession sessionRenewal);
+    }
+
     internal class RpaHttpClientFactory : IRpaHttpClientFactory
     {
         private const int MaxParallelism = 10;

src/Joba.IBM.RPA/Account/IAccountAuthenticator.cs

@@ -9,30 +9,4 @@ public interface IAccountAuthenticatorFactory
     {
         IAccountAuthenticator Create(DeploymentOption deployment, AuthenticationMethod authenticationMethod, Region region, PropertyOptions properties);
     }
-
-    public class AccountAuthenticatorFactory : IAccountAuthenticatorFactory
-    {
-        private readonly IRpaClientFactory clientFactory;
-        private readonly IRpaHttpClientFactory httpFactory;
-
-        public AccountAuthenticatorFactory(IRpaClientFactory clientFactory, IRpaHttpClientFactory httpFactory)
-        {
-            this.clientFactory = clientFactory;
-            this.httpFactory = httpFactory;
-        }
-
-        IAccountAuthenticator IAccountAuthenticatorFactory.Create(DeploymentOption deployment, AuthenticationMethod authenticationMethod, Region region, PropertyOptions properties)
-        {
-            if (deployment == DeploymentOption.OCP && authenticationMethod == AuthenticationMethod.OIDC)
-            {
-                var cloudPakAddress = properties[PropertyOptions.CloudPakConsoleAddress];
-                return cloudPakAddress == null
-                    ? throw new NotSupportedException($"Since the server is deployed in the CloudPak cluster, the CloudPak Console URL is required and it was not provided. More information https://ibm.github.io/ibm-rpa-cli/#/guide/environment?id=red-hat®-openshift®-support-with-single-sign-on.")
-                    : (IAccountAuthenticator)new RedHatOpenshiftOidcAuthenticator(httpFactory, region, new Uri(cloudPakAddress));
-            }
-
-            var client = clientFactory.CreateFromRegion(region);
-            return new WdgAuthenticator(client.Account);
-        }
-    }
 }

src/Joba.IBM.RPA/IRpaClient.cs

@@ -25,12 +25,6 @@ public interface IRpaClientFactory
         IRpaClient CreateFromPackageSource(PackageSource source);
     }
 
-    public interface IRpaHttpClientFactory
-    {
-        HttpClient Create(Uri address);
-        HttpClient Create(Uri address, IRenewExpiredSession sessionRenewal);
-    }
-
     public interface IRenewExpiredSession
     {
         Task<Session> RenewAsync(CancellationToken cancellation);

src/Joba.IBM.RPA/Pipeline/AsyncPipeline.cs

@@ -5,13 +5,13 @@
     /// Based on: https://github.com/ipvalverde/PipelineNet
     /// </summary>
     /// <typeparam name="TContext">The parameter type.</typeparam>
-    public sealed class AsyncPipeline<TContext> : IAsyncPipeline<TContext>
+    sealed class AsyncPipeline<TContext> : IAsyncPipeline<TContext>
     {
         private readonly IList<IAsyncMiddleware<TContext>> middlewares;
         private IAsyncMiddleware<TContext> @finally = EmptyMiddleware.None;
         private Func<TContext, PipelineExceptionSource, CancellationToken, Task> @catch;
 
         private AsyncPipeline()
         {
             middlewares = new List<IAsyncMiddleware<TContext>>();
         }
@@ -49,7 +49,7 @@
                 return;
 
             var index = 0;
             Func<TContext, Task> action = null;
             action = async (param) =>
             {
                 cancellation.ThrowIfCancellationRequested();
@@ -61,7 +61,7 @@
                 if (index == middlewares.Count)
                     action = (p) => Task.CompletedTask;
 
                 await middleware.Run(param, action, cancellation).ConfigureAwait(false);
             };
 
             try
@@ -90,7 +90,7 @@
             public static EmptyMiddleware None = new EmptyMiddleware();
             private readonly Func<TContext, CancellationToken, Task> @finally;
 
             private EmptyMiddleware() { }
 
             public EmptyMiddleware(Func<TContext, CancellationToken, Task> @finally)
             {

src/Joba.IBM.RPA/Pipeline/DefaultPipelineMiddleware.cs

@@ -4,7 +4,7 @@
     /// Default implementation of <see cref="IAsyncMiddleware{TParameter}"/>.
     /// </summary>
     /// <typeparam name="TContext"></typeparam>
-    public abstract class DefaultPipelineMiddleware<TContext> : IAsyncMiddleware<TContext>
+    abstract class DefaultPipelineMiddleware<TContext> : IAsyncMiddleware<TContext>
     {
         /// <summary>
         /// Override this method to implement the middleware logic.

src/Joba.IBM.RPA/Pipeline/IAsyncMiddleware.cs

@@ -4,7 +4,7 @@
     /// Defines a piece of code (a step) to be executed inside a pipeline.
     /// </summary>
     /// <typeparam name="TParameter">The parameter type.</typeparam>
-    public interface IAsyncMiddleware<TParameter>
+    interface IAsyncMiddleware<TParameter>
     {
         /// <summary>
         /// Runs this middleware and enables calling the next middleware.

src/Joba.IBM.RPA/Pipeline/IAsyncPipeline.cs

@@ -4,7 +4,7 @@
     /// Defines and executes a pipeline.
     /// </summary>
     /// <typeparam name="TContext">The parameter type.</typeparam>
-    public interface IAsyncPipeline<TContext>
+    interface IAsyncPipeline<TContext>
     {
         /// <summary>
         /// Adds a middleware.

src/Joba.IBM.RPA/Pipeline/PipelineExceptionSource.cs

@@ -3,7 +3,7 @@
     /// <summary>
     /// Defines the exception structure of a pipeline.
     /// </summary>
-    public sealed class PipelineExceptionSource
+    sealed class PipelineExceptionSource
     {
         public PipelineExceptionSource(Exception ex)
         {

src/Tests/Joba.IBM.RPA.Tests/Fitness/ArchitectureShould.cs

@@ -0,0 +1,37 @@
+using ArchUnitNET.Domain;
+using ArchUnitNET.Loader;
+using ArchUnitNET.xUnit;
+using static ArchUnitNET.Fluent.ArchRuleDefinition;
+
+namespace Joba.IBM.RPA.Tests
+{
+    public class ArchitectureShould
+    {
+        private static readonly System.Reflection.Assembly[] assemblies = new System.Reflection.Assembly[] { typeof(IProject).Assembly };
+        private static readonly Architecture architecture = new ArchLoader().LoadAssemblies(assemblies).Build();
+
+        [Fact]
+        public void DisallowUsingHttpClient()
+        {
+            var rule = Types().Should().NotDependOnAny(typeof(HttpClient))
+                .Because($"'{string.Join(", ", assemblies.Select(a => a.GetName().Name))}' require(s) using abstractions '{nameof(IRpaClient)} or {nameof(IRpaClientFactory)}'");
+            rule.Check(architecture);
+        }
+
+        [Fact]
+        public void EnsureSameNamespace()
+        {
+            var rule = Types().That().ArePublic().Should().ResideInNamespace(@"Joba.IBM.RPA(\.Server)?", useRegularExpressions: true)
+                .Because("exposing many namespaces is a bad practice.");
+            rule.Check(architecture);
+        }
+
+        //[Fact]
+        //public void DisallowReferencingSystemCommandLinePackage()
+        //{
+        //    //ArchUnitTEST does not support
+        //    //See: https://github.com/TNG/ArchUnitNET/issues/130
+        //    //See: https://gaevoy.com/2022/05/19/review-dependencies-on-every-commit.html
+        //}
+    }
+}

src/Tests/Joba.IBM.RPA.Tests/Fitness/readme.md

@@ -0,0 +1,11 @@
+# Fitness functions
+This directory contains fitness functions implemented as tests.
+
+## What are fitness functions?
+> Any mechanism that performs an objective integrity assessment of some architecture characteristic or combination of architecture characteristics.
+
+In the RPA CLI project, we implement fitness functions as a mechanism to test the **architecture** of the system, enforcing rules to be followed by developers, like forbidding some library packages to be installed in the *Joba.IBM.RPA* core project.
+
+## More details
+- Article: [The Up-and-Running Guide to Architectural Fitness Functions](https://betterprogramming.pub/the-up-and-running-guide-to-architectural-fitness-functions-1621ebe46ea).
+- Book: [Fundamentals of Software Architecture: An Engineering Approach](https://www.amazon.com/Fundamentals-Software-Architecture-Comprehensive-Characteristics/dp/1492043451).

src/Tests/Joba.IBM.RPA.Tests/Joba.IBM.RPA.Tests.csproj

@@ -10,6 +10,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.2" />
     <PackageReference Include="Moq" Version="4.20.69" />
+    <PackageReference Include="TngTech.ArchUnitNET.xUnit" Version="0.10.6" />
     <PackageReference Include="Verify.Xunit" Version="22.1.4" />
     <PackageReference Include="xunit" Version="2.5.3" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.5.3">