Merge e366517 into d68e4d7

microsoft · Jul 26, 2023 · 737df70 · 737df70
2 parents d68e4d7 + e366517
commit 737df70
Show file tree

Hide file tree

Showing 25 changed files with 150 additions and 79 deletions.
diff --git a/src/Rules/Library/ChromiumComponentsShouldUseWebScanner.cs b/src/Rules/Library/ChromiumComponentsShouldUseWebScanner.cs
@@ -4,16 +4,14 @@
 using Axe.Windows.Core.Bases;
 using Axe.Windows.Core.Enums;
 using Axe.Windows.Rules.Resources;
-using static Axe.Windows.Rules.PropertyConditions.ControlType;
-using static Axe.Windows.Rules.PropertyConditions.Framework;
-using static Axe.Windows.Rules.PropertyConditions.Relationships;
+using static Axe.Windows.Rules.PropertyConditions.ElementGroups;
 
 namespace Axe.Windows.Rules.Library
 {
     [RuleInfo(ID = RuleId.ChromiumComponentsShouldUseWebScanner)]
     class ChromiumComponentsShouldUseWebScanner : Rule
     {
-        public ChromiumComponentsShouldUseWebScanner()
+        public ChromiumComponentsShouldUseWebScanner() : base(excludedCondition: null)
         {
             Info.Description = Descriptions.ChromiumComponentsShouldUseWebScanner;
             Info.HowToFix = HowToFix.ChromiumComponentsShouldUseWebScanner;
@@ -27,7 +25,7 @@ public override bool PassesTest(IA11yElement e)
 
         protected override Condition CreateCondition()
         {
-            return Chrome & (Document | AnyAncestor(Document));
+            return IsChromiumDocument;
         }
     } // class
 } // namespace
diff --git a/src/Rules/Library/ClickablePointOffScreen.cs b/src/Rules/Library/ClickablePointOffScreen.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft. All rights reserved.
+// Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using Axe.Windows.Core.Bases;
@@ -14,7 +14,8 @@ namespace Axe.Windows.Rules.Library
     [RuleInfo(ID = RuleId.ClickablePointOffScreen)]
     class ClickablePointOffScreen : Rule
     {
-        public ClickablePointOffScreen()
+        // Testable constructor
+        internal ClickablePointOffScreen(Condition excludedCondition) : base(excludedCondition)
         {
             Info.Description = Descriptions.ClickablePointOffScreen;
             Info.HowToFix = HowToFix.ClickablePointOffScreen;
@@ -23,6 +24,10 @@ public ClickablePointOffScreen()
             Info.ErrorCode = EvaluationCode.Warning;
         }
 
+        public ClickablePointOffScreen() : this(DefaultExcludedCondition)
+        {
+        }
+
         public override bool PassesTest(IA11yElement e)
         {
             if (e == null) throw new ArgumentNullException(nameof(e));

diff --git a/src/Rules/Library/ClickablePointOnScreen.cs b/src/Rules/Library/ClickablePointOnScreen.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft. All rights reserved.
+// Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using Axe.Windows.Core.Bases;
@@ -15,7 +15,8 @@ namespace Axe.Windows.Rules.Library
     [RuleInfo(ID = RuleId.ClickablePointOnScreen)]
     class ClickablePointOnScreen : Rule
     {
-        public ClickablePointOnScreen()
+        // Testable constructor
+        public ClickablePointOnScreen(Condition excludedCondition) : base(excludedCondition)
         {
             Info.Description = Descriptions.ClickablePointOnScreen;
             Info.HowToFix = HowToFix.ClickablePointOnScreen;
@@ -24,6 +25,10 @@ public ClickablePointOnScreen()
             Info.ErrorCode = EvaluationCode.Error;
         }
 
+        public ClickablePointOnScreen() : this(DefaultExcludedCondition)
+        {
+        }
+
         public override bool PassesTest(IA11yElement e)
         {
             if (e == null) throw new ArgumentNullException(nameof(e));

diff --git a/src/Rules/Library/ClickablePointOnScreenWPF.cs b/src/Rules/Library/ClickablePointOnScreenWPF.cs
@@ -15,7 +15,8 @@ namespace Axe.Windows.Rules.Library
     [RuleInfo(ID = RuleId.ClickablePointOnScreenWPF)]
     class ClickablePointOnScreenWPF : Rule
     {
-        public ClickablePointOnScreenWPF()
+        // Testable constructor
+        public ClickablePointOnScreenWPF(Condition excludedCondition) : base(excludedCondition)
         {
             Info.Description = Descriptions.ClickablePointOnScreen;
             Info.HowToFix = HowToFix.ClickablePointOnScreen;
@@ -25,6 +26,10 @@ public ClickablePointOnScreenWPF()
             Info.FrameworkIssueLink = "https://go.microsoft.com/fwlink/?linkid=2214600";
         }
 
+        public ClickablePointOnScreenWPF() : this(DefaultExcludedCondition)
+        {
+        }
+
         public override bool PassesTest(IA11yElement e)
         {
             if (e == null) throw new ArgumentNullException(nameof(e));

diff --git a/src/Rules/Library/EdgeBrowserHasBeenDeprecated.cs b/src/Rules/Library/EdgeBrowserHasBeenDeprecated.cs
@@ -11,7 +11,8 @@ namespace Axe.Windows.Rules.Library
     [RuleInfo(ID = RuleId.EdgeBrowserHasBeenDeprecated)]
     class EdgeBrowserHasBeenDeprecated : Rule
     {
-        public EdgeBrowserHasBeenDeprecated()
+        // Testable constructor
+        internal EdgeBrowserHasBeenDeprecated(Condition excludedCondition) : base (excludedCondition)
         {
             Info.Description = Descriptions.EdgeBrowserHasBeenDeprecated;
             Info.HowToFix = HowToFix.EdgeBrowserHasBeenDeprecated;
@@ -20,6 +21,10 @@ public EdgeBrowserHasBeenDeprecated()
             Info.FrameworkIssueLink = "https://go.microsoft.com/fwlink/?linkid=2214421";
         }
 
+        public EdgeBrowserHasBeenDeprecated() : this (excludedCondition: DefaultExcludedCondition)
+        {
+        }
+
         public override bool PassesTest(IA11yElement e)
         {
             return false;

diff --git a/src/Rules/Library/FrameworkDoesNotSupportUIAutomation.cs b/src/Rules/Library/FrameworkDoesNotSupportUIAutomation.cs
@@ -18,7 +18,8 @@ class FrameworkDoesNotSupportUIAutomation : Rule
             @"^\s*SunAwt.*$",
         };
 
-        public FrameworkDoesNotSupportUIAutomation()
+        // Testable constructor
+        internal FrameworkDoesNotSupportUIAutomation(Condition excludedCondition) : base (excludedCondition)
         {
             Info.Description = Descriptions.FrameworkDoesNotSupportUIAutomation;
             Info.HowToFix = HowToFix.FrameworkDoesNotSupportUIAutomation;
@@ -27,6 +28,10 @@ public FrameworkDoesNotSupportUIAutomation()
             Info.FrameworkIssueLink = "https://go.microsoft.com/fwlink/?linkid=2214160";
         }
 
+        public FrameworkDoesNotSupportUIAutomation() : this(excludedCondition: DefaultExcludedCondition)
+        {
+        }
+
         public override bool PassesTest(IA11yElement e)
         {
             string className = e.ClassName;

diff --git a/src/Rules/Library/IsControlElementTrueRequired.cs b/src/Rules/Library/IsControlElementTrueRequired.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft. All rights reserved.
+// Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using Axe.Windows.Core.Bases;
@@ -14,7 +14,8 @@ namespace Axe.Windows.Rules.Library
     [RuleInfo(ID = RuleId.IsControlElementTrueRequired)]
     class IsControlElementTrueRequired : Rule
     {
-        public IsControlElementTrueRequired()
+        // Testable constructor
+        public IsControlElementTrueRequired(Condition excludedCondition) : base(excludedCondition)
         {
             Info.Description = Descriptions.IsControlElementTrueRequired;
             Info.HowToFix = HowToFix.IsControlElementTrueRequired;
@@ -23,6 +24,10 @@ public IsControlElementTrueRequired()
             Info.ErrorCode = EvaluationCode.Error;
         }
 
+        public IsControlElementTrueRequired() : this(DefaultExcludedCondition)
+        {
+        }
+
         public override bool PassesTest(IA11yElement e)
         {
             if (e == null) throw new ArgumentNullException(nameof(e));

diff --git a/src/Rules/Library/IsControlElementTrueRequiredButtonWPF.cs b/src/Rules/Library/IsControlElementTrueRequiredButtonWPF.cs
@@ -14,7 +14,8 @@ namespace Axe.Windows.Rules.Library
     [RuleInfo(ID = RuleId.IsControlElementTrueRequiredButtonWPF)]
     class IsControlElementTrueRequiredButtonWPF : Rule
     {
-        public IsControlElementTrueRequiredButtonWPF()
+        // Testable constructor
+        public IsControlElementTrueRequiredButtonWPF(Condition excludedCondition): base(excludedCondition)
         {
             Info.Description = Descriptions.IsControlElementTrueRequired;
             Info.HowToFix = HowToFix.IsControlElementTrueRequired;
@@ -24,6 +25,10 @@ public IsControlElementTrueRequiredButtonWPF()
             Info.FrameworkIssueLink = "https://go.microsoft.com/fwlink/?linkid=2214420";
         }
 
+        public IsControlElementTrueRequiredButtonWPF() : this(DefaultExcludedCondition)
+        {
+        }
+
         public override bool PassesTest(IA11yElement e)
         {
             if (e == null) throw new ArgumentNullException(nameof(e));

diff --git a/src/Rules/Library/IsControlElementTrueRequiredTextInEditXAML.cs b/src/Rules/Library/IsControlElementTrueRequiredTextInEditXAML.cs
@@ -14,7 +14,8 @@ namespace Axe.Windows.Rules.Library
     [RuleInfo(ID = RuleId.IsControlElementTrueRequiredTextInEditXAML)]
     class IsControlElementTrueRequiredTextInEditXAML : Rule
     {
-        public IsControlElementTrueRequiredTextInEditXAML()
+        // Testable constructor
+        public IsControlElementTrueRequiredTextInEditXAML(Condition excludedCondition) : base(excludedCondition)
         {
             Info.Description = Descriptions.IsControlElementTrueRequired;
             Info.HowToFix = HowToFix.IsControlElementTrueRequired;
@@ -24,6 +25,10 @@ public IsControlElementTrueRequiredTextInEditXAML()
             Info.FrameworkIssueLink = "https://go.microsoft.com/fwlink/?linkid=2214418";
         }
 
+        public IsControlElementTrueRequiredTextInEditXAML() : this(DefaultExcludedCondition)
+        {
+        }
+
         public override bool PassesTest(IA11yElement e)
         {
             if (e == null) throw new ArgumentNullException(nameof(e));

diff --git a/src/Rules/Library/ProgressBarRangeValue.cs b/src/Rules/Library/ProgressBarRangeValue.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft. All rights reserved.
+// Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using Axe.Windows.Core.Bases;
@@ -14,7 +14,8 @@ namespace Axe.Windows.Rules.Library
     [RuleInfo(ID = RuleId.ProgressBarRangeValue)]
     class ProgressBarRangeValue : Rule
     {
-        public ProgressBarRangeValue()
+        // Testable constructor
+        internal ProgressBarRangeValue(Condition excludedCondition) : base(excludedCondition)
         {
             Info.Description = Descriptions.ProgressBarRangeValue;
             Info.HowToFix = HowToFix.ProgressBarRangeValue;
@@ -23,6 +24,10 @@ public ProgressBarRangeValue()
             Info.ErrorCode = EvaluationCode.Error;
         }
 
+        public ProgressBarRangeValue() : this(excludedCondition: DefaultExcludedCondition)
+        {
+        }
+
         public override bool PassesTest(IA11yElement e)
         {
             if (e == null) throw new ArgumentNullException(nameof(e));

diff --git a/src/Rules/PropertyConditions/ElementGroups.cs b/src/Rules/PropertyConditions/ElementGroups.cs
@@ -4,6 +4,7 @@
 using Axe.Windows.Core.Bases;
 using Axe.Windows.Core.Misc;
 using Axe.Windows.Core.Types;
+using Axe.Windows.Rules.Resources;
 using static Axe.Windows.Rules.PropertyConditions.BoolProperties;
 using static Axe.Windows.Rules.PropertyConditions.ControlType;
 using static Axe.Windows.Rules.PropertyConditions.Framework;
@@ -13,7 +14,7 @@
 namespace Axe.Windows.Rules.PropertyConditions
 {
     /// <summary>
-    /// A collection of conditions representing elements grouped for miscellaneous  rules.
+    /// A collection of conditions representing elements grouped for miscellaneous rules.
     /// These are conditions which tend to be reused by multiple rules.
     /// </summary>
     static class ElementGroups
@@ -45,7 +46,8 @@ static class ElementGroups
         public static Condition WPFButton = WPF & Button;
         public static Condition XAMLTextInEdit = XAML & Text & Parent(Edit);
         public static Condition WinFormsEdit = Edit & WinForms;
-
+        public static Condition IsChromiumDocument = Chrome & Document;
+        public static Condition IsChromiumContent = (IsChromiumDocument | AnyAncestor(IsChromiumDocument))[ConditionDescriptions.IsChromiumContent];
         public static Condition AllowSameNameAndControlType = CreateAllowSameNameAndControlTypeCondition();
 
         private static Condition CreateMinMaxCloseButtonCondition()

diff --git a/src/Rules/Resources/ConditionDescriptions.Designer.cs b/src/Rules/Resources/ConditionDescriptions.Designer.cs
diff --git a/src/Rules/Resources/ConditionDescriptions.resx b/src/Rules/Resources/ConditionDescriptions.resx
@@ -286,4 +286,8 @@
     <value>LocalizedLandmarkType</value>
     <comment>Do not translate: the name of a UI Automation property.</comment>
   </data>
+  <data name="IsChromiumContent" xml:space="preserve">
+    <value>IsChromiumContent</value>
+    <comment>{Locked}: a token used by the Axe.Windows domain-specific language for accessibility descriptions.</comment>
+  </data>
 </root>
diff --git a/src/Rules/Rule.cs b/src/Rules/Rule.cs
@@ -5,6 +5,7 @@
 using Axe.Windows.Core.Exceptions;
 using Axe.Windows.Core.Misc;
 using Axe.Windows.Rules.Resources;
+using static Axe.Windows.Rules.PropertyConditions.ElementGroups;
 
 namespace Axe.Windows.Rules
 {
@@ -19,17 +20,27 @@ abstract class Rule : IRule
     {
         public RuleInfo Info { get; private set; }
         public Condition Condition { get; }
+        protected static Condition DefaultExcludedCondition => IsChromiumContent;
 
-        protected Rule()
+        protected Rule(Condition excludedCondition)
         {
-            // keep these two calls in the following order or the RuleInfo.Condition string won't get populated
+            // keep these calls in the following order or the RuleInfo.Condition string won't get populated
 #pragma warning disable CA2214
             Condition = CreateCondition();
 #pragma warning restore CA2214
 
+            if (excludedCondition != null)
+            {
+                Condition = Condition - excludedCondition;
+            }
+
             InitRuleInfo();
         }
 
+        protected Rule() : this (excludedCondition: DefaultExcludedCondition)
+        {
+        }
+
         private void InitRuleInfo()
         {
             var info = GetRuleInfoFromAttributes();