summaryrefslogtreecommitdiff
path: root/netwerk/test/unit/test_URIs2.js
blob: 201473f58f2238c240b44e9808be42d866e936e4 (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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */
Components.utils.import("resource://gre/modules/NetUtil.jsm");

var gIoService = Components.classes["@mozilla.org/network/io-service;1"]
                           .getService(Components.interfaces.nsIIOService);


// Run by: cd objdir;  make -C netwerk/test/ xpcshell-tests    
// or: cd objdir; make SOLO_FILE="test_URIs2.js" -C netwerk/test/ check-one

// This is a clone of test_URIs.js, with a different set of test data in gTests.
// The original test data in test_URIs.js was split between test_URIs and test_URIs2.js
// because test_URIs.js was running for too long on slow platforms, causing 
// intermittent timeouts.

// Relevant RFCs: 1738, 1808, 2396, 3986 (newer than the code)
// http://greenbytes.de/tech/webdav/rfc3986.html#rfc.section.5.4
// http://greenbytes.de/tech/tc/uris/

// TEST DATA
// ---------
var gTests = [
  { spec:    "view-source:about:blank",
    scheme:  "view-source",
    prePath: "view-source:",
    path:    "about:blank",
    ref:     "",
    nsIURL:  false, nsINestedURI: true, immutable: true },
  { spec:    "view-source:http://www.mozilla.org/",
    scheme:  "view-source",
    prePath: "view-source:",
    path:    "http://www.mozilla.org/",
    ref:     "",
    nsIURL:  false, nsINestedURI: true, immutable: true },
  { spec:    "x-external:",
    scheme:  "x-external",
    prePath: "x-external:",
    path:    "",
    ref:     "",
    nsIURL:  false, nsINestedURI: false },
  { spec:    "x-external:abc",
    scheme:  "x-external",
    prePath: "x-external:",
    path:    "abc",
    ref:     "",
    nsIURL:  false, nsINestedURI: false },
  { spec:    "http://www2.example.com/",
    relativeURI: "a/b/c/d",
    scheme:  "http",
    prePath: "http://www2.example.com",
    path:    "/a/b/c/d",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  // relative URL testcases from http://greenbytes.de/tech/webdav/rfc3986.html#rfc.section.5.4
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g:h",
    scheme:  "g",
    prePath: "g:",
    path:    "h",
    ref:     "",
    nsIURL:  false, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "./g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g/",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g/",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "/g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "?y",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/d;p?y",
    ref:     "",// fix
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g?y",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g?y",
    ref:     "",// fix
    specIgnoringRef: "http://a/b/c/g?y",
    hasRef:  false,
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "#s",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/d;p?q#s",
    ref:     "s",// fix
    specIgnoringRef: "http://a/b/c/d;p?q",
    hasRef:  true,
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g#s",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g#s",
    ref:     "s",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g?y#s",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g?y#s",
    ref:     "s",
    nsIURL:  true, nsINestedURI: false },
  /*
    Bug xxxxxx - we return a path of b/c/;x
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: ";x",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/d;x",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  */
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g;x",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g;x",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g;x?y#s",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g;x?y#s",
    ref:     "s",
    nsIURL:  true, nsINestedURI: false },
  /*
    Can't easily specify a relative URI of "" to the test code
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/d",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  */
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: ".",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "./",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "..",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "../",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "../g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "../..",
    scheme:  "http",
    prePath: "http://a",
    path:    "/",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "../../",
    scheme:  "http",
    prePath: "http://a",
    path:    "/",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "../../g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },

  // abnormal examples
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "../../../g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "../../../../g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },

  // coalesce 
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "/./g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "/../g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g.",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g.",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: ".g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/.g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g..",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g..",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "..g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/..g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: ".",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "./../g",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/g",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "./g/.",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g/",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g/./h",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g/h",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g/../h",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/h",
    ref:     "",// fix
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g;x=1/./y",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/g;x=1/y",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "http://a/b/c/d;p?q",
    relativeURI: "g;x=1/../y",
    scheme:  "http",
    prePath: "http://a",
    path:    "/b/c/y",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  // protocol-relative http://tools.ietf.org/html/rfc3986#section-4.2
  { spec:    "http://www2.example.com/",
    relativeURI: "//www3.example2.com/bar",
    scheme:  "http",
    prePath: "http://www3.example2.com",
    path:    "/bar",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
  { spec:    "https://www2.example.com/",
    relativeURI: "//www3.example2.com/bar",
    scheme:  "https",
    prePath: "https://www3.example2.com",
    path:    "/bar",
    ref:     "",
    nsIURL:  true, nsINestedURI: false },
];

