Custom Table e2e Tests 3: Create and add writable DBs (#27986)

* create separate writable testing DBs

* test writable testing dbs

* fix connection config

* update writable db name and test assertions

---------

Co-authored-by: Nemanja Glumac <31325167+nemanjaglumac@users.noreply.github.com>

frontend/test/__support__/e2e/cypress_data.js

@@ -173,6 +173,29 @@ export const QA_DB_CONFIG = {
   },
 };
 
+export const WRITABLE_DB_ID = 2;
+
+export const WRITABLE_DB_CONFIG = {
+  mysql: {
+    client: "mysql2",
+    connection: {
+      ...QA_DB_CREDENTIALS,
+      user: "root", // only the root user has create database privileges
+      database: "writable_db",
+      port: QA_MYSQL_PORT,
+      multipleStatements: true,
+    },
+  },
+  postgres: {
+    client: "pg",
+    connection: {
+      ...QA_DB_CREDENTIALS,
+      database: "writable_db",
+      port: QA_POSTGRES_PORT,
+    },
+  },
+};
+
 export const WEBMAIL_CONFIG = {
   WEB_PORT: 1080,
   SMTP_PORT: 1025,

frontend/test/__support__/e2e/helpers/e2e-qa-databases-helpers.js

@@ -3,6 +3,8 @@ import {
   QA_MONGO_PORT,
   QA_MYSQL_PORT,
   QA_DB_CREDENTIALS,
+  WRITABLE_DB_CONFIG,
+  WRITABLE_DB_ID,
   QA_DB_CONFIG,
 } from "__support__/e2e/cypress_data";
 
@@ -15,30 +17,38 @@ export function addMongoDatabase(name = "QA Mongo4") {
   addQADatabase("mongo", name, QA_MONGO_PORT);
 }
 
-export function addPostgresDatabase(name = "QA Postgres12") {
+export function addPostgresDatabase(name = "QA Postgres12", writable = false) {
   // https://hub.docker.com/layers/metabase/qa-databases/postgres-sample-12/images/sha256-80bbef27dc52552d6dc64b52796ba356d7541e7bba172740336d7b8a64859cf8
-  addQADatabase("postgres", name, QA_POSTGRES_PORT);
+  addQADatabase("postgres", name, QA_POSTGRES_PORT, writable);
 }
 
-export function addMySQLDatabase(name = "QA MySQL8") {
+export function addMySQLDatabase(name = "QA MySQL8", writable = false) {
   // https://hub.docker.com/layers/metabase/qa-databases/mysql-sample-8/images/sha256-df67db50379ec59ac3a437b5205871f85ab519ce8d2cdc526e9313354d00f9d4
-  addQADatabase("mysql", name, QA_MYSQL_PORT);
+  addQADatabase("mysql", name, QA_MYSQL_PORT, writable);
 }
 
-function addQADatabase(engine, db_display_name, port) {
+function addQADatabase(engine, db_display_name, port, enable_actions = false) {
   const PASS_KEY = engine === "mongo" ? "pass" : "password";
   const AUTH_DB = engine === "mongo" ? "admin" : null;
   const OPTIONS = engine === "mysql" ? "allowPublicKeyRetrieval=true" : null;
 
+  const db_name = enable_actions
+    ? WRITABLE_DB_CONFIG[engine].connection.database
+    : QA_DB_CREDENTIALS.database;
+
+  const credentials = enable_actions
+    ? WRITABLE_DB_CONFIG[engine].connection
+    : QA_DB_CREDENTIALS;
+
   cy.log(`**-- Adding ${engine.toUpperCase()} DB --**`);
   cy.request("POST", "/api/database", {
     engine: engine,
     name: db_display_name,
     details: {
-      dbname: QA_DB_CREDENTIALS.database,
-      host: QA_DB_CREDENTIALS.host,
+      dbname: db_name,
+      host: credentials.host,
       port: port,
-      user: QA_DB_CREDENTIALS.user,
+      user: credentials.user,
       [PASS_KEY]: QA_DB_CREDENTIALS.password, // NOTE: we're inconsistent in where we use `pass` vs `password` as a key
       authdb: AUTH_DB,
       "additional-options": OPTIONS,
@@ -61,13 +71,25 @@ function addQADatabase(engine, db_display_name, port) {
         schedule_type: "hourly",
       },
     },
-  }).then(({ status, body }) => {
-    expect(status).to.equal(200);
-    cy.wrap(body.id).as(`${engine}ID`);
-  });
+  })
+    .then(({ status, body }) => {
+      expect(status).to.equal(200);
+      cy.wrap(body.id).as(`${engine}ID`);
+    })
+    .then(dbId => {
+      // Make sure we have all the metadata because we'll need to use it in tests
+      assertOnDatabaseMetadata(engine);
 
-  // Make sure we have all the metadata because we'll need to use it in tests
-  assertOnDatabaseMetadata(engine);
+      // it's important that we don't enable actions until sync is complete
+      if (dbId && enable_actions) {
+        cy.log(`**-- Enabling actions --**`);
+        cy.request("PUT", `/api/database/${dbId}`, {
+          settings: { "database-enable-actions": true },
+        }).then(({ status }) => {
+          expect(status).to.equal(200);
+        });
+      }
+    });
 }
 
 function assertOnDatabaseMetadata(engine) {
@@ -95,6 +117,47 @@ function recursiveCheck(id, i = 0) {
   });
 }
 
+export const setupWritableDB = (type = "postgres") => {
+  const connectionConfig = {
+    postgres: {
+      client: "pg",
+      connection: {
+        ...QA_DB_CREDENTIALS,
+        port: QA_POSTGRES_PORT,
+      },
+    },
+    mysql: {
+      client: "mysql2",
+      connection: {
+        ...QA_DB_CREDENTIALS,
+        user: "root",
+        port: QA_MYSQL_PORT,
+      },
+    },
+  };
+
+  const dbName = WRITABLE_DB_CONFIG[type].connection.database;
+
+  const dbCheckQuery = {
+    postgres: `SELECT FROM pg_database WHERE datname = '${dbName}';`,
+    mysql: `SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME='${dbName}'`,
+  };
+
+  // we need to initially connect to the db we know exists to create the writable_db
+  cy.task("connectAndQueryDB", {
+    connectionConfig: connectionConfig[type],
+    query: dbCheckQuery[type],
+  }).then(results => {
+    if (!results.rows.length) {
+      cy.log(`**-- Adding ${type} DB for actions --**`);
+      cy.task("connectAndQueryDB", {
+        connectionConfig: connectionConfig[type],
+        query: `CREATE DATABASE ${dbName};`,
+      });
+    }
+  });
+};
+
 export function queryQADB(query, type = "postgres") {
   return cy.task("connectAndQueryDB", {
     connectionConfig: QA_DB_CONFIG[type],
@@ -102,8 +165,15 @@ export function queryQADB(query, type = "postgres") {
   });
 }
 
+export function queryWritableDB(query, type = "postgres") {
+  return cy.task("connectAndQueryDB", {
+    connectionConfig: WRITABLE_DB_CONFIG[type],
+    query,
+  });
+}
+
 // will this work for multiple schemas?
-export function getTableId({ databaseId = 2, name }) {
+export function getTableId({ databaseId = WRITABLE_DB_ID, name }) {
   return cy
     .request("GET", `/api/database/${databaseId}/metadata`)
     .then(({ body }) => {

frontend/test/metabase/scenarios/admin/databases/actions.cy.spec.js

+import { restore } from "__support__/e2e/helpers";
+import {
+  WRITABLE_DB_ID,
+  WRITABLE_DB_CONFIG,
+} from "__support__/e2e/cypress_data";
+
+describe(
+  "admin > database > external databases > enable actions",
+  { tags: ["@external", "@actions"] },
+  () => {
+    ["mysql", "postgres"].forEach(dialect => {
+      it(`should show ${dialect} writable_db with actions enabled`, () => {
+        restore(`${dialect}-writable`);
+        cy.signInAsAdmin();
+
+        cy.request(`/api/database/${WRITABLE_DB_ID}`).then(({ body }) => {
+          expect(body.name).to.include("Writable");
+          expect(body.name.toLowerCase()).to.include(dialect);
+
+          expect(body.details.dbname).to.equal(
+            WRITABLE_DB_CONFIG[dialect].connection.database,
+          );
+          expect(body.settings["database-enable-actions"]).to.eq(true);
+        });
+
+        cy.visit(`/admin/databases/${WRITABLE_DB_ID}`);
+        cy.get("#model-actions-toggle").should(
+          "have.attr",
+          "aria-checked",
+          "true",
+        );
+      });
+    });
+  },
+);

frontend/test/snapshot-creators/qa-db.cy.snap.js

@@ -4,6 +4,7 @@ import {
   addPostgresDatabase,
   addMongoDatabase,
   addMySQLDatabase,
+  setupWritableDB,
 } from "__support__/e2e/helpers";
 
 describe("qa databases snapshots", { tags: "@external" }, () => {
@@ -28,6 +29,20 @@ describe("qa databases snapshots", { tags: "@external" }, () => {
     snapshot("mongo-4");
     deleteDatabase("mongoID");
 
+    restoreAndAuthenticate();
+
+    setupWritableDB("mysql");
+    addMySQLDatabase("Writable MySQL8", true);
+    snapshot("mysql-writable");
+    deleteDatabase("mysqlID");
+
+    restoreAndAuthenticate();
+
+    setupWritableDB("postgres");
+    addPostgresDatabase("Writable Postgres12", true);
+    snapshot("postgres-writable");
+    deleteDatabase("postgresID");
+
     restore("blank");
   });
 });