fix(secretmanager): Typo/Formatting and flakiness for the existing global samples

Author: YashSaraf11

secretmanager/api/SecretManager.Samples.Tests/AccessSecretVersionTests.cs

@@ -32,9 +32,14 @@ public AccessSecretVersionTests(SecretManagerFixture fixture)
     [Fact]
     public void AddsSecretVersions()
     {
+        // Get the SecretVersionName.
         SecretVersionName secretVersionName = _fixture.SecretVersion.SecretVersionName;
+
+        // Run the code sample.
         string result = _sample.AccessSecretVersion(
           projectId: secretVersionName.ProjectId, secretId: secretVersionName.SecretId, secretVersionId: secretVersionName.SecretVersionId);
+
+        // Assert that expected result is observed.
         Assert.Equal("my super secret data", result);
     }
 }

secretmanager/api/SecretManager.Samples.Tests/AddSecretVersionTests.cs

@@ -32,14 +32,26 @@ public AddSecretVersionTests(SecretManagerFixture fixture)
     [Fact]
     public void AddsSecretVersions()
     {
+        // Get the payload data.
         string data = "my secret data";
-        SecretName secretName = _fixture.Secret.SecretName;
+
+        // Create the secret resource.
+        Secret secret = _fixture.CreateSecret(_fixture.RandomId());
+
+        // Get the SecretName.
+        SecretName secretName = secret.SecretName;
+
+        // Run the code sample.
         SecretVersion secretVersion = _sample.AddSecretVersion(
           projectId: secretName.ProjectId, secretId: secretName.SecretId,
           data: data);
 
-        SecretManagerServiceClient client = SecretManagerServiceClient.Create();
+        // Assert expected result is observed.
+        SecretManagerServiceClient client = _fixture.Client;
         AccessSecretVersionResponse result = client.AccessSecretVersion(secretVersion.SecretVersionName);
         Assert.Equal(data, result.Payload.Data.ToStringUtf8());
+
+        // Cleanup the created resource.
+        _fixture.DeleteSecret(secretName);
     }
 }

secretmanager/api/SecretManager.Samples.Tests/CreateSecretTests.cs

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-using Xunit;
 using Google.Cloud.SecretManager.V1;
+using Xunit;
 
 [Collection(nameof(SecretManagerFixture))]
 public class CreateSecretTests
@@ -32,9 +32,17 @@ public CreateSecretTests(SecretManagerFixture fixture)
     [Fact]
     public void CreatesSecrets()
     {
-        SecretName secretName = _fixture.SecretToCreateName;
+        // Get the SecretName.
+        SecretName secretName = new SecretName(_fixture.ProjectId, _fixture.RandomId());
+
+        // Run the code sample.
         Secret result = _sample.CreateSecret(
           projectId: secretName.ProjectId, secretId: secretName.SecretId);
+
+        // Assert expected result is observed.
         Assert.Equal(result.SecretName.SecretId, secretName.SecretId);
+
+        // Cleanup the created resource.
+        _fixture.DeleteSecret(secretName);
     }
 }

secretmanager/api/SecretManager.Samples.Tests/CreateUserManagedReplicationSecretTests.cs

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-using Xunit;
 using Google.Cloud.SecretManager.V1;
+using Xunit;
 
 [Collection(nameof(SecretManagerFixture))]
 public class CreateUserManagedReplicationSecretTests
@@ -32,13 +32,20 @@ public CreateUserManagedReplicationSecretTests(SecretManagerFixture fixture)
     [Fact]
     public void CreatesUmmrSecrets()
     {
-        SecretName secretName = _fixture.UserManagedReplicationSecretName;
-        string[] locations = {"us-east1", "us-east4", "us-west1"};
+        // Get the SecretName.
+        SecretName secretName = new SecretName(_fixture.ProjectId, _fixture.RandomId());
+
+        // Set the locations list for replications.
+        string[] locations = { "us-east1", "us-east4", "us-west1" };
+
+        // Run the code sample.
         Secret result = _sample.CreateUserManagedReplicationSecret(
           projectId: secretName.ProjectId, secretId: secretName.SecretId, locations: locations);
         Assert.Equal(result.SecretName.SecretId, secretName.SecretId);
         Assert.Contains(result.Replication.UserManaged.Replicas, r => r.Location == "us-east1");
         Assert.Contains(result.Replication.UserManaged.Replicas, r => r.Location == "us-east4");
         Assert.Contains(result.Replication.UserManaged.Replicas, r => r.Location == "us-west1");
+
+        _fixture.DeleteSecret(secretName);
     }
 }

secretmanager/api/SecretManager.Samples.Tests/DeleteSecretTests.cs

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-using Xunit;
 using Google.Cloud.SecretManager.V1;
+using Xunit;
 
 [Collection(nameof(SecretManagerFixture))]
 public class DeleteSecretTests
