Skip to content

Commit 393a8ef

Browse files
OMpawar-21OMpawar-21
authored
Merge pull request #144 from contentstack/enhc/DX-5434
feat(5434): extend content type schema coverage and validation in integration tests
2 parents b4da510 + 3b40b75 commit 393a8ef

18 files changed

+1914
-82
lines changed

‎Contentstack.Management.Core.Tests/Contentstack.Management.Core.Tests.csproj‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,55 @@
1-
<Project Sdk="Microsoft.NET.Sdk">
2-
3-
<PropertyGroup>
4-
<TargetFramework>net7.0</TargetFramework>
5-
6-
<IsPackable>false</IsPackable>
7-
<ReleaseVersion>$(Version)</ReleaseVersion>
8-
9-
<SignAssembly>true</SignAssembly>
10-
<AssemblyOriginatorKeyFile>../CSManagementSDK.snk</AssemblyOriginatorKeyFile>
11-
</PropertyGroup>
12-
13-
<ItemGroup>
14-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
15-
<PackageReference Include="MSTest.TestAdapter" Version="3.8.2" />
16-
<PackageReference Include="MSTest.TestFramework" Version="3.8.2" />
17-
<PackageReference Include="coverlet.collector" Version="6.0.4"><IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
18-
<PrivateAssets>all</PrivateAssets>
19-
</PackageReference>
20-
<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="9.0.2" />
21-
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="9.0.2" />
22-
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="9.0.2" />
23-
<PackageReference Include="AutoFixture" Version="4.18.1" />
24-
<PackageReference Include="AutoFixture.AutoMoq" Version="4.18.1" />
25-
<PackageReference Include="Moq" Version="4.20.72" />
26-
<PackageReference Include="Microsoft.AspNetCore.Http" Version="2.3.0" />
27-
<PackageReference Include="Newtonsoft.Json" Version="13.0.4" />
28-
<PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
29-
</ItemGroup>
30-
31-
<ItemGroup>
32-
<Folder Include="Helpers\" />
33-
<Folder Include="IntegrationTest\" />
34-
<Folder Include="Model\" />
35-
<Folder Include="Mock\" />
36-
</ItemGroup>
37-
38-
<ItemGroup>
39-
<EmbeddedResource Include="Mock\*.json" />
40-
</ItemGroup>
41-
42-
<ItemGroup>
43-
<Content Include="appSettings.json">
44-
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
45-
</Content>
46-
</ItemGroup>
47-
48-
<ItemGroup>
49-
<None Remove="Microsoft.AspNetCore.Http" />
50-
</ItemGroup>
51-
52-
<ItemGroup>
53-
<ProjectReference Include="..\Contentstack.Management.Core\contentstack.management.core.csproj" />
54-
</ItemGroup>
55-
</Project>
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFramework>net7.0</TargetFramework>
5+
6+
<IsPackable>false</IsPackable>
7+
<ReleaseVersion>$(Version)</ReleaseVersion>
8+
9+
<SignAssembly>true</SignAssembly>
10+
<AssemblyOriginatorKeyFile>../CSManagementSDK.snk</AssemblyOriginatorKeyFile>
11+
</PropertyGroup>
12+
13+
<ItemGroup>
14+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
15+
<PackageReference Include="MSTest.TestAdapter" Version="3.8.2" />
16+
<PackageReference Include="MSTest.TestFramework" Version="3.8.2" />
17+
<PackageReference Include="coverlet.collector" Version="6.0.4"><IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
18+
<PrivateAssets>all</PrivateAssets>
19+
</PackageReference>
20+
<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="9.0.2" />
21+
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="9.0.2" />
22+
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="9.0.2" />
23+
<PackageReference Include="AutoFixture" Version="4.18.1" />
24+
<PackageReference Include="AutoFixture.AutoMoq" Version="4.18.1" />
25+
<PackageReference Include="Moq" Version="4.20.72" />
26+
<PackageReference Include="Microsoft.AspNetCore.Http" Version="2.3.0" />
27+
<PackageReference Include="Newtonsoft.Json" Version="13.0.4" />
28+
<PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
29+
</ItemGroup>
30+
31+
<ItemGroup>
32+
<Folder Include="Helpers\" />
33+
<Folder Include="IntegrationTest\" />
34+
<Folder Include="Model\" />
35+
<Folder Include="Mock\" />
36+
</ItemGroup>
37+
38+
<ItemGroup>
39+
<EmbeddedResource Include="Mock\*.json" />
40+
</ItemGroup>
41+
42+
<ItemGroup>
43+
<Content Include="appSettings.json">
44+
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
45+
</Content>
46+
</ItemGroup>
47+
48+
<ItemGroup>
49+
<None Remove="Microsoft.AspNetCore.Http" />
50+
</ItemGroup>
51+
52+
<ItemGroup>
53+
<ProjectReference Include="..\Contentstack.Management.Core\contentstack.management.core.csproj" />
54+
</ItemGroup>
55+
</Project>

