Merge pull request #188 from AuxMon/dev

BUG: 3410517 [Event Service][PowerShell] cmdlets (e.g. Get-AzureSubscrip...

Author: ogail

src/ResourceManager/Insights/Commands.Insights.Test/Commands.Insights.Test.csproj

@@ -58,7 +58,7 @@
       <HintPath>..\..\..\packages\Microsoft.Azure.Common.2.0.2\lib\net45\Microsoft.Azure.Common.NetFramework.dll</HintPath>
     </Reference>
     <Reference Include="Microsoft.Azure.Insights">
-      <HintPath>..\..\..\packages\Microsoft.Azure.Insights.0.7.0-preview\lib\net45\Microsoft.Azure.Insights.dll</HintPath>
+      <HintPath>..\..\..\packages\Microsoft.Azure.Insights.0.7.1-preview\lib\net45\Microsoft.Azure.Insights.dll</HintPath>
     </Reference>
     <Reference Include="Microsoft.Azure.Test.Framework, Version=1.0.5513.27084, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>

src/ResourceManager/Insights/Commands.Insights.Test/Events/Utilities.cs

@@ -214,15 +214,15 @@ public static void ExecuteVerifications(EventCmdletBase cmdlet, Mock<IEventOpera
             Assert.True(string.Equals(PSEventDataNoDetails.SelectedFieldsForQuery, selected, StringComparison.OrdinalIgnoreCase), "Incorrect selected clause without optional parameters");
 
             // Calling with only start date
-            cmdlet.StartTime = startDate.ToString("O");
+            cmdlet.StartTime = startDate;
             cmdlet.ExecuteCmdlet();
 
             VerifyFilterIsUsable(filter: filter);
             VerifyStartDateInFilter(filter: filter, startDate: startDate);
             VerifyConditionInFilter(filter: filter, field: requiredFieldName, value: requiredFieldValue);
 
             // Calling with only start and end date
-            cmdlet.EndTime = startDate.AddSeconds(2).ToString("O");
+            cmdlet.EndTime = startDate.AddSeconds(2);
             cmdlet.ExecuteCmdlet();
 
             VerifyFilterIsUsable(filter: filter);
@@ -245,6 +245,18 @@ public static void ExecuteVerifications(EventCmdletBase cmdlet, Mock<IEventOpera
 
             VerifyDetailedOutput(cmdlet: cmdlet, selected: ref selected);
             VerifyContinuationToken(response: response, insinsightsEventOperationsMockightsClientMock: insinsightsEventOperationsMockightsClientMock, cmdlet: cmdlet);
+
+            // Execute negative tests
+            cmdlet.StartTime = DateTime.Now.AddSeconds(1);
+            Assert.Throws<ArgumentException>(() => cmdlet.ExecuteCmdlet());
+
+            cmdlet.StartTime = DateTime.Now.Subtract(TimeSpan.FromSeconds(20));
+            cmdlet.EndTime = DateTime.Now.Subtract(TimeSpan.FromSeconds(21));
+            Assert.Throws<ArgumentException>(() => cmdlet.ExecuteCmdlet());
+
+            cmdlet.StartTime = DateTime.Now.Subtract(TimeSpan.FromDays(30));
+            cmdlet.EndTime = DateTime.Now.Subtract(TimeSpan.FromDays(14));
+            Assert.Throws<ArgumentException>(() => cmdlet.ExecuteCmdlet());
         }
     }
 }

src/ResourceManager/Insights/Commands.Insights/Commands.Insights.csproj

@@ -58,7 +58,7 @@
       <HintPath>..\..\..\packages\Microsoft.Azure.Common.2.0.2\lib\net45\Microsoft.Azure.Common.NetFramework.dll</HintPath>
     </Reference>
     <Reference Include="Microsoft.Azure.Insights">
-      <HintPath>..\..\..\packages\Microsoft.Azure.Insights.0.7.0-preview\lib\net45\Microsoft.Azure.Insights.dll</HintPath>
+      <HintPath>..\..\..\packages\Microsoft.Azure.Insights.0.7.1-preview\lib\net45\Microsoft.Azure.Insights.dll</HintPath>
     </Reference>
     <Reference Include="Microsoft.IdentityModel.Clients.ActiveDirectory, Version=2.12.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>

src/ResourceManager/Insights/Commands.Insights/EventCmdletBase.cs

@@ -14,6 +14,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using System.Management.Automation;
 using System.Threading;
