Upstream cypress improvements (#13898)

* Improve Cypress helper functions with log messages (#13749) [ci skip]

- Adds helpful log message to various helper functions in `frontend/test/__support__/cypress.js`.
    - `--- Logging in as ${user} ---` to `signIn()`
    - `--- Signing out ---` to `signOut()` and
    - `--- Restore Data Set ---` to `restore()`

* Disable video uploads for successful Cypress tests (#13747)

* https://docs.cypress.io/guides/references/configuration.html#Videos

* Add Cypress file download testing (#13430)

* Add `read-excel-file` library

* Add "file download" config to `cypress-plugins.js`

* Switch to SheetJS for xlsx/csv testing and upgrade Cypress because of https://github.com/cypress-io/cypress/pull/7382




Co-authored-by: Damon P. Cortesi <d.lifehacker@gmail.com>

* Quarantine `field.cy.spec.js` (#13896)

Full quarantine list in #13682.

* Fix smoke tests (#13897)

Failure happened because of the obsolete references to the now updated actions/drill-through popover menu.

frontend/test/__support__/cypress.js

@@ -36,15 +36,19 @@ export const USERS = {
 };
 
 export function signIn(user = "admin") {
+  cy.log(`**--- Logging in as ${user} ---**`);
   cy.request("POST", "/api/session", USERS[user]);
 }
+
 export function signOut() {
+  cy.log(`**--- Signing out ---**`);
   cy.clearCookie("metabase.SESSION");
 }
 
 export function signInAsAdmin() {
   signIn("admin");
 }
+
 export function signInAsNormalUser() {
   signIn("normal");
 }
@@ -52,7 +56,9 @@ export function signInAsNormalUser() {
 export function snapshot(name) {
   cy.request("POST", `/api/testing/snapshot/${name}`);
 }
+
 export function restore(name = "default") {
+  cy.log(`**--- Restore Data Set ---**`);
   cy.request("POST", `/api/testing/restore/${name}`);
 }
 

frontend/test/cypress-plugins.js

@@ -15,6 +15,10 @@ const webpack = require("@cypress/webpack-preprocessor");
 module.exports = (on, config) => {
   // `on` is used to hook into various events Cypress emits
   // `config` is the resolved Cypress config
+
+  /********************************************************************
+   **                          WEBPACK                               **
+   ********************************************************************/
   const { resolve } = require("../../webpack.config.js");
   const options = {
     webpackOptions: { resolve },

frontend/test/cypress.json

@@ -4,6 +4,7 @@
   "pluginsFile": "frontend/test/cypress-plugins.js",
   "integrationFolder": ".",
   "supportFile": "frontend/test/__support__/cypress.js",
+  "videoUploadOnPasses": false,
   "viewportHeight": 800,
   "viewportWidth": 1280,
   "retries": {

frontend/test/metabase-smoketest/user.cy.spec.js

@@ -6,10 +6,7 @@ describe("smoketest > user", () => {
   beforeEach(signInAsNormalUser);
 
   it("should be able to ask a custom questions", () => {
-    cy.visit("/");
-
-    cy.findByText("Ask a question").click();
-    cy.findByText("Simple question");
+    cy.visit("/question/new");
 
     cy.findByText("Custom question").click();
     cy.findByText("Sample Dataset").click();
@@ -48,7 +45,7 @@ describe("smoketest > user", () => {
     cy.findAllByText("Average of Rating")
       .last()
       .click();
-    cy.findByText("Ascending").click();
+    cy.get(".Icon-arrow_up").click();
 
     cy.get(".TableInteractive-cellWrapper--firstColumn")
       .last()
@@ -129,9 +126,7 @@ describe("smoketest > user", () => {
       .contains("0");
 
     cy.findAllByText("Average of Rating").click();
-    cy.get(".Icon-funnel_outline")
-      .closest("div")
-      .click();
+    cy.findByText("Filter by this column").click();
     cy.findByText("Equal to").click();
     cy.findByText("Greater than or equal to").click();
     cy.get("input[placeholder='Enter a number']").type("4");
@@ -139,7 +134,7 @@ describe("smoketest > user", () => {
 
     cy.get(".TableInteractive-cellWrapper--lastColumn")
       .eq(1)
-      .contains("4");
+      .contains("4.2");
 
     // Can minimize Filter dispay in header
 
@@ -188,6 +183,16 @@ describe("smoketest > user", () => {
     cy.findAllByText("Created At");
   });
 
+  /**
+   * NOTE: - There is a HIGH chance that there are still references to the old "drill-through"/actions popover
+   *         among the skipped tests. Because of the urgency to fix smoke tests (2020-11-26) there is not enough
+   *         time to fully commit to cleaning skipped tests as well.
+   *
+   *       - In general, all smoke tests need serious refactoring
+   *
+   * TODO: - Once that work starts, make sure to update obsolete references in popover!
+   */
+
   it.skip("should be able to create custom columns in the notebook editor", () => {
     cy.get(".Icon-notebook").click();
 
@@ -320,11 +325,11 @@ describe("smoketest > user", () => {
 
     cy.findByText("ID").click();
 
-    cy.findByText("Ascending");
-    cy.findByText("Descending");
+    cy.get(".Icon-arrow_up");
+    cy.get(".Icon-arrow_down");
     cy.findByText("Distincts");
     cy.findByText("Distribution").should("not.exist");
-    cy.get(".Icon-funnel_outline");
+    cy.get(".Icon-filter");
     cy.findByText("Formatting");
 
     // String column
@@ -333,11 +338,11 @@ describe("smoketest > user", () => {
       .last()
       .click();
 
-    cy.findByText("Ascending");
-    cy.findByText("Descending");
+    cy.get(".Icon-arrow_up");
+    cy.get(".Icon-arrow_down");
     cy.findByText("Distincts");
     cy.findByText("Distribution");
-    cy.get(".Icon-funnel_outline");
+    cy.get(".Icon-filter");
     cy.findByText("Formatting");
     cy.get(".PopoverBody")
       .findByText("Sum")
@@ -349,15 +354,15 @@ describe("smoketest > user", () => {
       .last()
       .click();
 
-    cy.findByText("Ascending");
-    cy.findByText("Descending");
+    cy.get(".Icon-arrow_up");
+    cy.get(".Icon-arrow_down");
     cy.findByText("Sum");
     cy.findByText("Min");
     cy.findByText("Max");
     cy.findByText("Distincts");
     cy.findByText("Sum over time");
     cy.findByText("Distribution");
-    cy.get(".Icon-funnel_outline");
+    cy.get(".Icon-filter");
     cy.findByText("Formatting");
 
     // Longitude column (first switch to people table)
@@ -371,15 +376,15 @@ describe("smoketest > user", () => {
 
     cy.findByText("Longitude").click();
 
-    cy.findByText("Ascending");
-    cy.findByText("Descending");
+    cy.get(".Icon-arrow_up");
+    cy.get(".Icon-arrow_down");
     cy.findByText("Sum");
     cy.findByText("Min");
     cy.findByText("Max");
     cy.findByText("Distincts");
     cy.findByText("Sum over time");
     cy.findByText("Distribution");
-    cy.get(".Icon-funnel_outline");
+    cy.get(".Icon-filter");
     cy.findByText("Formatting");
 
     // Boolean column contians appropriate options

frontend/test/metabase/scenarios/admin/datamodel/field.cy.spec.js

@@ -7,7 +7,8 @@ import {
   popover,
 } from "__support__/cypress";
 
-describe("scenarios > admin > datamodel > field", () => {
+// [quarantine] - intermittently failing, possibly due to a "flickering" element (re-rendering)
+describe.skip("scenarios > admin > datamodel > field", () => {
   beforeEach(() => {
     signInAsAdmin();
     withSampleDataset(({ ORDERS, ORDERS_ID }) => {

frontend/test/metabase/scenarios/question/downloads.cy.spec.js

+import { restore, signInAsAdmin } from "__support__/cypress";
+
+const xlsx = require("xlsx");
+
+// csv and Excel files have different sheet names, so define them here and we'll reuse it throughout
+const testCases = [
+  { type: "csv", firstSheetName: "Sheet1" },
+  { type: "xlsx", firstSheetName: "Query result" },
+];
+
+describe("scenarios > question > download", () => {
+  before(restore);
+  beforeEach(() => {
+    signInAsAdmin();
+  });
+
+  it("downloads Excel and CSV files", () => {
+    // let's download a binary file
+
+    cy.visit("/");
+    cy.findByText("Ask a question").click();
+    cy.findByText("Simple question").click();
+    cy.findByText("Saved Questions").click();
+    cy.findByText("Orders, Count").click();
+    cy.contains("18,760");
+    cy.get(".Icon-download").click();
+
+    // Programatically issue download requests for this query for both CSV and Excel
+
+    cy.wrap(testCases).each(testCase => {
+      const downloadClassName = `.Icon-${testCase.type}`;
+      const endpoint = `/api/dataset/${testCase.type}`;
+      const sheetName = testCase.firstSheetName;
+
+      cy.log(`downloading a ${testCase.type} file`);
+
+      cy.get(downloadClassName)
+        .parent()
+        .parent()
+        .get('input[name="query"]')
+        .invoke("val")
+        .then(download_query_params => {
+          cy.request({
+            url: endpoint,
+            method: "POST",
+            form: true,
+            body: { query: download_query_params },
+            encoding: "binary",
+          }).then(resp => {
+            const workbook = xlsx.read(resp.body, { type: "binary" });
+
+            expect(workbook.SheetNames[0]).to.eq(sheetName);
+            expect(workbook.Sheets[sheetName]["A1"].v).to.eq("Count");
+            expect(workbook.Sheets[sheetName]["A2"].v).to.eq(18760);
+          });
+        });
+    });
+  });
+});

package.json

@@ -171,7 +171,8 @@
     "webpack-notifier": "^1.8.0",
     "webpack-postcss-tools": "^1.1.2",
     "xhr-mock": "^2.4.1",
-    "yaml-lint": "^1.2.4"
+    "yaml-lint": "^1.2.4",
+    "xlsx": "^0.16.8"
   },
   "scripts": {
     "dev": "concurrently --kill-others -p name -n 'backend,frontend,docs' -c 'blue,green,yellow' 'lein run' 'yarn build-hot' 'yarn docs'",

yarn.lock

@@ -1265,6 +1265,14 @@ acorn@^7.4.0:
   resolved "https://registry.yarnpkg.com/acorn/-/acorn-7.4.1.tgz#feaed255973d2e77555b83dbc08851a6c63520fa"
   integrity sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==
+adler-32@~1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/adler-32/-/adler-32-1.2.0.tgz#6a3e6bf0a63900ba15652808cb15c6813d1a5f25"
+  integrity sha1-aj5r8KY5ALoVZSgIyxXGgT0aXyU=
+  dependencies:
+    exit-on-epipe "~1.0.1"
+    printj "~1.1.0"
+
 adm-zip@~0.4.3:
   version "0.4.16"
   resolved "https://registry.yarnpkg.com/adm-zip/-/adm-zip-0.4.16.tgz#cf4c508fdffab02c269cbc7f471a875f05570365"
@@ -3250,6 +3258,15 @@ center-align@^0.1.1:
     align-text "^0.1.3"
     lazy-cache "^1.0.3"
+cfb@^1.1.4:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/cfb/-/cfb-1.2.0.tgz#6a4d0872b525ed60349e1ef51fb4b0bf73eca9a8"
+  integrity sha512-sXMvHsKCICVR3Naq+J556K+ExBo9n50iKl6LGarlnvuA2035uMlGA/qVrc0wQtow5P1vJEw9UyrKLCbtIKz+TQ==
+  dependencies:
+    adler-32 "~1.2.0"
+    crc-32 "~1.2.0"
+    printj "~1.1.2"
+
 chain-function@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/chain-function/-/chain-function-1.0.1.tgz#c63045e5b4b663fb86f1c6e186adaf1de402a1cc"
@@ -3607,6 +3624,14 @@ code-point-at@^1.0.0:
   resolved "https://registry.yarnpkg.com/code-point-at/-/code-point-at-1.1.0.tgz#0d070b4d043a5bea33a2f1a40e2edb3d9a4ccf77"
   integrity sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=
+codepage@~1.14.0:
+  version "1.14.0"
+  resolved "https://registry.yarnpkg.com/codepage/-/codepage-1.14.0.tgz#8cbe25481323559d7d307571b0fff91e7a1d2f99"
+  integrity sha1-jL4lSBMjVZ19MHVxsP/5HnodL5k=
+  dependencies:
+    commander "~2.14.1"
+    exit-on-epipe "~1.0.1"
+
 collapse-white-space@^1.0.0, collapse-white-space@^1.0.2:
   version "1.0.6"
   resolved "https://registry.yarnpkg.com/collapse-white-space/-/collapse-white-space-1.0.6.tgz#e63629c0016665792060dbbeb79c42239d2c5287"
@@ -3737,7 +3762,7 @@ comma-separated-tokens@^1.0.1:
   resolved "https://registry.yarnpkg.com/comma-separated-tokens/-/comma-separated-tokens-1.0.8.tgz#632b80b6117867a158f1080ad498b2fbe7e3f5ea"
   integrity sha512-GHuDRO12Sypu2cV70d1dkA2EUmXHgntrzbpvOB+Qy+49ypNfGgFQIC2fhhXbnyrJRynDCAARsT7Ou0M6hirpfw==
-commander@2.17.x:
+commander@2.17.x, commander@~2.17.1:
   version "2.17.1"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.17.1.tgz#bd77ab7de6de94205ceacc72f1716d29f20a77bf"
   integrity sha512-wPMUt6FnH2yzG95SA6mzjQOEKUU3aLaDEmzs1ti+1E9h+CsrZghRlqEM/EJ4KscsQVG8uNN4uVreUeT8+drlgg==
@@ -3762,6 +3787,11 @@ commander@~2.13.0:
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.13.0.tgz#6964bca67685df7c1f1430c584f07d7597885b9c"
   integrity sha512-MVuS359B+YzaWqjCL/c+22gfryv+mCBPHAv3zyVI2GN8EY6IRP8VwtasXn8jyyhvvq84R4ImN1OKRtcbIasjYA==
+commander@~2.14.1:
+  version "2.14.1"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-2.14.1.tgz#2235123e37af8ca3c65df45b026dbd357b01b9aa"
+  integrity sha512-+YR16o3rK53SmWHU3rEM3tPAh2rwb1yPcQX5irVn7mb0gXbwuCCrnkbV5+PBfETdfg1vui07nM6PCG1zndcjQw==
+
 commander@~2.19.0:
   version "2.19.0"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.19.0.tgz#f6198aa84e5b83c46054b94ddedbfed5ee9ff12a"
@@ -4014,6 +4044,14 @@ cosmiconfig@^6.0.0:
     path-type "^4.0.0"
     yaml "^1.7.2"
+crc-32@~1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/crc-32/-/crc-32-1.2.0.tgz#cb2db6e29b88508e32d9dd0ec1693e7b41a18208"
+  integrity sha512-1uBwHxF+Y/4yF5G48fwnKq6QsIXheor3ZLPT80yGBV1oEUwpPojlEhQbWKVw1VwcTQyMGHK1/XMmTjmlsmTTGA==
+  dependencies:
+    exit-on-epipe "~1.0.1"
+    printj "~1.1.0"
+
 create-ecdh@^4.0.0:
   version "4.0.4"
   resolved "https://registry.yarnpkg.com/create-ecdh/-/create-ecdh-4.0.4.tgz#d6e7f4bffa66736085a0762fd3a632684dabcc4e"
@@ -5546,6 +5584,11 @@ exit-hook@^1.0.0:
   resolved "https://registry.yarnpkg.com/exit-hook/-/exit-hook-1.1.1.tgz#f05ca233b48c05d54fff07765df8507e95c02ff8"
   integrity sha1-8FyiM7SMBdVP/wd2XfhQfpXAL/g=
+exit-on-epipe@~1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/exit-on-epipe/-/exit-on-epipe-1.0.1.tgz#0bdd92e87d5285d267daa8171d0eb06159689692"
+  integrity sha512-h2z5mrROTxce56S+pnvAV890uu7ls7f1kEvVGJbw1OlFH3/mlJ5bkXu0KRyW94v37zzHPiUd55iLn3DA7TjWpw==
+
 exit@^0.1.2:
   version "0.1.2"
   resolved "https://registry.yarnpkg.com/exit/-/exit-0.1.2.tgz#0632638f8d877cc82107d30a0fff1a17cba1cd0c"
@@ -6022,6 +6065,11 @@ forwarded@~0.1.2:
   resolved "https://registry.yarnpkg.com/forwarded/-/forwarded-0.1.2.tgz#98c23dab1175657b8c0573e8ceccd91b0ff18c84"
   integrity sha1-mMI9qxF1ZXuMBXPozszZGw/xjIQ=
+frac@~1.1.2:
+  version "1.1.2"
+  resolved "https://registry.yarnpkg.com/frac/-/frac-1.1.2.tgz#3d74f7f6478c88a1b5020306d747dc6313c74d0b"
+  integrity sha512-w/XBfkibaTl3YDqASwfDUqkna4Z2p9cFSr1aHDt0WoMTECnRfBOv2WArlZILlqgWlmdIlALXGpM2AOhEk5W3IA==
+
 fragment-cache@^0.2.1:
   version "0.2.1"
   resolved "https://registry.yarnpkg.com/fragment-cache/-/fragment-cache-0.2.1.tgz#4290fad27f13e89be7f33799c6bc5a0abfff0d19"
@@ -10945,6 +10993,11 @@ pretty-format@^26.4.2:
     ansi-styles "^4.0.0"
     react-is "^16.12.0"
+printj@~1.1.0, printj@~1.1.2:
+  version "1.1.2"
+  resolved "https://registry.yarnpkg.com/printj/-/printj-1.1.2.tgz#d90deb2975a8b9f600fb3a1c94e3f4c53c78a222"
+  integrity sha512-zA2SmoLaxZyArQTOPj5LXecR+RagfPSU5Kw1qP+jkWeNlrq+eJZyY2oS68SU1Z/7/myXM4lo9716laOFAVStCQ==
+
 private@^0.1.6, private@^0.1.8, private@~0.1.5:
   version "0.1.8"
   resolved "https://registry.yarnpkg.com/private/-/private-0.1.8.tgz#2381edb3689f7a53d653190060fcf822d2f368ff"
@@ -12827,6 +12880,13 @@ sprintf-js@~1.0.2:
   resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c"
   integrity sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=
+ssf@~0.11.2:
+  version "0.11.2"
+  resolved "https://registry.yarnpkg.com/ssf/-/ssf-0.11.2.tgz#0b99698b237548d088fc43cdf2b70c1a7512c06c"
+  integrity sha512-+idbmIXoYET47hH+d7dfm2epdOMUDjqcB4648sTZ+t2JwoyBFL/insLfB/racrDmsKB3diwsDA696pZMieAC5g==
+  dependencies:
+    frac "~1.1.2"
+
 sshpk@^1.7.0:
   version "1.16.1"
   resolved "https://registry.yarnpkg.com/sshpk/-/sshpk-1.16.1.tgz#fb661c0bef29b39db40769ee39fa70093d6f6877"
@@ -14417,11 +14477,21 @@ winston@^2.1.1:
     isstream "0.1.x"
     stack-trace "0.0.x"
+wmf@~1.0.1:
+  version "1.0.2"
+  resolved "https://registry.yarnpkg.com/wmf/-/wmf-1.0.2.tgz#7d19d621071a08c2bdc6b7e688a9c435298cc2da"
+  integrity sha512-/p9K7bEh0Dj6WbXg4JG0xvLQmIadrner1bi45VMJTfnbVHsc7yIajZyoSoK60/dtVBs12Fm6WkUI5/3WAVsNMw==
+
 word-wrap@^1.2.3, word-wrap@~1.2.3:
   version "1.2.3"
   resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c"
   integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==
+word@~0.3.0:
+  version "0.3.0"
+  resolved "https://registry.yarnpkg.com/word/-/word-0.3.0.tgz#8542157e4f8e849f4a363a288992d47612db9961"
+  integrity sha512-OELeY0Q61OXpdUfTp+oweA/vtLVg5VDOXh+3he3PNzLGG/y0oylSOC1xRVj0+l4vQ3tj/bB1HVHv1ocXkQceFA==
+
 wordwrap@0.0.2:
   version "0.0.2"
   resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-0.0.2.tgz#b79669bb42ecb409f83d583cad52ca17eaa1643f"
@@ -14506,6 +14576,21 @@ xhr-mock@^2.4.1:
     global "^4.3.0"
     url "^0.11.0"
+xlsx@^0.16.8:
+  version "0.16.8"
+  resolved "https://registry.yarnpkg.com/xlsx/-/xlsx-0.16.8.tgz#5546de9b0ba15169b36770d4e43b24790d3ff1b8"
+  integrity sha512-qWub4YCn0xLEGHI7WWhk6IJ73MDu7sPSJQImxN6/LiI8wsHi0hUhICEDbyqBT+jgFgORZxrii0HvhNSwBNAPoQ==
+  dependencies:
+    adler-32 "~1.2.0"
+    cfb "^1.1.4"
+    codepage "~1.14.0"
+    commander "~2.17.1"
+    crc-32 "~1.2.0"
+    exit-on-epipe "~1.0.1"
+    ssf "~0.11.2"
+    wmf "~1.0.1"
+    word "~0.3.0"
+
 xml-name-validator@^2.0.1:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/xml-name-validator/-/xml-name-validator-2.0.1.tgz#4d8b8f1eccd3419aa362061becef515e1e559635"