axe DevTools Mobile August 30, 2023 Release Notes
August 30, 2023
Component Versions
- axeDevToolsXCUI v2.7.0
- axe-devtools-android v4.1.0
- axe DevTools Reporter CLI v4.7.0
What's New?
WCAG 2.2 is currently in Proposed Recommendation status. Results from the WCAG 2.2 rule, "Touch Target Spacing", will be marked as Experimental until WCAG 2.2 reaches Recommendation status. This means results from this rule will now appear in your Fail, Pass, and Needs Review result counts under the Experimental heading. (This rule was previously appearing in the Ignored count.) You can also disable experimental rules, if you prefer. Learn more about experimental rules.
Android
- You can now ignore rules in your automated UI Tests (Espresso or UI Automator) using the View ID Resource Name. Use this to ignore rules when passing in the Instrumentation Registry.
iOS
- The Inaccessible Action rule is now apart of the axe DevTools XCUI framework.
Reporter CLI
- You can now save reports in CSV and JUnit XML in addition to HTML. Learn more about the axe DevTools Reporter CLI.
Bug Fixes
iOS
- Improved result accuracy when controls are disabled.
- Updated the "Color Contrast" rule to ensure it does not run on dimmed views behind a modal.
- Combined scan name and tag update calls into one network request to improve performance.
Android
- UI Automator tests will now wait for the window update to complete before scanning to avoid capturing an out-of-date screenshot.
- Fixed a false positive in the "Edit Text Name" rule for Compose. This rule will no longer report a failure when a Compose TextField contains a label.
- Fixed the "Edit Text Value" rule to run on all Compose TextField elements.
- Fixed a calculation issue with the "Touch Target Spacing" rule.
Dashboard
- Resolved an issue from the last release that caused the ordering of issues within scans to change.
Updates
Reminder: As of Aug. 16, 2023, we have stopped releasing updates to the UIKit framework for automated testing on iOS apps. We will continue to offer this framework for the foreseeable future, but will no longer make bug fixes or updates. We encourage you to switch to the XCUI framework which will be updated with new rules and improvements going forward. If you are currently using the UIKit framework for automated unit or UI testing and would like support transitioning to the XCUI framework, please let us know. Submit a request at support.deque.com, or email helpdesk@deque.com.
Known Issues
If you're experiencing any of the below issues, please contact us at helpdesk@deque.com or support.deque.com. We will then be able to notify you once it's resolved or of an identified workaround if none is listed.
- axe DevTools Mobile automated testing runs on native iOS, native Android, and React Native apps. Please contact your Deque representative for accessibility testing solutions on your tech stack.
- To support you in getting accurate results and applicable remediation advice axe DevTools Mobile rules does not run in web views or rendered PDFs. To test HTML content, please utilize axe DevTools for Web. axe Monitor supports scanning PDFs for accessibility.
axe DevTools Mobile for iOS
axeDevToolsUIKit.xcframework
Views built with SwiftUI cannot be tested using this framework for automated testing.
Use the axeDevToolsXCUI framework in UITesting for SwiftUI views.
Custom rule support is available only in Swift
The custom rule API is not open to Objective-C.
False Positives: InScrollView, SupportsDynamicType, Colliding Views
We are actively working on fixes for the following false positives and will update this list as fixes are released.
InScrollView
InScrollView may report issues for text within banner-behaving elements. To make these elements available to those that require larger text, use UILargeContentViewer.
SupportsDynamicType
You may see false positives in the following scenarios:
- If using the
UIContentSizeCategoryDidChangenotification, the framework may incorrectly report that text does not respond to Dynamic Type in UITests. - If using
NotificationCenter.default.addObserver(forName:.., object:.., queue:.., using:..)to respond to theUIContentSizeCategoryDidChangenotification. - If using
traitCollectionDidChangeon a text's parent view or view controller to respond to Dynamic Type.
When a scrollable subview contains text, and that subview does not span to the edge of the screen's bounds, you will see failures for text located within the view's bounds.
axeDevToolsXCUI.xcframework
SwiftUI Picker and UIKit Picker
Picker views in SwiftUI and UIKit may cause the framework to get stuck on simulators or devices. (#636)
Rules against Nested Controls
While looking at an improvement for our rules, we found that in XCTest, nested controls are not returned in the accessibility tree. A bug has been filed with Apple. (#1110)
False Positive: In Scroll View, ActiveControlName
We are actively working on fixes for the following false positives and will update this list as fixes are released.
In Scroll View
May report issues for text within banner-behaving elements. To make these elements available to those that require larger text, use UILargeContentViewer. (#622)
ActiveControlName
If an UIImageView has an `accessibilityIdentifier` set but is not focusable by VoiceOver, and it has focusable controls nested within it, ActiveControlName may report a false positive on the UIImageView. Removing the `accessibilityIdentifier` resolves the issue. (#1178)
False Negative: Image View Name, Focusable Text in iOS 13 through iOS 14.8.1
We are actively working on fixes for the following false negatives and will update this list as fixes are released.
Image View Name
If an UIImageView has an `accessibilityIdentifier` set but is not focusable by VoiceOver, ImageViewName may report a false negative on the UIImageView. Removing the `accessibilityIdentifier` resolves the issue. (#1188)
Focusable Text
Elements marked as non-accessibility elements may report improper results due to a bug in Apple's framework.
axe DevTools Mobile for Android
Crash when using Proguard
If your debug or test build is utilizing Proguard, follow the steps to ignore Deque in your Proguard settings.
Crash when `minifiedEnabled` is set to true
If minifying your build, you'll see a crash with an error log reporting an adapter could not be found when trying to login to the axe DevTools library. Disable minify for your debug builds with axe DevTools implemented. (#729)
Errors Compiling with Java8 Project and axe DevTools Android 3.1.0
Try the following imports:
implementation 'androidx.core:core-ktx:1.9.0' implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4' implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4'After importing the above library, if you see errors related to minSDK version for core-ktx library try the following in your project’s Android Manifest:
<uses-sdk tools:overrideLibrary="androidx.core" />
Builds with r8 enabled throw an error
A build with r8 enabled may attempt to minify the axeDevTools library resulting in an error similar to:
Caused by: java.lang.NullPointerException: throw with null exception at g.b.b.a$a.a(Unknown Source:1) at g.b.b.a$a.a(Unknown Source:0) at g.b.b.a.a(AccessToken.java:190)To resolve this error add the following line to your ProGuard file to keep axeDevTools classes:
keep class com.deque.** { *; }
Error message similar to:
Expected exactly '1' node but found '2' nodes that satisfy: (isRoot)
If you encounter an error along the lines of `Expected exactly '1' node but found '2' nodes that satisfy: (isRoot)`, please contact us at helpdesk@deque.com or support.deque.com for assistance. Under certain conditions, there may be two Compose root nodes existing at the same time.
axe DevTools Mobile Dashboard
Some Android scan names are unformatted
Some Android scan names that are defaulted to the screen title will appear as the full class name including the bundle identifier. In a future release, this will be resolved so that the screen title is formatted into a more readable name. As a workaround, you can set the scan name from the dashboard or frameworks. (#1643)