summaryrefslogtreecommitdiffstats
path: root/devtools/client/styleeditor/test/browser_styleeditor_autocomplete.js
blob: 626498418f77626d53b4243f3b707d76f98a66c9 (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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/* vim: set ts=2 et sw=2 tw=80: */
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";

// Test that autocompletion works as expected.

const TESTCASE_URI = TEST_BASE_HTTP + "autocomplete.html";
const MAX_SUGGESTIONS = 15;

const {initCssProperties} = require("devtools/shared/fronts/css-properties");

// Test cases to test that autocompletion works correctly when enabled.
// Format:
// [
//   key,
//   {
//     total: Number of suggestions in the popup (-1 if popup is closed),
//     current: Index of selected suggestion,
//     inserted: 1 to check whether the selected suggestion is inserted into the
//               editor or not,
//     entered: 1 if the suggestion is inserted and finalized
//   }
// ]

function getTestCases(cssProperties) {
  let keywords = getCSSKeywords(cssProperties);
  let getSuggestionNumberFor = suggestionNumberGetter(keywords);

  return [
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["Ctrl+Space", {total: 1, current: 0}],
    ["VK_LEFT"],
    ["VK_RIGHT"],
    ["VK_DOWN"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["Ctrl+Space", { total: getSuggestionNumberFor("font"), current: 0}],
    ["VK_END"],
    ["VK_RETURN"],
    ["b", {total: getSuggestionNumberFor("b"), current: 0}],
    ["a", {total: getSuggestionNumberFor("ba"), current: 0}],
    ["VK_DOWN", {total: getSuggestionNumberFor("ba"), current: 0, inserted: 1}],
    ["VK_TAB", {total: getSuggestionNumberFor("ba"), current: 1, inserted: 1}],
    ["VK_RETURN", {current: 1, inserted: 1, entered: 1}],
    ["b", {total: getSuggestionNumberFor("background", "b"), current: 0}],
    ["l", {total: getSuggestionNumberFor("background", "bl"), current: 0}],
    ["VK_TAB", {
      total: getSuggestionNumberFor("background", "bl"),
      current: 0, inserted: 1
    }],
    ["VK_DOWN", {
      total: getSuggestionNumberFor("background", "bl"),
      current: 1, inserted: 1
    }],
    ["VK_UP", {
      total: getSuggestionNumberFor("background", "bl"),
      current: 0,
      inserted: 1
    }],
    ["VK_TAB", {
      total: getSuggestionNumberFor("background", "bl"),
      current: 1,
      inserted: 1
    }],
    ["VK_TAB", {
      total: getSuggestionNumberFor("background", "bl"),
      current: 2,
      inserted: 1
    }],
    [";"],
    ["VK_RETURN"],
    ["c", {total: getSuggestionNumberFor("c"), current: 0}],
    ["o", {total: getSuggestionNumberFor("co"), current: 0}],
    ["VK_RETURN", {current: 0, inserted: 1}],
    ["r", {total: getSuggestionNumberFor("color", "r"), current: 0}],
    ["VK_RETURN", {current: 0, inserted: 1}],
    [";"],
    ["VK_LEFT"],
    ["VK_RIGHT"],
    ["VK_DOWN"],
    ["VK_RETURN"],
    ["b", {total: 2, current: 0}],
    ["u", {total: 1, current: 0}],
    ["VK_RETURN", {current: 0, inserted: 1}],
    ["{"],
    ["VK_HOME"],
    ["VK_DOWN"],
    ["VK_DOWN"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["VK_RIGHT"],
    ["Ctrl+Space", {total: 1, current: 0}],
  ];
}

add_task(function* () {
  let { panel, ui } = yield openStyleEditorForURL(TESTCASE_URI);
  let { cssProperties } = yield initCssProperties(panel._toolbox);
  let testCases = getTestCases(cssProperties);

  yield ui.selectStyleSheet(ui.editors[1].styleSheet);
  let editor = yield ui.editors[1].getSourceEditor();

  let sourceEditor = editor.sourceEditor;
  let popup = sourceEditor.getAutocompletionPopup();

  yield SimpleTest.promiseFocus(panel.panelWindow);

  for (let index in testCases) {
    yield testState(testCases, index, sourceEditor, popup, panel.panelWindow);
    yield checkState(testCases, index, sourceEditor, popup);
  }
});

function testState(testCases, index, sourceEditor, popup, panelWindow) {
  let [key, details] = testCases[index];
  let entered;
  if (details) {
    entered = details.entered;
  }
  let mods = {};

  info("pressing key " + key + " to get result: " +
                JSON.stringify(testCases[index]) + " for index " + index);

  let evt = "after-suggest";

  if (key == "Ctrl+Space") {
    key = " ";
    mods.ctrlKey = true;
  } else if (key == "VK_RETURN" && entered) {
    evt = "popup-hidden";
  } else if (/(left|right|return|home|end)/ig.test(key) ||
           (key == "VK_DOWN" && !popup.isOpen)) {
    evt = "cursorActivity";
  } else if (key == "VK_TAB" || key == "VK_UP" || key == "VK_DOWN") {
    evt = "suggestion-entered";
  }

  let ready = sourceEditor.once(evt);
  EventUtils.synthesizeKey(key, mods, panelWindow);

  return ready;
}

function checkState(testCases, index, sourceEditor, popup) {
  let deferred = defer();
  executeSoon(() => {
    let [, details] = testCases[index];
    details = details || {};
    let {total, current, inserted} = details;

    if (total != undefined) {
      ok(popup.isOpen, "Popup is open for index " + index);
      is(total, popup.itemCount,
         "Correct total suggestions for index " + index);
      is(current, popup.selectedIndex,
         "Correct index is selected for index " + index);
      if (inserted) {
        let { text } = popup.getItemAtIndex(current);
        let { line, ch } = sourceEditor.getCursor();
        let lineText = sourceEditor.getText(line);
        is(lineText.substring(ch - text.length, ch), text,
           "Current suggestion from the popup is inserted into the editor.");
      }
    } else {
      ok(!popup.isOpen, "Popup is closed for index " + index);
      if (inserted) {
        let { text } = popup.getItemAtIndex(current);
        let { line, ch } = sourceEditor.getCursor();
        let lineText = sourceEditor.getText(line);
        is(lineText.substring(ch - text.length, ch), text,
           "Current suggestion from the popup is inserted into the editor.");
      }
    }
    deferred.resolve();
  });

  return deferred.promise;
}

/**
 * Returns a list of all property names and a map of property name vs possible
 * CSS values provided by the Gecko engine.
 *
 * @return {Object} An object with following properties:
 *         - CSSProperties {Array} Array of string containing all the possible
 *                         CSS property names.
 *         - CSSValues {Object|Map} A map where key is the property name and
 *                     value is an array of string containing all the possible
 *                     CSS values the property can have.
 */
function getCSSKeywords(cssProperties) {
  let props = {};
  let propNames = cssProperties.getNames();
  propNames.forEach(prop => {
    props[prop] = cssProperties.getValues(prop).sort();
  });
  return {
    CSSValues: props,
    CSSProperties: propNames.sort()
  };
}

/**
 * Returns a function that returns the number of expected suggestions for the given
 * property and value. If the value is not null, returns the number of values starting
 * with `value`. Returns the number of properties starting with `property` otherwise.
 */
function suggestionNumberGetter({CSSProperties, CSSValues}) {
  return (property, value) => {
    if (value == null) {
      return CSSProperties.filter(prop => prop.startsWith(property))
                          .slice(0, MAX_SUGGESTIONS).length;
    }
    return CSSValues[property].filter(val => val.startsWith(value))
                              .slice(0, MAX_SUGGESTIONS).length;
  };
}