Introduce OrchardCore.Testing APIs

OrchardCore.sln

@@ -480,7 +480,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Media.AmazonS3"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.ArchiveLater", "src\OrchardCore.Modules\OrchardCore.ArchiveLater\OrchardCore.ArchiveLater.csproj", "{190C4BEB-C506-4F7F-BDCA-93F3C1C221BC}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrchardCore.Features.Core", "src\OrchardCore\OrchardCore.Features.Core\OrchardCore.Features.Core.csproj", "{122EC0DA-A593-4038-BD21-2D4A7061F348}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Features.Core", "src\OrchardCore\OrchardCore.Features.Core\OrchardCore.Features.Core.csproj", "{122EC0DA-A593-4038-BD21-2D4A7061F348}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Search", "src\OrchardCore.Modules\OrchardCore.Search\OrchardCore.Search.csproj", "{7BDF280B-70B7-4AFC-A6F7-B5759DCA2A2C}"
 EndProject
@@ -489,6 +489,9 @@ EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Notifications.Core", "src\OrchardCore\OrchardCore.Notifications.Core\OrchardCore.Notifications.Core.csproj", "{2A6E7DF9-E417-42F8-94F7-0060E252E4D6}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Notifications", "src\OrchardCore.Modules\OrchardCore.Notifications\OrchardCore.Notifications.csproj", "{19594A96-A033-4820-820B-C6186D00D507}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrchardCore.Testing", "src\OrchardCore\OrchardCore.Testing\OrchardCore.Testing.csproj", "{C3DA562E-7B0B-455E-87FF-FF3E1D31A400}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrchardCore.Testing.Tests", "test\OrchardCore.Testing.Tests\OrchardCore.Testing.Tests.csproj", "{841FF342-25ED-487E-8EA4-65C015545F3E}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -1278,10 +1281,6 @@ Global
 		{FF1C550C-6D30-499A-AF11-68DE7C8B6869}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{FF1C550C-6D30-499A-AF11-68DE7C8B6869}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{FF1C550C-6D30-499A-AF11-68DE7C8B6869}.Release|Any CPU.Build.0 = Release|Any CPU
-		{A6563050-EE6D-4E7C-81AA-C383DB3ED124}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{A6563050-EE6D-4E7C-81AA-C383DB3ED124}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{A6563050-EE6D-4E7C-81AA-C383DB3ED124}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{A6563050-EE6D-4E7C-81AA-C383DB3ED124}.Release|Any CPU.Build.0 = Release|Any CPU
 		{190C4BEB-C506-4F7F-BDCA-93F3C1C221BC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{190C4BEB-C506-4F7F-BDCA-93F3C1C221BC}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{190C4BEB-C506-4F7F-BDCA-93F3C1C221BC}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -1306,6 +1305,14 @@ Global
 		{19594A96-A033-4820-820B-C6186D00D507}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{19594A96-A033-4820-820B-C6186D00D507}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{19594A96-A033-4820-820B-C6186D00D507}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C3DA562E-7B0B-455E-87FF-FF3E1D31A400}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C3DA562E-7B0B-455E-87FF-FF3E1D31A400}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C3DA562E-7B0B-455E-87FF-FF3E1D31A400}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C3DA562E-7B0B-455E-87FF-FF3E1D31A400}.Release|Any CPU.Build.0 = Release|Any CPU
