kibana/packages/kbn-eslint-plugin-eslint/rules/require_include_in_check_a11y.test.js at 83b6d28682bf25dd5fcf90b5ff02f06636cc1433 · alexwizp/kibana · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the "Elastic License
 * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
 * Public License v 1"; you may not use this file except in compliance with, at
 * your election, the "Elastic License 2.0", the "GNU Affero General Public
 * License v3.0 only", or the "Server Side Public License, v 1".
 */

const { RuleTester } = require('eslint');
const rule = require('./require_include_in_check_a11y');
const dedent = require('dedent');

const ruleTester = new RuleTester({
  parser: require.resolve('@typescript-eslint/parser'),
  parserOptions: {
    sourceType: 'module',
    ecmaVersion: 2018,
  },
});

const MESSAGE =
  'We recommend running checkA11y with the include parameter set to the root element you are testing. This makes the tests more isolated and reduces the time required to analyze the DOM structure.';

ruleTester.run('@kbn/eslint/require_include_in_check_a11y', rule, {
  valid: [
    {
      code: dedent`
        page.checkA11y({ include: '#root' });
      `,
    },
    {
      code: dedent`
        page.checkA11y({ include: rootEl });
      `,
    },
    {
      code: dedent`
        something.checkA11y({ include: '#app', exclude: ['#legacy'] });
      `,
    },
    {
      code: dedent`
        page['checkA11y']({ include: '#root' });
      `,
    },
    {
      code: dedent`
        page.checkA11y({ include: '#root', other: true });
      `,
    },
    {
      code: dedent`
        page.checkA11y({ ['include']: '#root' });
      `,
    },
  ],

  invalid: [
    {
      code: dedent`
        page.checkA11y();
      `,
      errors: [{ line: 1, message: MESSAGE }],
    },
    {
      code: dedent`
        page.checkA11y({});
      `,
      errors: [{ line: 1, message: MESSAGE }],
    },
    {
      code: dedent`
        page.checkA11y({ foo: 1 });
      `,
      errors: [{ line: 1, message: MESSAGE }],
    },
    {
      code: dedent`
        page.checkA11y({ 'include ': '#root' });
      `,
      errors: [{ line: 1, message: MESSAGE }],
    },
    {
      code: dedent`
        page.checkA11y(config);
      `,
      errors: [{ line: 1, message: MESSAGE }],
    },
    {
      code: dedent`
        page['checkA11y']();
      `,
      errors: [{ line: 1, message: MESSAGE }],
    },
    {
      // include only in second arg (rule checks first arg)
      code: dedent`
        page.checkA11y({}, { include: '#root' });
      `,
      errors: [{ line: 1, message: MESSAGE }],
    },
    {
      // Non-object first argument
      code: dedent`
        page.checkA11y('not an object');
      `,
      errors: [{ line: 1, message: MESSAGE }],
    },
  ],
});