| 1 |
// Copyright 2013 The Closure Library Authors. All Rights Reserved. |
| 2 |
// |
| 3 |
// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 |
// you may not use this file except in compliance with the License. |
| 5 |
// You may obtain a copy of the License at |
| 6 |
// |
| 7 |
// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
// |
| 9 |
// Unless required by applicable law or agreed to in writing, software |
| 10 |
// distributed under the License is distributed on an "AS-IS" BASIS, |
| 11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 |
// See the License for the specific language governing permissions and |
| 13 |
// limitations under the License. |
| 14 |
|
| 15 |
goog.provide('goog.tweak.TweakUiTest'); |
| 16 |
goog.setTestOnly('goog.tweak.TweakUiTest'); |
| 17 |
|
| 18 |
goog.require('goog.dom'); |
| 19 |
goog.require('goog.dom.TagName'); |
| 20 |
goog.require('goog.string'); |
| 21 |
goog.require('goog.testing.jsunit'); |
| 22 |
goog.require('goog.tweak'); |
| 23 |
goog.require('goog.tweak.TweakUi'); |
| 24 |
/** @suppress {extraRequire} needed for createRegistryEntries. */ |
| 25 |
goog.require('goog.tweak.testhelpers'); |
| 26 |
|
| 27 |
var root; |
| 28 |
var registry; |
| 29 |
var EXPECTED_ENTRIES_COUNT = 14; |
| 30 |
|
| 31 |
function setUp() { |
| 32 |
root = document.getElementById('root'); |
| 33 |
// Make both test cases use the same entries in order to be able to test that |
| 34 |
// having two UIs on the same page does not cause trouble. |
| 35 |
createRegistryEntries(''); |
| 36 |
registry = goog.tweak.getRegistry(); |
| 37 |
} |
| 38 |
|
| 39 |
function tearDown() { |
| 40 |
goog.tweak.activeBooleanGroup_ = null; |
| 41 |
// When debugging a single test, don't clear out the DOM. |
| 42 |
if (window.location.search.indexOf('runTests') == -1) { |
| 43 |
goog.dom.removeChildren(root); |
| 44 |
} |
| 45 |
} |
| 46 |
|
| 47 |
function tearDownPage() { |
| 48 |
// When debugging a single test, don't clear out the DOM. |
| 49 |
if (window.location.search.indexOf('runTests') != -1) { |
| 50 |
return; |
| 51 |
} |
| 52 |
// Create both registries for interactive testing. |
| 53 |
createRegistryEntries(''); |
| 54 |
registry = goog.tweak.getRegistry(); |
| 55 |
// Add an extra tweak for testing the creation of tweaks after the UI has |
| 56 |
// already been rendered. |
| 57 |
var entryCounter = 0; |
| 58 |
goog.tweak.registerButton( |
| 59 |
'CreateNewTweak', 'Creates a new tweak. Meant ' + |
| 60 |
'to simulate a tweak being registered in a lazy-loaded module.', |
| 61 |
function() { |
| 62 |
goog.tweak.registerBoolean( |
| 63 |
'Lazy' + ++entryCounter, 'Lazy-loaded tweak.'); |
| 64 |
}); |
| 65 |
goog.tweak.registerButton( |
| 66 |
'CreateNewTweakInNamespace1', |
| 67 |
'Creates a new tweak within a namespace. Meant to simulate a tweak ' + |
| 68 |
'being registered in a lazy-loaded module.', |
| 69 |
function() { |
| 70 |
goog.tweak.registerString( |
| 71 |
'foo.bar.Lazy' + ++entryCounter, 'Lazy-loaded tweak.'); |
| 72 |
}); |
| 73 |
goog.tweak.registerButton( |
| 74 |
'CreateNewTweakInNamespace2', |
| 75 |
'Creates a new tweak within a namespace. Meant to simulate a tweak ' + |
| 76 |
'being registered in a lazy-loaded module.', |
| 77 |
function() { |
| 78 |
goog.tweak.registerNumber( |
| 79 |
'foo.bar.baz.Lazy' + ++entryCounter, 'Lazy combo', 3, |
| 80 |
{validValues: [1, 2, 3], label: 'Lazy!'}); |
| 81 |
}); |
| 82 |
|
| 83 |
var label = document.createElement('h3'); |
| 84 |
goog.dom.setTextContent(label, 'TweakUi:'); |
| 85 |
root.appendChild(label); |
| 86 |
createUi(false); |
| 87 |
|
| 88 |
label = document.createElement('h3'); |
| 89 |
goog.dom.setTextContent(label, 'Collapsible:'); |
| 90 |
root.appendChild(label); |
| 91 |
createUi(true); |
| 92 |
} |
| 93 |
|
| 94 |
function createUi(collapsible) { |
| 95 |
var tweakUiElem = collapsible ? goog.tweak.TweakUi.createCollapsible() : |
| 96 |
goog.tweak.TweakUi.create(); |
| 97 |
root.appendChild(tweakUiElem); |
| 98 |
} |
| 99 |
|
| 100 |
function getAllEntryDivs() { |
| 101 |
return goog.dom.getElementsByTagNameAndClass( |
| 102 |
goog.dom.TagName.DIV, goog.tweak.TweakUi.ENTRY_CSS_CLASS_); |
| 103 |
} |
| 104 |
|
| 105 |
function getEntryDiv(entry) { |
| 106 |
var label = goog.tweak.TweakUi.getNamespacedLabel_(entry); |
| 107 |
var allDivs = getAllEntryDivs(); |
| 108 |
var ret; |
| 109 |
for (var i = 0, div; div = allDivs[i]; i++) { |
| 110 |
var divText = goog.dom.getTextContent(div); |
| 111 |
if (goog.string.startsWith(divText, label) && |
| 112 |
goog.string.contains(divText, entry.description)) { |
| 113 |
assertFalse('Found multiple divs matching entry ' + entry.getId(), !!ret); |
| 114 |
ret = div; |
| 115 |
} |
| 116 |
} |
| 117 |
assertTrue('getEntryDiv failed for ' + entry.getId(), !!ret); |
| 118 |
return ret; |
| 119 |
} |
| 120 |
|
| 121 |
function getEntryInput(entry) { |
| 122 |
var div = getEntryDiv(entry); |
| 123 |
return goog.dom.getElementsByTagName(goog.dom.TagName.INPUT, div)[0] || |
| 124 |
goog.dom.getElementsByTagName(goog.dom.TagName.SELECT, div)[0]; |
| 125 |
} |
| 126 |
|
| 127 |
function testCreate() { |
| 128 |
createUi(false); |
| 129 |
assertEquals( |
| 130 |
'Wrong number of entry divs.', EXPECTED_ENTRIES_COUNT, |
| 131 |
getAllEntryDivs().length); |
| 132 |
|
| 133 |
assertFalse( |
| 134 |
'checkbox should not be checked 1', getEntryInput(boolEntry).checked); |
| 135 |
assertTrue('checkbox should be checked 2', getEntryInput(boolEntry2).checked); |
| 136 |
// Enusre custom labels are being used. |
| 137 |
var html = |
| 138 |
goog.dom.getElementsByTagName(goog.dom.TagName.BUTTON)[0].innerHTML; |
| 139 |
assertTrue('Button label is wrong', html.indexOf('<btn>') > -1); |
| 140 |
html = getEntryDiv(numEnumEntry).innerHTML; |
| 141 |
assertTrue('Enum2 label is wrong', html.indexOf('second&') > -1); |
| 142 |
} |
| 143 |
|
| 144 |
function testToggleBooleanSetting() { |
| 145 |
boolEntry.setValue(true); |
| 146 |
createUi(false); |
| 147 |
|
| 148 |
assertTrue('checkbox should be checked', getEntryInput(boolEntry).checked); |
| 149 |
|
| 150 |
boolEntry.setValue(false); |
| 151 |
assertFalse( |
| 152 |
'checkbox should not be checked 1', getEntryInput(boolEntry).checked); |
| 153 |
} |
| 154 |
|
| 155 |
function testToggleStringSetting() { |
| 156 |
strEntry.setValue('val1'); |
| 157 |
createUi(false); |
| 158 |
|
| 159 |
assertEquals( |
| 160 |
'Textbox has wrong value 1', 'val1', getEntryInput(strEntry).value); |
| 161 |
|
| 162 |
strEntry.setValue('val2'); |
| 163 |
assertEquals( |
| 164 |
'Textbox has wrong value 2', 'val2', getEntryInput(strEntry).value); |
| 165 |
} |
| 166 |
|
| 167 |
function testToggleStringEnumSetting() { |
| 168 |
strEnumEntry.setValue('B'); |
| 169 |
createUi(false); |
| 170 |
|
| 171 |
assertEquals('wrong value 1', 'B', getEntryInput(strEnumEntry).value); |
| 172 |
|
| 173 |
strEnumEntry.setValue('C'); |
| 174 |
assertEquals('wrong value 2', 'C', getEntryInput(strEnumEntry).value); |
| 175 |
} |
| 176 |
|
| 177 |
|
| 178 |
function testToggleNumericSetting() { |
| 179 |
numEntry.setValue(3); |
| 180 |
createUi(false); |
| 181 |
|
| 182 |
assertEquals('wrong value 1', '3', getEntryInput(numEntry).value); |
| 183 |
|
| 184 |
numEntry.setValue(4); |
| 185 |
assertEquals('wrong value 2', '4', getEntryInput(numEntry).value); |
| 186 |
} |
| 187 |
|
| 188 |
function testToggleNumericEnumSetting() { |
| 189 |
numEnumEntry.setValue(2); |
| 190 |
createUi(false); |
| 191 |
|
| 192 |
assertEquals('wrong value 1', '2', getEntryInput(numEnumEntry).value); |
| 193 |
|
| 194 |
numEnumEntry.setValue(3); |
| 195 |
assertEquals('wrong value 2', '3', getEntryInput(numEnumEntry).value); |
| 196 |
} |
| 197 |
|
| 198 |
function testClickBooleanSetting() { |
| 199 |
createUi(false); |
| 200 |
|
| 201 |
var input = getEntryInput(boolEntry); |
| 202 |
input.checked = true; |
| 203 |
input.onchange(); |
| 204 |
assertTrue('setting should be true', boolEntry.getNewValue()); |
| 205 |
input.checked = false; |
| 206 |
input.onchange(); |
| 207 |
assertFalse('setting should be false', boolEntry.getNewValue()); |
| 208 |
} |
| 209 |
|
| 210 |
function testToggleDescriptions() { |
| 211 |
createUi(false); |
| 212 |
var toggleLink = goog.dom.getElementsByTagName(goog.dom.TagName.A, root)[0]; |
| 213 |
var heightBefore = root.offsetHeight; |
| 214 |
toggleLink.onclick(); |
| 215 |
assertTrue( |
| 216 |
'Expected div height to grow from toggle descriptions.', |
| 217 |
root.offsetHeight > heightBefore); |
| 218 |
toggleLink.onclick(); |
| 219 |
assertEquals( |
| 220 |
'Expected div height to revert from toggle descriptions.', heightBefore, |
| 221 |
root.offsetHeight); |
| 222 |
} |
| 223 |
|
| 224 |
function assertEntryOrder(entryId1, entryId2) { |
| 225 |
var entry1 = registry.getEntry(entryId1); |
| 226 |
var entry2 = registry.getEntry(entryId2); |
| 227 |
var div1 = getEntryDiv(entry1); |
| 228 |
var div2 = getEntryDiv(entry2); |
| 229 |
var order = goog.dom.compareNodeOrder(div1, div2); |
| 230 |
assertTrue(entry1.getId() + ' should be before ' + entry2.getId(), order < 0); |
| 231 |
} |
| 232 |
|
| 233 |
function testAddEntry() { |
| 234 |
createUi(false); |
| 235 |
goog.tweak.registerBoolean('Lazy1', 'Lazy-loaded tweak.'); |
| 236 |
goog.tweak.registerBoolean( |
| 237 |
'Lazy2', 'Lazy-loaded tweak.', |
| 238 |
/* defaultValue */ false, {restartRequired: false}); |
| 239 |
goog.tweak.beginBooleanGroup('LazyGroup', 'Lazy-loaded tweak.'); |
| 240 |
goog.tweak.registerBoolean('Lazy3', 'Lazy-loaded tweak.'); |
| 241 |
goog.tweak.endBooleanGroup(); |
| 242 |
|
| 243 |
assertEquals( |
| 244 |
'Wrong number of entry divs.', EXPECTED_ENTRIES_COUNT + 4, |
| 245 |
getAllEntryDivs().length); |
| 246 |
assertEntryOrder('Enum2', 'Lazy1'); |
| 247 |
assertEntryOrder('Lazy1', 'Lazy2'); |
| 248 |
assertEntryOrder('Lazy2', 'Num'); |
| 249 |
assertEntryOrder('BoolGroup', 'Lazy3'); |
| 250 |
} |
| 251 |
|
| 252 |
function testAddNamespacedEntries() { |
| 253 |
createUi(false); |
| 254 |
goog.tweak.beginBooleanGroup('NS.LazyGroup', 'Lazy-loaded tweak.'); |
| 255 |
goog.tweak.registerBoolean('NS.InGroup', 'Lazy-loaded tweak.'); |
| 256 |
goog.tweak.endBooleanGroup(); |
| 257 |
goog.tweak.registerBoolean('NS.Banana', 'Lazy-loaded tweak.'); |
| 258 |
goog.tweak.registerBoolean('NS.Apple', 'Lazy-loaded tweak.'); |
| 259 |
|
| 260 |
assertEquals( |
| 261 |
'Wrong number of entry divs.', EXPECTED_ENTRIES_COUNT + 5, |
| 262 |
getAllEntryDivs().length); |
| 263 |
assertEntryOrder('Enum2', 'NS.Apple'); |
| 264 |
assertEntryOrder('NS.Apple', 'NS.Banana'); |
| 265 |
assertEntryOrder('NS.Banana', 'NS.InGroup'); |
| 266 |
} |
| 267 |
|
| 268 |
function testCollapsibleIsLazy() { |
| 269 |
if (document.createEvent) { |
| 270 |
createUi(true); |
| 271 |
assertEquals('Expected no entry divs.', 0, getAllEntryDivs().length); |
| 272 |
var showLink = goog.dom.getElementsByTagName(goog.dom.TagName.A, root)[0]; |
| 273 |
var event = document.createEvent('MouseEvents'); |
| 274 |
event.initMouseEvent( |
| 275 |
'click', true, true, window, 0, 0, 0, 0, 0, false, false, false, false, |
| 276 |
0, null); |
| 277 |
showLink.dispatchEvent(event); |
| 278 |
assertEquals( |
| 279 |
'Wrong number of entry divs.', EXPECTED_ENTRIES_COUNT, |
| 280 |
getAllEntryDivs().length); |
| 281 |
} |
| 282 |
} |