+		{841FF342-25ED-487E-8EA4-65C015545F3E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{841FF342-25ED-487E-8EA4-65C015545F3E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{841FF342-25ED-487E-8EA4-65C015545F3E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{841FF342-25ED-487E-8EA4-65C015545F3E}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -1533,6 +1540,8 @@ Global
 		{307AA9CB-D62E-4E30-B715-53E3BF535D94} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{2A6E7DF9-E417-42F8-94F7-0060E252E4D6} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{19594A96-A033-4820-820B-C6186D00D507} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
+		{C3DA562E-7B0B-455E-87FF-FF3E1D31A400} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
+		{841FF342-25ED-487E-8EA4-65C015545F3E} = {B8D16C60-99B4-43D5-A3AD-4CD89AF39B25}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {46A1D25A-78D1-4476-9CBF-25B75E296341}

src/OrchardCore.Cms.Web/OrchardCore.Cms.Web.csproj

@@ -14,6 +14,7 @@
     <Nullable>enable</Nullable>
     <ImplicitUsings Condition="'$(RazorRuntimeCompilation)' == 'false'">enable</ImplicitUsings>
   </PropertyGroup>
+
   <!-- For Unit Tests-->
   <ItemGroup>
     <InternalsVisibleTo Include="OrchardCore.Tests" />

src/OrchardCore/OrchardCore.Testing/Apis/Extensions/SiteContextExtensions.cs

@@ -0,0 +1,56 @@
+using System;
+using OrchardCore.Testing.Apis.Security;
+
+namespace OrchardCore.Testing.Apis
+{
+    public static class SiteContextExtensions
+    {
+        public static ISiteContext WithDatabaseProvider(this ISiteContext siteContext, string databaseProvider)
+        {
+            if (String.IsNullOrEmpty(databaseProvider))
+            {
+                throw new ArgumentException($"'{nameof(databaseProvider)}' cannot be null or empty.", nameof(databaseProvider));
+            }
+
+            siteContext.Options.DatabaseProvider = databaseProvider;
+
+            return siteContext;
+        }
+
+        public static ISiteContext WithConnectionString(this ISiteContext siteContext, string connectionString)
+        {
+            if (String.IsNullOrEmpty(connectionString))
+            {
+                throw new ArgumentException($"'{nameof(connectionString)}' cannot be null or empty.", nameof(connectionString));
+            }
+
+            siteContext.Options.ConnectionString = connectionString;
+
+            return siteContext;
+        }
+
+        public static ISiteContext WithPermissionsContext(this ISiteContext siteContext, PermissionsContext permissionsContext)
+        {
+            if (permissionsContext is null)
+            {
+                throw new ArgumentNullException(nameof(permissionsContext));
+            }
+
+            siteContext.Options.PermissionsContext = permissionsContext;
+
+            return siteContext;
+        }
+
+        public static ISiteContext WithRecipe(this ISiteContext siteContext, string recipeName)
+        {
+            if (String.IsNullOrEmpty(recipeName))
+            {
+                throw new ArgumentException($"'{nameof(recipeName)}' cannot be null or empty.", nameof(recipeName));
+            }
+
+            siteContext.Options.RecipeName = recipeName;
+
+            return siteContext;
+        }
+    }
+}

src/OrchardCore/OrchardCore.Testing/Apis/ISiteContext.cs

@@ -0,0 +1,29 @@
+using System;
+using System.Net.Http;
+using System.Threading.Tasks;
+using OrchardCore.Apis.GraphQL.Client;
+using OrchardCore.Environment.Shell;
+
+namespace OrchardCore.Testing.Apis
+{
+    public interface ISiteContext : IDisposable
+    {
+        static IShellHost ShellHost { get; }
+
+        static IShellSettingsManager ShellSettingsManager { get; }
+
+        static HttpClient DefaultTenantClient { get; }
+
+        SiteContextOptions Options { init; get; }
+
+        HttpClient Client { get; }
+
+        string TenantName { get; }
+
+        OrchardGraphQLClient GraphQLClient { get; }
+
+        Task InitializeAsync();
+
+        Task RunRecipeAsync(string recipeName, string recipePath);
+    }
+}

src/OrchardCore/OrchardCore.Testing/Apis/ISiteContextOfT.cs

@@ -0,0 +1,9 @@
+using OrchardCore.Testing.Infrastructure;
+
+namespace OrchardCore.Testing.Apis
+{
+    public interface ISiteContext<TSiteStartup> : ISiteContext where TSiteStartup : class
+    {
+        static OrchardCoreTestFixture<TSiteStartup> Site { get; }
+    }
+}

test/OrchardCore.Tests/Apis/Context/AuthenticationContext.cs → src/OrchardCore/OrchardCore.Testing/Apis/Security/PermissionContextAuthorizationHandler.cs

@@ -1,9 +1,15 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
 using OrchardCore.Security;
 using OrchardCore.Security.Permissions;
 
-namespace OrchardCore.Tests.Apis.Context
+namespace OrchardCore.Testing.Apis.Security
 {
-    internal class PermissionContextAuthorizationHandler : AuthorizationHandler<PermissionRequirement>
+    public class PermissionContextAuthorizationHandler : AuthorizationHandler<PermissionRequirement>
     {
         private readonly PermissionsContext _permissionsContext;
 
@@ -26,7 +32,7 @@ public PermissionContextAuthorizationHandler(IHttpContextAccessor httpContextAcc
             }
         }
 
-        // Used for static graphql test; passes a permissionsContext directly
+        // Used for static graphql test; passes a permissions Context directly
         public PermissionContextAuthorizationHandler(PermissionsContext permissionsContext)
         {
             _permissionsContext = permissionsContext;
@@ -88,20 +94,4 @@ private void GetGrantingNamesInternal(Permission permission, HashSet<string> sta
             }
         }
     }
-
-    public class PermissionsContext
-    {
-        public IEnumerable<Permission> AuthorizedPermissions { get; set; } = Enumerable.Empty<Permission>();
-
-        public bool UsePermissionsContext { get; set; } = false;
-    }
-
-    internal class StubIdentity : IIdentity
-    {
-        public string AuthenticationType => "TEST TEST";
-
-        public bool IsAuthenticated => true;
-
-        public string Name => "Mr Robot";
-    }
 }

src/OrchardCore/OrchardCore.Testing/Apis/Security/PermissionsContext.cs

@@ -0,0 +1,18 @@
+using System.Collections.Generic;
+using System.Linq;
+using OrchardCore.Security.Permissions;
+
+namespace OrchardCore.Testing.Apis.Security
+{
+    public class PermissionsContext
+    {
+        public PermissionsContext()
+        {
+            AuthorizedPermissions = Enumerable.Empty<Permission>();
+            UsePermissionsContext = false;
+        }
+        public IEnumerable<Permission> AuthorizedPermissions { get; set; }
+
+        public bool UsePermissionsContext { get; set; }
+    }
+}

src/OrchardCore/OrchardCore.Testing/Apis/SiteContextBase.cs

@@ -0,0 +1,149 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.DependencyInjection;
+using OrchardCore.Apis.GraphQL.Client;
+using OrchardCore.Environment.Shell;
+using OrchardCore.Recipes.Services;
+using OrchardCore.Tenants.ViewModels;
+using OrchardCore.Testing.Data;
+using OrchardCore.Testing.Infrastructure;
+
+namespace OrchardCore.Testing.Apis
+{
+    public abstract class SiteContextBase<TSiteStartup> : ISiteContext<TSiteStartup> where TSiteStartup : class
+    {
+        static SiteContextBase()
+        {
+            Site = new OrchardCoreTestFixture<TSiteStartup>();
+            ShellHost = Site.Services.GetRequiredService<IShellHost>();
+            ShellSettingsManager = Site.Services.GetRequiredService<IShellSettingsManager>();
+            DefaultTenantClient = Site.CreateDefaultClient();
+        }
+
+        public SiteContextBase()
+        {
+            Options = new SiteContextOptions();
+        }
+
+        public static OrchardCoreTestFixture<TSiteStartup> Site { get; }
+
+        public static IShellHost ShellHost { get; private set; }
+
+        public static IShellSettingsManager ShellSettingsManager { get; private set; }
+
+        public static HttpClient DefaultTenantClient { get; }
+
+        public SiteContextOptions Options { init; get; }
+
+        public HttpClient Client { get; private set; }
+
+        public string TenantName { get; private set; }
+
+        public OrchardGraphQLClient GraphQLClient { get; protected set; }
+
+        public virtual async Task InitializeAsync()
+        {
+            var tenantName = Guid.NewGuid().ToString("n");
+
+            if (String.IsNullOrEmpty(Options.TablePrefix))
+            {
+                Options.TablePrefix = await new TablePrefixGenerator().GeneratePrefixAsync();
+            }
+
+            var createResult = await CreateSiteAsync(tenantName);
+
+            var content = await createResult.Content.ReadAsStringAsync();
+
+            await SetupSiteAsync(tenantName);
+
+            lock (Site)
+            {
+                var url = new Uri(content.Trim('"'));
+                url = new Uri(url.Scheme + "://" + url.Authority + url.LocalPath + "/");
+
+                Client = Site.CreateDefaultClient(url);
+
+                TenantName = tenantName;
+            }
+
+            if (Options.PermissionsContext != null)
+            {
+                var permissionContextKey = Guid.NewGuid().ToString();
+
+                SiteContextOptions.PermissionsContexts.TryAdd(permissionContextKey, Options.PermissionsContext);
+
+                Client.DefaultRequestHeaders.Add("PermissionsContext", permissionContextKey);
+            }
+
+            GraphQLClient = new OrchardGraphQLClient(Client);
+        }
+
+        public async Task RunRecipeAsync(string recipeName, string recipePath)
+        {
+            var shellScope = await ShellHost.GetScopeAsync(TenantName);
+
+            await shellScope.UsingServiceScopeAsync(async scope =>
+            {
+                var shellFeaturesManager = scope.ServiceProvider.GetRequiredService<IShellFeaturesManager>();
+                var recipeHarvesters = scope.ServiceProvider.GetRequiredService<IEnumerable<IRecipeHarvester>>();
+                var recipeExecutor = scope.ServiceProvider.GetRequiredService<IRecipeExecutor>();
+
+                var recipeCollections = await Task.WhenAll(recipeHarvesters
+                    .Select(recipe => recipe.HarvestRecipesAsync()));
+
+                var recipe = recipeCollections
+                    .SelectMany(r => r)
+                    .FirstOrDefault(d => d.RecipeFileInfo.Name == recipeName && d.BasePath == recipePath);
+
+                var executionId = Guid.NewGuid().ToString("n");
+
+                await recipeExecutor.ExecuteAsync(executionId, recipe, new Dictionary<string, object>(), CancellationToken.None);
+            });
+        }
+
+        public void Dispose() => Client?.Dispose();
+
+        private async Task<HttpResponseMessage> CreateSiteAsync(string tenantName)
+        {
+            var createModel = new CreateApiViewModel
+            {
+                DatabaseProvider = Options.DatabaseProvider,
+                TablePrefix = Options.TablePrefix,
+                ConnectionString = Options.ConnectionString,
+                RecipeName = Options.RecipeName,
+                Name = tenantName,
+                RequestUrlPrefix = tenantName
+            };
+
+            var result = await DefaultTenantClient.PostAsJsonAsync("api/tenants/create", createModel);
+
+            result.EnsureSuccessStatusCode();
+
+            return result;
+        }
+
+        private async Task SetupSiteAsync(string tenantName)
+        {
+            var setupModel = new SetupApiViewModel
+            {
+                SiteName = "Orchard Core Site",
+                DatabaseProvider = Options.DatabaseProvider,
+                TablePrefix = Options.TablePrefix,
+                ConnectionString = Options.ConnectionString,
+                RecipeName = Options.RecipeName,
+                UserName = "admin",
+                Password = "P@ssw0rd",
+                Name = tenantName,
+                Email = "[email protected]"
+            };
+
+            var result = await DefaultTenantClient.PostAsJsonAsync("api/tenants/setup", setupModel);
+
+            result.EnsureSuccessStatusCode();
+        }
+    }
+}