summaryrefslogtreecommitdiffstats
path: root/addon-sdk/source/test/addons/places/lib/test-places-favicon.js
blob: 669c66e64dd1779fe51f9dad1dd60b2fd07c754b (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
232
233
234
235
236
237
238
239
240
241
242
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

'use strict';

module.metadata = {
  'engines': {
    'Firefox': '*'
  }
};

const { Cc, Ci, Cu } = require('chrome');
const { getFavicon } = require('sdk/places/favicon');
const tabs = require('sdk/tabs');
const open = tabs.open;
const port = 8099;
const host = 'http://localhost:' + port;
const { onFaviconChange, serve, binFavicon } = require('./favicon-helpers');
const { once } = require('sdk/system/events');
const { resetPlaces } = require('./places-helper');
const faviconService = Cc["@mozilla.org/browser/favicon-service;1"].
                         getService(Ci.nsIFaviconService);

exports.testStringGetFaviconCallbackSuccess = function*(assert) {
  let name = 'callbacksuccess'
  let srv = yield makeServer(name);
  let url = host + '/' + name + '.html';
  let favicon = host + '/' + name + '.ico';
  let tab;

  let wait = new Promise(resolve => {
    onFaviconChange(url).then((faviconUrl) => {
      getFavicon(url, (url) => {
        assert.equal(favicon, url, 'Callback returns correct favicon url');
        resolve();
      });
    });
  });

  assert.pass("Opening tab");

  open({
    url: url,
    onOpen: (newTab) => tab = newTab,
    inBackground: true
  });

  yield wait;

  assert.pass("Complete");

  yield complete(tab, srv);
};

exports.testStringGetFaviconCallbackFailure = function*(assert) {
  let name = 'callbackfailure';
  let srv = yield makeServer(name);
  let url = host + '/' + name + '.html';
  let tab;

  let wait = waitAndExpire(url);

  assert.pass("Opening tab");

  open({
    url: url,
    onOpen: (newTab) => tab = newTab,
    inBackground: true
  });

  yield wait;

  assert.pass("Getting favicon");

  yield new Promise(resolve => {
    getFavicon(url, (url) => {
      assert.equal(url, null, 'Callback returns null');
      resolve();
    });
  });

  assert.pass("Complete");

  yield complete(tab, srv);
};

exports.testStringGetFaviconPromiseSuccess = function*(assert) {
  let name = 'promisesuccess'
  let srv = yield makeServer(name);
  let url = host + '/' + name + '.html';
  let favicon = host + '/' + name + '.ico';
  let tab;

  let wait = onFaviconChange(url);

  assert.pass("Opening tab");

  open({
    url: url,
    onOpen: (newTab) => tab = newTab,
    inBackground: true
  });

  yield wait;

  assert.pass("Getting favicon");

  yield getFavicon(url).then((url) => {
    assert.equal(url, favicon, 'Callback returns null');
  }, () => {
    assert.fail('Reject should not be called');
  });

  assert.pass("Complete");

  yield complete(tab, srv);
};

exports.testStringGetFaviconPromiseFailure = function*(assert) {
  let name = 'promisefailure'
  let srv = yield makeServer(name);
  let url = host + '/' + name + '.html';
  let tab;

  let wait = waitAndExpire(url);

  assert.pass("Opening tab");

  open({
    url: url,
    onOpen: (newTab) => tab = newTab,
    inBackground: true
  });

  yield wait;

  assert.pass("Getting favicon");

  yield getFavicon(url).then(invalidResolve(assert), validReject(assert, 'expired url'));

  assert.pass("Complete");

  yield complete(tab, srv);
};

exports.testTabsGetFaviconPromiseSuccess = function*(assert) {
  let name = 'tabs-success'
  let srv = yield makeServer(name);
  let url = host + '/' + name + '.html';
  let favicon = host + '/' + name + '.ico';
  let tab;

  let iconPromise = onFaviconChange(url);

  assert.pass("Opening tab");

  open({
    url: url,
    onOpen: (newTab) => tab = newTab,
    inBackground: true
  });

  yield iconPromise;

  assert.pass("Getting favicon");

  yield getFavicon(tab).then((url) => {
    assert.equal(url, favicon, "getFavicon should return url for tab");
  });

  assert.pass("Complete");

  yield complete(tab, srv);
};


exports.testTabsGetFaviconPromiseFailure = function*(assert) {
  let name = 'tabs-failure'
  let srv = yield makeServer(name);
  let url = host + '/' + name + '.html';
  let tab;

  let wait = waitAndExpire(url);

  assert.pass("Opening tab");

  open({
    url: url,
    onOpen: (newTab) => tab = newTab,
    inBackground: true
  });

  yield wait;

  assert.pass("Getting favicon");

  yield getFavicon(tab).then(invalidResolve(assert), validReject(assert, 'expired tab'));

  assert.pass("Complete");

  yield complete(tab, srv);
};

exports.testRejects = function*(assert) {
  yield getFavicon({})
    .then(invalidResolve(assert), validReject(assert, 'Object'));

  yield getFavicon(null)
    .then(invalidResolve(assert), validReject(assert, 'null'));

  yield getFavicon(undefined)
    .then(invalidResolve(assert), validReject(assert, 'undefined'));

  yield getFavicon([])
    .then(invalidResolve(assert), validReject(assert, 'Array'));
};

var invalidResolve = (assert) => () => assert.fail('Promise should not be resolved successfully');
var validReject = (assert, name) => () => assert.pass(name + ' correctly rejected');

var makeServer = (name) => serve({
  name: name,
  favicon: binFavicon,
  port: port,
  host: host
});

var waitAndExpire = (url) => new Promise(resolve => {
  onFaviconChange(url).then(() => {
    once('places-favicons-expired', resolve);
    faviconService.expireAllFavicons();
  });
});

var complete = (tab, srv) => new Promise(resolve => {
  tab.close(() => {
    resetPlaces(() => {
      srv.stop(resolve);
    });
  });
});