Multiple simulation support and adding stats to simulation definition (#234)

* Support for configuring multiple simulations but running only 1 at a time
* Support for saving Simulation statistics

Author: hathind-ms

Services.Test/SimulationsTest.cs

@@ -138,23 +138,6 @@ public void CreateWithInvalidTemplate()
                 .Wait(Constants.TEST_TIMEOUT);
         }
 
-        [Fact, Trait(Constants.TYPE, Constants.UNIT_TEST)]
-        public void CreatingMultipleSimulationsIsNotAllowed()
-        {
-            // Arrange
-            this.ThereAreSomeDeviceModels();
-            this.ThereIsAnEnabledSimulationInTheStorage();
-            var s = new SimulationModel { Id = Guid.NewGuid().ToString(), Enabled = false };
-
-            // Act + Assert
-            // This fails because only 1 solution can be created
-            Assert.ThrowsAsync<ConflictingResourceException>(async () => await this.target.InsertAsync(s))
-                .Wait(Constants.TEST_TIMEOUT);
-            // This fails because only "1" can be used as a simulation ID
-            Assert.ThrowsAsync<InvalidInputException>(async () => await this.target.UpsertAsync(s))
-                .Wait(Constants.TEST_TIMEOUT);
-        }
-
         [Fact, Trait(Constants.TYPE, Constants.UNIT_TEST)]
         public void CreatedSimulationsAreStored()
         {
@@ -201,10 +184,10 @@ public void SimulationsCanBeUpserted()
         public void UpsertRequiresIdWhileInsertDoesNot()
         {
             // Arrange
-            var s1 = new SimulationModel();
-            var s2 = new SimulationModel();
+            var s1 = new SimulationModel() { Name = "Test Simulation 1"};
+            var s2 = new SimulationModel() { Name = "Test Simulation 2" };
             this.ThereAreNoSimulationsInTheStorage();
-
+            
             // Act - No exception occurs
             this.target.InsertAsync(s1).Wait(Constants.TEST_TIMEOUT);
 
@@ -221,7 +204,7 @@ public void UpsertUsesOptimisticConcurrency()
             const string ETAG2 = "002";
 
             // Initial simulation 
-            var simulation1 = new SimulationModel { Id = SIMULATION_ID, ETag = ETAG1 };
+            var simulation1 = new SimulationModel { Id = SIMULATION_ID, Name = "Test Simulation 1", ETag = ETAG1 };
             var storageRecord1 = new ValueApiModel
             {
                 Key = SIMULATION_ID,
@@ -232,7 +215,7 @@ public void UpsertUsesOptimisticConcurrency()
             storageList1.Items.Add(storageRecord1);
 
             // Simulation after update
-            var simulation2 = new SimulationModel { Id = SIMULATION_ID, ETag = ETAG2 };
+            var simulation2 = new SimulationModel { Id = SIMULATION_ID, Name = "Test Simulation 2", ETag = ETAG2 };
             var storageRecord2 = new ValueApiModel
             {
                 Key = SIMULATION_ID,
@@ -253,9 +236,11 @@ public void UpsertUsesOptimisticConcurrency()
 
             // Arrange - the ETag won't match
             this.storage.Setup(x => x.GetAllAsync(STORAGE_COLLECTION)).ReturnsAsync(storageList2);
+            this.storage.Setup(x => x.GetAsync(STORAGE_COLLECTION, SIMULATION_ID)).ReturnsAsync(storageRecord2);
 
             // Act + Assert
             var simulationOutOfDate = new SimulationModel { Id = SIMULATION_ID, ETag = ETAG1 };
+
             Assert.ThrowsAsync<ResourceOutOfDateException>(
                     async () => await this.target.UpsertAsync(simulationOutOfDate))
                 .Wait(Constants.TEST_TIMEOUT);
@@ -269,15 +254,17 @@ public void ThereAreNoNullPropertiesInTheDeviceModel()
             this.ThereAreNoSimulationsInTheStorage();
 
             // Arrange the simulation data returned by the storage adapter
+            var id = SIMULATION_ID;
             var simulation = new SimulationModel
             {
-                Id = SIMULATION_ID,
+                Id = id,
+                Name = "Test Simulation",
                 ETag = "ETag0",
                 Enabled = true
             };
             var updatedValue = new ValueApiModel
             {
-                Key = SIMULATION_ID,
+                Key = id,
                 Data = JsonConvert.SerializeObject(simulation),
                 ETag = simulation.ETag
             };
@@ -290,26 +277,11 @@ public void ThereAreNoNullPropertiesInTheDeviceModel()
             // Assert
             this.storage.Verify(x => x.UpdateAsync(
                 STORAGE_COLLECTION,
-                SIMULATION_ID,
-                It.Is<string>(s => !s.Contains("null")),
+                id,
+                It.IsAny<string>(),
                 "ETag0"));
         }
 
-        [Fact, Trait(Constants.TYPE, Constants.UNIT_TEST)]
-        public void CreatingMultipleSimulationsViaUpsertIsNotAllowed()
-        {
-            // Arrange
-            this.ThereAreSomeDeviceModels();
-            this.ThereIsAnEnabledSimulationInTheStorage();
-            var s = new SimulationModel { Id = Guid.NewGuid().ToString(), Enabled = false };
-
-            // Act + Assert
-            // Note: the exception is 'InvalidInputException' because only id='1' is allowed. This will
-            // change in future when multiple simulation will be allowed.
-            Assert.ThrowsAsync<InvalidInputException>(async () => await this.target.UpsertAsync(s))
-                .Wait(Constants.TEST_TIMEOUT);
-        }
-
         private void ThereAreSomeDeviceModels()
         {
             this.deviceModels.Setup(x => x.GetListAsync())
@@ -320,7 +292,7 @@ private void ThereAreNoSimulationsInTheStorage()
         {
             this.storage.Setup(x => x.GetAllAsync(STORAGE_COLLECTION)).ReturnsAsync(new ValueListApiModel());
             // In case the test inserts a record, return a valid storage object
-            this.storage.Setup(x => x.UpdateAsync(STORAGE_COLLECTION, SIMULATION_ID, It.IsAny<string>(), "*"))
+            this.storage.Setup(x => x.UpdateAsync(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<string>(), It.IsAny<string>()))
                 .ReturnsAsync(new ValueApiModel { Key = SIMULATION_ID, Data = "{}", ETag = "someETag" });
         }
 

Services/Concurrency/RateLimiting.cs

@@ -97,6 +97,6 @@ public long GetPauseForNextMessage()
         /// <summary>
         /// Get message throughput (messages per second)
         /// </summary>
-        public double GetThroughputForMessages() => this.messaging.GetThroughputForMessages();
+        public double GetThroughputForMessages() => System.Math.Ceiling(this.messaging.GetThroughputForMessages() * 100) / 100;
     }
 }

Services/Devices.cs

@@ -5,7 +5,6 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.Azure.Devices;
-using Microsoft.Azure.Devices.Client;
 using Microsoft.Azure.Devices.Common.Exceptions;
 using Microsoft.Azure.Devices.Shared;
 using Microsoft.Azure.IoTSolutions.DeviceSimulation.Services.Diagnostics;
@@ -54,7 +53,9 @@ public interface IDevices
 
         Task DeleteListAsync(IEnumerable<string> deviceIds);
 
-        // Generate a device Id
+        /// <summary>
+        /// Generate a device Id
+        /// </summary>
         string GenerateId(string deviceModelId, int position);
     }
 
@@ -347,7 +348,9 @@ public async Task DeleteListAsync(IEnumerable<string> deviceIds)
             }
         }
 
