Cleaned up unit tests.

SkylineCommunications · Dec 8, 2023 · 229a3c8 · 229a3c8
1 parent 09d1628
commit 229a3c8
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 15 deletions.
diff --git a/CICD.Tools.CatalogUpload.LibTests/CICD.Tools.CatalogUpload.LibTests.csproj b/CICD.Tools.CatalogUpload.LibTests/CICD.Tools.CatalogUpload.LibTests.csproj
@@ -24,16 +24,16 @@
   </ItemGroup>
 
   <ItemGroup>
-    <None Update="TestData\Demo InterAppCalls 1.0.0-CU1.dmapp">
+    <None Update="TestData\withAutomation.dmapp">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
-    <None Update="TestData\Microsoft Platform 1.0.0-CU4.dmapp">
+    <None Update="TestData\withVisio.dmapp">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
-    <None Update="TestData\SLNetSubscriptionsBenchmarking 1.0.1_B15.dmapp">
+    <None Update="TestData\withProtocols.dmapp">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
-    <None Update="TestData\Tandberg RX1290 1.0.0-CU1.dmapp">
+    <None Update="TestData\withDashboard.dmapp">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
   </ItemGroup>

diff --git a/CICD.Tools.CatalogUpload.LibTests/CatalogArtifactTests.cs b/CICD.Tools.CatalogUpload.LibTests/CatalogArtifactTests.cs
@@ -60,9 +60,23 @@ public async Task UploadAsyncTest_NoToken()
 				Version = "1.0.0.1-alpha"
 			};
 
-			CatalogArtifact artifactModel = new CatalogArtifact(pathToArtifact, fakeService.Object, fakeFileSystem.Object, logger, metaData);
-			Func<Task> uploadAction = async () => { await artifactModel.UploadAsync(); };
-			await uploadAction.Should().ThrowAsync<InvalidOperationException>().WithMessage("*missing token*");
+			var originalKey_encrypt = Environment.GetEnvironmentVariable("dmcatalogtoken_encrypted", EnvironmentVariableTarget.Machine) ?? "";
+			var originalKey = Environment.GetEnvironmentVariable("dmcatalogtoken") ?? "";
+
+			try
+			{
+				Environment.SetEnvironmentVariable("dmcatalogtoken_encrypted", "", EnvironmentVariableTarget.Machine);
+				Environment.SetEnvironmentVariable("dmcatalogtoken", "");
+
+				CatalogArtifact artifactModel = new CatalogArtifact(pathToArtifact, fakeService.Object, fakeFileSystem.Object, logger, metaData);
+				Func<Task> uploadAction = async () => { await artifactModel.UploadAsync(); };
+				await uploadAction.Should().ThrowAsync<InvalidOperationException>().WithMessage("*missing token*");
+			}
+			finally
+			{
+				Environment.SetEnvironmentVariable("dmcatalogtoken_encrypted", originalKey_encrypt, EnvironmentVariableTarget.Machine);
+				Environment.SetEnvironmentVariable("dmcatalogtoken", originalKey);
+			}
 		}
 
 		[TestMethod()]
@@ -93,8 +107,13 @@ public async Task UploadAsyncTest_ProvidedEncryptedTokenEnvironment()
 
 			fakeService.Setup(p => p.ArtifactUploadAsync(It.IsAny<byte[]>(), "encryptedFake", metaData, It.IsAny<CancellationToken>())).ReturnsAsync(model);
 
+			var originalKey_encrypt = Environment.GetEnvironmentVariable("dmcatalogtoken_encrypted", EnvironmentVariableTarget.Machine) ?? "";
+			var originalKey = Environment.GetEnvironmentVariable("dmcatalogtoken") ?? "";
+
 			try
 			{
+				Environment.SetEnvironmentVariable("dmcatalogtoken", "");
+
 				WinEncryptedKeys.Lib.Keys.SetKey("dmcatalogtoken_encrypted", "encryptedFake");
 
 				// Act
@@ -111,7 +130,8 @@ public async Task UploadAsyncTest_ProvidedEncryptedTokenEnvironment()
 			}
 			finally
 			{
-				Environment.SetEnvironmentVariable("dmcatalogtoken_encrypted", "", EnvironmentVariableTarget.Machine);
+				Environment.SetEnvironmentVariable("dmcatalogtoken_encrypted", originalKey_encrypt, EnvironmentVariableTarget.Machine);
+				Environment.SetEnvironmentVariable("dmcatalogtoken", originalKey);
 			}
 		}
 
@@ -184,8 +204,12 @@ public async Task UploadAsyncTest_ProvidedTokenEnvironment()
 
 			fakeService.Setup(p => p.ArtifactUploadAsync(It.IsAny<byte[]>(), "fake", metaData, It.IsAny<CancellationToken>())).ReturnsAsync(model);
 
