test/spec/mkws-pazpar2.js

   1 /* Copyright (c) 2013 IndexData ApS. http://indexdata.com
   2  *
   3  * perform papzpar2 / pz2.js search & retrieve request in the browser
   4  *
   5  */
   6
   7 // get references from mkws.js, lazy evaluation
   8 var debug = function (text) {
   9         mkws.debug_function(text)
  10     }
  11
  12     // Define empty mkws_config for simple applications that don't define it.
  13 if (jasmine_config == null || typeof jasmine_config != 'object') {
  14     var jasmine_config = {};
  15 }
  16
  17 /* check config for jasmine test
  18  *
  19  * you can override the default values in the config
  20  * object: jasmine_config = {};
  21  *
  22  */
  23 function init_jasmine_config() {
  24
  25     var jasmine_config_default = {
  26         search_query: "freebsd",
  27         max_time: 16,
  28         // in seconds
  29         expected_hits: 80,
  30         // at least expected hit counter
  31         second: 1000,
  32         // miliseconds to seconds
  33         show_record_url: true,
  34         // check for valid URL in records
  35         dummy: false
  36     };
  37
  38     // use default values for undefined values
  39     for (var key in jasmine_config_default) {
  40         if (!jasmine_config.hasOwnProperty(key)) {
  41             jasmine_config[key] = jasmine_config_default[key];
  42         }
  43         debug("jasmine config: " + key + " => " + jasmine_config[key]);
  44     }
  45 }
  46
  47 var get_hit_counter = function () {
  48         // not yet here
  49         if ($("#mkwsPager").length == 0) return -1;
  50
  51         var found = $("#mkwsPager").text();
  52         var re = /\([A-Za-z]+:\s+([0-9]+)\)/;
  53         re.exec(found);
  54         var hits = -1;
  55
  56         if (RegExp.$1) {
  57             hits = parseInt(RegExp.$1);
  58             expect(hits).toBeGreaterThan(0);
  59         }
  60
  61         //debug("Hits: " + hits);
  62         return hits;
  63     }
  64
  65 describe("Init jasmine config", function () {
  66     it("jasmine was successfully initialized", function () {
  67         init_jasmine_config();
  68
  69         expect(jasmine_config.search_query).toMatch(/\w/);
  70         expect(jasmine_config.second).toBeGreaterThan(100);
  71         expect(jasmine_config.max_time).toBeGreaterThan(1);
  72         expect(jasmine_config.expected_hits).toBeGreaterThan(1);
  73     });
  74 });
  75
  76 describe("Check pazpar2 search", function () {
  77     it("pazpar2 was successfully initialize", function () {
  78         expect(mkws_config.error).toBe(undefined);
  79     });
  80
  81     it("validate HTML id's", function () {
  82         expect($("input#mkwsQuery").length).toBe(1);
  83         expect($("input#mkwsButton").length).toBe(1);
  84
  85         expect($("#mkwsNext").length).not.toBe(1);
  86         expect($("#mkwsPrev").length).not.toBe(1);
  87     });
  88
  89     it("run search query", function () {
  90         var search_query = jasmine_config.search_query; // short hit counter with some paging
  91         $("input#mkwsQuery").val(search_query);
  92         debug("set search query: " + search_query)
  93         expect($("input#mkwsQuery").val()).toMatch("^" + search_query + "$");
  94
  95         if (mkws_config.use_service_proxy) {
  96             // wait for service proxy auth
  97             waitsFor(function () {
  98                 return mkws.authenticated;
  99             }, "SP auth done", 10 * jasmine_config.second);
 100         } else {
 101             debug("running raw pp2, don't wait for mkws auth");
 102         }
 103
 104         runs(function () {
 105             debug("Click on submit button");
 106             var click = $("input#mkwsButton").trigger("click");
 107             expect(click.length).toBe(1);
 108         })
 109     });
 110 });
 111
 112
 113 /*
 114  * This part runs in background. It should be rewritten with
 115  * async jasmine functions
 116  *
 117  */
 118 describe("Check pazpar2 navigation", function () {
 119     // Asynchronous part
 120     it("check running search next/prev", function () {
 121         expect($("#mkwsPager").length).toBe(1);
 122
 123         function my_click(id, time) {
 124             setTimeout(function () {
 125                 debug("trigger click on id: " + id);
 126                 var click = $(id).trigger("click");
 127
 128                 debug("next/prev: " + id + " click is success: " + click.length);
 129                 expect(click.length).toBe(1);
 130             }, time * jasmine_config.second);
 131         }
 132
 133         waitsFor(function () {
 134             return $("div#mkwsPager div:nth-child(2) a").length >= 2 ? true : false;
 135         }, "Expect next link 2", 10 * jasmine_config.second);
 136
 137         runs(function () {
 138             // click next/prev after N seconds
 139             my_click("#mkwsNext", 0);
 140         });
 141
 142         waitsFor(function () {
 143             return $("div#mkwsPager div:nth-child(2) a").length >= 3 ? true : false;
 144         }, "Expect next link 3", 5 * jasmine_config.second);
 145
 146         runs(function () {
 147             // click next/prev after N seconds
 148             my_click("#mkwsNext", 0);
 149             my_click("#mkwsPrev", 0.2);
 150         });
 151     });
 152 });
 153
 154 describe("Check pazpar2 hit counter", function () {
 155     it("check running search hit counter", function () {
 156         var max_time = jasmine_config.max_time; // in seconds
 157         var expected_hits = jasmine_config.expected_hits; // at least expected hit counter
 158         var hits = 0;
 159
 160         waitsFor(function () {
 161             hits = get_hit_counter();
 162
 163             return hits > expected_hits;
 164         }, "Expect " + expected_hits + " hits", max_time * jasmine_config.second);
 165
 166
 167         runs(function () {
 168             debug("mkws pager found records: '" + hits + "'");
 169             expect($("#mkwsPager").length).toBe(1);
 170             expect(hits).toBeGreaterThan(expected_hits);
 171         });
 172     });
 173 });
 174
 175 describe("Check Termlist", function () {
 176     it("found Termlist", function () {
 177         var termlist = $("div#mkwsTermlists");
 178         debug("Termlist success: " + termlist.length);
 179         expect(termlist.length).toBe(1);
 180
 181         waitsFor(function () {
 182             return $("div#mkwsFacetSources").length == 1 ? true : false;
 183         }, "check for facet sources", 2 * jasmine_config.second);
 184
 185
 186         // everything displayed?
 187         runs(function () {
 188             var sources = $("div#mkwsFacetSources");
 189             debug("Termlist sources success: " + sources.length);
 190             expect(sources.length).toBe(1);
 191
 192             var subjects = $("div#mkwsFacetSubjects");
 193             expect(subjects.length).toBe(1);
 194
 195             var authors = $("div#mkwsFacetAuthors");
 196             expect(authors.length).toBe(1);
 197         });
 198
 199         waitsFor(function () {
 200             return $("div#mkwsFacetAuthors div.term").length >= 2 ? true : false;
 201         }, "At least one author link displayed", 4 * jasmine_config.second);
 202
 203         runs(function () {
 204             expect($("div#mkwsFacetAuthors div.term").length).toBeGreaterThan(1);
 205         });
 206     });
 207
 208     it("limit search to first author", function () {
 209         var hits_all_targets = get_hit_counter();
 210         var author_number = 2; // 2=first author
 211         var author_name = $("div#mkwsFacetAuthors div.term:nth-child(" + author_number + ") a").text();
 212         // do not click on author with numbers, e.g.: "Bower, James M. Beeman, David, 1938-"
 213         // do not click on author names without a comma, e.g.: "Joe Barbara"
 214         if (author_name.match(/[0-9].+[0-9]/) || !author_name.match(/,/)) {
 215             author_number++;
 216         }
 217
 218         var click = $("div#mkwsFacetAuthors div.term:nth-child(" + author_number + ") a").trigger("click");
 219         debug("limit author click is success: " + click.length);
 220         expect(click.length).toBe(1);
 221
 222         waitsFor(function () {
 223             return get_hit_counter() < hits_all_targets ? true : false;
 224         }, "Limited author search for less than " + hits_all_targets + " hits", 6 * jasmine_config.second);
 225
 226         runs(function () {
 227             var hits_single_target = get_hit_counter();
 228             debug("get less hits for authors: " + hits_all_targets + " > " + hits_single_target);
 229             expect(hits_all_targets).toBeGreaterThan(hits_single_target);
 230         });
 231     });
 232
 233     it("limit search to first source", function () {
 234         var hits_all_targets = get_hit_counter();
 235         var source_number = 2; // 2=first source
 236         // do not click on wikipedia link - no author or subject facets possible
 237         var terms = $("div#mkwsFacetSources div.term a");
 238         for (var i = 0; i < terms.length; i++) {
 239             if (terms[i].text.match(/wikipedia/i)) {
 240                 debug("ignore source facet: " + terms[i].text);
 241                 source_number++;
 242             } else {
 243                 break;
 244             }
 245         }
 246
 247         var click = $("div#mkwsFacetSources div.term:nth-child(" + source_number + ") a").trigger("click");
 248         debug("limit source click " + (source_number - 1) + " is success: " + click.length);
 249         expect(click.length).toBe(1);
 250
 251         waitsFor(function () {
 252             if ($("div#mkwsNavi").length && $("div#mkwsNavi").text().match(/Source: /)) {
 253                 return true;
 254             } else {
 255                 return false;
 256             }
 257         }, "Search for source in navi bar", jasmine_config.second);
 258
 259         // Note: it may happens that limited source search returns the same number of hits
 260         // as before. Thats not really an error, but unfortunate
 261         waitsFor(function () {
 262             return get_hit_counter() <= hits_all_targets ? true : false;
 263         }, "Limited source search for less than " + hits_all_targets + " hits", 5 * jasmine_config.second);
 264
 265         runs(function () {
 266             var hits_single_target = get_hit_counter();
 267             debug("get less hits for sources: " + hits_all_targets + " > " + hits_single_target);
 268             expect(hits_all_targets).not.toBeLessThan(hits_single_target);
 269         });
 270     });
 271 });
 272
 273 describe("Show record", function () {
 274     var record_number = 1; // the Nth record in hit list
 275     it("show record author", function () {
 276         var click = $("div#mkwsRecords div.record:nth-child(" + record_number + ") a").trigger("click");
 277         debug("show record click is success: " + click.length);
 278         expect(click.length).toBe(1);
 279
 280         // wait until the record pops up
 281         waitsFor(function () {
 282             var show = $("div#mkwsRecords div.record:nth-child(" + record_number + ") div");
 283             return show != null && show.length ? true : false;
 284         }, "wait some miliseconds to show up a record", 2 * jasmine_config.second);
 285
 286         runs(function () {
 287             debug("show record pop up");
 288             expect($("div#mkwsRecords div.record:nth-child(" + record_number + ") div")).not.toBe(null);
 289         });
 290     });
 291
 292     it("extract URL", function () {
 293         if (jasmine_config.show_record_url == false) {
 294             debug("ignore test for URL in record")
 295             return;
 296         }
 297
 298         var urls = $("div#mkwsRecords div.record:nth-child(" + record_number + ") div table tbody tr td a");
 299         debug("number of extracted URL from record: " + urls.length);
 300         for (var i = 0; i < urls.length; i++) {
 301             debug("URL: " + urls[i].href);
 302             expect(urls[i].href).not.toBe(null);
 303             expect(urls[i].href).toMatch(/^https?:\/\/[a-z0-9]+\.[0-9a-z].*\//i);
 304             expect(urls[i].href).toBe(urls[i].text);
 305         }
 306     });
 307 });
 308
 309 describe("Check switch menu Records/Targets", function () {
 310     it("check mkwsSwitch", function () {
 311         expect($("div#mkwsSwitch").length).toBe(1);
 312
 313         // expect 2 clickable links
 314         expect($("div#mkwsSwitch a").length).toBe(2);
 315     });
 316
 317     it("switch to target view", function () {
 318         var click = $("a#mkwsSwitch_targets").trigger("click");
 319         debug("target view click is success: " + click.length);
 320         expect(click.length).toBe(1);
 321
 322         // now the target table must be visible
 323         expect($("div#mkwsBytarget").is(":visible")).toBe(true);
 324         expect($("div#mkwsRecords").is(":visible")).toBe(false);
 325
 326         // wait a half second, to show the target view
 327         var time = (new Date).getTime();
 328         waitsFor(function () {
 329             return (new Date).getTime() - time > 700 ? true : false;
 330         }, "wait some miliseconds", 1 * jasmine_config.second);
 331
 332         // look for table header
 333         runs(function () {
 334             expect($("div#mkwsBytarget").html()).toMatch(/Target ID/);
 335         });
 336     });
 337
 338     it("switch back to record view", function () {
 339         var click = $("a#mkwsSwitch_records").trigger("click");
 340         debug("record view click is success: " + click.length);
 341         expect(click.length).toBe(1);
 342
 343         // now the target table must be visible
 344         expect($("div#mkwsBytarget").is(":visible")).toBe(false);
 345         expect($("div#mkwsRecords").is(":visible")).toBe(true);
 346     });
 347 });
 348
 349 describe("Check status client counter", function () {
 350     function get_time() {
 351         var date = new Date();
 352         return date.getTime();
 353     }
 354     var time = get_time();
 355
 356     it("check status clients", function () {
 357         waitsFor(function () {
 358             var clients = $("div#mkwsStat span.clients");
 359             if (clients.length == 1 && clients.text().match("0/1$")) {
 360                 return true;
 361             } else {
 362                 return false;
 363             }
 364
 365         }, "wait for Active clients: 0/1", 4 * jasmine_config.second);
 366
 367 /*
 368         runs(function () {
 369             var clients = $("div#mkwsStat span.clients");
 370             debug("span.clients: " + clients.text());
 371             expect(clients.text()).toEqual("0/1");
 372         });
 373         */
 374
 375     });
 376
 377 });
 378
 379 /* dummy EOF */
 380 describe("All tests are done", function () {
 381     it(">>> hooray <<<", function () {});
 382 });