feat(testing): split out the testing resources.

Christoph Bühler · buehler · commit f4f6fa612f92 · 2020-09-01T11:17:39.000+02:00
BREAKING CHANGE: This removes the application factory
from `KubeOps`. Please install the `KubeOps.Testing`
package if you need the resources.
diff --git a/DotnetOperatorSdk.sln b/DotnetOperatorSdk.sln
@@ -32,6 +32,8 @@ ProjectSection(SolutionItems) = preProject
 	.releaserc.json = .releaserc.json
 EndProjectSection
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "KubeOps.Testing", "src\KubeOps.Testing\KubeOps.Testing.csproj", "{4A6D1BEB-CB4C-495A-A20D-D8728F6BBC93}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -56,6 +58,10 @@ Global
 		{B374D7E4-E9BA-47F8-B1A4-440DECD376E4}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{B374D7E4-E9BA-47F8-B1A4-440DECD376E4}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{B374D7E4-E9BA-47F8-B1A4-440DECD376E4}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4A6D1BEB-CB4C-495A-A20D-D8728F6BBC93}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4A6D1BEB-CB4C-495A-A20D-D8728F6BBC93}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4A6D1BEB-CB4C-495A-A20D-D8728F6BBC93}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4A6D1BEB-CB4C-495A-A20D-D8728F6BBC93}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -66,6 +72,7 @@ Global
 		{D47717CB-A02E-4B12-BAA8-1D7F8BAE9BBD} = {9AF95FE4-DA1F-4BB0-B60E-23FCFA6AAAA2}
 		{751BDC14-D75F-4DDE-9C45-2432041FBCAC} = {50E9B964-68F7-4B9F-BEA8-165CE45BC5C6}
 		{B374D7E4-E9BA-47F8-B1A4-440DECD376E4} = {50E9B964-68F7-4B9F-BEA8-165CE45BC5C6}
+		{4A6D1BEB-CB4C-495A-A20D-D8728F6BBC93} = {95F3A6DD-B421-441D-B263-1B34A1465FF5}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {ADAA5DFB-A7E5-490C-88EF-48D67C715F24}
diff --git a/src/KubeOps.Testing/KubeOps.Testing.csproj b/src/KubeOps.Testing/KubeOps.Testing.csproj
@@ -0,0 +1,27 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <Import Project="..\..\config\Common.targets" />
+    <Import Project="..\..\config\CodeAnalysis.targets" />
+
+    <PropertyGroup>
+        <IsPackable>true</IsPackable>
+        <PackageId>KubeOps.Testing</PackageId>
+        <PackageTags>Kubernetes Operator SDK CustomResourceDefinition Testing Test</PackageTags>
+        <PackageProjectUrl>https://github.com/buehler/dotnet-operator-sdk</PackageProjectUrl>
+        <PackageLicense>https://opensource.org/licenses/MIT</PackageLicense>
+        <PackageDescription>
+            Additional Resources that helps / supports integration
+            testing on a kubernetes operator written with the KubeOps
+            operator sdk.
+        </PackageDescription>
+    </PropertyGroup>
+    
+    <ItemGroup>
+        <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="3.1.7" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\KubeOps\KubeOps.csproj" />
+    </ItemGroup>
+
+</Project>
diff --git a/src/KubeOps.Testing/KubernetesOperatorFactory.cs b/src/KubeOps.Testing/KubernetesOperatorFactory.cs
diff --git a/src/KubeOps.Testing/MockKubernetesClient.cs b/src/KubeOps.Testing/MockKubernetesClient.cs
diff --git a/src/KubeOps.Testing/MockResourceEventQueue.cs b/src/KubeOps.Testing/MockResourceEventQueue.cs
diff --git a/src/KubeOps.Testing/MockResourceQueueCollection.cs b/src/KubeOps.Testing/MockResourceQueueCollection.cs
diff --git a/src/KubeOps/KubeOps.csproj b/src/KubeOps/KubeOps.csproj
@@ -5,6 +5,7 @@
 
     <PropertyGroup>
         <OutputType>exe</OutputType>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
     </PropertyGroup>
 
     <PropertyGroup>
@@ -42,10 +43,4 @@
         </Content>
     </ItemGroup>
 
-    <ItemGroup>
-        <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
-            <_Parameter1>$(MSBuildProjectName).Test</_Parameter1>
-        </AssemblyAttribute>
-    </ItemGroup>
-
 </Project>