-        // Generate a device Id
+        /// <summary>
+        /// Generate a device Id
+        /// </summary>
         public string GenerateId(string deviceModelId, int position)
         {
             return deviceModelId + "." + position;

Services/Models/Simulation.cs

@@ -11,36 +11,46 @@ public class Simulation
     {
         private DateTimeOffset? startTime;
         private DateTimeOffset? endTime;
-        private string iotHubConnectionString;
+        private IList<string> iotHubConnectionStrings;
 
+        // When Simulation is written to storage, Id and Etag are not serialized as part of body
+        // These are instead written in dedicated columns (key and eTag)
         [JsonIgnore]
         public string ETag { get; set; }
 
         [JsonIgnore]
         public string Id { get; set; }
 
+        public string Name { get; set; }
+        public string Description { get; set; }
         public bool Enabled { get; set; }
         public IList<DeviceModelRef> DeviceModels { get; set; }
         public DateTimeOffset Created { get; set; }
         public DateTimeOffset Modified { get; set; }
+        public StatisticsRef Statistics { get; set; }
         public IList<CustomDeviceRef> CustomDevices { get; set; }
 
+        // StartTime is the time when Simulation was started
         public DateTimeOffset? StartTime
         {
             get => this.startTime;
             set => this.startTime = value ?? DateTimeOffset.MinValue;
         }
 
+        // EndTime is the time when Simulation ended after running for scheduled duration
         public DateTimeOffset? EndTime
         {
             get => this.endTime;
             set => this.endTime = value ?? DateTimeOffset.MaxValue;
         }
 
-        public string IotHubConnectionString
+        // StoppedTime is the time when Simulation was explicitly stopped by user
+        public DateTimeOffset? StoppedTime { get; set; }
+
+        public IList<string> IotHubConnectionStrings
         {
-            get => this.iotHubConnectionString;
-            set => this.iotHubConnectionString = value ?? ServicesConfig.USE_DEFAULT_IOTHUB;
+            get => this.iotHubConnectionStrings;
+            set => this.iotHubConnectionStrings = value ?? new List<string> { };
         }
 
         public Simulation()
@@ -52,9 +62,10 @@ public Simulation()
             this.EndTime = DateTimeOffset.MaxValue;
 
             // by default, use environment variable
-            this.IotHubConnectionString = ServicesConfig.USE_DEFAULT_IOTHUB;
+            this.IotHubConnectionStrings = new List<string> { };
             this.DeviceModels = new List<DeviceModelRef>();
             this.CustomDevices = new List<CustomDeviceRef>();
+            this.Statistics = new StatisticsRef();
         }
 
         public class DeviceModelRef
@@ -70,6 +81,12 @@ public class CustomDeviceRef
             public DeviceModelRef DeviceModel { get; set; }
         }
 
+        public class StatisticsRef
+        {
+            public long TotalMessagesSent { get; set; }
+            public double AverageMessagesPerSecond { get; set; }
+        }
+
         public class DeviceModelOverride
         {
             // Optional field, used to customize the scripts which update the device state

Services/Models/SimulationPatch.cs

@@ -7,5 +7,12 @@ public class SimulationPatch
         public string ETag { get; set; }
         public string Id { get; set; }
         public bool? Enabled { get; set; }
+        public SimulationStatistics Statistics { get; set; }
+    }
+
+    public class SimulationStatistics
+    {
+        public long TotalMessagesSent { get; set; }
+        public double AverageMessagesPerSecond { get; set; }
     }
 }