+			var originalKey_encrypt = Environment.GetEnvironmentVariable("dmcatalogtoken_encrypted", EnvironmentVariableTarget.Machine) ?? "";
+			var originalKey = Environment.GetEnvironmentVariable("dmcatalogtoken") ?? "";
+
 			try
 			{
+				Environment.SetEnvironmentVariable("dmcatalogtoken_encrypted", "", EnvironmentVariableTarget.Machine);
 				Environment.SetEnvironmentVariable("dmcatalogtoken", "fake");
 
 				// Act
@@ -202,7 +226,8 @@ public async Task UploadAsyncTest_ProvidedTokenEnvironment()
 			}
 			finally
 			{
-				Environment.SetEnvironmentVariable("dmcatalogtoken", String.Empty);
+				Environment.SetEnvironmentVariable("dmcatalogtoken_encrypted", originalKey_encrypt, EnvironmentVariableTarget.Machine);
+				Environment.SetEnvironmentVariable("dmcatalogtoken", originalKey);
 			}
 		}
 	}

diff --git a/CICD.Tools.CatalogUpload.LibTests/CatalogService/CatalogMetaDataTests.cs b/CICD.Tools.CatalogUpload.LibTests/CatalogService/CatalogMetaDataTests.cs
@@ -11,7 +11,7 @@ public class CatalogMetaDataTests
 		public void FromArtifactTest_BuildPreReleaseDmappWithProtocols()
 		{
 			// Arrange
-			string pathToArtifact = "TestData/SLNetSubscriptionsBenchmarking 1.0.1_B15.dmapp";
+			string pathToArtifact = "TestData/withProtocols.dmapp";
 
 			// Act
 			CatalogMetaData result = CatalogMetaData.FromArtifact(pathToArtifact);
@@ -33,7 +33,7 @@ public void FromArtifactTest_BuildPreReleaseDmappWithProtocols()
 		public void FromArtifactTest_ReleaseAutomation()
 		{
 			// Arrange
-			string pathToArtifact = "TestData/Demo InterAppCalls 1.0.0-CU1.dmapp";
+			string pathToArtifact = "TestData/withAutomation.dmapp";
 
 			// Act
 			CatalogMetaData result = CatalogMetaData.FromArtifact(pathToArtifact);
@@ -55,7 +55,7 @@ public void FromArtifactTest_ReleaseAutomation()
 		public void FromArtifactTest_ReleaseDashboard()
 		{
 			// Arrange
-			string pathToArtifact = "TestData/Tandberg RX1290 1.0.0-CU1.dmapp";
+			string pathToArtifact = "TestData/withDashboard.dmapp";
 
 			// Act
 			CatalogMetaData result = CatalogMetaData.FromArtifact(pathToArtifact);
@@ -77,7 +77,7 @@ public void FromArtifactTest_ReleaseDashboard()
 		public void FromArtifactTest_ReleaseProtocolVisio()
 		{
 			// Arrange
-			string pathToArtifact = "TestData/Microsoft Platform 1.0.0-CU4.dmapp";
+			string pathToArtifact = "TestData/withVisio.dmapp";
 
 			// Act
 			CatalogMetaData result = CatalogMetaData.FromArtifact(pathToArtifact);

diff --git a/...stData/Demo InterAppCalls 1.0.0-CU1.dmapp → ...ad.LibTests/TestData/withAutomation.dmapp b/...stData/Demo InterAppCalls 1.0.0-CU1.dmapp → ...ad.LibTests/TestData/withAutomation.dmapp
diff --git a/.../TestData/Tandberg RX1290 1.0.0-CU1.dmapp → ...oad.LibTests/TestData/withDashboard.dmapp b/.../TestData/Tandberg RX1290 1.0.0-CU1.dmapp → ...oad.LibTests/TestData/withDashboard.dmapp
diff --git a/...SubscriptionsBenchmarking 1.0.1_B15.dmapp → ...oad.LibTests/TestData/withProtocols.dmapp b/...SubscriptionsBenchmarking 1.0.1_B15.dmapp → ...oad.LibTests/TestData/withProtocols.dmapp
diff --git a/...stData/Microsoft Platform 1.0.0-CU4.dmapp → ...gUpload.LibTests/TestData/withVisio.dmapp b/...stData/Microsoft Platform 1.0.0-CU4.dmapp → ...gUpload.LibTests/TestData/withVisio.dmapp
diff --git a/CICD.Tools.CatalogUpload/README.md b/CICD.Tools.CatalogUpload/README.md
@@ -2,7 +2,7 @@
 
 ## About
 
-Uploads artifacts to the Skyline DataMiner catalog (https://catalog.dataminer.services) visible or invisible.
+Uploads and/or makes visible, artifacts to the Skyline DataMiner catalog (https://catalog.dataminer.services).
 
 ### About DataMiner
 
@@ -55,8 +55,8 @@ You can choose to add the dmcatalogtoken to an environment variable instead and
 
 The first option is commonplace for environment setups in cloud-based CI/CD Pipelines (github, gitlab, azure, ...)
 The second option can be beneficial on a static server such as Jenkins or your local machine (windows only). It adds additional encryption to the environment variable only allowing decryption on the same machine. 
-for example:
 
+Running as Administrator:
 ```console
 dotnet tool install -g Skyline.DataMiner.CICD.Tools.WinEncryptedKeys
 WinEncryptedKeys --name "dmcatalogtoken_encrypted" --value "MyTokenHere"