summaryrefslogtreecommitdiffstats
path: root/devtools/client/shared/test/unit/test_suggestion-picker.js
blob: 28c9df13b68d0b8331593c5205283b63b13efcfb (plain)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

/**
 * Test the suggestion-picker helper methods.
 */
const {require} = Components.utils.import("resource://devtools/shared/Loader.jsm", {});
const {
  findMostRelevantIndex,
  findMostRelevantCssPropertyIndex
} = require("devtools/client/shared/suggestion-picker");

/**
 * Run all tests defined below.
 */
function run_test() {
  ensureMostRelevantIndexProvidedByHelperFunction();
  ensureMostRelevantIndexProvidedByClassMethod();
  ensureErrorThrownWithInvalidArguments();
}

/**
 * Generic test data.
 */
const TEST_DATA = [
  {
    // Match in sortedItems array.
    items: ["chrome", "edge", "firefox"],
    sortedItems: ["firefox", "chrome", "edge"],
    expectedIndex: 2
  }, {
    // No match in sortedItems array.
    items: ["apple", "oranges", "banana"],
    sortedItems: ["kiwi", "pear", "peach"],
    expectedIndex: 0
  }, {
    // Empty items array.
    items: [],
    sortedItems: ["empty", "arrays", "can't", "have", "relevant", "indexes"],
    expectedIndex: -1
  }
];

function ensureMostRelevantIndexProvidedByHelperFunction() {
  do_print("Running ensureMostRelevantIndexProvidedByHelperFunction()");

  for (let testData of TEST_DATA) {
    let { items, sortedItems, expectedIndex } = testData;
    let mostRelevantIndex = findMostRelevantIndex(items, sortedItems);
    strictEqual(mostRelevantIndex, expectedIndex);
  }
}

/**
 * CSS properties test data.
 */
const CSS_TEST_DATA = [
  {
    items: [
      "backface-visibility",
      "background",
      "background-attachment",
      "background-blend-mode",
      "background-clip",
      "background-color",
      "background-image",
      "background-origin",
      "background-position",
      "background-repeat"
    ],
    expectedIndex: 1
  },
  {
    items: [
      "caption-side",
      "clear",
      "clip",
      "clip-path",
      "clip-rule",
      "color",
      "color-interpolation",
      "color-interpolation-filters",
      "content",
      "counter-increment"
    ],
    expectedIndex: 5
  },
  {
    items: [
      "direction",
      "display",
      "dominant-baseline"
    ],
    expectedIndex: 1
  },
  {
    items: [
      "object-fit",
      "object-position",
      "offset-block-end",
      "offset-block-start",
      "offset-inline-end",
      "offset-inline-start",
      "opacity",
      "order",
      "orphans",
      "outline"
    ],
    expectedIndex: 6
  },
  {
    items: [
      "white-space",
      "widows",
      "width",
      "will-change",
      "word-break",
      "word-spacing",
      "word-wrap",
      "writing-mode"
    ],
    expectedIndex: 2
  }
];

function ensureMostRelevantIndexProvidedByClassMethod() {
  do_print("Running ensureMostRelevantIndexProvidedByClassMethod()");

  for (let testData of CSS_TEST_DATA) {
    let { items, expectedIndex } = testData;
    let mostRelevantIndex = findMostRelevantCssPropertyIndex(items);
    strictEqual(mostRelevantIndex, expectedIndex);
  }
}

function ensureErrorThrownWithInvalidArguments() {
  do_print("Running ensureErrorThrownWithInvalidTypeArgument()");

  let expectedError = "Please provide valid items and sortedItems arrays.";
  // No arguments passed.
  throws(() => findMostRelevantIndex(), expectedError);
  // Invalid arguments passed.
  throws(() => findMostRelevantIndex([]), expectedError);
  throws(() => findMostRelevantIndex(null, []), expectedError);
  throws(() => findMostRelevantIndex([], "string"), expectedError);
  throws(() => findMostRelevantIndex("string", []), expectedError);
}