‎Contentstack.Management.Core.Tests/Helpers/AssertLogger.cs‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
using System;
2+
using System.Linq;
3+
using System.Net;
4+
using System.Threading.Tasks;
5+
using Contentstack.Management.Core.Exceptions;
26
using Microsoft.VisualStudio.TestTools.UnitTesting;
37

48
namespace Contentstack.Management.Core.Tests.Helpers
@@ -110,5 +114,50 @@ public static void Inconclusive(string message)
110114
TestOutputLogger.LogAssertion("Inconclusive", "N/A", message ?? "", false);
111115
Assert.Inconclusive(message);
112116
}
117+
118+
/// <summary>
119+
/// Asserts a Contentstack API error with an HTTP status in the allowed set.
120+
/// </summary>
121+
public static ContentstackErrorException ThrowsContentstackError(Action action, string name, params HttpStatusCode[] acceptableStatuses)
122+
{
123+
var ex = ThrowsException<ContentstackErrorException>(action, name);
124+
IsTrue(
125+
acceptableStatuses.Contains(ex.StatusCode),
126+
$"Expected one of [{string.Join(", ", acceptableStatuses)}] but was {ex.StatusCode}",
127+
"statusCode");
128+
return ex;
129+
}
130+
131+
/// <summary>
132+
/// Async variant: runs the task and expects <see cref="ContentstackErrorException"/> with an allowed status.
133+
/// </summary>
134+
public static async Task<ContentstackErrorException> ThrowsContentstackErrorAsync(Func<Task> action, string name, params HttpStatusCode[] acceptableStatuses)
135+
{
136+
try
137+
{
138+
await action();
139+
TestOutputLogger.LogAssertion($"ThrowsContentstackErrorAsync({name})", "ContentstackErrorException", "NoException", false);
140+
throw new AssertFailedException($"Expected exception ContentstackErrorException was not thrown.");
141+
}
142+
catch (ContentstackErrorException ex)
143+
{
144+
IsTrue(
145+
acceptableStatuses.Contains(ex.StatusCode),
146+
$"Expected one of [{string.Join(", ", acceptableStatuses)}] but was {ex.StatusCode}",
147+
"statusCode");
148+
TestOutputLogger.LogAssertion($"ThrowsContentstackErrorAsync({name})", nameof(ContentstackErrorException), ex.StatusCode.ToString(), true);
149+
return ex;
150+
}
151+
catch (AssertFailedException)
152+
{
153+
throw;
154+
}
155+
catch (Exception ex)
156+
{
157+
TestOutputLogger.LogAssertion($"ThrowsContentstackErrorAsync({name})", nameof(ContentstackErrorException), ex.GetType().Name, false);
158+
throw new AssertFailedException(
159+
$"Expected exception ContentstackErrorException but got {ex.GetType().Name}: {ex.Message}", ex);
160+
}
161+
}
113162
}
114163
}

‎Contentstack.Management.Core.Tests/Helpers/ContentTypeFixtureLoader.cs‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
using Contentstack.Management.Core.Models;
2+
using Newtonsoft.Json;
3+
using Newtonsoft.Json.Linq;
4+
5+
namespace Contentstack.Management.Core.Tests.Helpers
6+
{
7+
/// <summary>
8+
/// Loads embedded content-type JSON and assigns unique UIDs/titles for disposable integration tests.
9+
/// </summary>
10+
public static class ContentTypeFixtureLoader
11+
{
12+
public static ContentModelling LoadFromMock(JsonSerializer serializer, string embeddedFileName, string uidSuffix)
13+
{
14+
var text = Contentstack.GetResourceText(embeddedFileName);
15+
var jo = JObject.Parse(text);
16+
var baseUid = jo["uid"]?.Value<string>() ?? "ct";
17+
jo["uid"] = $"{baseUid}_{uidSuffix}";
18+
var title = jo["title"]?.Value<string>() ?? "CT";
19+
jo["title"] = $"{title} {uidSuffix}";
20+
return jo.ToObject<ContentModelling>(serializer);
21+
}
22+
}
23+
}

