Add type checking when importing types from recipes #15979

src/OrchardCore.Modules/OrchardCore.ContentTypes/RecipeSteps/ContentDefinitionStep.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Text.Json.Nodes;
 using System.Threading.Tasks;
+using Microsoft.Extensions.Localization;
 using OrchardCore.ContentManagement.Metadata;
 using OrchardCore.ContentManagement.Metadata.Models;
 using OrchardCore.ContentManagement.Metadata.Records;
@@ -15,10 +16,11 @@ namespace OrchardCore.ContentTypes.RecipeSteps
     public class ContentDefinitionStep : IRecipeStepHandler
     {
         private readonly IContentDefinitionManager _contentDefinitionManager;
-
-        public ContentDefinitionStep(IContentDefinitionManager contentDefinitionManager)
+        private readonly IStringLocalizer S;
+        public ContentDefinitionStep(IContentDefinitionManager contentDefinitionManager, IStringLocalizer<ContentDefinitionStep> s)
         {
             _contentDefinitionManager = contentDefinitionManager;
+            S = s;
         }
 
         public async Task ExecuteAsync(RecipeExecutionContext context)
@@ -58,6 +60,11 @@ private Task UpdateContentTypeAsync(ContentTypeDefinition type, ContentTypeDefin
 
                 foreach (var part in record.ContentTypePartDefinitionRecords)
                 {
+                    if (string.IsNullOrEmpty(part.PartName))
+                    {
+                        throw new InvalidOperationException(S["Unable to add content-part to the '{0}' content-type. The part name cannot be null or empty.", type.Name]);
+                    }
+
                     builder.WithPart(part.Name, part.PartName, partBuilder => partBuilder.MergeSettings(part.Settings));
                 }
             });

src/OrchardCore.Modules/OrchardCore.Deployment/Controllers/ImportController.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using System.IO.Compression;
 using System.Text.Json;
@@ -91,6 +92,10 @@ public async Task<IActionResult> Import(IFormFile importedPackage)
 
                     await _notifier.SuccessAsync(H["Deployment package imported."]);
                 }
+                catch (Exception ex)
+                {
+                    await _notifier.ErrorAsync(H[ex.Message]);
+                }
                 finally
                 {
                     if (System.IO.File.Exists(tempArchiveName))
@@ -148,6 +153,10 @@ public async Task<IActionResult> Json(ImportJsonViewModel model)
 
                     await _notifier.SuccessAsync(H["Recipe imported."]);
                 }
+                catch (Exception ex)
+                {
+                    await _notifier.ErrorAsync(H[ex.Message]);
+                }
                 finally
                 {
                     if (Directory.Exists(tempArchiveFolder))

test/OrchardCore.Tests/OrchardCore.Tests.csproj

@@ -29,6 +29,7 @@
     <None Remove="Recipes\RecipeFiles\recipe3.json" />
     <None Remove="Recipes\RecipeFiles\recipe4.json" />
     <None Remove="Recipes\RecipeFiles\recipe5.json" />
+    <None Remove="Recipes\RecipeFiles\recipe6.json" />
   </ItemGroup>
 
   <ItemGroup>
@@ -44,6 +45,7 @@
     <EmbeddedResource Include="Recipes\RecipeFiles\recipe3.json" />
     <EmbeddedResource Include="Recipes\RecipeFiles\recipe4.json" />
     <EmbeddedResource Include="Recipes\RecipeFiles\recipe5.json" />
+    <EmbeddedResource Include="Recipes\RecipeFiles\recipe6.json" />
   </ItemGroup>
 
   <ItemGroup>

test/OrchardCore.Tests/Recipes/RecipeExecutorTests.cs

@@ -8,6 +8,7 @@
 using OrchardCore.Recipes.Models;
 using OrchardCore.Recipes.Services;
 using OrchardCore.Scripting;
+using OrchardCore.Tests.Apis.Context;
 
 namespace OrchardCore.Recipes
 {
@@ -50,6 +51,27 @@ public async Task ShouldTrimValidScriptExpression(string recipeName, string expe
             });
         }
 
+        [Fact]
+        public async Task ContentDefinitionStep_WhenPartNameIsMissing_ThrowInvalidOperationException()
+        {
+            var context = new BlogContext();
+            await context.InitializeAsync();
+            await context.UsingTenantScopeAsync(async scope =>
+            {
+                var recipeExecutor = scope.ServiceProvider.GetRequiredService<IRecipeExecutor>();
+                // Act
+                var executionId = Guid.NewGuid().ToString("n");
+                var recipeDescriptor = new RecipeDescriptor { RecipeFileInfo = GetRecipeFileInfo("recipe6") };
+
+                var exception = await Assert.ThrowsAsync<InvalidOperationException>(async () =>
+                {
+                    await recipeExecutor.ExecuteAsync(executionId, recipeDescriptor, new Dictionary<string, object>(), CancellationToken.None);
+                });
+
+                Assert.Equal("Unable to add content-part to the 'Message' content-type. The part name cannot be null or empty.", exception.Message);
+            });
+        }
+
         private static Task<ShellScope> GetScopeAsync() => ShellScope.Context.CreateScopeAsync();
 
         private static ShellContext CreateShellContext() => new()

test/OrchardCore.Tests/Recipes/RecipeFiles/recipe6.json

@@ -0,0 +1,27 @@
+{
+  "name": "Recipe6",
+  "displayName": "Recipe 6",
+  "description": "This recipe is designed to uncover potential bugs during the content-definition import process. It serves as a validation for the import functionality.",
+  "author": "Tony Han",
+  "website": "",
+  "version": "1.0.0",
+  "issetuprecipe": false,
+  "categories": [ "test" ],
+  "steps": [
+    {
+      "name": "ContentDefinition",
+      "ContentTypes": [
+        {
+          "Name": "Message",
+          "DisplayName": "Message",
+          "ContentTypePartDefinitionRecords": [ 
+            {
+              // "PartName": "TitlePart", // Test PartName validation.
+              "Name": "TitlePart"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}