Review Comments Incorporation

Remove Test code
Add help content
Add xml comments
Re-Record

Author: ankushbindlish2

src/StorageSync/StorageSync.Test/Common/MockEcsManagementInteropClient.cs

@@ -0,0 +1,144 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using Commands.StorageSync.Interop.Clients;
+using Commands.StorageSync.Interop.DataObjects;
+using Commands.StorageSync.Interop.Interfaces;
+using Microsoft.Azure.Commands.StorageSync.Common;
+using Microsoft.Azure.Commands.StorageSync.Interfaces;
+using System;
+using System.Text.RegularExpressions;
+
+namespace StorageSync.Test.Common
+{
+    /// <summary>
+    /// Class StorageSyncResourceManager.
+    /// Implements the <see cref="Microsoft.Azure.Commands.StorageSync.Common.IStorageSyncResourceManager" />
+    /// Implements the <see cref="Microsoft.Azure.Commands.StorageSync.Interfaces.IStorageSyncResourceManager" />
+    /// </summary>
+    /// <seealso cref="Microsoft.Azure.Commands.StorageSync.Interfaces.IStorageSyncResourceManager" />
+    /// <seealso cref="Microsoft.Azure.Commands.StorageSync.Common.IStorageSyncResourceManager" />
+    public class MockStorageSyncResourceManager : IStorageSyncResourceManager
+    {
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MockStorageSyncResourceManager"/> class.
+        /// </summary>
+        /// <param name="testName">Name of the test.</param>
+        public MockStorageSyncResourceManager(string testName)
+        {
+            TestName = testName;
+        }
+
+        /// <summary>
+        /// The is playback mode
+        /// </summary>
+        private bool? isPlaybackMode;
+
+        /// <summary>
+        /// Gets a value indicating whether this instance is playback mode.
+        /// </summary>
+        /// <value><c>true</c> if this instance is playback mode; otherwise, <c>false</c>.</value>
+        /// <exception cref="NotSupportedException"></exception>
+        protected bool IsPlaybackMode
+        {
+            get
+            {
+                if (!isPlaybackMode.HasValue)
+                {
+                    if (Microsoft.Azure.Test.HttpRecorder.HttpMockServer.Mode == Microsoft.Azure.Test.HttpRecorder.HttpRecorderMode.Playback)
+                    {
+                        isPlaybackMode =true;
+                    }
+                    else if (Microsoft.Azure.Test.HttpRecorder.HttpMockServer.Mode == Microsoft.Azure.Test.HttpRecorder.HttpRecorderMode.Record)
+                    {
+                        isPlaybackMode = false;
+
+                    } else
+                    {
+                        throw new NotSupportedException($"{Microsoft.Azure.Test.HttpRecorder.HttpMockServer.Mode} Mode is not supported");
+                    }
+                }
+                return isPlaybackMode.Value;
+            }
+        }
+
+        /// <summary>
+        /// Gets the name of the test.
+        /// </summary>
+        /// <value>The name of the test.</value>
+        public string TestName
+        {
+            get;
+        }
+
+        /// <summary>
+        /// Creates the ecs management.
+        /// </summary>
+        /// <returns>IEcsManagement.</returns>
+        public IEcsManagement CreateEcsManagement() => IsPlaybackMode ? new MockEcsManagementInteropClient() as IEcsManagement : new EcsManagementInteropClient();
+
+        /// <summary>
+        /// Gets the unique identifier.
+        /// </summary>
+        /// <param name="testName">Name of the test.</param>
+        /// <returns>Guid.</returns>
+        public Guid GetGuid(string testName) => Microsoft.Azure.Test.HttpRecorder.HttpMockServer.GetAssetGuid(testName);
+
+        /// <summary>
+        /// Gets the afs agent installer path.
+        /// </summary>
+        /// <param name="afsAgentInstallerPath">The afs agent installer path.</param>
+        /// <returns>System.String.</returns>
+        public bool TryGetAfsAgentInstallerPath(out string afsAgentInstallerPath)
+        {
+            afsAgentInstallerPath = @"C:\Program Files\Azure\StorageSyncAgent\";
+            return true;
+        }
+
+        /// <summary>
+        /// Gets the afs agent version.
+        /// </summary>
+        /// <param name="afsAgentVersion">The afs agent version.</param>
+        /// <returns>System.String.</returns>
+        public bool TryGetAfsAgentVersion(out string afsAgentVersion)
+        {
+            afsAgentVersion = @"5.0.2.0";
+            return true;
+        }
+
+        /// <summary>
+        /// Updates the server registration data.
+        /// </summary>
+        /// <param name="pServerRegistrationData">The p server registration data.</param>
+        /// <returns>ServerRegistrationData.</returns>
+        public ServerRegistrationData UpdateServerRegistrationData(ServerRegistrationData pServerRegistrationData)
+        {
+            pServerRegistrationData.Id = Microsoft.Azure.Test.HttpRecorder.HttpMockServer.GetVariable(StorageSyncConstants.SyncServerId, pServerRegistrationData.Id);
+            pServerRegistrationData.ServerId = Guid.Parse(Regex.Match(pServerRegistrationData.Id, @"([^/]+)$").Value);
+            return pServerRegistrationData;
+        }
+
+        /// <summary>
+        /// Waits for access propogation.
+        /// </summary>
+        public void WaitForAccessPropogation()
+        {
+            if (!IsPlaybackMode)
+            {
+                System.Threading.Thread.Sleep(40 * 1000);
+            }
+        }
+    }
+}