‎Contentstack.Management.Core.Tests/IntegrationTest/Contentstack012_ContentTypeTest.cs‎

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
using System;
22
using System.Collections.Generic;
3+
using System.Linq;
4+
using System.Net;
5+
using Contentstack.Management.Core.Exceptions;
36
using Contentstack.Management.Core.Models;
47
using Contentstack.Management.Core.Tests.Helpers;
58
using Contentstack.Management.Core.Tests.Model;
@@ -8,7 +11,7 @@
811
namespace Contentstack.Management.Core.Tests.IntegrationTest
912
{
1013
[TestClass]
11-
public class Contentstack005_ContentTypeTest
14+
public class Contentstack012_ContentTypeTest
1215
{
1316
private static ContentstackClient _client;
1417
private Stack _stack;
@@ -39,34 +42,30 @@ public void Initialize ()
3942

4043
[TestMethod]
4144
[DoNotParallelize]
42-
public void Test001_Should_Create_Content_Type()
45+
public void Test001_Should_Create_SinglePage_Content_Type()
4346
{
4447
TestOutputLogger.LogContext("TestScenario", "CreateContentType_SinglePage");
45-
ContentstackResponse response = _stack.ContentType().Create(_singlePage);
46-
ContentTypeModel ContentType = response.OpenTResponse<ContentTypeModel>();
4748
TestOutputLogger.LogContext("ContentType", _singlePage.Uid);
48-
AssertLogger.IsNotNull(response, "response");
49+
ContentTypeModel ContentType = TryCreateOrFetchContentType(_singlePage);
4950
AssertLogger.IsNotNull(ContentType, "ContentType");
5051
AssertLogger.IsNotNull(ContentType.Modelling, "ContentType.Modelling");
5152
AssertLogger.AreEqual(_singlePage.Title, ContentType.Modelling.Title, "Title");
5253
AssertLogger.AreEqual(_singlePage.Uid, ContentType.Modelling.Uid, "Uid");
53-
AssertLogger.AreEqual(_singlePage.Schema.Count, ContentType.Modelling.Schema.Count, "SchemaCount");
54+
AssertLogger.IsTrue(ContentType.Modelling.Schema.Count >= _singlePage.Schema.Count, "SchemaCount");
5455
}
5556

5657
[TestMethod]
5758
[DoNotParallelize]
58-
public void Test002_Should_Create_Content_Type()
59+
public void Test002_Should_Create_MultiPage_Content_Type()
5960
{
6061
TestOutputLogger.LogContext("TestScenario", "CreateContentType_MultiPage");
61-
ContentstackResponse response = _stack.ContentType().Create(_multiPage);
62-
ContentTypeModel ContentType = response.OpenTResponse<ContentTypeModel>();
6362
TestOutputLogger.LogContext("ContentType", _multiPage.Uid);
64-
AssertLogger.IsNotNull(response, "response");
63+
ContentTypeModel ContentType = TryCreateOrFetchContentType(_multiPage);
6564
AssertLogger.IsNotNull(ContentType, "ContentType");
6665
AssertLogger.IsNotNull(ContentType.Modelling, "ContentType.Modelling");
6766
AssertLogger.AreEqual(_multiPage.Title, ContentType.Modelling.Title, "Title");
6867
AssertLogger.AreEqual(_multiPage.Uid, ContentType.Modelling.Uid, "Uid");
69-
AssertLogger.AreEqual(_multiPage.Schema.Count, ContentType.Modelling.Schema.Count, "SchemaCount");
68+
AssertLogger.IsTrue(ContentType.Modelling.Schema.Count >= _multiPage.Schema.Count, "SchemaCount");
7069
}
7170

7271
[TestMethod]
@@ -82,7 +81,7 @@ public void Test003_Should_Fetch_Content_Type()
8281
AssertLogger.IsNotNull(ContentType.Modelling, "ContentType.Modelling");
8382
AssertLogger.AreEqual(_multiPage.Title, ContentType.Modelling.Title, "Title");
8483
AssertLogger.AreEqual(_multiPage.Uid, ContentType.Modelling.Uid, "Uid");
85-
AssertLogger.AreEqual(_multiPage.Schema.Count, ContentType.Modelling.Schema.Count, "SchemaCount");
84+
AssertLogger.IsTrue(ContentType.Modelling.Schema.Count >= _multiPage.Schema.Count, "SchemaCount");
8685
}
8786

8887
[TestMethod]
@@ -98,7 +97,7 @@ public async System.Threading.Tasks.Task Test004_Should_Fetch_Async_Content_Type
9897
AssertLogger.IsNotNull(ContentType.Modelling, "ContentType.Modelling");
9998
AssertLogger.AreEqual(_singlePage.Title, ContentType.Modelling.Title, "Title");
10099
AssertLogger.AreEqual(_singlePage.Uid, ContentType.Modelling.Uid, "Uid");
101-
AssertLogger.AreEqual(_singlePage.Schema.Count, ContentType.Modelling.Schema.Count, "SchemaCount");
100+
AssertLogger.IsTrue(ContentType.Modelling.Schema.Count >= _singlePage.Schema.Count, "SchemaCount");
102101
}
103102

