Annotate Arrange/Act/Assert in unit tests

Author: edwardneal

src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/AlwaysEncrypted/AeadAes256CbcHmac256EncryptionKeyTest.cs

@@ -22,9 +22,12 @@ public class AeadAes256CbcHmac256EncryptionKeyTest
     [Fact]
     public void Constructor_ThrowsOnInvalidSize()
     {
+        // Arrange
         byte[] invalidSizeRootKey = [0x01, 0x02, 0x03, 0x04];
+        // Act
         Action createEncryptionKey = () => new AeadAes256CbcHmac256EncryptionKey(invalidSizeRootKey);
 
+        // Assert
         Assert.NotEqual(AeadAes256CbcHmac256EncryptionKey.KeySizeInBytes, invalidSizeRootKey.Length);
         Assert.Throws<ArgumentException>(createEncryptionKey);
     }
@@ -37,14 +40,17 @@ public void Constructor_ThrowsOnInvalidSize()
     [Fact]
     public void Constructor_SucceedsOnValidSize()
     {
+        // Arrange
         byte[] validRootKey = [
             0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,
             0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,
             0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,
             0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08
         ];
+        // Act
         AeadAes256CbcHmac256EncryptionKey encryptionKey = new(validRootKey);
 
+        // Assert
         Assert.Equal(AeadAes256CbcHmac256EncryptionKey.KeySizeInBytes, encryptionKey.EncryptionKey.Length);
         Assert.Equal(AeadAes256CbcHmac256EncryptionKey.KeySizeInBytes, encryptionKey.MacKey.Length);
         Assert.Equal(AeadAes256CbcHmac256EncryptionKey.KeySizeInBytes, encryptionKey.IvKey.Length);

src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/AlwaysEncrypted/AeadAes256CbcHmac256FactoryTest.cs

@@ -21,11 +21,14 @@ public class AeadAes256CbcHmac256FactoryTest
     [Fact]
     public void InvalidEncryptionType_Throws()
     {
+        // Arrange
         byte[] dummySymmetricKeyMaterial = [0x00];
         SymmetricKey symmetricKey = new(dummySymmetricKeyMaterial);
+        // Act
         Action createEncryptionAlgorithm = () =>
             AeadAes256CbcHmac256Factory.Instance.Create(symmetricKey, (EncryptionType)0xFF, SqlAeadAes256CbcHmac256Algorithm.AlgorithmName);
 
+        // Assert
         Assert.Throws<ArgumentException>(createEncryptionAlgorithm);
     }
 
@@ -36,6 +39,7 @@ public void InvalidEncryptionType_Throws()
     [Fact]
     public void MultipleCreateCalls_ReturnCachedAlgorithm()
     {
+        // Arrange
         byte[] validFirstRootKeyMaterial = [
             0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,
             0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,
@@ -51,10 +55,12 @@ public void MultipleCreateCalls_ReturnCachedAlgorithm()
         SymmetricKey firstRootKey = new(validFirstRootKeyMaterial);
         SymmetricKey secondRootKey = new(validSecondRootKeyMaterial);
 
+        // Act
         SqlClientEncryptionAlgorithm initialFirstAlgorithm = AeadAes256CbcHmac256Factory.Instance.Create(firstRootKey, EncryptionType.Deterministic, SqlAeadAes256CbcHmac256Algorithm.AlgorithmName);
         SqlClientEncryptionAlgorithm cachedFirstAlgorithm = AeadAes256CbcHmac256Factory.Instance.Create(firstRootKey, EncryptionType.Deterministic, SqlAeadAes256CbcHmac256Algorithm.AlgorithmName);
         SqlClientEncryptionAlgorithm initialSecondAlgorithm = AeadAes256CbcHmac256Factory.Instance.Create(secondRootKey, EncryptionType.Deterministic, SqlAeadAes256CbcHmac256Algorithm.AlgorithmName);
 
+        // Assert
         Assert.Equal(initialFirstAlgorithm, cachedFirstAlgorithm);
         Assert.NotEqual(initialFirstAlgorithm, initialSecondAlgorithm);
 

src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/AlwaysEncrypted/EncryptionAlgorithmFactoryListTest.cs

@@ -22,10 +22,13 @@ public void GetAlgorithmWithInvalidAlgorithm_Throws()
     {
         const string InvalidAlgorithmName = nameof(EncryptionAlgorithmFactoryListTest);
 
+        // Arrange
         byte[] dummySymmetricKeyMaterial = [0x00];
         SymmetricKey dummySymmetricKey = new(dummySymmetricKeyMaterial);
+        // Act
         Action getAlgorithm = () => EncryptionAlgorithmFactoryList.GetAlgorithm(dummySymmetricKey, 0x01, InvalidAlgorithmName, out _);
 
+        // Assert
         ArgumentException thrownException = Assert.Throws<ArgumentException>(getAlgorithm);
 
         Assert.Contains(InvalidAlgorithmName, thrownException.Message);

src/Microsoft.Data.SqlClient/tests/UnitTests/Microsoft/Data/SqlClient/AlwaysEncrypted/SymmetricKeyTest.cs

@@ -21,9 +21,12 @@ public class SymmetricKeyTest
     [Fact]
     public void Constructor_WrapsByteArray()
     {
+        // Arrange
         byte[] dummySymmetricKeyMaterial = [0x00];
+        // Act
         SymmetricKey symmetricKey = new(dummySymmetricKeyMaterial);
 
+        // Assert
         Assert.Same(dummySymmetricKeyMaterial, symmetricKey.RootKey);
     }
 
@@ -34,9 +37,11 @@ public void Constructor_WrapsByteArray()
     [Fact]
     public void Constructor_ThrowsOnNullOrEmptyArray()
     {
+        // Act
         Action createNullArray = () => new SymmetricKey(rootKey: null);
         Action createEmptyArray = () => new SymmetricKey(rootKey: []);
 
+        // Assert
         Assert.Throws<ArgumentNullException>(createNullArray);
         Assert.Throws<ArgumentNullException>(createEmptyArray);
     }