Cleanup

- Enable warnings as errors
- Remove unused code
- Add comments to tests

Author: andreas-valtech

src/Web/Models/Media/GenericMedia.cs

@@ -6,5 +6,5 @@ public class GenericMedia : MediaData
     /// <summary>
     /// Gets or sets the description.
     /// </summary>
-    public virtual String Description { get; set; }
+    public virtual string Description { get; set; } = null!;
 }

src/Web/Models/Media/ImageFile.cs

@@ -12,5 +12,5 @@ public class ImageFile : ImageData
     /// <value>
     /// The copyright.
     /// </value>
-    public virtual string Copyright { get; set; }
+    public virtual string Copyright { get; set; } = null!;
 }

src/Web/Models/Media/VideoFile.cs

@@ -11,11 +11,11 @@ public class VideoFile : VideoData
     /// <summary>
     /// Gets or sets the copyright.
     /// </summary>
-    public virtual string Copyright { get; set; }
+    public virtual string Copyright { get; set; } = null!;
 
     /// <summary>
     /// Gets or sets the URL to the preview image.
     /// </summary>
     [UIHint(UIHint.Image)]
-    public virtual ContentReference PreviewImage { get; set; }
+    public virtual ContentReference PreviewImage { get; set; } = null!;
 }

src/Web/Models/Pages/NewsPage.cs

@@ -5,5 +5,5 @@
     DisplayName = "News Page")]
 public class NewsPage : PageData
 {
-    public virtual string Title { get; set; }
+    public virtual string Title { get; set; } = null!;
 }

src/Web/Models/Pages/StartPage.cs

@@ -1,52 +1,17 @@
 using System.ComponentModel.DataAnnotations;
 
 namespace Optimizely.TestContainers.Models.Pages;
-//using AlloyTemplates.Models.Blocks;
 
 /// <summary>
 /// Used for the site's start page and also acts as a container for site settings
 /// </summary>
 [ContentType(
-    GUID = "19671657-B684-4D95-A61F-8DD4FE60D559"
-    /*GroupName = Global.GroupNames.Specialized*/)]
-//[SiteImageUrl]
-/*
-[AvailableContentTypes(
-    Availability.Specific,
-    Include = new[] { typeof(ContainerPage), typeof(ProductPage), typeof(StandardPage), typeof(ISearchPage), typeof(LandingPage), typeof(ContentFolder) }, // Pages we can create under the start page...
-    ExcludeOn = new[] { typeof(ContainerPage), typeof(ProductPage), typeof(StandardPage), typeof(ISearchPage), typeof(LandingPage) })] // ...and underneath those we can't create additional start pages
-*/
+    GUID = "19671657-B684-4D95-A61F-8DD4FE60D559")]
 public class StartPage : PageData
 {
     [Display(
         GroupName = SystemTabNames.Content,
         Order = 320)]
     [CultureSpecific]
-    public virtual ContentArea MainContentArea { get; set; }
-    
-    /*
-    [Display(GroupName = Global.GroupNames.SiteSettings, Order = 300)]
-    public virtual LinkItemCollection ProductPageLinks { get; set; }
-
-    [Display(GroupName = Global.GroupNames.SiteSettings, Order = 350)]
-    public virtual LinkItemCollection CompanyInformationPageLinks { get; set; }
-
-    [Display(GroupName = Global.GroupNames.SiteSettings, Order = 400)]
-    public virtual LinkItemCollection NewsPageLinks { get; set; }
-
-    [Display(GroupName = Global.GroupNames.SiteSettings, Order = 450)]
-    public virtual LinkItemCollection CustomerZonePageLinks { get; set; }
-
-    [Display(GroupName = Global.GroupNames.SiteSettings)]
-    public virtual PageReference GlobalNewsPageLink { get; set; }
-
-    [Display(GroupName = Global.GroupNames.SiteSettings)]
-    public virtual PageReference ContactsPageLink { get; set; }
-
-    [Display(GroupName = Global.GroupNames.SiteSettings)]
-    public virtual PageReference SearchPageLink { get; set; }
-
-    [Display(GroupName = Global.GroupNames.SiteSettings)]
-    public virtual SiteLogotypeBlock SiteLogotype { get; set; }
-    */
+    public virtual ContentArea MainContentArea { get; set; } = null!;
 }

src/Web/Optimizely.TestContainers.csproj

@@ -4,6 +4,12 @@
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+  </PropertyGroup>
 
   <ItemGroup>
     <Using Include="EPiServer" />

test/OptimizelyTestContainers.Tests/NewsPageIntegrationTests.cs

@@ -20,34 +20,31 @@ public void Can_Create_And_Read_NewsPage()
         // Import test data
         var basePath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)!;
         var episerverDataFile = Path.Combine(basePath, "DefaultSiteContent.episerverdata");
-        
         var dataImporter = Services.GetRequiredService<OptimizelyDataImporter>();
         dataImporter.Import(episerverDataFile);
 
-        
         // Find StartPage from root
-        // Setup site definition
-        
         var startPage = repo.GetChildren<StartPage>(ContentReference.RootPage).First();
 
+        // Setup site definition
         var siteDefinitionRepo = Services.GetRequiredService<ISiteDefinitionRepository>();
-        
         siteDefinitionRepo.Save(new SiteDefinition()
         {
             Name = "TestSite",
             StartPage = startPage.ContentLink,
             SiteUrl = new Uri("http://localhost"),
         });
 
+        // Find first site
         var allSites = siteDefinitionRepo.List();
-
         var site = allSites.First();
 
+        // Create NewsPage
         var news = repo.GetDefault<NewsPage>(site.StartPage);
         news.Name = "Alien Invasion";
         news.Title = "Martians Landed in Stockholm";
 
-        // Act
+        // Act (Save and Load NewsPage)
         var savedRef = repo.Save(news, SaveAction.Publish, AccessLevel.NoAccess);
         var loaded = repo.Get<NewsPage>(savedRef);
 

test/OptimizelyTestContainers.Tests/OptimizelyIntegrationTestBase.cs

@@ -37,14 +37,6 @@ public async Task InitializeAsync()
             {
                 webBuilder.ConfigureServices((context, services) =>
                 {
-                    // Add CMS services
-                    services.AddCms();
-                    services.AddCmsHost();
-                    services.AddCmsFrameworkWeb();
-                    services.AddCmsCoreWeb(); 
-                    services.AddCmsTemplating();
-                    services.AddCmsUI();
-
                     // Override connection string to use container connection
                     services.Configure<DataAccessOptions>(opt =>
                     {

test/OptimizelyTestContainers.Tests/OptimizelyTestContainers.Tests.csproj

@@ -7,6 +7,14 @@
         <IsPackable>false</IsPackable>
     </PropertyGroup>
 
+    <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
+      <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    </PropertyGroup>
+
+    <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+      <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    </PropertyGroup>
+
     <ItemGroup>
         <PackageReference Include="coverlet.collector" Version="6.0.4">
           <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>