var gHashSuffixes = [
  "#",
  "#myRef",
  "#myRef?a=b",
  "#myRef#",
  "#myRef#x:yz"
];

// TEST HELPER FUNCTIONS
// ---------------------
function do_info(text, stack) {
  if (!stack)
    stack = Components.stack.caller;

  dump( "\n" +
       "TEST-INFO | " + stack.filename + " | [" + stack.name + " : " +
       stack.lineNumber + "] " + text + "\n");
}

// Checks that the URIs satisfy equals(), in both possible orderings.
// Also checks URI.equalsExceptRef(), because equal URIs should also be equal
// when we ignore the ref.
// 
// The third argument is optional. If the client passes a third argument
// (e.g. todo_check_true), we'll use that in lieu of do_check_true.
function do_check_uri_eq(aURI1, aURI2, aCheckTrueFunc) {
  if (!aCheckTrueFunc) {
    aCheckTrueFunc = do_check_true;
  }

  do_info("(uri equals check: '" + aURI1.spec + "' == '" + aURI2.spec + "')");
  aCheckTrueFunc(aURI1.equals(aURI2));
  do_info("(uri equals check: '" + aURI2.spec + "' == '" + aURI1.spec + "')");
  aCheckTrueFunc(aURI2.equals(aURI1));

  // (Only take the extra step of testing 'equalsExceptRef' when we expect the
  // URIs to really be equal.  In 'todo' cases, the URIs may or may not be
  // equal when refs are ignored - there's no way of knowing in general.)
  if (aCheckTrueFunc == do_check_true) {
    do_check_uri_eqExceptRef(aURI1, aURI2, aCheckTrueFunc);
  }
}

// Checks that the URIs satisfy equalsExceptRef(), in both possible orderings.
//
// The third argument is optional. If the client passes a third argument
// (e.g. todo_check_true), we'll use that in lieu of do_check_true.
function do_check_uri_eqExceptRef(aURI1, aURI2, aCheckTrueFunc) {
  if (!aCheckTrueFunc) {
    aCheckTrueFunc = do_check_true;
  }

  do_info("(uri equalsExceptRef check: '" +
          aURI1.spec + "' == '" + aURI2.spec + "')");
  aCheckTrueFunc(aURI1.equalsExceptRef(aURI2));
  do_info("(uri equalsExceptRef check: '" +
          aURI2.spec + "' == '" + aURI1.spec + "')");
  aCheckTrueFunc(aURI2.equalsExceptRef(aURI1));
}

// Checks that the given property on aURI matches the corresponding property
// in the test bundle (or matches some function of that corresponding property,
// if aTestFunctor is passed in).
function do_check_property(aTest, aURI, aPropertyName, aTestFunctor) {
  if (aTest[aPropertyName]) {
    var expectedVal = aTestFunctor ?
                      aTestFunctor(aTest[aPropertyName]) :
                      aTest[aPropertyName];

    do_info("testing " + aPropertyName + " of " +
            (aTestFunctor ? "modified '" : "'" ) + aTest.spec +
            "' is '" + expectedVal + "'");
    do_check_eq(aURI[aPropertyName], expectedVal);
  }
}

// Test that a given URI parses correctly into its various components.
function do_test_uri_basic(aTest) {
  var URI;

  do_info("Basic tests for " + aTest.spec + " relative URI: " + aTest.relativeURI);

  try {
    URI = NetUtil.newURI(aTest.spec);
  } catch(e) {
    do_info("Caught error on parse of" + aTest.spec + " Error: " + e.result);
    if (aTest.fail) {
      do_check_eq(e.result, aTest.result);
      return;
    }
    do_throw(e.result);
  }

  if (aTest.relativeURI) {
    var relURI;

    try {
      relURI = gIoService.newURI(aTest.relativeURI, null, URI);
    } catch (e) {
      do_info("Caught error on Relative parse of " + aTest.spec + " + " + aTest.relativeURI +" Error: " + e.result);
      if (aTest.relativeFail) {
        do_check_eq(e.result, aTest.relativeFail);
        return;
      }
      do_throw(e.result);
    }
    do_info("relURI.path = " + relURI.path + ", was " + URI.path);
    URI = relURI;
    do_info("URI.path now = " + URI.path);
  }

  // Sanity-check
  do_info("testing " + aTest.spec + " equals a clone of itself");
  do_check_uri_eq(URI, URI.clone());
  do_check_uri_eqExceptRef(URI, URI.cloneIgnoringRef());
  do_info("testing " + aTest.spec + " instanceof nsIURL");
  do_check_eq(URI instanceof Ci.nsIURL, aTest.nsIURL);
  do_info("testing " + aTest.spec + " instanceof nsINestedURI");
  do_check_eq(URI instanceof Ci.nsINestedURI,
              aTest.nsINestedURI);

  do_info("testing that " + aTest.spec + " throws or returns false " +
          "from equals(null)");
  // XXXdholbert At some point it'd probably be worth making this behavior
  // (throwing vs. returning false) consistent across URI implementations.
  var threw = false;
  var isEqualToNull;
  try {
    isEqualToNull = URI.equals(null);
  } catch(e) {
    threw = true;
  }
  do_check_true(threw || !isEqualToNull);


  // Check the various components
  do_check_property(aTest, URI, "scheme");
  do_check_property(aTest, URI, "prePath");
  do_check_property(aTest, URI, "path");
  do_check_property(aTest, URI, "ref");
  do_check_property(aTest, URI, "port");
  do_check_property(aTest, URI, "username");
  do_check_property(aTest, URI, "password");
  do_check_property(aTest, URI, "host");
  do_check_property(aTest, URI, "specIgnoringRef");
  if ("hasRef" in aTest) {
    do_info("testing hasref: " + aTest.hasRef + " vs " + URI.hasRef);
    do_check_eq(aTest.hasRef, URI.hasRef);
  }
}

