Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test(cubesql): Introduce E2E tests for SQL API
- Loading branch information
Showing
8 changed files
with
309 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
packages/cubejs-testing/birdbox-fixtures/postgresql/schema/SecurityContextTest.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| cube(`SecurityContextTest`, { | ||
| sql: ` | ||
| SELECT r.user, r.uid FROM ( | ||
| select 'admin' as user, 1 as uid | ||
| UNION ALL | ||
| select 'moderator' as user, 2 as uid | ||
| UNION ALL | ||
| select 'usr1' as user, 3 as uid | ||
| UNION ALL | ||
| select 'usr2' as user, 4 as uid | ||
| ) as r | ||
| WHERE ${SECURITY_CONTEXT.user.requiredFilter('r.user')} | ||
| `, | ||
|
|
||
| dimensions: { | ||
| user: { | ||
| sql: `user`, | ||
| type: `string`, | ||
| }, | ||
| uid: { | ||
| sql: `uid`, | ||
| type: `string`, | ||
| }, | ||
| }, | ||
| }); |
69 changes: 69 additions & 0 deletions
69
packages/cubejs-testing/birdbox-fixtures/postgresql/single/sqlapi.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| // Cube.js configuration options: https://cube.dev/docs/config | ||
| // It's a special configuration file for SQL API smoke's testing | ||
| module.exports = { | ||
| queryRewrite: (query, { securityContext }) => { | ||
| if (!securityContext.user) { | ||
| throw new Error('Property user does not exist in in Security Context!'); | ||
| } | ||
|
|
||
| console.log('queryRewrite', { | ||
| securityContext | ||
| }); | ||
|
|
||
| return query; | ||
| }, | ||
| checkSqlAuth: async (req, user) => { | ||
| if (user === 'admin') { | ||
| return { | ||
| password: 'admin_password', | ||
| superuser: true, | ||
| securityContext: { | ||
| user: 'admin' | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| if (user === 'moderator') { | ||
| return { | ||
| password: 'moderator_password', | ||
| securityContext: { | ||
| user: 'moderator' | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| if (user === 'usr1') { | ||
| return { | ||
| password: 'user1_password', | ||
| securityContext: { | ||
| user: 'usr1' | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| if (user === 'usr2') { | ||
| return { | ||
| password: 'ignore password', | ||
| securityContext: { | ||
| user: 'usr2' | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| throw new Error(`User "${user}" doesn't exist`); | ||
| }, | ||
| // ADMIN is allowed to access with superuser: true | ||
| // moderator is allowed to access -> user1/usr2 | ||
| // usr1/usr2 are not allowed to change | ||
| canSwitchSqlUser: async (current, user) => { | ||
| await new Promise((resolve) => { | ||
| setTimeout(resolve, 1000); | ||
| }); | ||
|
|
||
| if (current === 'moderator') { | ||
| return user === 'usr1'; | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
packages/cubejs-testing/test/__snapshots__/smoke-cubesql.test.ts.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`SQL API Postgres (Data) SELECT COUNT(*) as cn, "status" FROM Orders GROUP BY 2 ORDER BY cn DESC: sql_orders 1`] = ` | ||
| Array [ | ||
| Object { | ||
| "cn": "2", | ||
| "status": "processed", | ||
| }, | ||
| Object { | ||
| "cn": "2", | ||
| "status": "new", | ||
| }, | ||
| Object { | ||
| "cn": "1", | ||
| "status": "shipped", | ||
| }, | ||
| ] | ||
| `; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| // eslint-disable-next-line import/no-extraneous-dependencies | ||
| import { afterAll, beforeAll, jest, expect } from '@jest/globals'; | ||
| import { Client as PgClient } from 'pg'; | ||
| import { PostgresDBRunner } from '@cubejs-backend/testing-shared'; | ||
| import type { StartedTestContainer } from 'testcontainers'; | ||
|
|
||
| import { BirdBox, getBirdbox } from '../src'; | ||
| import { DEFAULT_CONFIG } from './smoke-tests'; | ||
|
|
||
| describe('SQL API', () => { | ||
| jest.setTimeout(60 * 5 * 1000); | ||
|
|
||
| let connection: PgClient; | ||
| let birdbox: BirdBox; | ||
| let db: StartedTestContainer; | ||
|
|
||
| // TODO: Random port? | ||
| const pgPort = 5656; | ||
| let connectionId = 0; | ||
|
|
||
| async function createPostgresClient(user: string, password: string) { | ||
| connectionId++; | ||
| const currentConnId = connectionId; | ||
|
|
||
| console.debug(`[pg] new connection ${currentConnId}`); | ||
|
|
||
| const conn = new PgClient({ | ||
| database: 'db', | ||
| port: pgPort, | ||
| host: 'localhost', | ||
| user, | ||
| password, | ||
| ssl: false, | ||
| }); | ||
| conn.on('error', (err) => { | ||
| console.log(err); | ||
| }); | ||
| conn.on('end', () => { | ||
| console.debug(`[pg] end ${currentConnId}`); | ||
| }); | ||
|
|
||
| await conn.connect(); | ||
|
|
||
| return conn; | ||
| } | ||
|
|
||
| beforeAll(async () => { | ||
| db = await PostgresDBRunner.startContainer({}); | ||
| birdbox = await getBirdbox( | ||
| 'postgres', | ||
| { | ||
| ...DEFAULT_CONFIG, | ||
| // | ||
| CUBESQL_LOG_LEVEL: 'trace', | ||
| // | ||
| CUBEJS_DB_TYPE: 'postgres', | ||
| CUBEJS_DB_HOST: db.getHost(), | ||
| CUBEJS_DB_PORT: `${db.getMappedPort(5432)}`, | ||
| CUBEJS_DB_NAME: 'test', | ||
| CUBEJS_DB_USER: 'test', | ||
| CUBEJS_DB_PASS: 'test', | ||
| // | ||
| CUBEJS_PG_SQL_PORT: `${pgPort}`, | ||
| }, | ||
| { | ||
| schemaDir: 'postgresql/schema', | ||
| cubejsConfig: 'postgresql/single/sqlapi.js', | ||
| } | ||
| ); | ||
| connection = await createPostgresClient('admin', 'admin_password'); | ||
| }); | ||
|
|
||
| afterAll(async () => { | ||
| await birdbox.stop(); | ||
| await db.stop(); | ||
| // await not working properly | ||
| await connection.end(); | ||
| }); | ||
|
|
||
| describe('Postgres (Auth)', () => { | ||
| test('Success Admin', async () => { | ||
| const conn = await createPostgresClient('admin', 'admin_password'); | ||
|
|
||
| try { | ||
| const res = await conn.query('SELECT "user", "uid" FROM SecurityContextTest'); | ||
| expect(res.rows).toEqual([{ | ||
| user: 'admin', | ||
| uid: '1' | ||
| }]); | ||
| } finally { | ||
| await conn.end(); | ||
| } | ||
| }); | ||
|
|
||
| test('Error Admin Password', async () => { | ||
| try { | ||
| await createPostgresClient('admin', 'wrong_password'); | ||
|
|
||
| throw new Error('Code must thrown auth error, something wrong...'); | ||
| } catch (e) { | ||
| expect(e.message).toContain('password authentication failed for user "admin"'); | ||
| } | ||
| }); | ||
|
|
||
| test('Security Context (Admin -> Moderator) - allowed superuser', async () => { | ||
| const conn = await createPostgresClient('admin', 'admin_password'); | ||
|
|
||
| try { | ||
| const res = await conn.query('SELECT "user", "uid" FROM SecurityContextTest WHERE __user = \'moderator\''); | ||
| expect(res.rows).toEqual([{ | ||
| user: 'moderator', | ||
| uid: '2' | ||
| }]); | ||
| } finally { | ||
| await conn.end(); | ||
| } | ||
| }); | ||
|
|
||
| test('Security Context (Moderator -> Usr1) - allowed sqlCanChangeUser', async () => { | ||
| const conn = await createPostgresClient('moderator', 'moderator_password'); | ||
|
|
||
| try { | ||
| const res = await conn.query('SELECT "user", "uid" FROM SecurityContextTest WHERE __user = \'usr1\''); | ||
| expect(res.rows).toEqual([{ | ||
| user: 'usr1', | ||
| uid: '3' | ||
| }]); | ||
| } finally { | ||
| await conn.end(); | ||
| } | ||
| }); | ||
|
|
||
| test('Security Context (Moderator -> Usr2) - not allowed', async () => { | ||
| const conn = await createPostgresClient('moderator', 'moderator_password'); | ||
|
|
||
| try { | ||
| await conn.query('SELECT "user", "uid" FROM SecurityContextTest WHERE __user = \'usr2\''); | ||
|
|
||
| throw new Error('Code must thrown auth error, something wrong...'); | ||
| } catch (e) { | ||
| expect(e.message).toContain('You cannot change security context via __user from moderator to usr2, because it\'s not allowed'); | ||
| } finally { | ||
| await conn.end(); | ||
| } | ||
| }); | ||
|
|
||
| test('Security Context (Usr1 -> Moderator) - not allowed', async () => { | ||
| const conn = await createPostgresClient('usr1', 'user1_password'); | ||
|
|
||
| try { | ||
| await conn.query('SELECT "user", "uid" FROM SecurityContextTest WHERE __user = \'moderator\''); | ||
|
|
||
| throw new Error('Code must thrown auth error, something wrong...'); | ||
| } catch (e) { | ||
| expect(e.message).toContain('You cannot change security context via __user from usr1 to moderator, because it\'s not allowed'); | ||
| } finally { | ||
| await conn.end(); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| describe('Postgres (Data)', () => { | ||
| test('SELECT COUNT(*) as cn, "status" FROM Orders GROUP BY 2 ORDER BY cn DESC', async () => { | ||
| const res = await connection.query('SELECT COUNT(*) as cn, "status" FROM Orders GROUP BY 2 ORDER BY cn DESC'); | ||
| expect(res.rows).toMatchSnapshot('sql_orders'); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.