test/spec/mkws-pazpar2.js

   1 /* Copyright (c) 2013-2014 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.log("Jasmine: " + text)
  10     }
  11
  12     // Define empty jasmine_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 var jasmine_status = {
  18     source_click: 0
  19 };
  20
  21 /* check config for jasmine test
  22  *
  23  * you can override the default values in the config
  24  * object: jasmine_config = {};
  25  *
  26  */
  27 function init_jasmine_config() {
  28
  29     var jasmine_config_default = {
  30         search_query: "freebsd",
  31         max_time: 16,
  32         // in seconds
  33         expected_hits: 80,
  34         // at least expected hit counter
  35         second: 1000,
  36         // miliseconds to seconds
  37         show_record_url: true,
  38         // check for valid URL in records
  39         dummy: false
  40     };
  41
  42     // use default values for undefined values
  43     for (var key in jasmine_config_default) {
  44         if (!jasmine_config.hasOwnProperty(key)) {
  45             jasmine_config[key] = jasmine_config_default[key];
  46         }
  47         debug("jasmine config: " + key + " => " + jasmine_config[key]);
  48     }
  49
  50     mkws.jasmine_done = false;
  51 }
  52
  53 var get_hit_counter = function () {
  54         // not yet here
  55         if ($(".mkwsPager").length == 0) return -1;
  56
  57         var found = $(".mkwsPager").text();
  58         var re = /\([A-Za-z]+:\s+([0-9]+)\)/;
  59         re.exec(found);
  60         var hits = -1;
  61
  62         if (RegExp.$1) {
  63             hits = parseInt(RegExp.$1);
  64             expect(hits).toBeGreaterThan(0);
  65         }
  66
  67         //debug("Hits: " + hits);
  68         return hits;
  69     }
  70
  71 describe("Init jasmine config", function () {
  72     it("jasmine was successfully initialized", function () {
  73         init_jasmine_config();
  74
  75         expect(jasmine_config.search_query).toMatch(/\w/);
  76         expect(jasmine_config.second).toBeGreaterThan(100);
  77         expect(jasmine_config.max_time).toBeGreaterThan(1);
  78         expect(jasmine_config.expected_hits).toBeGreaterThan(1);
  79     });
  80 });
  81
  82 describe("Check MOTD before search", function () {
  83     // Check that the MOTD has been moved into its container, and
  84     // is visible before the search.
  85     // the mkwsMOTD div was originally inside a testMOTD div, which should
  86     // now be empty
  87     // Note that the testMOTD is a regular div, and uses #testMOTD,
  88     // since the automagic class-making does not apply to it.
  89     it("MOTD is hidden", function () {
  90         expect($(".mkwsMOTD").length).toBe(1);
  91         expect($("#testMOTD").length).toBe(1);
  92         expect($("#testMOTD").text()).toMatch("^ *$");
  93     });
  94
  95     it("mkwsMOTDContainer has received the text", function () {
  96         expect($(".mkwsMOTDContainer").length).toBe(1);
  97         expect($(".mkwsMOTDContainer").text()).toMatch(/MOTD/);
  98     });
  99 });
 100
 101 describe("Check pazpar2 search", function () {
 102     it("pazpar2 was successfully initialized", function () {
 103         expect(mkws.config.error).toBe(undefined);
 104     });
 105
 106     it("validate HTML id's", function () {
 107         expect($("input.mkwsQuery").length).toBe(1);
 108         expect($("input.mkwsButton").length).toBe(1);
 109
 110         expect($(".mkwsNext").length).not.toBe(1);
 111         expect($(".mkwsPrev").length).not.toBe(1);
 112     });
 113
 114     it("run search query", function () {
 115         var search_query = jasmine_config.search_query; // short hit counter with some paging
 116         $("input.mkwsQuery").val(search_query);
 117         debug("set search query: " + search_query)
 118         expect($("input.mkwsQuery").val()).toMatch("^" + search_query + "$");
 119
 120         if (mkws.config.use_service_proxy) {
 121             // wait for service proxy auth
 122             waitsFor(function () {
 123                 return mkws.authenticated;
 124             }, "SP auth done", 10 * jasmine_config.second);
 125         } else {
 126             debug("running raw pp2, don't wait for mkws auth");
 127         }
 128
 129         runs(function () {
 130             debug("Click on submit button");
 131             $("input.mkwsButton").trigger("click");
 132         })
 133     });
 134 });
 135
 136 describe("Check MOTD after search", function () {
 137     it("MOTD is hidden", function () {
 138         expect($(".mkwsMOTD").length).toBe(1);
 139         expect($(".mkwsMOTD").is(":hidden")).toBe(true);
 140         debug("motd t=" + $(".mkwsMOTD").text());
 141         debug("motd v=" + $(".mkwsMOTD").is(":visible"));
 142     });
 143 });
 144
 145
 146 /*
 147  * This part runs in background. It should be rewritten with
 148  * async jasmine functions
 149  *
 150  */
 151 describe("Check pazpar2 navigation", function () {
 152     // Asynchronous part
 153     it("check running search next/prev", function () {
 154         expect($(".mkwsPager").length).toBe(1);
 155
 156         function my_click(id, time) {
 157             setTimeout(function () {
 158                 debug("trigger click on id: " + id);
 159                 $(id).trigger("click");
 160             }, time * jasmine_config.second);
 161         }
 162
 163         waitsFor(function () {
 164             return $("div.mkwsPager div:nth-child(2) a").length >= 2 ? true : false;
 165         }, "Expect next link 2", 10 * jasmine_config.second);
 166
 167         runs(function () {
 168             // click next/prev after N seconds
 169             my_click(".mkwsNext", 0);
 170         });
 171
 172         waitsFor(function () {
 173             return $("div.mkwsPager div:nth-child(2) a").length >= 3 ? true : false;
 174         }, "Expect next link 3", 5 * jasmine_config.second);
 175
 176         runs(function () {
 177             // click next/prev after N seconds
 178             my_click(".mkwsNext", 0);
 179             my_click(".mkwsPrev", 0.2);
 180         });
 181     });
 182 });
 183
 184 describe("Check pazpar2 hit counter", function () {
 185     it("check running search hit counter", function () {
 186         var max_time = jasmine_config.max_time; // in seconds
 187         var expected_hits = jasmine_config.expected_hits; // at least expected hit counter
 188         var hits = 0;
 189
 190         waitsFor(function () {
 191             hits = get_hit_counter();
 192             return hits > expected_hits;
 193         }, "Expect " + expected_hits + " hits", max_time * jasmine_config.second);
 194
 195         runs(function () {
 196             debug("mkws pager found records: '" + hits + "'");
 197             expect($(".mkwsPager").length).toBe(1);
 198             expect(hits).toBeGreaterThan(expected_hits);
 199         });
 200     });
 201 });
 202
 203 describe("Check Termlist", function () {
 204     it("found Termlist", function () {
 205         var termlist = $("div.mkwsTermlists");
 206         debug("Termlist success: " + termlist.length);
 207         expect(termlist.length).toBe(1);
 208
 209         waitsFor(function () {
 210             return $("div.mkwsFacet[data-mkws-facet='xtargets']").length == 1 ? true : false;
 211         }, "check for facet sources", 4 * jasmine_config.second);
 212
 213         // everything displayed?
 214         runs(function () {
 215             var sources = $("div.mkwsFacet[data-mkws-facet='xtargets']");
 216             debug("Termlist sources success: " + sources.length);
 217             expect(sources.length).toBe(1);
 218
 219             var subjects = $("div.mkwsFacet[data-mkws-facet='subject']");
 220             expect(subjects.length).toBe(1);
 221
 222             var authors = $("div.mkwsFacet[data-mkws-facet='author']");
 223             expect(authors.length).toBe(1);
 224         });
 225
 226         waitsFor(function () {
 227             return $("div.mkwsFacet[data-mkws-facet='author'] div.term").length >= 2 ? true : false;
 228         }, "At least one author link displayed", 4 * jasmine_config.second);
 229
 230         runs(function () {
 231             expect($("div.mkwsFacet[data-mkws-facet='author'] div.term").length).toBeGreaterThan(1);
 232         });
 233     });
 234 });
 235
 236 describe("Check Author Facets", function () {
 237     it("limit search to first author", function () {
 238         if (mkws.config.disable_facet_authors_search) {
 239             debug("Facets: ignore limit search for authors");
 240             return;
 241         }
 242
 243         var hits_all_targets = get_hit_counter();
 244         var author_number = 2; // 2=first author
 245         // do not click on author with numbers, e.g.: "Bower, James M. Beeman, David, 1938-"
 246         // do not click on author names without a comma, e.g.: "Joe Barbara"
 247         // because searching on such authors won't find anything.
 248         runs(function () {
 249             var terms = $("div.mkwsFacet[data-mkws-facet='author'] div.term a");
 250             for (var i = 0; i < terms.length; i++) {
 251                 var term = $(terms[i]).text();
 252                 if (term.match(/[0-9].+[0-9]/i) || !term.match(/,/)) {
 253                     debug("ignore author facet: " + term);
 254                     author_number++;
 255                 } else {
 256                     break;
 257                 }
 258             }
 259             if ($("div.mkwsFacet[data-mkws-facet='author'] div.term:nth-child(" + author_number + ") a").text().length == 0) {
 260                 debug("No good authors found. Not clicking on the bad ones");
 261                 return;
 262             }
 263
 264             debug("Clicking on author (" + author_number + ") " + $("div.mkwsFacet[data-mkws-facet='author'] div.term:nth-child(" + author_number + ") a").text());
 265             $("div.mkwsFacet[data-mkws-facet='author'] div.term:nth-child(" + author_number + ") a").trigger("click");
 266         });
 267
 268         waitsFor(function () {
 269             var hits_single_target = get_hit_counter();
 270             return hits_single_target > 0 && hits_single_target < hits_all_targets ? true : false;
 271         }, "Limited author search for less than " + hits_all_targets + " hits", 6 * jasmine_config.second);
 272
 273         runs(function () {
 274             var hits_single_target = get_hit_counter();
 275             debug("get less hits for authors: " + hits_all_targets + " > " + hits_single_target);
 276             expect(hits_all_targets).toBeGreaterThan(hits_single_target);
 277         });
 278     });
 279
 280     it("check for active clients after limited author search", function () {
 281         waitsFor(function () {
 282             var clients = $("div#mkwsStat span.clients");
 283             //debug("clients: " + clients.text());
 284             return clients.length == 1 && clients.text().match("/[1-9]+[0-9]+$");
 285         }, "wait for Active clients: x/y", 5 * jasmine_config.second);
 286
 287         runs(function () {
 288             var clients = $("div#mkwsStat span.clients");
 289             debug("span.clients: " + clients.text());
 290             expect(clients.text()).toMatch("/[1-9]+[0-9]+$");
 291
 292             // exact match of active clients (e.g. a SP misconfiguration)
 293             if (jasmine_config.active_clients) {
 294                 debug("check for " + jasmine_config.active_clients + " active connections");
 295                 expect(clients.text()).toMatch(" [0-9]+/" + jasmine_config.active_clients + "$");
 296             }
 297         });
 298     });
 299 });
 300
 301 describe("Check Source Facets", function () {
 302     it("limit search to first source", function () {
 303         var hits_all_targets = get_hit_counter();
 304         var source_number = 2; // 2=first source
 305         // wait for a stat response
 306         var waitcount = 0;
 307         // do not click on wikipedia link - no author or subject facets possible
 308         var link = "div.mkwsFacet[data-mkws-facet='xtargets'] div.term a";
 309
 310         // wait for a visible source link in facets
 311         waitsFor(function () {
 312             var terms = $(link);
 313             return terms && terms.length > 0;
 314         }, "wait for source facets after author search", 5 * jasmine_config.second);
 315
 316
 317         runs(function () {
 318             var terms = $(link);
 319             for (var i = 0; i < terms.length; i++) {
 320                 var term = $(terms[i]).text();
 321                 debug("check for good source: " + term);
 322
 323                 if (term.match(/wikipedia/i)) {
 324                     debug("ignore source facet: " + term);
 325                     source_number++;
 326                 } else {
 327                     break;
 328                 }
 329             }
 330             debug("Source counter: " + terms.length + ", select: " + (source_number - 1));
 331
 332             if ($("div.mkwsFacet[data-mkws-facet='xtargets'] div.term:nth-child(" + source_number + ") a").text().length == 0) {
 333                 debug("No good source found. Not clicking on the bad ones");
 334                 return;
 335             }
 336
 337             debug("click on source link nth-child(): " + source_number);
 338             $("div.mkwsFacet[data-mkws-facet='xtargets'] div.term:nth-child(" + source_number + ") a").trigger("click");
 339
 340             $(".mkwsPager").bind("DOMNodeInserted DOMNodeRemoved propertychange", function () {
 341                 waitcount++;
 342                 debug("DOM wait for stat: " + waitcount);
 343             });
 344         });
 345
 346         waitsFor(function () {
 347             if ($("div.mkwsNavi").length && $("div.mkwsNavi").text().match(/(Source|datenquelle|kilder): /i)) {
 348                 return true;
 349             } else {
 350                 return false;
 351             }
 352         }, "Search for source in navi bar", 4 * jasmine_config.second);
 353
 354         // Note: it may happens that limited source search returns the same number of hits
 355         // as before. Thats not really an error, but unfortunate
 356         waitsFor(function () {
 357             var hits_single_target = get_hit_counter();
 358
 359             return waitcount >= 2 && hits_single_target > 0 && hits_single_target <= hits_all_targets ? true : false;
 360         }, "Limited source search for less than " + hits_all_targets + " hits", 5 * jasmine_config.second);
 361
 362         runs(function () {
 363             var hits_single_target = get_hit_counter();
 364             debug("get less hits for sources: " + hits_all_targets + " > " + hits_single_target);
 365             expect(hits_all_targets).not.toBeLessThan(hits_single_target);
 366             jasmine_status.source_click = 1;
 367
 368             $(".mkwsPager").unbind("DOMNodeInserted DOMNodeRemoved propertychange");
 369         });
 370     });
 371 });
 372
 373
 374 describe("Check record list", function () {
 375     it("check for single active client", function () {
 376         if (!jasmine_status.source_click) {
 377             debug("skip clients check due missing source click");
 378             return;
 379         }
 380
 381         waitsFor(function () {
 382             var clients = $("div#mkwsStat span.clients");
 383             //debug("clients: " + clients.text());
 384             return clients.length == 1 && clients.text().match("/1$");
 385         }, "wait for Active clients: x/1", 5 * jasmine_config.second);
 386
 387         runs(function () {
 388             var clients = $("div#mkwsStat span.clients");
 389             debug("span.clients: " + clients.text());
 390             expect(clients.text()).toMatch("/1$");
 391         });
 392     });
 393
 394     it("got a record", function () {
 395         var linkaddr = "div.mkwsRecords div.record:nth-child(1) a";
 396
 397         waitsFor(function () {
 398             // remove + insert node: must be at least 2
 399             return $(linkaddr).length > 0;
 400         }, "wait until we see a new record", 2.5 * jasmine_config.second);
 401
 402         runs(function () {
 403             expect($(linkaddr).length).toBeGreaterThan(0);
 404         });
 405     });
 406 });
 407
 408 describe("Show record", function () {
 409     var record_number = 1; // the Nth record in hit list
 410     it("show record author", function () {
 411         var click = $("div.mkwsRecords div.record:nth-child(" + record_number + ") a").trigger("click");
 412         debug("show record click is success: " + click.length);
 413         expect(click.length).toBe(1);
 414
 415         // wait until the record pops up
 416         waitsFor(function () {
 417             var show = $("div.mkwsRecords div.record:nth-child(" + record_number + ") > div.details");
 418             //debug("poprecord: " + (show ? show.length : -1) + " " + $("div.mkwsRecords div.record").text());
 419             return show != null && show.length ? true : false;
 420         }, "wait some miliseconds to show up a record", 2 * jasmine_config.second);
 421
 422         runs(function () {
 423             debug("show record pop up");
 424             expect($("div.mkwsRecords div.record:nth-child(" + record_number + ") div")).not.toBe(null);
 425         });
 426     });
 427
 428     it("extract URL", function () {
 429         if (jasmine_config.show_record_url == false) {
 430             debug("ignore test for URL in record")
 431             return;
 432         }
 433
 434         var urls = $("div.mkwsRecords div.record:nth-child(" + record_number + ") div table tbody tr td a");
 435         debug("number of extracted URL from record: " + urls.length);
 436         // expect(urls.length).toBeGreaterThan(0); // LoC has records without links
 437         for (var i = 0; i < urls.length; i++) {
 438             var url = $(urls[i]);
 439             debug("URL: " + url.attr('href') + " text: " + url.text());
 440
 441             expect(url.attr('href')).not.toBe(null);
 442             expect(url.attr('href')).toMatch(/^https?:\/\/[a-z0-9\-]+\.[0-9a-z].*\//i);
 443             expect(url.text()).not.toBe("");
 444         }
 445     });
 446 });
 447
 448 describe("Check switch menu Records/Targets", function () {
 449     it("check mkwsSwitch", function () {
 450         expect($("div.mkwsSwitch").length).toBe(1);
 451
 452         // expect 2 clickable links
 453         expect($("div.mkwsSwitch a").length).toBe(2);
 454     });
 455
 456     it("switch to target view", function () {
 457         $("div.mkwsSwitch").children('a').eq(1).trigger("click");
 458
 459         // now the target table must be visible
 460         expect($("div.mkwsBytarget").is(":visible")).toBe(true);
 461         expect($("div.mkwsRecords").is(":visible")).toBe(false);
 462
 463         // wait a half second, to show the target view
 464         var time = (new Date).getTime();
 465         waitsFor(function () {
 466             return (new Date).getTime() - time > 700 ? true : false;
 467         }, "wait some miliseconds", 1 * jasmine_config.second);
 468
 469         // look for table header
 470         runs(function () {
 471             expect($("div.mkwsBytarget").html()).toMatch(/Target ID/);
 472         });
 473     });
 474
 475     it("switch back to record view", function () {
 476         $("div.mkwsSwitch").children('a').eq(0).trigger("click");
 477
 478         // now the target table must be visible
 479         expect($("div.mkwsBytarget").is(":visible")).toBe(false);
 480         expect($("div.mkwsRecords").is(":visible")).toBe(true);
 481     });
 482 });
 483
 484 describe("Check status client counter", function () {
 485     function get_time() {
 486         var date = new Date();
 487         return date.getTime();
 488     }
 489     var time = get_time();
 490
 491     it("check status clients", function () {
 492         if (!jasmine_status.source_click) {
 493             debug("skip clients check due missing source click");
 494             return;
 495         }
 496
 497         waitsFor(function () {
 498             var clients = $("div#mkwsStat span.clients");
 499             debug("clients: " + clients.text());
 500             if (clients.length == 1 && clients.text().match("0/1$")) {
 501                 return true;
 502             } else {
 503                 return false;
 504             }
 505         }, "wait for Active clients: 0/1", 4 * jasmine_config.second);
 506
 507         runs(function () {
 508             var clients = $("div#mkwsStat span.clients");
 509             debug("span.clients: " + clients.text());
 510             expect(clients.text()).toMatch("0/1$");
 511         });
 512     });
 513 });
 514
 515 /* done */
 516 describe("All tests are done", function () {
 517     it(">>> hooray <<<", function () {
 518         mkws.jasmine_done = true;
 519     });
 520 });