// Test that a given URI parses correctly when we add a given ref to the end
function do_test_uri_with_hash_suffix(aTest, aSuffix) {
  do_info("making sure caller is using suffix that starts with '#'");
  do_check_eq(aSuffix[0], "#");

  var origURI = NetUtil.newURI(aTest.spec);
  var testURI;

  if (aTest.relativeURI) {
    try {
      origURI = gIoService.newURI(aTest.relativeURI, null, origURI);
    } catch (e) {
      do_info("Caught error on Relative parse of " + aTest.spec + " + " + aTest.relativeURI +" Error: " + e.result);
      return;
    }
    try {
      testURI = gIoService.newURI(aSuffix, null, origURI);
    } catch (e) {
      do_info("Caught error adding suffix to " + aTest.spec + " + " + aTest.relativeURI + ", suffix " + aSuffix + " Error: " + e.result);
      return;
    }
  } else {
    testURI = NetUtil.newURI(aTest.spec + aSuffix);
  }

  do_info("testing " + aTest.spec + " with '" + aSuffix + "' appended " +
           "equals a clone of itself");
  do_check_uri_eq(testURI, testURI.clone());

  do_info("testing " + aTest.spec +
          " doesn't equal self with '" + aSuffix + "' appended");

  do_check_false(origURI.equals(testURI));

  do_info("testing " + aTest.spec +
          " is equalExceptRef to self with '" + aSuffix + "' appended");
  do_check_uri_eqExceptRef(origURI, testURI);

  do_check_eq(testURI.hasRef, true);

  if (!origURI.ref) {
    // These tests fail if origURI has a ref
    do_info("testing cloneIgnoringRef on " + testURI.spec +
            " is equal to no-ref version but not equal to ref version");
    var cloneNoRef = testURI.cloneIgnoringRef();
    do_check_uri_eq(cloneNoRef, origURI);
    do_check_false(cloneNoRef.equals(testURI));
  }

  do_check_property(aTest, testURI, "scheme");
  do_check_property(aTest, testURI, "prePath");
  if (!origURI.ref) {
    // These don't work if it's a ref already because '+' doesn't give the right result
    do_check_property(aTest, testURI, "path",
                      function(aStr) { return aStr + aSuffix; });
    do_check_property(aTest, testURI, "ref",
                      function(aStr) { return aSuffix.substr(1); });
  }
}