diff --git a/src/KubeOps/Operator/Caching/CacheComparisonResult.cs b/src/KubeOps/Operator/Caching/CacheComparisonResult.cs
@@ -2,10 +2,31 @@
 {
     public enum CacheComparisonResult
     {
+        /// <summary>
+        /// The resource is new to the cache
+        /// and was never seen.
+        /// </summary>
         New,
+
+        /// <summary>
+        /// The resource was in the cache and some
+        /// properties changed (but not resourceVersion).
+        /// </summary>
         Modified,
+
+        /// <summary>
+        /// The resource has changed, but only the "status" of it.
+        /// </summary>
         StatusModified,
+
+        /// <summary>
+        /// The resource has changed, but only the "finalizers" list.
+        /// </summary>
         FinalizersModified,
+
+        /// <summary>
+        /// The resource stayed the same.
+        /// </summary>
         NotModified,
     }
 }
diff --git a/src/KubeOps/Operator/Entities/EntityScope.cs b/src/KubeOps/Operator/Entities/EntityScope.cs
@@ -2,7 +2,14 @@
 {
     public enum EntityScope
     {
+        /// <summary>
+        /// The resource is namespace.
+        /// </summary>
         Namespaced,
+
+        /// <summary>
+        /// The resource is cluster-wide.
+        /// </summary>
         Cluster,
     }
 }
diff --git a/src/KubeOps/Operator/Entities/Extensions/DeepCloneExtensions.cs b/src/KubeOps/Operator/Entities/Extensions/DeepCloneExtensions.cs
@@ -18,8 +18,12 @@ internal static class DeepCloneExtensions
                                                          throw new ArgumentNullException();
 
         /// <summary>
-        /// Returns a Deep Clone / Deep Copy of an object of type T using a recursive call to the CloneMethod specified above.
+        /// Returns a Deep Clone / Deep Copy of an object of type T using a recursive
+        /// call to the CloneMethod specified above.
         /// </summary>
+        /// <param name="obj">The object to deeply clone.</param>
+        /// <typeparam name="TResource">Object type.</typeparam>
+        /// <returns>A deep clone of a given object.</returns>
         internal static TResource DeepClone<TResource>(this TResource obj)
             where TResource : IKubernetesObject<V1ObjectMeta>
         {
diff --git a/src/KubeOps/Operator/Rbac/RbacVerbs.cs b/src/KubeOps/Operator/Rbac/RbacVerbs.cs
@@ -5,14 +5,49 @@ namespace KubeOps.Operator.Rbac
     [Flags]
     public enum RbacVerb
     {
+        /// <summary>
+        /// No permissions on the resource.
+        /// </summary>
         None = 0,
+
+        /// <summary>
+        /// All possible permissions.
+        /// </summary>
         All = 1 << 0,
+
+        /// <summary>
+        /// Retrieve the resource from the api.
+        /// </summary>
         Get = 1 << 1,
+
+        /// <summary>
+        /// List resources on the api.
+        /// </summary>
         List = 1 << 2,
+
+        /// <summary>
+        /// Watch for events on resources.
+        /// </summary>
         Watch = 1 << 3,
+
+        /// <summary>
+        /// Create new instances of the resource.
+        /// </summary>
         Create = 1 << 4,
+
+        /// <summary>
+        /// Update existing resources.
+        /// </summary>
         Update = 1 << 5,
+
+        /// <summary>
+        /// Patch resources.
+        /// </summary>
         Patch = 1 << 6,
+
+        /// <summary>
+        /// Delete resources on the api.
+        /// </summary>
         Delete = 1 << 7,
     }
 }
diff --git a/src/KubeOps/Operator/Serialization/SerializerOutputFormat.cs b/src/KubeOps/Operator/Serialization/SerializerOutputFormat.cs
@@ -2,7 +2,14 @@
 {
     internal enum SerializerOutputFormat
     {
+        /// <summary>
+        /// Return the generated output in yaml format.
+        /// </summary>
         Yaml,
+
+        /// <summary>
+        /// Return the generated output in json format.
+        /// </summary>
         Json,
     }
 }
diff --git a/tests/KubeOps.TestOperator.Test/KubeOps.TestOperator.Test.csproj b/tests/KubeOps.TestOperator.Test/KubeOps.TestOperator.Test.csproj
@@ -16,6 +16,7 @@
     </ItemGroup>
 
     <ItemGroup>
+      <ProjectReference Include="..\..\src\KubeOps.Testing\KubeOps.Testing.csproj" />
       <ProjectReference Include="..\..\src\KubeOps\KubeOps.csproj" />
       <ProjectReference Include="..\KubeOps.TestOperator\KubeOps.TestOperator.csproj" />
     </ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,14 @@`
`2`	`2`	`{`
`3`	`3`	`public enum EntityScope`
`4`	`4`	`{`
	`5`	`+ /// <summary>`
	`6`	`+ /// The resource is namespace.`
	`7`	`+ /// </summary>`
`5`	`8`	`Namespaced,`
	`9`	`+`
	`10`	`+ /// <summary>`
	`11`	`+ /// The resource is cluster-wide.`
	`12`	`+ /// </summary>`
`6`	`13`	`Cluster,`
`7`	`14`	`}`
`8`	`15`	`}`