Customer bug fixes and enhancements to Activity History and deploymen…

…t settings (#562) * Remove aadUpdateMode from QA settings to prevent overwrite, #556 * Added Message attribute to model, #560 * Update Activity document on status change, #559 Added Message attribute for failure message to Activity document, #560 * missing status set * added source to contextcreate * added serialization settings for http/json results * fixed syntax * Update local build to 1.0, #561
retaildevcrews · Mar 18, 2021 · b572702 · b572702
1 parent d02d039
commit b572702
Show file tree

Hide file tree

Showing 12 changed files with 69 additions and 46 deletions.
diff --git a/.github/workflows/appConfigSettingsQA.json b/.github/workflows/appConfigSettingsQA.json
@@ -6,6 +6,5 @@
     "SPDeltaDiscoverySchedule": "0 */30 * * * *",
     "SPDiscoverQueue": "discoverqa",
     "SPEvaluateQueue": "evaluateqa",
-    "SPUpdateQueue": "updateqa",
-    "aadUpdateMode": "ReportOnly"
+    "SPUpdateQueue": "updateqa"
 }
diff --git a/src/Automation/CSE.Automation.Tests/IntegrationTests/GraphDeltaProcessorFunctionsTests.cs b/src/Automation/CSE.Automation.Tests/IntegrationTests/GraphDeltaProcessorFunctionsTests.cs
@@ -281,7 +281,7 @@ public void FunctionEvaluateTestCase1()
 
             TestCase thisTestCase = testCaseCollection.TC1;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new EvaluateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 
@@ -323,7 +323,7 @@ public void FunctionEvaluateTestCase2()
 
             TestCase thisTestCase = testCaseCollection.TC2;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new EvaluateInputGenerator(_config, _graphHelperSettings,testCaseCollection, thisTestCase);
 
@@ -364,7 +364,7 @@ public void FunctionEvaluateTestCase2_2()
 
             TestCase thisTestCase = testCaseCollection.TC2_2;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new EvaluateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 
@@ -405,7 +405,7 @@ public void FunctionEvaluateTestCase3()
 
             TestCase thisTestCase = testCaseCollection.TC3;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new EvaluateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 
@@ -439,7 +439,7 @@ public void FunctionEvaluateTestCase3_2()
 
             TestCase thisTestCase = testCaseCollection.TC3_2;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new EvaluateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 
@@ -480,7 +480,7 @@ public void FunctionEvaluateTestCase4()
 
             TestCase thisTestCase = testCaseCollection.TC4;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new EvaluateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 
@@ -522,7 +522,7 @@ public void FunctionEvaluateTestCase5()
 
             TestCase thisTestCase = testCaseCollection.TC5;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new EvaluateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 
@@ -564,7 +564,7 @@ public void FunctionEvaluateTestCase6()
 
             TestCase thisTestCase = testCaseCollection.TC6;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - EVALUATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new EvaluateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 
@@ -599,7 +599,7 @@ public void FunctionDiscoverTestCase1()
 
             TestCase thisTestCase = testCaseCollection.TC1;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - DISCOVER Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - DISCOVER Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             GraphDeltaProcessorWrapper graphDeltaProcessorWrapper  = _graphDeltaProcessorWrapperFactory.GetNewGraphDeltaProcessorWrapper();
 
@@ -648,7 +648,7 @@ public void FunctionDiscoverTestCase1_2()
 
             TestCase thisTestCase = testCaseCollection.TC1_2;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - DISCOVER Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - DISCOVER Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             GraphDeltaProcessorWrapper graphDeltaProcessorWrapper  = _graphDeltaProcessorWrapperFactory.GetNewGraphDeltaProcessorWrapper();
 
@@ -701,7 +701,7 @@ public void FunctionDiscoverTestCase2()
 
             TestCase thisTestCase = testCaseCollection.TC2;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - DISCOVER Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - DISCOVER Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             GraphDeltaProcessorWrapper graphDeltaProcessorWrapper  = _graphDeltaProcessorWrapperFactory.GetNewGraphDeltaProcessorWrapper();
 