src/StorageSync/StorageSync.Test/Common/MockStorageSyncResourceManager.cs

@@ -21,44 +21,69 @@
 
 namespace StorageSyncTests
 {
+    /// <summary>
+    /// Class CloudEndpointTests.
+    /// </summary>
     public class CloudEndpointTests
     {
+        /// <summary>
+        /// The logger
+        /// </summary>
         private readonly XunitTracingInterceptor _logger;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CloudEndpointTests"/> class.
+        /// </summary>
+        /// <param name="output">The output.</param>
         public CloudEndpointTests(ITestOutputHelper output)
         {
             _logger = new XunitTracingInterceptor(output);
             XunitTracingInterceptor.AddToContext(_logger);
         }
 
+        /// <summary>
+        /// Defines the test method TestCloudEndpoint.
+        /// </summary>
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestCloudEndpoint()
         {
             TestController.NewInstance.RunPsTest(_logger, "Test-CloudEndpoint");
         }
 
+        /// <summary>
+        /// Defines the test method TestNewCloudEndpoint.
+        /// </summary>
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestNewCloudEndpoint()
         {
             TestController.NewInstance.RunPsTest(_logger, "Test-NewCloudEndpoint");
         }
 
+        /// <summary>
+        /// Defines the test method TestGetCloudEndpoint.
+        /// </summary>
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestGetCloudEndpoint()
         {
             TestController.NewInstance.RunPsTest(_logger, "Test-GetCloudEndpoint");
         }
 
+        /// <summary>
+        /// Defines the test method TestGetCloudEndpointParentObject.
+        /// </summary>
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestGetCloudEndpointParentObject()
         {
             TestController.NewInstance.RunPsTest(_logger, "Test-GetCloudEndpointParentObject");
         }
 
+        /// <summary>
+        /// Defines the test method TestGetCloudEndpointParentResourceId.
+        /// </summary>
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestGetCloudEndpointParentResourceId()
@@ -67,27 +92,39 @@ public void TestGetCloudEndpointParentResourceId()
         }
 
 
+        /// <summary>
+        /// Defines the test method TestGetCloudEndpoints.
+        /// </summary>
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestGetCloudEndpoints()
         {
             TestController.NewInstance.RunPsTest(_logger, "Test-GetCloudEndpoints");
         }
 
+        /// <summary>
+        /// Defines the test method TestRemoveCloudEndpoint.
+        /// </summary>
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestRemoveCloudEndpoint()
         {
             TestController.NewInstance.RunPsTest(_logger, "Test-RemoveCloudEndpoint");
         }
 
+        /// <summary>
+        /// Defines the test method TestRemoveCloudEndpointResourceId.
+        /// </summary>
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestRemoveCloudEndpointResourceId()
         {
             TestController.NewInstance.RunPsTest(_logger, "Test-RemoveCloudEndpointResourceId");
         }
 
+        /// <summary>
+        /// Defines the test method TestRemoveCloudEndpointInputObject.
+        /// </summary>
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestRemoveCloudEndpointInputObject()