chore(firebolt-driver): Setup CI tests (#9019)

* chore(firebolt-driver): code polishment and fix lint warnings

* fix running tests

* chore(firebolt-driver): setup CI tests

Author: KSDaemon

.github/actions/integration/firebolt.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -eo pipefail
+
+# Debug log for test containers
+export DEBUG=testcontainers
+
+echo "::group::Firebolt [cloud]"
+yarn lerna run --concurrency 1 --stream --no-prefix integration:firebolt
+
+echo "::endgroup::"

.github/workflows/push.yml

@@ -319,7 +319,7 @@ jobs:
         node-version: [20.x]
         db: [
             'clickhouse', 'druid', 'elasticsearch', 'mssql', 'mysql', 'postgres', 'prestodb',
-            'mysql-aurora-serverless', 'crate', 'mongobi'
+            'mysql-aurora-serverless', 'crate', 'mongobi', 'firebolt'
         ]
       fail-fast: false
 
@@ -370,6 +370,13 @@ jobs:
           retry_wait_seconds: 15
           timeout_minutes: 30
           command: ./.github/actions/integration/${{ matrix.db }}.sh
+        env:
+          # Firebolt Integration
+          DRIVERS_TESTS_FIREBOLT_CUBEJS_FIREBOLT_ENGINE_NAME: ${{ secrets.DRIVERS_TESTS_FIREBOLT_CUBEJS_FIREBOLT_ENGINE_NAME }}
+          DRIVERS_TESTS_FIREBOLT_CUBEJS_DB_NAME: ${{ secrets.DRIVERS_TESTS_FIREBOLT_CUBEJS_DB_NAME }}
+          DRIVERS_TESTS_FIREBOLT_CUBEJS_FIREBOLT_ACCOUNT: ${{ secrets.DRIVERS_TESTS_FIREBOLT_CUBEJS_FIREBOLT_ACCOUNT }}
+          DRIVERS_TESTS_FIREBOLT_CUBEJS_DB_USER: ${{ secrets.DRIVERS_TESTS_FIREBOLT_CUBEJS_DB_USER }}
+          DRIVERS_TESTS_FIREBOLT_CUBEJS_DB_PASS: ${{ secrets.DRIVERS_TESTS_FIREBOLT_CUBEJS_DB_PASS }}
 
   integration-smoke:
     needs: [ latest-tag-sha, build-cubestore ]

packages/cubejs-firebolt-driver/package.json

@@ -23,7 +23,7 @@
     "watch": "tsc -w",
     "test": "yarn integration",
     "integration": "npm run integration:firebolt",
-    "integration:firebolt": "jest --verbose dist/test",
+    "integration:firebolt": "jest --verbose dist/test --runInBand",
     "lint": "eslint src/* --ext .ts",
     "lint:fix": "eslint --fix src/* --ext .ts"
   },
@@ -43,7 +43,10 @@
     "access": "public"
   },
   "jest": {
-    "testEnvironment": "node"
+    "testEnvironment": "node",
+    "setupFiles": [
+      "./test/test-env.js"
+    ]
   },
   "eslintConfig": {
     "extends": "../cubejs-linter"

packages/cubejs-firebolt-driver/test/Firebolt.test.ts packages/cubejs-firebolt-driver/test/FireboltDriver.test.ts

@@ -70,50 +70,48 @@ cube(\`sales\`, {
         measures: ['sales.count'],
         filters: [
           {
-            member: "sales.isShiped",
-            operator: "equals",
-            values: ["true"]
+            member: 'sales.isShiped',
+            operator: 'equals',
+            values: ['true']
           }
         ]
       }
-    )
+    );
 
     const queryAndParams = query.buildSqlAndParams();
 
     expect(queryAndParams[0]).toContain(
       '("sales".is_shiped = CAST(? AS BOOLEAN))'
     );
 
-    expect(queryAndParams[1]).toEqual(["true"]);
-  }))
-    it("should cast timestamp", () =>
-    compiler.compile().then(() => {
-      const query = new FireboltQuery(
-        { joinGraph, cubeEvaluator, compiler },
-        {
-          measures: ["sales.count"],
-          timeDimensions: [
-            {
-              dimension: "sales.salesDatetime",
-              granularity: "day",
-              dateRange: ["2017-01-01", "2017-01-02"],
-            },
-          ],
-          timezone: "America/Los_Angeles",
-          order: [
-            {
-              id: "sales.salesDatetime",
-            },
-          ],
-        }
-      );
-
-      const queryAndParams = query.buildSqlAndParams();
+    expect(queryAndParams[1]).toEqual(['true']);
+  }));
 
-      expect(queryAndParams[0]).toContain(
-        '("sales".sales_datetime >= ?::timestamptz AND "sales".sales_datetime <= ?::timestamptz)'
-      );
-    }));
+  it('should cast timestamp', () => compiler.compile().then(() => {
+    const query = new FireboltQuery(
+      { joinGraph, cubeEvaluator, compiler },
+      {
+        measures: ['sales.count'],
+        timeDimensions: [
+          {
+            dimension: 'sales.salesDatetime',
+            granularity: 'day',
+            dateRange: ['2017-01-01', '2017-01-02'],
+          },
+        ],
+        timezone: 'America/Los_Angeles',
+        order: [
+          {
+            id: 'sales.salesDatetime',
+          },
+        ],
+      }
+    );
 
+    const queryAndParams = query.buildSqlAndParams();
 
-})
+    expect(queryAndParams[0]).toContain(
+      '("sales".sales_datetime >= ?::timestamptz AND "sales".sales_datetime <= ?::timestamptz)'
+    );
+  }));
+});

packages/cubejs-firebolt-driver/test/FireboltQuery.test.ts

@@ -1,9 +1,9 @@
-import {assertDataSource, getEnv} from '@cubejs-backend/shared';
+import { assertDataSource, getEnv } from '@cubejs-backend/shared';
 import { DriverTests } from '@cubejs-backend/testing-shared';
 
-import { FireboltDriver } from '../src';
 import { Firebolt } from 'firebolt-sdk';
 import { version } from 'firebolt-sdk/package.json';
+import { FireboltDriver } from '../src';
 
 describe('FireboltDriver autostart', () => {
   let tests: DriverTests;
@@ -43,7 +43,7 @@ describe('FireboltDriver autostart', () => {
     const engineName = getEnv('fireboltEngineName', { dataSource });
     const firebolt = Firebolt({
       apiEndpoint: getEnv('fireboltApiEndpoint', { dataSource }) || 'api.app.firebolt.io',
-    })
+    });
     await firebolt.connect({
       auth,
       database: getEnv('dbName', { dataSource }),

packages/cubejs-firebolt-driver/test/autostart.test.ts

@@ -0,0 +1,14 @@
+const REQUIRED_ENV_VARS = [
+  'CUBEJS_DB_USER',
+  'CUBEJS_DB_PASS',
+  'CUBEJS_DB_NAME',
+  'CUBEJS_FIREBOLT_ENGINE_NAME',
+  'CUBEJS_FIREBOLT_ACCOUNT',
+];
+
+REQUIRED_ENV_VARS.forEach((key) => {
+  // Trying to populate from DRIVERS_TESTS_FIREBOLT_* vars
+  if (process.env[`DRIVERS_TESTS_FIREBOLT_${key}`] !== undefined) {
+    process.env[key] = process.env[`DRIVERS_TESTS_FIREBOLT_${key}`];
+  }
+});