@@ -759,7 +759,7 @@ public void FunctionDiscoverTestCase3()
                 using var inputGenerator = new DiscoverInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase, graphDeltaProcessorWrapper.ConfigId, graphDeltaProcessorHelper);
 
 
-                using var activityContext = _activityService.CreateContext($"Integration Test - DISCOVER Test Case [{thisTestCase}] ", withTracking: true);
+                using var activityContext = _activityService.CreateContext($"Integration Test - DISCOVER Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
                 CloudQueueMessage  cloudQueueMessage = new CloudQueueMessage(inputGenerator.GetTestMessageContent(DiscoveryMode.Deltas, "HTTP", activityContext));
 
@@ -801,7 +801,7 @@ public void FunctionUpdateTestCase1()
 
             TestCase thisTestCase = testCaseCollection.TC1;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - UPDATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - UPDATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new UpdateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 
@@ -841,7 +841,7 @@ public void FunctionUpdateTestCase2()
 
             TestCase thisTestCase = testCaseCollection.TC2;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - UPDATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - UPDATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new UpdateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 
@@ -877,7 +877,7 @@ public void FunctionUpdateTestCase3()
 
             TestCase thisTestCase = testCaseCollection.TC3;
 
-            using var activityContext = _activityService.CreateContext($"Integration Test - UPDATE Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = _activityService.CreateContext($"Integration Test - UPDATE Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             using var inputGenerator = new UpdateInputGenerator(_config, _graphHelperSettings, testCaseCollection, thisTestCase);
 

diff --git a/...Tests/TestCaseValidators/ServicePrincipalStates/Discover/DiscoverSpStateDefinitionBase.cs b/...Tests/TestCaseValidators/ServicePrincipalStates/Discover/DiscoverSpStateDefinitionBase.cs
@@ -62,7 +62,7 @@ protected bool RunFullSeedDiscovery()
 
             TestCase thisTestCase = testCaseCollection.TC1;
 
-            using var activityContext = GraphDeltaProcessorHelper.ActivityServiceInstance.CreateContext($"Nested execution Integration Test - Test Case [{thisTestCase}] ", withTracking: true);
+            using var activityContext = GraphDeltaProcessorHelper.ActivityServiceInstance.CreateContext($"Nested execution Integration Test - Test Case [{thisTestCase}] ", "TEST", withTracking: true);
 
             GraphDeltaProcessorHelper.DeleteDynamicCreatedServicePrincipals = false;
             string mainTestCaseConfigId  = GraphDeltaProcessorHelper.MainTestCaseConfigId;

diff --git a/src/Automation/CSE.Automation.Tests/Mocks/DefaultActivityService.cs b/src/Automation/CSE.Automation.Tests/Mocks/DefaultActivityService.cs
@@ -34,7 +34,7 @@ public Task<IEnumerable<ActivityHistory>> GetCorrelated(string correlationId)
             throw new NotImplementedException();
         }
 
-        public ActivityContext CreateContext(string name, string correlationId = null, bool withTracking = false)
+        public ActivityContext CreateContext(string name, string source, string correlationId = null, bool withTracking = false)
         {
             var now = DateTimeOffset.Now;
 
@@ -46,6 +46,7 @@ public ActivityContext CreateContext(string name, string correlationId = null, b
                 Created = now,
                 Name = name,
                 Status = ActivityHistoryStatus.Running,
+                CommandSource = source,
             };
 
             // we need the id of the run when we initiate

diff --git a/src/Automation/CSE.Automation.Tests/UnitTests/Processors/ServicePrincipalProcessorTests.cs b/src/Automation/CSE.Automation.Tests/UnitTests/Processors/ServicePrincipalProcessorTests.cs
@@ -199,7 +199,7 @@ private async Task Evaluate(ServicePrincipalEvaluateTestData testData, AuditActi
 
             var activityService = fixture.Host.Services.GetService<IActivityService>() as DefaultActivityService;
             Assert.NotNull(activityService);
-            var context = activityService.CreateContext("Test Case");
+            var context = activityService.CreateContext("Test Case", "Evaluate TEST");
 
             await processor.Evaluate(context, testData.Target).ConfigureAwait(false);
 
@@ -338,7 +338,7 @@ private async Task Discover(ServicePrincipalDiscoverTestData testData)
 
             var activityService = fixture.Host.Services.GetService<IActivityService>() as DefaultActivityService;
             Assert.NotNull(activityService);
-            var context = activityService.CreateContext("Test Case").WithCorrelationId(testData.Target.CorrelationId);
+            var context = activityService.CreateContext("Test Case", "Discover TEST").WithCorrelationId(testData.Target.CorrelationId);
 
             await processor.DiscoverDeltas(context, testData.Target.DiscoveryMode == DiscoveryMode.FullSeed);
 

diff --git a/src/Automation/CSE.Automation/CSE.Automation.csproj b/src/Automation/CSE.Automation/CSE.Automation.csproj
@@ -9,6 +9,7 @@
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <BuildUTC>$([System.DateTime]::UtcNow.ToString("o"))</BuildUTC>
     <NeutralLanguage>en-US</NeutralLanguage>
+    <Version>1.0-local</Version>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/Automation/CSE.Automation/GraphDeltaProcessor.cs b/src/Automation/CSE.Automation/GraphDeltaProcessor.cs
@@ -26,13 +26,19 @@ internal class GraphDeltaProcessor
         private readonly IActivityService activityService;
         private readonly IServicePrincipalProcessor processor;
         private readonly ILogger logger;
+        private readonly JsonSerializerSettings httpJsonSerializerSettings;
 
         public GraphDeltaProcessor(VersionMetadata versionMetadata, IServiceProvider serviceProvider, IActivityService activityService, IServicePrincipalProcessor processor, ILogger<GraphDeltaProcessor> logger)
         {
             this.versionMetadata = versionMetadata;
             this.activityService = activityService;
             this.processor = processor;
             this.logger = logger;
+            this.httpJsonSerializerSettings = new JsonSerializerSettings()
+            {
+                Formatting = Formatting.None,
+                NullValueHandling = NullValueHandling.Ignore,
+            };
 
             ValidateServices(serviceProvider);
         }
@@ -78,7 +84,7 @@ public async Task<IActionResult> RequestDiscovery([HttpTrigger(AuthorizationLeve
 
                 return hasRedirect
                         ? new RedirectResult($"{uriBuilder.Uri}")
-                        : (IActionResult)new JsonResult(result);
+                        : (IActionResult)new JsonResult(result, httpJsonSerializerSettings);
             }
             catch (Exception ex)
             {
@@ -135,24 +141,21 @@ public async Task Discover([QueueTrigger(Constants.DiscoverQueueAppSetting)] Clo
             }
 
             var operation = command.DiscoveryMode.Description();
-            using var context = activityService.CreateContext(operation, correlationId: command.CorrelationId, withTracking: true);
+            using var context = activityService.CreateContext(operation, command.Source, correlationId: command.CorrelationId, withTracking: true);
 
             try
             {
                 log.LogDebug($"Executing Discover QueueTrigger Function - [{context.CorrelationId}/{context.Activity.Id}]");
 
-                context.Activity.CommandSource = command.Source;
                 context.WithProcessorLock(processor);
             }
             catch (Exception ex)
             {
-                if (context != null)
-                {
-                    context.Activity.Status = ActivityHistoryStatus.Failed;
-                }
-
                 ex.Data["activityContext"] = context;
                 log.LogError(ex, Resources.LockConflictMessage);
+
+                context?.AsStatus(ActivityHistoryStatus.Failed, Resources.LockConflictMessage);
+
                 return; // this will delete the message, we don't want to retry
             }
 
@@ -164,10 +167,10 @@ await processor
             }
             catch (Exception ex)
             {
-                context.Activity.Status = ActivityHistoryStatus.Failed;
-
                 ex.Data["activityContext"] = context;
                 log.LogError(ex, Resources.ServicePrincipalDiscoverException);
+
+                context?.AsStatus(ActivityHistoryStatus.Failed, Resources.ServicePrincipalDiscoverException);
             }
         }
 
@@ -199,8 +202,7 @@ public async Task Evaluate([QueueTrigger(Constants.EvaluateQueueAppSetting)] Clo
             ActivityContext context = null;
             try
             {
-                context = activityService.CreateContext("Evaluate Service Principal", command.CorrelationId);
-                context.Activity.CommandSource = "QUEUE";
+                context = activityService.CreateContext("Evaluate Service Principal", "QUEUE", command.CorrelationId);
 
                 await processor.Evaluate(context, command.Model).ConfigureAwait(false);
 
@@ -253,8 +255,7 @@ public async Task UpdateAAD([QueueTrigger(Constants.UpdateQueueAppSetting)]Cloud
             ActivityContext context = null;
             try
             {
-                context = activityService.CreateContext("Update Service Principal", command.CorrelationId);
-                context.Activity.CommandSource = "QUEUE";
+                context = activityService.CreateContext("Update Service Principal", "QUEUE", command.CorrelationId);
 
                 var message = JsonConvert.DeserializeObject<QueueMessage<ServicePrincipalUpdateCommand>>(msg.AsString);
 
@@ -293,7 +294,7 @@ public async Task<IActionResult> Activities([HttpTrigger(AuthorizationLevel.Func
             var activityId = req.Query["activityId"];
             var correlationId = req.Query["correlationId"];
 
-            using var context = activityService.CreateContext("Activities", withTracking: false);
+            using var context = activityService.CreateContext("Activities", "HTTP", withTracking: false);
             try
             {
                 log.LogDebug("Executing ActivityStatus HttpTrigger Function");
@@ -313,7 +314,7 @@ public async Task<IActionResult> Activities([HttpTrigger(AuthorizationLevel.Func
                     context.ElapsedTime,
                 };
 
-                return new JsonResult(result);
+                return new JsonResult(result, httpJsonSerializerSettings);
             }
             catch (Exception ex)
             {
@@ -337,7 +338,7 @@ public async Task<IActionResult> Activities([HttpTrigger(AuthorizationLevel.Func
         public Task<IActionResult> Version([HttpTrigger(AuthorizationLevel.Function, "get")] HttpRequest req, ILogger log)
         {
             log.LogInformation(this.versionMetadata.ProductVersion);
-            return Task.FromResult((IActionResult)new JsonResult(this.versionMetadata));
+            return Task.FromResult((IActionResult)new JsonResult(this.versionMetadata, httpJsonSerializerSettings));
         }
 
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "Ensure graceful return under all trappable error conditions.")]
@@ -347,9 +348,8 @@ private async Task<dynamic> CommandDiscovery(DiscoveryMode discoveryMode, string
 
             try
             {
-                context = activityService.CreateContext($"{discoveryMode.Description()} Request", withTracking: true);
+                context = activityService.CreateContext($"{discoveryMode.Description()} Request", source, withTracking: true);
 
-                context.Activity.CommandSource = source;
                 await processor.RequestDiscovery(context, discoveryMode, source).ConfigureAwait(false);
                 var result = new
                 {
@@ -365,14 +365,15 @@ private async Task<dynamic> CommandDiscovery(DiscoveryMode discoveryMode, string
             }
             catch (Exception ex)
             {
+                var message = $"Failed to request Discovery {discoveryMode}";
+
                 if (context != null)
                 {
                     context.Activity.Status = ActivityHistoryStatus.Failed;
-
+                    context.Activity.Message = message;
                     ex.Data["activityContext"] = context;
                 }
 
-                var message = $"Failed to request Discovery {discoveryMode}";
                 log.LogError(ex, message);
 
                 throw;

diff --git a/src/Automation/CSE.Automation/Interfaces/IActivityService.cs b/src/Automation/CSE.Automation/Interfaces/IActivityService.cs
@@ -16,6 +16,6 @@ internal interface IActivityService
         Task<ActivityHistory> Put(ActivityHistory document);
         Task<ActivityHistory> Get(string id);
         Task<IEnumerable<ActivityHistory>> GetCorrelated(string correlationId);
-        ActivityContext CreateContext(string name, string correlationId = null, bool withTracking = false);
+        ActivityContext CreateContext(string name, string source, string correlationId = null, bool withTracking = false);
     }
 }