koha-dev.rot13.org Git - srvgit/blob - t/cypress/integration/Agreements_spec.ts

   1 import { mount } from "@cypress/vue";
   2 const dayjs = require("dayjs"); /* Cannot use our calendar JS code, it's in an include file (!)
   3                                    Also note that moment.js is deprecated */
   4
   5 const dates = {
   6     today_iso: dayjs().format("YYYY-MM-DD"),
   7     today_us: dayjs().format("MM/DD/YYYY"),
   8     tomorrow_iso: dayjs().add(1, "day").format("YYYY-MM-DD"),
   9     tomorrow_us: dayjs().add(1, "day").format("MM/DD/YYYY"),
  10 };
  11 function get_agreement() {
  12     return {
  13         agreement_id: 1,
  14         closure_reason: "",
  15         description: "my first agreement",
  16         is_perpetual: false,
  17         license_info: "",
  18         name: "agreement 1",
  19         renewal_priority: "",
  20         status: "active",
  21         vendor_id: null,
  22         periods: [
  23             {
  24                 started_on: dates["today_iso"],
  25                 ended_on: dates["tomorrow_iso"],
  26                 cancellation_deadline: null,
  27                 notes: null,
  28             },
  29             {
  30                 started_on: dates["today_iso"],
  31                 ended_on: null,
  32                 cancellation_deadline: dates["tomorrow_iso"],
  33                 notes: "this is a note",
  34             },
  35         ],
  36         user_roles: [],
  37         agreement_licenses: [
  38             {
  39                 agreement_id: 1,
  40                 agreement_license_id: 3,
  41                 license: {
  42                     description: "license description",
  43                     license_id: 1,
  44                     name: "license name",
  45                     status: "expired",
  46                     type: "alliance"
  47                 },
  48                 license_id:1,
  49                 notes: "license notes",
  50                 physical_location: "cupboard",
  51                 status: "controlling",
  52                 uri: "license uri"
  53             },
  54             {
  55                 agreement_id: 1,
  56                 agreement_license_id: 4,
  57                 license: {
  58                     description: "second license description",
  59                     license_id: 2,
  60                     name: "second license name",
  61                     status: "expired",
  62                     type: "alliance"
  63                 },
  64                 license_id:2,
  65                 notes: "second license notes",
  66                 physical_location: "cupboard",
  67                 status: "future",
  68                 uri: "license uri"
  69             }
  70         ],
  71         agreement_relationships: [
  72             {
  73                 agreement_id: 1,
  74                 notes: 'related agreement notes',
  75                 related_agreement: {
  76                     agreement_id: 2,
  77                     description: "agreement description",
  78                     name: "agreement name"
  79                 },
  80                 related_agreement_id: 2,
  81                 relationship: "supersedes"
  82             }
  83         ],
  84         agreement_packages: [],
  85         documents: [
  86             {
  87                 agreement_id:1,
  88                 file_description: "file description",
  89                 file_name: "file.json",
  90                 notes: "file notes",
  91                 physical_location: "file physical location",
  92                 uri: "file uri",
  93                 uploaded_on: "2022-10-27T11:57:02+00:00"
  94             }
  95         ],
  96     };
  97 }
  98
  99 function get_licenses_to_relate() {
 100     return [
 101         {
 102             license_id: 1,
 103             description: "a license",
 104             name: "first license name"
 105         },
 106         {
 107             license_id: 2,
 108             description: "a second license",
 109             name: "second license name"
 110         },
 111         {
 112             license_id: 3,
 113             description: "a third license",
 114             name: "third license name"
 115         },
 116     ]
 117 }
 118
 119 describe("Agreement CRUD operations", () => {
 120     beforeEach(() => {
 121         cy.login("koha", "koha");
 122         cy.title().should("eq", "Koha staff interface");
 123     });
 124
 125     it("List agreements", () => {
 126         // GET agreements returns 500
 127         cy.intercept("GET", "/api/v1/erm/agreements", {
 128             statusCode: 500,
 129             error: "Something went wrong",
 130         });
 131         cy.visit("/cgi-bin/koha/erm/erm.pl");
 132         cy.get("#navmenulist").contains("Agreements").click();
 133         cy.get("main div[class='dialog alert']").contains(
 134             /Something went wrong/
 135         );
 136
 137         // GET agreements returns empty list
 138         cy.intercept("GET", "/api/v1/erm/agreements*", []);
 139         cy.visit("/cgi-bin/koha/erm/agreements");
 140         cy.get("#agreements_list").contains("There are no agreements defined");
 141
 142         // GET agreements returns something
 143         let agreement = get_agreement();
 144         let agreements = [agreement];
 145
 146         cy.intercept("GET", "/api/v1/erm/agreements*", {
 147             statusCode: 200,
 148             body: agreements,
 149             headers: {
 150                 "X-Base-Total-Count": "1",
 151                 "X-Total-Count": "1",
 152             },
 153         });
 154         cy.intercept("GET", "/api/v1/erm/agreements/*", agreement);
 155         cy.visit("/cgi-bin/koha/erm/agreements");
 156         cy.get("#agreements_list").contains("Showing 1 to 1 of 1 entries");
 157     });
 158
 159     it("Add agreement", () => {
 160         // No agreement, no license yet
 161         cy.intercept("GET", "/api/v1/erm/agreements", {
 162             statusCode: 200,
 163             body: [],
 164         });
 165         cy.intercept("GET", "/api/v1/erm/licenses", {
 166             statusCode: 200,
 167             body: [],
 168         });
 169
 170         // Click the button in the toolbar
 171         cy.visit("/cgi-bin/koha/erm/agreements");
 172         cy.contains("New agreement").click();
 173         cy.get("#agreements_add h2").contains("New agreement");
 174
 175         // Fill in the form for normal attributes
 176         let agreement = get_agreement();
 177
 178         cy.get("#agreements_add").contains("Submit").click();
 179         cy.get("input:invalid,textarea:invalid,select:invalid").should(
 180             "have.length",
 181             3
 182         );
 183         cy.get("#agreement_name").type(agreement.name);
 184         cy.get("#agreement_description").type(agreement.description);
 185         cy.get("#agreements_add").contains("Submit").click();
 186         cy.get("input:invalid,textarea:invalid,select:invalid").should(
 187             "have.length",
 188             1
 189         ); // name, description, status
 190         cy.get("#agreement_status .vs__search").type(
 191             agreement.status + "{enter}",
 192             { force: true }
 193         );
 194
 195         cy.contains("Add new period").click();
 196         cy.get("#agreements_add").contains("Submit").click();
 197         cy.get("input:invalid,textarea:invalid,select:invalid").should(
 198             "have.length",
 199             1
 200         ); // Start date
 201
 202         // Add new periods
 203         cy.contains("Add new period").click();
 204         cy.contains("Add new period").click();
 205         cy.get("#agreement_periods > fieldset").should("have.length", 3);
 206
 207         cy.get("#agreement_period_1").contains("Remove this period").click();
 208
 209         cy.get("#agreement_periods > fieldset").should("have.length", 2);
 210         cy.get("#agreement_period_0");
 211         cy.get("#agreement_period_1");
 212
 213         // Selecting the flatpickr values is a bit tedious here...
 214         // We have 3 date inputs per period
 215         cy.get("#ended_on_0+input").click();
 216         // Second flatpickr => ended_on for the first period
 217         cy.get(".flatpickr-calendar")
 218             .eq(1)
 219             .find("span.today")
 220             .click({ force: true }); // select today. No idea why we should force, but there is a random failure otherwise
 221
 222         cy.get("#started_on_0+input").click();
 223         cy.get(".flatpickr-calendar")
 224             .eq(0)
 225             .find("span.today")
 226             .next("span")
 227             .click(); // select tomorrow
 228
 229         cy.get("#ended_on_0").should("have.value", ""); // Has been reset correctly
 230
 231         cy.get("#started_on_0+input").click();
 232         cy.get(".flatpickr-calendar").eq(0).find("span.today").click(); // select today
 233         cy.get("#ended_on_0+input").click({ force: true }); // No idea why we should force, but there is a random failure otherwise
 234         cy.get(".flatpickr-calendar")
 235             .eq(1)
 236             .find("span.today")
 237             .next("span")
 238             .click(); // select tomorrow
 239
 240         // Second period
 241         cy.get("#started_on_1+input").click({ force: true });
 242         cy.get(".flatpickr-calendar").eq(3).find("span.today").click(); // select today
 243         cy.get("#cancellation_deadline_1+input").click();
 244         cy.get(".flatpickr-calendar")
 245             .eq(5)
 246             .find("span.today")
 247             .next("span")
 248             .click(); // select tomorrow
 249         cy.get("#notes_1").type("this is a note");
 250
 251         // TODO Add a new user
 252         // How to test a new window with cypresS?
 253         //cy.contains("Add new user").click();
 254         //cy.contains("Select user").click();
 255
 256         cy.get("#agreement_licenses").contains(
 257             "There are no licenses created yet"
 258         );
 259         cy.get("#agreement_relationships").contains(
 260             "There are no other agreements created yet"
 261         );
 262
 263         // Add new document
 264         cy.get("#documents").contains("Add new document").click();
 265         cy.get("#document_0 input[id=file_0]").click();
 266         cy.get('#document_0 input[id=file_0]').selectFile('t/cypress/fixtures/file.json');
 267         cy.get("#document_0 .file_information span").contains("file.json");
 268         cy.get('#document_0 input[id=file_description_0]').type('file description');
 269         cy.get('#document_0 input[id=physical_location_0]').type('file physical location');
 270         cy.get('#document_0 input[id=uri_0]').type('file URI');
 271         cy.get('#document_0 input[id=notes_0]').type('file notes');
 272
 273         // Submit the form, get 500
 274         cy.intercept("POST", "/api/v1/erm/agreements", {
 275             statusCode: 500,
 276             error: "Something went wrong",
 277         });
 278         cy.get("#agreements_add").contains("Submit").click();
 279         cy.get("main div[class='dialog alert']").contains(
 280             "Something went wrong: Internal Server Error"
 281         );
 282
 283         // Submit the form, success!
 284         cy.intercept("POST", "/api/v1/erm/agreements", {
 285             statusCode: 201,
 286             body: agreement,
 287         });
 288         cy.get("#agreements_add").contains("Submit").click();
 289         cy.get("main div[class='dialog message']").contains(
 290             "Agreement created"
 291         );
 292
 293         cy.intercept("GET", "/api/v1/erm/agreements", {
 294             statusCode: 200,
 295             body: [{ agreement_id: 1, description: "an existing agreement" }],
 296         });
 297
 298         // Add new license
 299         let licenses_to_relate = get_licenses_to_relate();
 300         let related_license = agreement.agreement_licenses[0];
 301         cy.intercept("GET", "/api/v1/erm/licenses", {
 302             statusCode: 200,
 303             body: licenses_to_relate,
 304         });
 305         cy.visit("/cgi-bin/koha/erm/agreements/add");
 306         cy.get("#agreement_licenses").contains("Add new license").click();
 307         cy.get("#agreement_license_0").contains("Agreement license 1");
 308         cy.get("#agreement_license_0 #license_id_0 .vs__search").type(
 309             related_license.license.name
 310         );
 311         cy.get("#agreement_license_0 #license_id_0 .vs__dropdown-menu li").eq(0).click( { force: true } ); //click first license suggestion
 312         cy.get("#agreement_license_0 #license_status_0 .vs__search").type(
 313             related_license.status + "{enter}",
 314             { force: true }
 315         );
 316         cy.get("#agreement_license_0 #license_location_0 .vs__search").type(
 317             related_license.physical_location + "{enter}",
 318             { force: true }
 319         );
 320         cy.get("#agreement_license_0 #license_notes_0").type(related_license.notes);
 321         cy.get("#agreement_license_0 #license_uri_0").type(related_license.uri);
 322
 323         // Add new related agreement
 324         let related_agreement = agreement.agreement_relationships[0];
 325         cy.intercept("GET", "/api/v1/erm/agreements", {
 326             statusCode: 200,
 327             body: cy.get_agreements_to_relate(),
 328         });
 329         cy.visit("/cgi-bin/koha/erm/agreements/add");
 330         cy.get("#agreement_relationships").contains("Add new related agreement").click();
 331         cy.get("#related_agreement_0").contains("Related agreement 1");
 332         cy.get("#related_agreement_0 #related_agreement_id_0 .vs__search").type(
 333             related_agreement.related_agreement.name
 334         );
 335         cy.get("#related_agreement_0 #related_agreement_id_0 .vs__dropdown-menu li").eq(0).click( { force: true } ); //click first agreement suggestion
 336         cy.get("#related_agreement_0 #related_agreement_notes_0").type(related_agreement.notes);
 337         cy.get("#related_agreement_0 #related_agreement_relationship_0 .vs__search").type(
 338             related_agreement.relationship + "{enter}",
 339             { force: true }
 340         );
 341     });
 342
 343     it("Edit agreement", () => {
 344         let licenses_to_relate = get_licenses_to_relate();
 345         let agreement = get_agreement();
 346         let agreements = [agreement];
 347
 348         // Intercept initial /agreements request once
 349         cy.intercept(
 350             {
 351                 method: "GET",
 352                 url: "/api/v1/erm/agreements",
 353                 times: 1
 354             },
 355             {
 356                 body: agreements
 357             }
 358         );
 359
 360         // Intercept follow-up 'search' request after entering /agreements
 361         cy.intercept("GET", "/api/v1/erm/agreements?_page*", {
 362             statusCode: 200,
 363             body: agreements,
 364             headers: {
 365                 "X-Base-Total-Count": "1",
 366                 "X-Total-Count": "1",
 367             },
 368         }).as("get-single-agreement-search-result");
 369         cy.visit("/cgi-bin/koha/erm/agreements");
 370
 371         // Intercept request after edit click
 372         cy.intercept("GET", "/api/v1/erm/agreements/*", agreement).as(
 373             "get-agreement"
 374         );
 375         // Intercept related licenses request after entering agreement edit
 376         cy.intercept("GET", "/api/v1/erm/licenses", {
 377             statusCode: 200,
 378             body: licenses_to_relate,
 379         }).as("get-related-licenses");
 380         // Intercept related agreements request after entering agreement edit
 381         cy.intercept("GET", "/api/v1/erm/agreements", {
 382             statusCode: 200,
 383             body: cy.get_agreements_to_relate(),
 384         }).as("get-related-agreements");
 385
 386         // Click the 'Edit' button from the list
 387         cy.get("#agreements_list table tbody tr:first")
 388             .contains("Edit")
 389             .click();
 390         cy.wait("@get-agreement");
 391         cy.wait(500); // Cypress is too fast! Vue hasn't populated the form yet!
 392         cy.get("#agreements_add h2").contains("Edit agreement");
 393
 394         // Form has been correctly filled in
 395         cy.get("#agreement_name").should("have.value", agreements[0].name);
 396         cy.get("#agreement_description").should(
 397             "have.value",
 398             agreements[0].description
 399         );
 400         cy.get("#agreement_status .vs__selected").contains("Active");
 401         cy.get("#agreement_is_perpetual_no").should("be.checked");
 402         cy.get("#started_on_0").invoke("val").should("eq", dates["today_iso"]);
 403         cy.get("#ended_on_0").invoke("val").should("eq", dates["tomorrow_iso"]);
 404         cy.get("#cancellation_deadline_0").invoke("val").should("eq", "");
 405         cy.get("#notes_0").should("have.value", "");
 406         cy.get("#started_on_1").invoke("val").should("eq", dates["today_iso"]);
 407         cy.get("#ended_on_1").invoke("val").should("eq", "");
 408         cy.get("#cancellation_deadline_1")
 409             .invoke("val")
 410             .should("eq", dates["tomorrow_iso"]);
 411         cy.get("#notes_1").should("have.value", "this is a note");
 412
 413         //Test related content
 414         cy.get("#agreement_license_0 #license_id_0 .vs__selected").contains("first license name");
 415         cy.get("#agreement_license_1 #license_id_1 .vs__selected").contains("second license name");
 416         cy.get("#document_0 .file_information span").contains("file.json" );
 417         cy.get("#related_agreement_0 #related_agreement_id_0 .vs__selected").contains("agreement name");
 418
 419         // Submit the form, get 500
 420         cy.intercept("PUT", "/api/v1/erm/agreements/*", {
 421             statusCode: 500,
 422             error: "Something went wrong",
 423         });
 424         cy.get("#agreements_add").contains("Submit").click();
 425         cy.get("main div[class='dialog alert']").contains(
 426             "Something went wrong: Internal Server Error"
 427         );
 428
 429         // Submit the form, success!
 430         cy.intercept("PUT", "/api/v1/erm/agreements/*", {
 431             statusCode: 200,
 432             body: agreement,
 433         });
 434         cy.get("#agreements_add").contains("Submit").click();
 435         cy.get("main div[class='dialog message']").contains(
 436             "Agreement updated"
 437         );
 438     });
 439
 440     it("Show agreement", () => {
 441         let agreement = get_agreement();
 442         let agreements = [agreement];
 443         // Click the "name" link from the list
 444         cy.intercept("GET", "/api/v1/erm/agreements*", {
 445             statusCode: 200,
 446             body: agreements,
 447             headers: {
 448                 "X-Base-Total-Count": "1",
 449                 "X-Total-Count": "1",
 450             },
 451         });
 452         cy.intercept("GET", "/api/v1/erm/agreements/*", agreement).as(
 453             "get-agreement"
 454         );
 455         cy.visit("/cgi-bin/koha/erm/agreements");
 456         let name_link = cy.get(
 457             "#agreements_list table tbody tr:first td:first a"
 458         );
 459         name_link.should(
 460             "have.text",
 461             agreement.name + " (#" + agreement.agreement_id + ")"
 462         );
 463         name_link.click();
 464         cy.wait("@get-agreement");
 465         cy.wait(500); // Cypress is too fast! Vue hasn't populated the form yet!
 466         cy.get("#agreements_show h2").contains(
 467             "Agreement #" + agreement.agreement_id
 468         );
 469
 470         // TODO There are more to test here:
 471         // Dates correctly formatted
 472         // Vendors displayed
 473         // AV's libs displayed
 474         // Tables for periods and users
 475     });
 476     it("Delete agreement", () => {
 477         let agreement = get_agreement();
 478         let agreements = [agreement];
 479
 480         // Click the 'Delete' button from the list
 481         cy.intercept("GET", "/api/v1/erm/agreements*", {
 482             statusCode: 200,
 483             body: agreements,
 484             headers: {
 485                 "X-Base-Total-Count": "1",
 486                 "X-Total-Count": "1",
 487             },
 488         });
 489         cy.intercept("GET", "/api/v1/erm/agreements/*", agreement);
 490         cy.visit("/cgi-bin/koha/erm/agreements");
 491
 492         cy.get("#agreements_list table tbody tr:first")
 493             .contains("Delete")
 494             .click();
 495         cy.get("#agreements_confirm_delete h2").contains("Delete agreement");
 496         cy.contains("Agreement name: " + agreement.name);
 497
 498         // Submit the form, get 500
 499         cy.intercept("DELETE", "/api/v1/erm/agreements/*", {
 500             statusCode: 500,
 501             error: "Something went wrong",
 502         });
 503         cy.contains("Yes, delete").click();
 504         cy.get("main div[class='dialog alert']").contains(
 505             "Something went wrong: Internal Server Error"
 506         );
 507
 508         // Submit the form, success!
 509         cy.intercept("DELETE", "/api/v1/erm/agreements/*", {
 510             statusCode: 204,
 511             body: null,
 512         });
 513         cy.contains("Yes, delete").click();
 514         cy.get("main div[class='dialog message']").contains(
 515             "Agreement deleted"
 516         );
 517     });
 518 });