// Tests various ways of setting & clearing a ref on a URI.
function do_test_mutate_ref(aTest, aSuffix) {
  do_info("making sure caller is using suffix that starts with '#'");
  do_check_eq(aSuffix[0], "#");

  var refURIWithSuffix    = NetUtil.newURI(aTest.spec + aSuffix);
  var refURIWithoutSuffix = NetUtil.newURI(aTest.spec);

  var testURI             = NetUtil.newURI(aTest.spec);

  // First: Try setting .ref to our suffix
  do_info("testing that setting .ref on " + aTest.spec +
          " to '" + aSuffix + "' does what we expect");
  testURI.ref = aSuffix;
  do_check_uri_eq(testURI, refURIWithSuffix);
  do_check_uri_eqExceptRef(testURI, refURIWithoutSuffix);

  // Now try setting .ref but leave off the initial hash (expect same result)
  var suffixLackingHash = aSuffix.substr(1);
  if (suffixLackingHash) { // (skip this our suffix was *just* a #)
    do_info("testing that setting .ref on " + aTest.spec +
            " to '" + suffixLackingHash + "' does what we expect");
    testURI.ref = suffixLackingHash;
    do_check_uri_eq(testURI, refURIWithSuffix);
    do_check_uri_eqExceptRef(testURI, refURIWithoutSuffix);
  }

  // Now, clear .ref (should get us back the original spec)
  do_info("testing that clearing .ref on " + testURI.spec +
          " does what we expect");
  testURI.ref = "";
  do_check_uri_eq(testURI, refURIWithoutSuffix);
  do_check_uri_eqExceptRef(testURI, refURIWithSuffix);

  if (!aTest.relativeURI) {
    // TODO: These tests don't work as-is for relative URIs.

    // Now try setting .spec directly (including suffix) and then clearing .ref
    var specWithSuffix = aTest.spec + aSuffix;
    do_info("testing that setting spec to " +
            specWithSuffix + " and then clearing ref does what we expect");
    testURI.spec = specWithSuffix;
    testURI.ref = "";
    do_check_uri_eq(testURI, refURIWithoutSuffix);
    do_check_uri_eqExceptRef(testURI, refURIWithSuffix);

    // XXX nsIJARURI throws an exception in SetPath(), so skip it for next part.
    if (!(testURI instanceof Ci.nsIJARURI)) {
      // Now try setting .path directly (including suffix) and then clearing .ref
      // (same as above, but with now with .path instead of .spec)
      testURI = NetUtil.newURI(aTest.spec);

      var pathWithSuffix = aTest.path + aSuffix;
      do_info("testing that setting path to " +
              pathWithSuffix + " and then clearing ref does what we expect");
      testURI.path = pathWithSuffix;
      testURI.ref = "";
      do_check_uri_eq(testURI, refURIWithoutSuffix);
      do_check_uri_eqExceptRef(testURI, refURIWithSuffix);

      // Also: make sure that clearing .path also clears .ref
      testURI.path = pathWithSuffix;
      do_info("testing that clearing path from " + 
              pathWithSuffix + " also clears .ref");
      testURI.path = "";
      do_check_eq(testURI.ref, "");
    }
  }
}

// Tests that normally-mutable properties can't be modified on
// special URIs that are known to be immutable.
function do_test_immutable(aTest) {
  do_check_true(aTest.immutable);

  var URI = NetUtil.newURI(aTest.spec);
  // All the non-readonly attributes on nsIURI.idl:
  var propertiesToCheck = ["spec", "scheme", "userPass", "username", "password",
                           "hostPort", "host", "port", "path", "ref"];

  propertiesToCheck.forEach(function(aProperty) {
    var threw = false;
    try {
      URI[aProperty] = "anothervalue";
    } catch(e) {
      threw = true;
    }

    do_info("testing that setting '" + aProperty +
            "' on immutable URI '" + aTest.spec + "' will throw");
    do_check_true(threw);
  });
}


// TEST MAIN FUNCTION
// ------------------
function run_test()
{
  // UTF-8 check - From bug 622981
  // ASCII
  let base = gIoService.newURI("http://example.org/xenia?", null, null);
  let resolved = gIoService.newURI("?x", null, base);
  let expected = gIoService.newURI("http://example.org/xenia?x",
                                  null, null);
  do_info("Bug 662981: ACSII - comparing " + resolved.spec + " and " + expected.spec);
  do_check_true(resolved.equals(expected));

  // UTF-8 character "è"
  // Bug 622981 was triggered by an empty query string
  base = gIoService.newURI("http://example.org/xènia?", null, null);
  resolved = gIoService.newURI("?x", null, base);
  expected = gIoService.newURI("http://example.org/xènia?x",
                              null, null);
  do_info("Bug 662981: UTF8 - comparing " + resolved.spec + " and " + expected.spec);
  do_check_true(resolved.equals(expected));

  gTests.forEach(function(aTest) {
    // Check basic URI functionality
    do_test_uri_basic(aTest);

    if (!aTest.fail) {
      // Try adding various #-prefixed strings to the ends of the URIs
      gHashSuffixes.forEach(function(aSuffix) {
          do_test_uri_with_hash_suffix(aTest, aSuffix);
          if (!aTest.immutable) {
            do_test_mutate_ref(aTest, aSuffix);
          }
        });

      // For URIs that we couldn't mutate above due to them being immutable:
      // Now we check that they're actually immutable.
      if (aTest.immutable) {
        do_test_immutable(aTest);
      }
    }
  });
}