104103
[TestMethod]
@@ -115,7 +114,7 @@ public void Test005_Should_Update_Content_Type()
115114
AssertLogger.IsNotNull(ContentType.Modelling, "ContentType.Modelling");
116115
AssertLogger.AreEqual(_multiPage.Title, ContentType.Modelling.Title, "Title");
117116
AssertLogger.AreEqual(_multiPage.Uid, ContentType.Modelling.Uid, "Uid");
118-
AssertLogger.AreEqual(_multiPage.Schema.Count, ContentType.Modelling.Schema.Count, "SchemaCount");
117+
AssertLogger.IsTrue(ContentType.Modelling.Schema.Count >= _multiPage.Schema.Count, "SchemaCount");
119118
}
120119

121120
[TestMethod]
@@ -152,7 +151,7 @@ public async System.Threading.Tasks.Task Test006_Should_Update_Async_Content_Typ
152151
AssertLogger.IsNotNull(ContentType, "ContentType");
153152
AssertLogger.IsNotNull(ContentType.Modelling, "ContentType.Modelling");
154153
AssertLogger.AreEqual(_multiPage.Uid, ContentType.Modelling.Uid, "Uid");
155-
AssertLogger.AreEqual(_multiPage.Schema.Count, ContentType.Modelling.Schema.Count, "SchemaCount");
154+
AssertLogger.IsTrue(ContentType.Modelling.Schema.Count >= _multiPage.Schema.Count, "SchemaCount");
156155
Console.WriteLine($"Successfully updated content type with {ContentType.Modelling.Schema.Count} fields");
157156
}
158157
else
@@ -176,7 +175,9 @@ public void Test007_Should_Query_Content_Type()
176175
AssertLogger.IsNotNull(response, "response");
177176
AssertLogger.IsNotNull(ContentType, "ContentType");
178177
AssertLogger.IsNotNull(ContentType.Modellings, "ContentType.Modellings");
179-
AssertLogger.AreEqual(2, ContentType.Modellings.Count, "ModellingsCount");
178+
AssertLogger.IsTrue(ContentType.Modellings.Count >= 2, "At least legacy single_page and multi_page exist");
179+
AssertLogger.IsTrue(ContentType.Modellings.Any(m => m.Uid == _singlePage.Uid), "single_page in query result");
180+
AssertLogger.IsTrue(ContentType.Modellings.Any(m => m.Uid == _multiPage.Uid), "multi_page in query result");
180181
}
181182

182183
[TestMethod]
@@ -189,7 +190,29 @@ public async System.Threading.Tasks.Task Test008_Should_Query_Async_Content_Type
189190
AssertLogger.IsNotNull(response, "response");
190191
AssertLogger.IsNotNull(ContentType, "ContentType");
191192
AssertLogger.IsNotNull(ContentType.Modellings, "ContentType.Modellings");
192-
AssertLogger.AreEqual(2, ContentType.Modellings.Count, "ModellingsCount");
193+
AssertLogger.IsTrue(ContentType.Modellings.Count >= 2, "At least legacy single_page and multi_page exist");
194+
AssertLogger.IsTrue(ContentType.Modellings.Any(m => m.Uid == _singlePage.Uid), "single_page in query result");
195+
AssertLogger.IsTrue(ContentType.Modellings.Any(m => m.Uid == _multiPage.Uid), "multi_page in query result");
196+
}
197+
198+
/// <summary>
199+
/// Creates the content type when missing; otherwise fetches it (stack may already have legacy types).
200+
/// </summary>
201+
private ContentTypeModel TryCreateOrFetchContentType(ContentModelling modelling)
202+
{
203+
try
204+
{
205+
var response = _stack.ContentType().Create(modelling);
206+
return response.OpenTResponse<ContentTypeModel>();
207+
}
208+
catch (ContentstackErrorException ex) when (
209+
ex.StatusCode == HttpStatusCode.UnprocessableEntity
210+
|| ex.StatusCode == HttpStatusCode.Conflict
211+
|| ex.StatusCode == (HttpStatusCode)422)
212+
{
213+
var response = _stack.ContentType(modelling.Uid).Fetch();
214+
return response.OpenTResponse<ContentTypeModel>();
215+
}
193216
}
194217
}
195218
}

0 commit comments

Comments
 (0)