Merge pull request #329 from MabOneSdk/anudeeb-dev1

Fixing 7349803 in Helper, Logger and Models Layers

Author: Samuel Anudeep

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/Conversions/JobConversions.cs

@@ -82,7 +82,7 @@ public static void AddServiceClientJobsToPSList(JobListResponse serviceClientJob
         #region AzureVm job private helpers
 
         /// <summary>
-        /// Helper function to convert ps auzre vm backup policy job from service response.
+        /// Helper function to convert ps azure vm backup policy job from service response.
         /// </summary>
         private static CmdletModel.AzureVmJob GetPSAzureVmJob(JobResource serviceClientJob)
         {
@@ -154,7 +154,7 @@ private static CmdletModel.AzureVmJob GetPSAzureVmJob(JobResource serviceClientJ
         }
 
         /// <summary>
-        /// Helper function to convert ps auzre vm backup job error info from service response.
+        /// Helper function to convert ps azure vm backup job error info from service response.
         /// </summary>
         private static CmdletModel.AzureVmJobErrorInfo GetPSAzureVmErrorInfo(AzureIaaSVMErrorInfo serviceClientError)
         {
@@ -187,7 +187,7 @@ public static string GetLastIdFromFullId(string fullId)
 
 
         /// <summary>
-        /// Helper function to get job type from ps backupmanagement type.
+        /// Helper function to get job type from ps backup management type.
         /// </summary>
         public static string GetJobTypeForService(CmdletModel.BackupManagementType mgmtType)
         {

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/Conversions/SchedulePolicyConversions.cs

@@ -84,7 +84,7 @@ public static List<DateTime> ParseDateTimesToUTC(IList<DateTime> localTimes)
         }
 
         // <summary>
-        /// Helper function to convert service simple schedule policy from ps scheduel policy.
+        /// Helper function to convert service simple schedule policy from ps schedule policy.
         /// </summary>
         public static ServiceClientModel.SimpleSchedulePolicy GetServiceClientSimpleSchedulePolicy(
             SimpleSchedulePolicy psPolicy)

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/HelperUtils.cs

@@ -23,8 +23,18 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
 {
+    /// <summary>
+    /// Utilities used by the helpers.
+    /// </summary>
     public class HelperUtils
     {
+        /// <summary>
+        /// Gets list of enums of type T given the corresponding list of string equivalents. 
+        /// This method parses each of the strings and converts them into enums.
+        /// </summary>
+        /// <typeparam name="T">Type of the enum into which each string in the input list is to be type casted</typeparam>
+        /// <param name="strList">List of strings</param>
+        /// <returns></returns>
         public static List<T> GetEnumListFromStringList<T>(IList<string> strList)
         {
             if (strList == null || strList.Count == 0)
@@ -41,6 +51,12 @@ public static List<T> GetEnumListFromStringList<T>(IList<string> strList)
             return ret;
         }
 
+        /// <summary>
+        /// Gets list of string equivalents given the corresponding list of enums of type T. 
+        /// </summary>
+        /// <typeparam name="T">Type of the enum whose list should be converted to list of strings</typeparam>
+        /// <param name="enumList">List of enums</param>
+        /// <returns></returns>
         public static List<string> GetStringListFromEnumList<T>(IList<T> enumList)
         {
             if (enumList == null || enumList.Count == 0)
@@ -97,6 +113,12 @@ public static List<string> GetStringListFromEnumList<T>(IList<T> enumList)
             return keyValuePairDict;
         }
 
+        /// <summary>
+        /// Gets container URI from the provided dictionary of key value pairs.
+        /// </summary>
+        /// <param name="keyValuePairDict">Dictionary of UriEnum as key and value as value of corresponding URI enum</param>
+        /// <param name="id">ID of the resource</param>
+        /// <returns></returns>
         public static string GetContainerUri(
             Dictionary<CmdletModel.UriEnums, string> keyValuePairDict, 
             string id
@@ -116,6 +138,12 @@ string id
             return containerUri;
         }
 
+        /// <summary>
+        /// Gets protected item URI from the provided dictionary of key value pairs.
+        /// </summary>
+        /// <param name="keyValuePairDict">Dictionary of UriEnum as key and value as value of corresponding URI enum</param>
+        /// <param name="id">ID of the resource</param>
+        /// <returns></returns>
         public static string GetProtectedItemUri(
             Dictionary<CmdletModel.UriEnums, string> keyValuePairDict, 
             string id
@@ -135,6 +163,12 @@ string id
             return itemUri;
         }
 
+        /// <summary>
+        /// Gets protectable item URI from the provided dictionary of key value pairs.
+        /// </summary>
+        /// <param name="keyValuePairDict">Dictionary of UriEnum as key and value as value of corresponding URI enum</param>
+        /// <param name="id">ID of the resource</param>
+        /// <returns></returns>
         public static string GetProtectableItemUri(
             Dictionary<CmdletModel.UriEnums, string> keyValuePairDict, 
             string id
@@ -154,6 +188,12 @@ string id
             return protectableItemUri;
         }
 
+        /// <summary>
+        /// Gets polcy name from the provided dictionary of key value pairs.
+        /// </summary>
+        /// <param name="keyValuePairDict">Dictionary of UriEnum as key and value as value of corresponding URI enum</param>
+        /// <param name="id">ID of the resource</param>
+        /// <returns></returns>
         public static string GetPolicyNameFromPolicyId(
             Dictionary<CmdletModel.UriEnums, string> keyValuePairDict, 
             string id

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/ServiceClientHelpers.cs

@@ -20,13 +20,25 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
 {
+    /// <summary>
+    /// Constants used by the service client helpers.
+    /// </summary>
     public class ServiceClientConstants
     {
         public const string SkipToken = "skipToken";
     }
 
+    /// <summary>
+    /// Helper methods used by the service client adapter.
+    /// </summary>
     public class ServiceClientHelpers
     {
+        /// <summary>
+        /// Gets the provider type with which the service client calls are to made to contact the backend service. 
+        /// This can be determined by the container type in case of certain containers such as those of the type AzureVM.
+        /// </summary>
+        /// <param name="containerType">Type of the container</param>
+        /// <returns></returns>
         public static string GetServiceClientProviderType(CmdletModel.ContainerType containerType)
         {
             string providerType = string.Empty;
@@ -43,6 +55,12 @@ public static string GetServiceClientProviderType(CmdletModel.ContainerType cont
             return providerType;
         }
 
+        /// <summary>
+        /// Gets the provider type with which the service client calls are to made to contact the backend service. 
+        /// This is determined by the workload type in case of certain containers such as those of the type AzureVM.
+        /// </summary>
+        /// <param name="workloadType"></param>
+        /// <returns></returns>
         public static string GetServiceClientProviderType(CmdletModel.WorkloadType workloadType)
         {
             string providerType = string.Empty;
@@ -59,6 +77,13 @@ public static string GetServiceClientProviderType(CmdletModel.WorkloadType workl
             return providerType;
         }
 
+        /// <summary>
+        /// Gets the skip token from the next link. Usually, next link is the location uri returned as a header
+        /// when an ARM call is made. When this skip token (if non-null) is used in the next call to the backend service,
+        /// the next set of objects are returned.
+        /// </summary>
+        /// <param name="nextLink">The next link a.k.a location url</param>
+        /// <param name="skipToken">The skip token extracted from the next link</param>
         public static void GetSkipTokenFromNextLink(string nextLink, out string skipToken)
         {
             if (nextLink != null)
@@ -98,6 +123,11 @@ public static string GetLastIdFromFullId(string fullId)
             return splitArr[splitArr.Length - 1];
         }
 
+        /// <summary>
+        /// Gets the service client specific container type given the PS container type
+        /// </summary>
+        /// <param name="containerType">PS container type</param>
+        /// <returns></returns>
         public static string GetServiceClientContainerType(CmdletModel.ContainerType containerType)
         {
             string serviceClientContainerType = string.Empty;
@@ -114,6 +144,11 @@ public static string GetServiceClientContainerType(CmdletModel.ContainerType con
             return serviceClientContainerType;
         }
 
+        /// <summary>
+        /// Gets the service client specific workload type given the PS workload type
+        /// </summary>
+        /// <param name="workloadType"></param>
+        /// <returns></returns>
         public static string GetServiceClientWorkloadType(CmdletModel.WorkloadType workloadType)
         {
             string serviceClientWorkloadType = string.Empty;

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Helpers/Validations/PolicyValidations.cs

@@ -22,6 +22,9 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Helpers
 {
+    /// <summary>
+    /// Backup policy validation helpers.
+    /// </summary>
     public partial class PolicyHelpers
     {
         // <summary>

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Logger/Logger.cs

@@ -21,6 +21,10 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup
 {
+    /// <summary>
+    /// Utility for logging. Uses PS logging underneath. 
+    /// Plan to add more functionality in the upcoming releases.
+    /// </summary>
     public class Logger
     {
         private Action<string> writeWarningAction;
@@ -33,6 +37,13 @@ public class Logger
 
         public static Logger Instance { get; set; }
 
+        /// <summary>
+        /// Constructor. Takes the delegates for the various logging operations as input.
+        /// </summary>
+        /// <param name="writeWarning">Delegate to write warnings</param>
+        /// <param name="writeDebug">Delegate to write debug messages</param>
+        /// <param name="writeVerbose">Delegate to write verbose messages</param>
+        /// <param name="throwTerminatingError">Delegate to throw terminating errors</param>
         public Logger(Action<string> writeWarning,
                       Action<string> writeDebug,
                       Action<string> writeVerbose,
@@ -44,21 +55,37 @@ public Logger(Action<string> writeWarning,
             throwTerminatingErrorAction = throwTerminatingError;
         }
 
+        /// <summary>
+        /// Writes verbose message.
+        /// </summary>
+        /// <param name="text"></param>
         public void WriteVerbose(string text)
         {
             writeVerboseAction(text);
         }
 
+        /// <summary>
+        /// Writes debug message.
+        /// </summary>
+        /// <param name="text"></param>
         public void WriteDebug(string text)
         {
             writeDebugAction(text);
         }
 
+        /// <summary>
+        /// Writes warning message.
+        /// </summary>
+        /// <param name="text"></param>
         public void WriteWarning(string text)
         {
             writeWarningAction(text);
         }
 
+        /// <summary>
+        /// Throws a terminating error.
+        /// </summary>
+        /// <param name="errorRecord"></param>
         public void ThrowTerminatingError(ErrorRecord errorRecord)
         {
             throwTerminatingErrorAction(errorRecord);

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmContainer.cs

@@ -41,6 +41,11 @@ public class AzureVmContainer : ContainerBase
         /// </summary>
         public ContainerRegistrationStatus Status { get; set; }
 
+        /// <summary>
+        /// Constructor. Takes the service client object representing the container 
+        /// and converts it in to the PS container model
+        /// </summary>
+        /// <param name="protectionContainer">Service client object representing the container</param>
         public AzureVmContainer(ProtectionContainerResource protectionContainer)
             : base(protectionContainer)
         {

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmItem.cs

@@ -53,6 +53,14 @@ public class AzureVmItem : ItemBase
         /// </summary
         public AzureVmItemExtendedInfo ExtendedInfo { get; set; }
 
+        /// <summary>
+        /// Constructor. Takes the service client object representing the protected item 
+        /// and converts it in to the PS protected item model
+        /// </summary>
+        /// <param name="protectedItemResource">Service client object representing the protected item resource</param>
+        /// <param name="containerName">Name of the container associated with this protected item</param>
+        /// <param name="containerType">Type of the container associated with this protected item</param>
+        /// <param name="policyName">Name of the protection policy associated with this protected item</param>
         public AzureVmItem(ProtectedItemResource protectedItemResource,
             string containerName, ContainerType containerType, string policyName)
             : base(protectedItemResource, containerName, containerType)

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmJob.cs

@@ -21,12 +21,24 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
     /// </summary>
     public class AzureVmJob : JobBase
     {
+        /// <summary>
+        /// Represents whether this job is cancellable.
+        /// </summary>
         public bool IsCancellable { get; set; }
 
+        /// <summary>
+        /// Represents whether this job is retriable.
+        /// </summary>
         public bool IsRetriable { get; set; }
 
+        /// <summary>
+        /// The VM version of the Azure VM associated with this job.
+        /// </summary>
         public string VmVersion { get; set; }
 
+        /// <summary>
+        /// Error details associated with this job.
+        /// </summary>
         public List<AzureVmJobErrorInfo> ErrorDetails { get; set; }
     }
 
@@ -41,8 +53,14 @@ public class AzureVmJobDetails : AzureVmJob
         /// </summary>
         public string DynamicErrorMessage { get; set; }
 
+        /// <summary>
+        /// Property bag consisting of the some Azure VM specific job details.
+        /// </summary>
         public Dictionary<string, string> Properties { get; set; }
 
+        /// <summary>
+        /// List of sub tasks triggered as part of this job's operation.
+        /// </summary>
         public List<AzureVmJobSubTask> SubTasks { get; set; }
     }
 
@@ -51,6 +69,9 @@ public class AzureVmJobDetails : AzureVmJob
     /// </summary>
     public class AzureVmJobErrorInfo : JobErrorInfoBase
     {
+        /// <summary>
+        /// Error code of this job's error.
+        /// </summary>
         public int ErrorCode { get; set; }
     }
 

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmPolicy.cs

@@ -25,8 +25,14 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
     /// </summary>
     public class AzureVmPolicy : PolicyBase
     {
+        /// <summary>
+        /// Object defining the schedule associated with this policy.
+        /// </summary>
         public SchedulePolicyBase SchedulePolicy { get; set; }
 
+        /// <summary>
+        /// Object defining the retention behavior of this policy.
+        /// </summary>
         public RetentionPolicyBase RetentionPolicy { get; set; }
 
         public override void Validate()

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup.Models/AzureVmModels/AzureVmRecoveryPoint.cs

@@ -25,8 +25,14 @@ namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models
     /// </summary>
     public class AzureVmRecoveryPoint : RecoveryPointBase
     {
+        /// <summary>
+        /// Additional info associated with this recovery point serialized into a string.
+        /// </summary>
         public string RecoveryPointAdditionalInfo { get; set; }
 
+        /// <summary>
+        /// Storage type of the VM whose backup operation has created this recovery point.
+        /// </summary>
         public string SourceVMStorageType { get; set; }
 
         public AzureVmRecoveryPoint()