WebSVN – Moodle – Diff – /lib/tests/behat/behat_accessibility.php

 // GNU General Public License for more details.
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
-/**
- * Steps definitions to open and close action menus.
- *
- * @package    core
- * @category   test
+use Behat\Mink\Exception\DriverException;
- * @copyright  2020 Andrew Nicols <andrew@nicols.co.uk>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+use Behat\Mink\Exception\ExpectationException;
-use Behat\Mink\Exception\{DriverException, ExpectationException};
+use Behat\Mink\Element\NodeElement;
  * @category   test
  * @copyright  2020 Andrew Nicols <andrew@nicols.co.uk>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class behat_accessibility extends behat_base {
     /**
      * Run the axe-core accessibility tests.
+     *
      * There are standard tags to ensure WCAG 2.1 A, WCAG 2.1 AA, and Section 508 compliance.
      * It is also possible to specify any desired optional tags.
+     *
-     * The list of available tags can be found at
-     * https://github.com/dequelabs/axe-core/blob/v4.8.4/doc/rule-descriptions.md.
+     * See {@link https://github.com/dequelabs/axe-core/blob/v4.10.2/doc/rule-descriptions.md} for the list of available tags
+     *
      * @Then the page should meet accessibility standards
      * @Then the page should meet accessibility standards with :extratags extra tests
      * @Then the page should meet :standardtags accessibility standards
      * @param   string $standardtags Comma-separated list of standard tags to run
             array_filter(array_map('trim', explode(',', $extratags)))
         );
+    }
+    /**
+     * Run the axe-core accessibility tests for a page region.
+     *
+     * There are standard tags to ensure WCAG 2.1 A, WCAG 2.1 AA, and Section 508 compliance.
+     * It is also possible to specify any desired optional tags.
+     *
+     * See {@link https://github.com/dequelabs/axe-core/blob/v4.10.0/doc/rule-descriptions.md} for the list of available tags
+     *
+     * @Then the :element :selector should meet accessibility standards
+     * @Then the :element :selector should meet accessibility standards with :extratags extra tests
+     * @Then the :element :selector should meet :standardtags accessibility standards
+     * @param  string $element The element to run the tests on
+     * @param  string $selector The selector to use to find the element
+     * @param  string $standardtags Comma-separated list of standard tags to run
+     * @param  string $extratags Comma-separated list of tags to run in addition to the standard tags
+     */
+    public function run_axe_validation_for_tags_within_element(
+        string $element,
+        string $selector,
+        string $standardtags = '',
+        string $extratags = '',
+    ): void {
+        $node = $this->get_selected_node($selector, $element);
+        $this->run_axe_for_tags(
+            // Turn the comma-separated string into an array of trimmed values, filtering out empty values.
+            array_filter(array_map('trim', explode(',', $standardtags))),
+            array_filter(array_map('trim', explode(',', $extratags))),
+            $node,
+        );
+    }
     /**
      * Run the Axe tests.
      *
-     * See https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md for details of the supported
-     * tags.
+     * See {@see behat_accessibility::run_axe_validation_for_tags} for details of the supported tags.
+     *
      * @param   array $standardtags The list of standard tags to run
+     * @param   array $extratags The list of tags, in addition to the standard tags, to run
-     * @param   array $extratags The list of tags, in addition to the standard tags, to run
+     * @param null|NodeElement $containerelement The element to run the tests on
      */
+    protected function run_axe_for_tags(
+        array $standardtags = [],
+        array $extratags = [],
+        ?NodeElement $containerelement = null,
-    protected function run_axe_for_tags(array $standardtags = [], array $extratags = []): void {
+    ): void {
         if (!behat_config_manager::get_behat_run_config_value('axe')) {
             return;
+        }
         $this->require_javascript();
+        $axeurl = (new \moodle_url('/lib/behat/axe/axe.min.js'))->out(false);
+        $axeconfig = $this->get_axe_config_for_tags($standardtags, $extratags);
+        $xpath = '';
+        if ($containerelement) {
-        $axeurl = (new \moodle_url('/lib/behat/axe/axe.min.js'))->out(false);
+            $xpath = $this->prepare_xpath_for_javascript($containerelement->getXpath());
         $axeconfig = $this->get_axe_config_for_tags($standardtags, $extratags);
         $runaxe = <<<EOF
 (axeurl => {
     const runTests = () => {
+        const axeTag = document.querySelector('script[data-purpose="axe"]');
+        axeTag.dataset.results = null;
+        const getRun = () => {
+            const xpath = "{$xpath}";
+            if (xpath.length) {
+                const targetElements = [];
+                const results = document.evaluate(xpath, document, null, XPathResult.ANY_TYPE, null);
+                let targetElement = results.iterateNext();
+                while (targetElement) {
+                    targetElements.push(targetElement);
+                    targetElement = results.iterateNext();
+                }
-        const axeTag = document.querySelector('script[data-purpose="axe"]');
+                return axe.run(targetElements, {$axeconfig});
+            }
+            return axe.run({$axeconfig});
-        axeTag.dataset.results = null;
+        };
-        axe.run({$axeconfig})
+        getRun()
         .then(results => {
             axeTag.dataset.results = JSON.stringify({
                     implode("\n      ", $node->target)
                 );
+            }
             $violationdata .= sprintf(
-                "  %.03d violations of '%s' (severity: %s)\n%s\n",
+                "  %.03d violations of rule '%s' found (severity: %s)\n",
                 count($violation->nodes),
-                $violation->description,
+                $violation->id,
-                $violation->impact,
-                $nodedata
+                $violation->impact,
+            );
+            $violationdata .= "  {$violation->help}\n";
+            $violationdata .= "  {$violation->description}\n";
+            $violationdata .= "  {$violation->helpUrl}\n";
-            );
+            $violationdata .= $nodedata;
+        }
         throw new ExpectationException($violationdata, $this->getSession());
+    }
     /**
      * Get the configuration to use with Axe.
+     *
-     * See https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md for details of the rules.
+     * See {@see behat_accessibility::run_axe_validation_for_tags} for details of the rules.
+     *
      * @param   array|null $standardtags The list of standard tags to run
      * @param   array|null $extratags The list of tags, in addition to the standard tags, to run
      * @return  string The JSON-encoded configuration.
      */
     protected function get_axe_config_for_tags(?array $standardtags = null, ?array $extratags = null): string {
+        if (empty($standardtags)) {
+            $standardtags = [
-        if (empty($standardtags)) {
+                // Meet WCAG 2.2 Level A success criteria.
-            $standardtags = [
+                'wcag2a',
+                'wcag21a',
+                'wcag22a',
                 // Meet WCAG 2.2 Level A success criteria.
-                'wcag22a',
+                // Meet WCAG 2.2 Level AA success criteria.
                 'wcag2aa',
-                // Meet WCAG 2.2 Level AA success criteria.
+                'wcag21aa',

Proyectos de Subversion Moodle

(root)/lib/tests/behat/behat_accessibility.php – Rev 11 → 1441