@@ -32,10 +32,17 @@ public DeleteSecretTests(SecretManagerFixture fixture)
     [Fact]
     public void DeletesSecrets()
     {
-        SecretName secretName = _fixture.SecretToDelete.SecretName;
+        // Create the secret.
+        Secret secret = _fixture.CreateSecret(_fixture.RandomId());
+
+        // Get the secretName from the created secret.
+        SecretName secretName = secret.SecretName;
+
+        // Call the code sample function.
         _sample.DeleteSecret(projectId: secretName.ProjectId, secretId: secretName.SecretId);
 
-        SecretManagerServiceClient client = SecretManagerServiceClient.Create();
+        // Assert expected behavior is seen.
+        SecretManagerServiceClient client = _fixture.Client;
         Assert.Throws<Grpc.Core.RpcException>(() => client.GetSecret(secretName));
     }
 }

secretmanager/api/SecretManager.Samples.Tests/EditSecretAnnotationsTests.cs

@@ -44,7 +44,7 @@ public void EditSecretAnnotations()
         string oldAnnotationKey = _fixture.AnnotationKey;
         string oldAnnotationValue = _fixture.AnnotationValue;
 
-        // Create the secret with the specificed fields.
+        // Call the code sample function.
         Secret result = _sample.EditSecretAnnotations(
           projectId: secretName.ProjectId, secretId: secretName.SecretId, annotationKey: newAnnotationKey, annotationValue: newAnnotationValue);
 

secretmanager/api/SecretManager.Samples.Tests/QuickstartTests.cs

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-using Xunit;
 using Google.Cloud.SecretManager.V1;
+using Xunit;
 
 [Collection(nameof(SecretManagerFixture))]
 public class QuickstartTests
@@ -32,7 +32,10 @@ public QuickstartTests(SecretManagerFixture fixture)
     [Fact]
     public void Runs()
     {
-        SecretName secretName = _fixture.SecretForQuickstartName;
+        SecretName secretName = new SecretName(_fixture.ProjectId, _fixture.RandomId());
+
         _sample.Quickstart(projectId: secretName.ProjectId, secretId: secretName.SecretId);
+
+        _fixture.DeleteSecret(secretName);
     }
 }

secretmanager/api/SecretManager.Samples.Tests/SecretManagerFixture.cs

@@ -28,11 +28,6 @@ public class SecretManagerFixture : IDisposable, ICollectionFixture<SecretManage
     public string ProjectId { get; }
     public ProjectName ProjectName { get; }
     public Secret Secret { get; }
-    public Secret SecretToDelete { get; }
-    public Secret SecretWithVersions { get; }
-    public SecretName SecretForQuickstartName { get; }
-    public SecretName SecretToCreateName { get; }
-    public SecretName UserManagedReplicationSecretName { get; }
     public SecretVersion SecretVersion { get; }
 
     public string AnnotationKey { get; }
@@ -64,23 +59,12 @@ public SecretManagerFixture()
         LabelValue = "my-label-value";
 
         Secret = CreateSecret(RandomId());
-        SecretToDelete = CreateSecret(RandomId());
-        SecretWithVersions = CreateSecret(RandomId());
-        SecretForQuickstartName = new SecretName(ProjectId, RandomId());
-        SecretToCreateName = new SecretName(ProjectId, RandomId());
-        UserManagedReplicationSecretName = new SecretName(ProjectId, RandomId());
-
-        SecretVersion = AddSecretVersion(SecretWithVersions);
+        SecretVersion = AddSecretVersion(Secret);
     }
 
     public void Dispose()
     {
         DeleteSecret(Secret.SecretName);
-        DeleteSecret(SecretForQuickstartName);
-        DeleteSecret(SecretToCreateName);
-        DeleteSecret(UserManagedReplicationSecretName);
-        DeleteSecret(SecretToDelete.SecretName);
-        DeleteSecret(SecretWithVersions.SecretName);
     }
 
     public String RandomId()

secretmanager/api/SecretManager.Samples.Tests/UpdateSecretTests.cs

@@ -32,8 +32,16 @@ public UpdateSecretTests(SecretManagerFixture fixture)
     [Fact]
     public void UpdatesSecrets()
     {
-        SecretName secretName = _fixture.Secret.SecretName;
+        // Get the secret name.
+        SecretName secretName = _fixture.CreateSecret(_fixture.RandomId()).SecretName;
+
+        // Run the code sample.
         Secret result = _sample.UpdateSecret(projectId: secretName.ProjectId, secretId: secretName.SecretId);
+
+        // Verify the result.
         Assert.Equal("rocks", result.Labels["secretmanager"]);
+
+        // Cleanup the created resource.
+        _fixture.DeleteSecret(secretName);
     }
 }

secretmanager/api/SecretManager.Samples.Tests/UpdateSecretWithAliasTests.cs

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-using Xunit;
 using Google.Cloud.SecretManager.V1;
+using Xunit;
 
 [Collection(nameof(SecretManagerFixture))]
 public class UpdateSecretWithAliasTests
@@ -32,8 +32,13 @@ public UpdateSecretWithAliasTests(SecretManagerFixture fixture)
     [Fact]
     public void UpdatesSecrets()
     {
-        SecretName secretName = _fixture.SecretWithVersions.SecretName;
+        // Get the SecretName.
+        SecretName secretName = _fixture.Secret.SecretName;
+
+        // Run the code sample.
         Secret result = _sample.UpdateSecret(projectId: secretName.ProjectId, secretId: secretName.SecretId);
+
+        // Assert that the expected behaviour is seen.
         Assert.Equal(1, result.VersionAliases["test"]);
     }
 }