@@ -27,9 +28,9 @@ namespace Microsoft.Azure.Commands.Insights
     /// </summary>
     public abstract class EventCmdletBase : InsightsCmdletBase
     {
-        internal static readonly TimeSpan DefaultQueryTimeRange = TimeSpan.FromHours(-1);
-
-        internal static int MaxNumberOfReturnedRecords = 100000;
+        private static readonly TimeSpan MaximumDateDifferenceAllowedInDays = TimeSpan.FromDays(15);
+        private static readonly TimeSpan DefaultQueryTimeRange = TimeSpan.FromHours(1);
+        private const int MaxNumberOfReturnedRecords = 100000;
 
         internal const string SubscriptionLevelName = "Query at subscription level";
         internal const string ResourceProviderName = "Query on ResourceProvider";
@@ -43,15 +44,13 @@ public abstract class EventCmdletBase : InsightsCmdletBase
         /// Gets or sets the starttime parameter of the cmdlet
         /// </summary>
         [Parameter(ValueFromPipelineByPropertyName = true, HelpMessage = "The startTime of the query")]
-        [ValidateNotNullOrEmpty]
-        public string StartTime { get; set; }
+        public DateTime? StartTime { get; set; }
 
         /// <summary>
         /// Gets or sets the endtime parameter of the cmdlet
         /// </summary>
         [Parameter(ValueFromPipelineByPropertyName = true, HelpMessage = "The endTime of the query")]
-        [ValidateNotNullOrEmpty]
-        public string EndTime { get; set; }
+        public DateTime? EndTime { get; set; }
 
         /// <summary>
         /// Gets or sets the status parameter of the cmdlet
@@ -90,39 +89,55 @@ protected string AddConditionIfPResent(string currentQueryFilter, string name, s
         }
 
         /// <summary>
-        /// Process the parameters defined by this class
+        /// Gets the default query time range
         /// </summary>
-        /// <returns>The query filter with the conditions for general parameters (i.e. defined by this class) added</returns>
-        private string ProcessGeneralParameters()
+        /// <returns>The default query time range for this class</returns>
+        protected virtual TimeSpan GetDefaultQueryTimeRange()
+        {
+            return DefaultQueryTimeRange;
+        }
+
+        /// <summary>
+        /// Validates that the range of dates (start / end) makes sense, it is not to great (less 15 days), and adds the defaul values if needed
+        /// </summary>
+        /// <returns>A query filter string with the time conditions</returns>
+        private string ValidateDateTimeRangeAndAdddefaults()
         {
-            DateTime startTime;
-            if (string.IsNullOrWhiteSpace(this.StartTime))
+            // EndTime is optional
+            DateTime endTime = this.EndTime.HasValue ? this.EndTime.Value : DateTime.Now;
+
+            // StartTime is optional
+            DateTime startTime = this.StartTime.HasValue ? this.StartTime.Value : endTime.Subtract(this.GetDefaultQueryTimeRange());
+
+            // Check the value of StartTime
+            if (startTime > DateTime.Now)
             {
-                // Default to one hour from Now
-                startTime = DateTime.Now.Subtract(DefaultQueryTimeRange);
+                throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, "StartDate {0:o} is invalid. It is later than Now: {1:o}", startTime, DateTime.Now));
             }
-            else if (!DateTime.TryParse(this.StartTime, out startTime))
+
+            // Check that the dateTime range makes sense
+            if (endTime < startTime)
             {
-                throw new ArgumentException("Unable to parse startTime argument");
+                throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, "EndDate {0:o} is earlier than StartDate {1:o}", endTime, startTime));
             }
 
-            string queryFilter;
-
-            // EndTime is optional
-            if (string.IsNullOrWhiteSpace(this.EndTime))
+            // Validate start and end dates difference is reasonable (<= MaximumDateDifferenceAllowedInDays)
+            var dateDifference = endTime.Subtract(startTime);
+            if (dateDifference > MaximumDateDifferenceAllowedInDays)
             {
-                queryFilter = string.Format("eventTimestamp ge '{0:o}'", startTime.ToUniversalTime());
+                throw new ArgumentException(string.Format(CultureInfo.InvariantCulture, "Start and end dates are too far appart. Separation {0} days. Maximum allowed {1} days", dateDifference.TotalDays, MaximumDateDifferenceAllowedInDays.TotalDays));
             }
-            else
-            {
-                DateTime endTime;
-                if (!DateTime.TryParse(this.EndTime, out endTime))
-                {
-                    throw new ArgumentException("Unable to parse endTime argument");
-                }
 
-                queryFilter = string.Format("eventTimestamp ge '{0:o}' and eventTimestamp le '{1:o}'", startTime.ToUniversalTime(), endTime.ToUniversalTime());
-            }
+            return string.Format("eventTimestamp ge '{0:o}' and eventTimestamp le '{1:o}'", startTime.ToUniversalTime(), endTime.ToUniversalTime());
+        }
+
+        /// <summary>
+        /// Process the parameters defined by this class
+        /// </summary>
+        /// <returns>The query filter with the conditions for general parameters (i.e. defined by this class) added</returns>
+        private string ProcessGeneralParameters()
+        {
+            string queryFilter = this.ValidateDateTimeRangeAndAdddefaults();
 
             // Include the status if present
             queryFilter = this.AddConditionIfPResent(queryFilter, "status", this.Status);