aboutsummaryrefslogtreecommitdiff
path: root/contexts/data/lib/closure-library/closure/goog/testing/ui/rendererharness.js
blob: edd3405dba7121c379f4d4b4610599c04845b776 (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
// Copyright 2009 The Closure Library Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// All Rights Reserved

/**
 * @fileoverview A driver for testing renderers.
 *
 * @author nicksantos@google.com (Nick Santos)
 */

goog.provide('goog.testing.ui.RendererHarness');

goog.require('goog.Disposable');
goog.require('goog.dom.NodeType');
goog.require('goog.testing.asserts');



/**
 * A driver for testing renderers.
 *
 * @param {goog.ui.ControlRenderer} renderer A renderer to test.
 * @param {Element} renderParent The parent of the element where controls will
 *     be rendered.
 * @param {Element} decorateParent The parent of the element where controls will
 *     be decorated.
 * @constructor
 * @extends {goog.Disposable}
 */
goog.testing.ui.RendererHarness = function(renderer, renderParent,
    decorateParent) {
  goog.Disposable.call(this);

  /**
   * The renderer under test.
   * @type {goog.ui.ControlRenderer}
   * @private
   */
  this.renderer_ = renderer;

  /**
   * The parent of the element where controls will be rendered.
   * @type {Element}
   * @private
   */
  this.renderParent_ = renderParent;

  /**
   * The original HTML of the render element.
   * @type {string}
   * @private
   */
  this.renderHtml_ = renderParent.innerHTML;

  /**
   * Teh parent of the element where controls will be decorated.
   * @type {Element}
   * @private
   */
  this.decorateParent_ = decorateParent;

  /**
   * The original HTML of the decorated element.
   * @type {string}
   * @private
   */
  this.decorateHtml_ = decorateParent.innerHTML;
};
goog.inherits(goog.testing.ui.RendererHarness, goog.Disposable);


/**
 * A control to create by decoration.
 * @type {goog.ui.Control}
 * @private
 */
goog.testing.ui.RendererHarness.prototype.decorateControl_;


/**
 * A control to create by rendering.
 * @type {goog.ui.Control}
 * @private
 */
goog.testing.ui.RendererHarness.prototype.renderControl_;


/**
 * Whether all the necessary assert methods have been called.
 * @type {boolean}
 * @private
 */
goog.testing.ui.RendererHarness.prototype.verified_ = false;


/**
 * Attach a control and render its DOM.
 * @param {goog.ui.Control} control A control.
 * @return {Element} The element created.
 */
goog.testing.ui.RendererHarness.prototype.attachControlAndRender =
    function(control) {
  this.renderControl_ = control;

  control.setRenderer(this.renderer_);
  control.render(this.renderParent_);
  return control.getElement();
};


/**
 * Attach a control and decorate the element given in the constructor.
 * @param {goog.ui.Control} control A control.
 * @return {Element} The element created.
 */
goog.testing.ui.RendererHarness.prototype.attachControlAndDecorate =
    function(control) {
  this.decorateControl_ = control;

  control.setRenderer(this.renderer_);

  var child = this.decorateParent_.firstChild;
  assertEquals('The decorated node must be an element',
               goog.dom.NodeType.ELEMENT, child.nodeType);
  control.decorate(/** @type {Element} */ (child));
  return control.getElement();
};


/**
 * Assert that the rendered element and the decorated element match.
 */
goog.testing.ui.RendererHarness.prototype.assertDomMatches = function() {
  assert('Both elements were not generated',
         !!(this.renderControl_ && this.decorateControl_));
  assertHTMLEquals(
      'Rendered control and decorated control produced different HTML',
      this.renderControl_.getElement().innerHTML,
      this.decorateControl_.getElement().innerHTML);
  this.verified_ = true;
};


/**
 * Destroy the harness, verifying that all assertions had been checked.
 * @override
 * @protected
 */
goog.testing.ui.RendererHarness.prototype.disposeInternal = function() {
  // If the harness was not verified appropriately, throw an exception.
  assert('Expected assertDomMatches to be called',
         this.verified_ || !this.renderControl_ || !this.decorateControl_);

  if (this.decorateControl_) {
    this.decorateControl_.dispose();
  }
  if (this.renderControl_) {
    this.renderControl_.dispose();
  }

  this.renderParent_.innerHTML = this.renderHtml_;
  this.decorateParent_.innerHTML = this.decorateHtml_;

  goog.testing.ui.RendererHarness.superClass_.disposeInternal.call(this);
};