add externalSchemaTests

Author: KSDaemon

packages/cubejs-testing-drivers/src/tests/testExternalSchemas.ts

@@ -0,0 +1,49 @@
+import { expect } from '@jest/globals';
+import { BaseDriver, QuerySchemasResult } from '@cubejs-backend/base-driver';
+
+const EXTERNAL_SCHEMA = 'spectrum_test_schema';
+const EXTERNAL_TABLE = 'sales';
+
+export function redshiftExternalSchemasSuite(
+  execute: (name: string, test: () => Promise<void>) => void,
+  driver: () => BaseDriver & { stream?: (query: string, values: string[], options: { highWaterMark: number }) => Promise<any> }
+) {
+  execute('should establish a connection', async () => {
+    await driver().testConnection();
+  });
+
+  execute('should load schemas (including external)', async () => {
+    const inputSchemas: QuerySchemasResult[] = await driver().getSchemas();
+    expect(inputSchemas).toBeInstanceOf(Array);
+    expect(inputSchemas.length).toBeGreaterThan(0);
+    expect(inputSchemas).toContainEqual({
+      schema_name: EXTERNAL_SCHEMA,
+    });
+  });
+
+  execute('should load tables for external schema', async () => {
+    const inputTables = await driver().getTablesForSpecificSchemas([{ schema_name: EXTERNAL_SCHEMA }]);
+    expect(inputTables).toBeInstanceOf(Array);
+    expect(inputTables.length).toBeGreaterThan(0);
+    expect(inputTables).toContainEqual({
+      schema_name: EXTERNAL_SCHEMA,
+      table_name: EXTERNAL_TABLE,
+    });
+  });
+
+  execute('should load columns for external table', async () => {
+    const columnsForTables = await driver().getColumnsForSpecificTables([{
+      schema_name: EXTERNAL_SCHEMA,
+      table_name: EXTERNAL_TABLE,
+    }]);
+    expect(columnsForTables).toBeInstanceOf(Array);
+    expect(columnsForTables.length).toBeGreaterThan(0);
+
+    columnsForTables.forEach((it) => {
+      expect(it.schema_name).toEqual(EXTERNAL_SCHEMA);
+      expect(it.table_name).toEqual(EXTERNAL_TABLE);
+      expect(it.column_name).toEqual(expect.any(String));
+      expect(it.data_type).toEqual(expect.any(String));
+    });
+  });
+}

packages/cubejs-testing-drivers/src/tests/testQueries.ts

@@ -13,14 +13,16 @@ import {
   buildPreaggs,
 } from '../helpers';
 import { incrementalSchemaLoadingSuite } from './testIncrementalSchemaLoading';
+import { redshiftExternalSchemasSuite } from './testExternalSchemas';
 
 type TestQueriesOptions = {
   includeIncrementalSchemaSuite?: boolean,
   includeHLLSuite?: boolean,
   extendedEnv?: string
+  externalSchemaTests?: boolean,
 };
 
-export function testQueries(type: string, { includeIncrementalSchemaSuite, extendedEnv, includeHLLSuite }: TestQueriesOptions = {}): void {
+export function testQueries(type: string, { includeIncrementalSchemaSuite, extendedEnv, includeHLLSuite, externalSchemaTests }: TestQueriesOptions = {}): void {
   describe(`Queries with the @cubejs-backend/${type}-driver${extendedEnv ? ` ${extendedEnv}` : ''}`, () => {
     jest.setTimeout(60 * 5 * 1000);
 
@@ -1784,7 +1786,15 @@ export function testQueries(type: string, { includeIncrementalSchemaSuite, exten
     });
 
     if (includeIncrementalSchemaSuite) {
-      incrementalSchemaLoadingSuite(execute, () => driver, tables);
+      describe(`Incremental schema loading with @cubejs-backend/${type}-driver`, () => {
+        incrementalSchemaLoadingSuite(execute, () => driver, tables);
+      });
+    }
+
+    if (externalSchemaTests) {
+      describe(`External schema retrospection with @cubejs-backend/${type}-driver`, () => {
+        redshiftExternalSchemasSuite(execute, () => driver);
+      });
     }
 
     executePg('SQL API: powerbi min max push down', async (connection) => {

packages/cubejs-testing-drivers/test/redshift-full.test.ts

@@ -2,4 +2,5 @@ import { testQueries } from '../src/tests/testQueries';
 
 testQueries('redshift', {
   includeIncrementalSchemaSuite: true,
+  externalSchemaTests: true
 });