Support for .bypassrules directive

src/aggregator-cli/Rules/AggregatorRules.cs

@@ -164,7 +164,7 @@ internal async Task<bool> AddAsync(InstanceName instance, string ruleName, strin
             if (preprocessedRule.Impersonate)
             {
                 _logger.WriteInfo($"Configure {ruleName} to execute impersonated.");
-                ok &= await ConfigureAsync(instance, ruleName, impersonate: true, cancellationToken: cancellationToken);
+                ok &= await ConfigureAsync(instance, ruleName, impersonate: true, bypassrules: true, cancellationToken: cancellationToken);
                 if (ok)
                 {
                     _logger.WriteInfo($"Updated {ruleName} configuration successfully.");
@@ -339,7 +339,7 @@ internal async Task<bool> RemoveAsync(InstanceName instance, string name, Cancel
             return true;
         }
 
-        internal async Task<bool> ConfigureAsync(InstanceName instance, string name, bool? disable = null, bool? impersonate = null, CancellationToken cancellationToken = default)
+        internal async Task<bool> ConfigureAsync(InstanceName instance, string name, bool? disable = null, bool? impersonate = null, bool? bypassrules = null, CancellationToken cancellationToken = default)
         {
             var webFunctionApp = await GetWebApp(instance, cancellationToken);
             var configuration = await AggregatorConfiguration.ReadConfiguration(webFunctionApp);
@@ -355,6 +355,11 @@ internal async Task<bool> ConfigureAsync(InstanceName instance, string name, boo
                 ruleConfig.Impersonate = impersonate.Value;
             }
 
+            if (bypassrules.HasValue)
+            {
+                ruleConfig.BypassRules = impersonate.Value;
+            }
+
             ruleConfig.WriteConfiguration(webFunctionApp);
 
             return true;
@@ -443,6 +448,7 @@ private async Task<bool> InvokeLocalAsyncImpl(string projectName, string @event,
                     {
                         ImpersonateExecution = impersonateExecution
                     };
+                    _logger.WriteVerbose("Test 1");
 
                     var engineLogger = new EngineWrapperLogger(_logger);
                     var engine = new Engine.RuleEngine(engineLogger, saveMode, dryRun: dryRun);

src/aggregator-cli/Rules/ConfigureRuleCommand.cs

@@ -44,7 +44,7 @@ internal override async Task<int> RunAsync(CancellationToken cancellationToken)
             var disable = GetDisableStatus(Disable, Enable);
             var impersonate = GetEnableStatus(DisableImpersonateExecution, EnableImpersonateExecution);
 
-            var ok = await rules.ConfigureAsync(instance, Name, disable, impersonate, cancellationToken);
+            var ok = await rules.ConfigureAsync(instance, Name, disable, impersonate, false, cancellationToken);
             return ok ? ExitCodes.Success : ExitCodes.Failure;
         }
 

src/aggregator-ruleng/IRule.cs

@@ -18,6 +18,13 @@ public interface IRule
         /// <remarks>Setter public for CLI</remarks>
         bool ImpersonateExecution { get; set; }
 
+        /// <summary>
+        /// WorkItem creation/updates will bypass rules
+        /// Assumes PAT or Account Permission is high enough
+        /// </summary>
+        /// <remarks>Setter public for CLI</remarks>
+        bool BypassRules { get; set; }
+
         ///<summary>
         /// Configuration data picked by the directive parser that may influence a rule behaviour.
         ///</summary>

src/aggregator-ruleng/Language/IPreprocessedRule.cs

@@ -5,6 +5,7 @@ namespace aggregator.Engine.Language
 {
     public interface IPreprocessedRule
     {
+        bool BypassRules { get; set; }
         bool Impersonate { get; set; }
         IRuleSettings Settings { get; }
         RuleLanguage Language { get; }

src/aggregator-ruleng/Language/PreprocessedRule.cs

@@ -8,6 +8,7 @@ internal class PreprocessedRule : IPreprocessedRule
     {
         public PreprocessedRule()
         {
+            BypassRules = false;
             Impersonate = false;
             Settings = new RuleSettings();
             Language = RuleLanguage.Unknown;
@@ -20,6 +21,8 @@ public PreprocessedRule()
 
         public bool Impersonate { get; set; }
 
+        public bool BypassRules { get; set; }
+
         public IRuleSettings Settings { get; private set; }
 
         public RuleLanguage Language { get; internal set; }

src/aggregator-ruleng/Language/RuleFileParser.cs

@@ -56,17 +56,22 @@ void FailParsingWithMessage(string message)
 
         (IPreprocessedRule preprocessedRule, bool parseSuccess) Parse(string[] ruleCode)
         {
+            logger.WriteVerbose("start Parse");
 
             var directiveLineIndex = 0;
             var preprocessedRule = new PreprocessedRule()
             {
                 Language = RuleLanguage.Csharp
             };
 
+            logger.WriteVerbose("start Parse while");
+
             while (directiveLineIndex < ruleCode.Length
                 && ruleCode[directiveLineIndex].Length > 0
                 && ruleCode[directiveLineIndex][0] == '.')
             {
+                logger.WriteVerbose("inside Parse while");
+
                 string directive = ruleCode[directiveLineIndex][1..];
                 // stop at first '=' or ' '
                 int endVerb = directive.IndexOfAny(new char[] { '=', ' ' });
@@ -90,6 +95,7 @@ void FailParsingWithMessage(string message)
             preprocessedRule.RuleCode.AddRange(ruleCode.Skip(preprocessedRule.FirstCodeLine));
 
             var parseSuccessful = !parsingIssues;
+            logger.WriteVerbose("end Parse");
             return (preprocessedRule, parseSuccessful);
 
         }
@@ -123,7 +129,10 @@ void ParseDirective(PreprocessedRule preprocessedRule, string directive, string
                 case "impersonate":
                     ParseImpersonateDirective(preprocessedRule, directive, arguments);
                     break;
-
+                case "bypassrules":
+                    logger.WriteVerbose("bypassrules");
+                    ParseBypassRulesDirective(preprocessedRule, directive, arguments);
+                    break;
                 case "check":
                     ParseCheckDirective(preprocessedRule, directive, arguments);
                     break;
@@ -214,6 +223,18 @@ private void ParseImpersonateDirective(PreprocessedRule preprocessedRule, string
             }
         }
 
+        private void ParseBypassRulesDirective(PreprocessedRule preprocessedRule, string directive, string arguments)
+        {
+            if (string.IsNullOrWhiteSpace(arguments))
+            {
+                FailParsingWithMessage($"Invalid bypassrules directive {directive}");
+            }
+            else
+            {
+                preprocessedRule.BypassRules = string.Equals("true", arguments.TrimEnd(), StringComparison.OrdinalIgnoreCase);
+            }
+        }
+
         private void ParseCheckDirective(PreprocessedRule preprocessedRule, string directive, string arguments)
         {
             if (string.IsNullOrWhiteSpace(arguments))
@@ -280,6 +301,11 @@ public static string[] Write(IPreprocessedRule preprocessedRule)
                 content.Add($".impersonate=onBehalfOfInitiator");
             }
 
+            if (preprocessedRule.BypassRules)
+            {
+                content.Add($".bypassrules=true");
+            }
+
             content.AddRange(preprocessedRule.References.Select(reference => $".reference={reference}"));
             content.AddRange(preprocessedRule.Imports.Select(import => $".import={import}"));
             content.AddRange(preprocessedRule.Events.Select(evnt => $".event={evnt}"));

src/aggregator-ruleng/RuleEngine.cs

@@ -69,7 +69,7 @@ protected override async Task<string> ExecuteRuleAsync(IRule rule, RuleExecution
             var result = await rule.ApplyAsync(executionContext, cancellationToken);
 
             var store = executionContext.store;
-            var (created, updated) = await store.SaveChanges(saveMode, !dryRun, rule.ImpersonateExecution, cancellationToken);
+            var (created, updated) = await store.SaveChanges(saveMode, !dryRun, rule.ImpersonateExecution, rule.BypassRules, cancellationToken);
             if (created + updated > 0)
             {
                 logger.WriteInfo($"Changes saved to Azure DevOps (mode {saveMode}): {created} created, {updated} updated.");

src/aggregator-ruleng/ScriptedRuleWrapper.cs

@@ -30,6 +30,7 @@ public class ScriptedRuleWrapper : IRule
         internal IPreprocessedRule RuleDirectives { get; private set; }
 
         public IRuleSettings Settings { get; private set; }
+        public bool BypassRules { get; set; }
 
         private ScriptedRuleWrapper(string ruleName, IAggregatorLogger logger)
         {
@@ -72,8 +73,11 @@ public ScriptedRuleWrapper(string ruleName, IPreprocessedRule preprocessedRule,
 
         private void Initialize(IPreprocessedRule preprocessedRule)
         {
+
             RuleDirectives = preprocessedRule;
             ImpersonateExecution = RuleDirectives.Impersonate;
+            BypassRules = RuleDirectives.BypassRules;
+
             Settings = preprocessedRule.Settings;
 
             var references = new HashSet<Assembly>(DefaultAssemblyReferences().Concat(RuleDirectives.LoadAssemblyReferences()));

src/aggregator-ruleng/WorkItemStore.cs

@@ -162,7 +162,7 @@ private void ImpersonateChanges()
         }
 
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Sonar Code Smell", "S907:\"goto\" statement should not be used")]
-        public async Task<(int created, int updated)> SaveChanges(SaveMode mode, bool commit, bool impersonate, CancellationToken cancellationToken)
+        public async Task<(int created, int updated)> SaveChanges(SaveMode mode, bool commit, bool impersonate, bool bypassrules, CancellationToken cancellationToken)
         {
             if (impersonate)
             {
@@ -175,20 +175,20 @@ private void ImpersonateChanges()
                     _context.Logger.WriteVerbose($"No save mode specified, assuming {SaveMode.TwoPhases}.");
                     goto case SaveMode.TwoPhases;
                 case SaveMode.Item:
-                    var resultItem = await SaveChanges_ByItem(commit, impersonate, cancellationToken);
+                    var resultItem = await SaveChanges_ByItem(commit, impersonate, bypassrules, cancellationToken);
                     return resultItem;
                 case SaveMode.Batch:
-                    var resultBatch = await SaveChanges_Batch(commit, impersonate, cancellationToken);
+                    var resultBatch = await SaveChanges_Batch(commit, impersonate, bypassrules, cancellationToken);
                     return resultBatch;
                 case SaveMode.TwoPhases:
-                    var resultTwoPhases = await SaveChanges_TwoPhases(commit, impersonate, cancellationToken);
+                    var resultTwoPhases = await SaveChanges_TwoPhases(commit, impersonate, bypassrules, cancellationToken);
                     return resultTwoPhases;
                 default:
                     throw new InvalidOperationException($"Unsupported save mode: {mode}.");
             }
         }
 
-        private async Task<(int created, int updated)> SaveChanges_ByItem(bool commit, bool impersonate, CancellationToken cancellationToken)
+        private async Task<(int created, int updated)> SaveChanges_ByItem(bool commit, bool impersonate, bool bypassrules, CancellationToken cancellationToken)
         {
             int createdCounter = 0;
             int updatedCounter = 0;
@@ -203,7 +203,7 @@ private void ImpersonateChanges()
                         item.Changes,
                         _context.ProjectName,
                         item.WorkItemType,
-                        bypassRules: impersonate,
+                        bypassRules: impersonate || bypassrules,
                         cancellationToken: cancellationToken
                     );
                 }
@@ -236,7 +236,7 @@ private void ImpersonateChanges()
                     _ = await _clients.WitClient.UpdateWorkItemAsync(
                         item.Changes,
                         item.Id,
-                        bypassRules: impersonate,
+                        bypassRules: impersonate || bypassrules,
                         cancellationToken: cancellationToken
                     );
                 }
@@ -251,7 +251,7 @@ private void ImpersonateChanges()
             return (createdCounter, updatedCounter);
         }
 
-        private async Task<(int created, int updated)> SaveChanges_Batch(bool commit, bool impersonate, CancellationToken cancellationToken)
+        private async Task<(int created, int updated)> SaveChanges_Batch(bool commit, bool impersonate, bool bypassrules, CancellationToken cancellationToken)
         {
             // see https://github.com/redarrowlabs/vsts-restapi-samplecode/blob/master/VSTSRestApiSamples/WorkItemTracking/Batch.cs
             // and https://docs.microsoft.com/en-us/rest/api/vsts/wit/workitembatchupdate?view=vsts-rest-4.1
@@ -280,7 +280,7 @@ private void ImpersonateChanges()
 
                 var request = _clients.WitClient.CreateWorkItemBatchRequest(item.Id,
                                                                             item.Changes,
-                                                                            bypassRules: impersonate,
+                                                                            bypassRules: impersonate || bypassrules,
                                                                             suppressNotifications: false);
                 batchRequests.Add(request);
             }
@@ -309,7 +309,7 @@ private static bool IsSuccessStatusCode(int statusCode)
 
         //TODO no error handling here? SaveChanges_Batch has at least the DryRun support and error handling
         //TODO Improve complex handling with ReplaceIdAndResetChanges and RemapIdReferences
-        private async Task<(int created, int updated)> SaveChanges_TwoPhases(bool commit, bool impersonate, CancellationToken cancellationToken)
+        private async Task<(int created, int updated)> SaveChanges_TwoPhases(bool commit, bool impersonate, bool bypassrules, CancellationToken cancellationToken)
         {
             // see https://github.com/redarrowlabs/vsts-restapi-samplecode/blob/master/VSTSRestApiSamples/WorkItemTracking/Batch.cs
             // and https://docs.microsoft.com/en-us/rest/api/vsts/wit/workitembatchupdate?view=vsts-rest-4.1
@@ -337,7 +337,7 @@ private static bool IsSuccessStatusCode(int statusCode)
                 var request = _clients.WitClient.CreateWorkItemBatchRequest(_context.ProjectName,
                                                                             item.WorkItemType,
                                                                             document,
-                                                                            bypassRules: impersonate,
+                                                                            bypassRules: impersonate || bypassrules,
                                                                             suppressNotifications: false);
                 batchRequests.Add(request);
             }
@@ -366,10 +366,11 @@ private static bool IsSuccessStatusCode(int statusCode)
                     continue;
                 }
                 _context.Logger.WriteInfo($"Found a request to update workitem {item.Id} in {_context.ProjectName}");
+                _context.Logger.WriteVerbose(JsonConvert.SerializeObject(item.Changes));
 
                 var request = _clients.WitClient.CreateWorkItemBatchRequest(item.Id,
                                                                             item.Changes,
-                                                                            bypassRules: impersonate,
+                                                                            bypassRules: impersonate || bypassrules,
                                                                             suppressNotifications: false);
                 batchRequests.Add(request);
             }

src/aggregator-shared/AggregatorConfiguration.cs

@@ -39,6 +39,7 @@ public interface IRuleConfiguration
         string RuleName { get; }
         bool IsDisabled { get; set; }
         bool Impersonate { get; set; }
+        bool BypassRules { get; set; }
     }
 
 
@@ -73,6 +74,11 @@ public static async Task<IAggregatorConfiguration> ReadConfiguration(Microsoft.A
                 {
                     ruleConfig.Impersonate = string.Equals("onBehalfOfInitiator", ruleSetting.value, StringComparison.OrdinalIgnoreCase);
                 }
+
+                if (string.Equals("BypassRules", key, StringComparison.OrdinalIgnoreCase))
+                {
+                    ruleConfig.BypassRules = string.Equals("true", ruleSetting.value, StringComparison.OrdinalIgnoreCase);
+                }
             }
 
             Enum.TryParse(settings.GetValueOrDefault("Aggregator_VstsTokenType")?.Value, out DevOpsTokenType vtt);
@@ -156,6 +162,7 @@ private static void AddRuleSettings(this Dictionary<string, string> settings, IR
         {
             settings[$"{RULE_SETTINGS_PREFIX}{ruleSetting.RuleName}.Disabled"] = ruleSetting.IsDisabled.ToString();
             settings[$"{RULE_SETTINGS_PREFIX}{ruleSetting.RuleName}.Impersonate"] = ruleSetting.Impersonate ? "onBehalfOfInitiator" : "false";
+            settings[$"{RULE_SETTINGS_PREFIX}{ruleSetting.RuleName}.BypassRules"] = ruleSetting.BypassRules ? "true" : "false";
         }
 
         private static void ApplyWithAppSettings(this Microsoft.Azure.Management.AppService.Fluent.IWebApp webApp, Dictionary<string, string> settings)

src/aggregator-shared/Model/RuleConfiguration.cs

@@ -13,5 +13,6 @@ public RuleConfiguration(string ruleName)
         public string RuleName { get; }
         public bool IsDisabled { get; set; }
         public bool Impersonate { get; set; }
+        public bool BypassRules { get; set; }
     }
-}
+}