-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SNOW-1346233 execute automated external browser tests (#970)
- Loading branch information
1 parent
753aa3d
commit 599e55c
Showing
12 changed files
with
299 additions
and
189 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
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 |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| *.swp | ||
| .idea | ||
| .git | ||
| parameters.json | ||
| parameters*.json | ||
| snowflake-sdk-*.tgz | ||
| dist | ||
| junit*.xml | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| #!/bin/bash -e | ||
|
|
||
| set -o pipefail | ||
|
|
||
| AUTH_PARAMETER_FILE=./.github/workflows/parameters_aws_auth_tests.json | ||
| eval $(jq -r '.authtestparams | to_entries | map("export \(.key)=\(.value|tostring)")|.[]' $AUTH_PARAMETER_FILE) | ||
|
|
||
| npm run test:authentication |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| #!/bin/bash -e | ||
|
|
||
| set -o pipefail | ||
| THIS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" | ||
| export WORKSPACE=${WORKSPACE:-/tmp} | ||
|
|
||
| gpg --quiet --batch --yes --decrypt --passphrase="$PARAMETERS_SECRET" --output $THIS_DIR/../.github/workflows/parameters_aws_auth_tests.json "$THIS_DIR/../.github/workflows/parameters_aws_auth_tests.json.gpg" | ||
|
|
||
| docker run \ | ||
| -v $(cd $THIS_DIR/.. && pwd):/mnt/host \ | ||
| -v $WORKSPACE:/mnt/workspace \ | ||
| --rm \ | ||
| nexus.int.snowflakecomputing.com:8086/docker/snowdrivers-test-external-browser:2 \ | ||
| "/mnt/host/ci/container/test_authentication.sh" |
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
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,30 @@ | ||
| const snowflakeAuthTestProtocol = process.env.SNOWFLAKE_AUTH_TEST_PROTOCOL; | ||
| const snowflakeAuthTestHost = process.env.SNOWFLAKE_AUTH_TEST_HOST; | ||
| const snowflakeAuthTestPort = process.env.SNOWFLAKE_AUTH_TEST_PORT; | ||
| const snowflakeAuthTestAccount = process.env.SNOWFLAKE_AUTH_TEST_ACCOUNT; | ||
| const snowflakeAuthTestRole = process.env.SNOWFLAKE_AUTH_TEST_ROLE; | ||
| const snowflakeTestBrowserUser = process.env.SNOWFLAKE_AUTH_TEST_BROWSER_USER; | ||
| const snowflakeAuthTestOktaPass = process.env.SNOWFLAKE_AUTH_TEST_OKTA_PASS; | ||
| const snowflakeAuthTestDatabase = process.env.SNOWFLAKE_AUTH_TEST_DATABASE; | ||
| const snowflakeAuthTestWarehouse = process.env.SNOWFLAKE_AUTH_TEST_WAREHOUSE; | ||
| const snowflakeAuthTestSchema = process.env.SNOWFLAKE_AUTH_TEST_SCHEMA; | ||
|
|
||
| const accessUrlAuthTests = snowflakeAuthTestProtocol + '://' + snowflakeAuthTestHost + ':' + | ||
| snowflakeAuthTestPort; | ||
|
|
||
| const externalBrowser = | ||
| { | ||
| accessUrl: accessUrlAuthTests, | ||
| username: snowflakeTestBrowserUser, | ||
| account: snowflakeAuthTestAccount, | ||
| role: snowflakeAuthTestRole, | ||
| host: snowflakeAuthTestHost, | ||
| warehouse: snowflakeAuthTestWarehouse, | ||
| database: snowflakeAuthTestDatabase, | ||
| schema: snowflakeAuthTestSchema, | ||
| authenticator: 'EXTERNALBROWSER' | ||
| }; | ||
|
|
||
| exports.externalBrowser = externalBrowser; | ||
| exports.snowflakeTestBrowserUser = snowflakeTestBrowserUser; | ||
| exports.snowflakeAuthTestOktaPass = snowflakeAuthTestOktaPass; |
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,203 @@ | ||
| const snowflake = require('../../lib/snowflake'); | ||
| const assert = require('assert'); | ||
| const testUtil = require('../integration/testUtil'); | ||
| const connParameters = require('./connectionParameters'); | ||
| const { spawn } = require('child_process'); | ||
| const Util = require('../../lib/util'); | ||
| const JsonCredentialManager = require('../../lib/authentication/secure_storage/json_credential_manager'); | ||
|
|
||
| describe('External browser authentication tests', function () { | ||
| const cleanBrowserProcessesPath = '/externalbrowser/cleanBrowserProcesses.js'; | ||
| const provideBrowserCredentialsPath = '/externalbrowser/provideBrowserCredentials.js'; | ||
| const login = connParameters.snowflakeTestBrowserUser; | ||
| const password = connParameters.snowflakeAuthTestOktaPass; | ||
| let connection, error, callbackCompleted; | ||
|
|
||
| before(async () => { | ||
| await cleanBrowserProcesses(); | ||
| }); | ||
|
|
||
| afterEach(async () => { | ||
| await cleanBrowserProcesses(); | ||
| await destroyConnection(connection); | ||
| callbackCompleted = false; | ||
| error = undefined; | ||
| }); | ||
|
|
||
| describe('External browser tests', async () => { | ||
| it('Successful connection', async () => { | ||
| const connectionOption = { ...connParameters.externalBrowser, clientStoreTemporaryCredential: false }; | ||
| connection = await snowflake.createConnection(connectionOption); | ||
| const provideCredentialsPromise = execWithTimeout('node', [provideBrowserCredentialsPath, 'success', login, password], 15000); | ||
| await connectAndProvideCredentials(connection, provideCredentialsPromise); | ||
| verifyNoErrorWasThrown(); | ||
| await verifyConnectionIsUp(connection); | ||
| }); | ||
|
|
||
| it('Mismatched Username', async () => { | ||
| const connectionOption = { ...connParameters.externalBrowser, username: 'differentUsername', clientStoreTemporaryCredential: false }; | ||
| connection = await snowflake.createConnection(connectionOption); | ||
| const provideCredentialsPromise = execWithTimeout('node', [provideBrowserCredentialsPath, 'success', login, password], 15000); | ||
| await connectAndProvideCredentials(connection, provideCredentialsPromise); | ||
| assert.strictEqual(error?.message, 'The user you were trying to authenticate as differs from the user currently logged in at the IDP.'); | ||
| await verifyConnectionIsNotUp(connection, 'Unable to perform operation using terminated connection.'); | ||
| }); | ||
|
|
||
| it('Wrong credentials', async () => { | ||
| const login = 'itsnotanaccount.com'; | ||
| const password = 'fakepassword'; | ||
| const connectionOption = { ...connParameters.externalBrowser, browserActionTimeout: 10000, clientStoreTemporaryCredential: false }; | ||
| connection = await snowflake.createConnection(connectionOption); | ||
| const provideCredentialsPromise = execWithTimeout('node', [provideBrowserCredentialsPath, 'fail', login, password]); | ||
| await connectAndProvideCredentials(connection, provideCredentialsPromise); | ||
| assert.strictEqual(error?.message, 'Error while getting SAML token: Browser action timed out after 10000 ms.'); | ||
| await verifyConnectionIsNotUp(connection); | ||
| }); | ||
|
|
||
| it('External browser timeout', async () => { | ||
| const connectionOption = { ...connParameters.externalBrowser, browserActionTimeout: 100, clientStoreTemporaryCredential: false }; | ||
| connection = await snowflake.createConnection(connectionOption); | ||
| const connectToBrowserPromise = execWithTimeout('node', [provideBrowserCredentialsPath, 'timeout']); | ||
| await connectAndProvideCredentials(connection, connectToBrowserPromise); | ||
| assert.strictEqual(error?.message, 'Error while getting SAML token: Browser action timed out after 100 ms.'); | ||
| await verifyConnectionIsNotUp(connection); | ||
| }); | ||
| }); | ||
|
|
||
| describe('ID Token authentication tests', async () => { | ||
| const connectionOption = { ...connParameters.externalBrowser, clientStoreTemporaryCredential: true }; | ||
| const key = Util.buildCredentialCacheKey(connectionOption.host, connectionOption.username, 'ID_TOKEN'); | ||
| const defaultCredentialManager = new JsonCredentialManager(); | ||
| let firstIdToken; | ||
|
|
||
| before(async () => { | ||
| await defaultCredentialManager.remove(key); | ||
| }); | ||
|
|
||
| it('obtains the id token from the server and saves it on the local storage', async function () { | ||
| connection = snowflake.createConnection(connectionOption); | ||
| const provideCredentialsPromise = execWithTimeout('node', [provideBrowserCredentialsPath, 'success', login, password], 15000); | ||
| await connectAndProvideCredentials(connection, provideCredentialsPromise); | ||
| verifyNoErrorWasThrown(); | ||
| await verifyConnectionIsUp(connection); | ||
| }); | ||
|
|
||
| it('the token is saved in the credential manager', async function () { | ||
| firstIdToken = await defaultCredentialManager.read(key); | ||
| assert.notStrictEqual(firstIdToken, null); | ||
| }); | ||
|
|
||
| it('authenticates by token, browser credentials not needed', async function () { | ||
| connection = snowflake.createConnection(connectionOption); | ||
| await connection.connectAsync(connectAsyncCallback()); | ||
| verifyNoErrorWasThrown(); | ||
| await verifyConnectionIsUp(connection); | ||
| }); | ||
|
|
||
| it('opens browser okta authentication again when token is incorrect', async function () { | ||
| await defaultCredentialManager.write(key, '1234'); | ||
| connection = snowflake.createConnection(connectionOption); | ||
| const provideCredentialsPromise = execWithTimeout('node', [provideBrowserCredentialsPath, 'success', login, password], 15000); | ||
| await connectAndProvideCredentials(connection, provideCredentialsPromise); | ||
| verifyNoErrorWasThrown(); | ||
| await verifyConnectionIsUp(connection); | ||
| }); | ||
|
|
||
| it('refreshes the token for credential cache key', async function () { | ||
| const newToken = await defaultCredentialManager.read(key); | ||
| assert.notStrictEqual(firstIdToken, newToken); | ||
| }); | ||
| }); | ||
|
|
||
| function connectAsyncCallback() { | ||
| return function (err) { | ||
| error = err; | ||
| callbackCompleted = true; | ||
| }; | ||
| } | ||
|
|
||
| function verifyNoErrorWasThrown() { | ||
| assert.equal(error, null); | ||
| } | ||
|
|
||
| async function cleanBrowserProcesses() { | ||
| if (process.env.RUN_AUTH_TESTS_MANUALLY !== 'true') { | ||
| await execWithTimeout('node', [cleanBrowserProcessesPath], 15000); | ||
| } | ||
| } | ||
|
|
||
| async function connectAndProvideCredentials(connection, provideCredentialsPromise) { | ||
| if (process.env.RUN_AUTH_TESTS_MANUALLY === 'true') { | ||
| await connection.connectAsync(connectAsyncCallback()); | ||
| } else { | ||
| await Promise.allSettled([connection.connectAsync(connectAsyncCallback()), provideCredentialsPromise]); | ||
| } | ||
| await waitForCallbackCompletion(); | ||
| } | ||
|
|
||
| async function waitForCallbackCompletion() { | ||
| const timeout = Date.now() + 5000; | ||
| while (Date.now() < timeout) { | ||
| await new Promise(resolve => setTimeout(resolve, 100)); | ||
| if (callbackCompleted) { | ||
| return; | ||
| } | ||
| } | ||
| throw new Error('Connection callback did not complete'); | ||
| } | ||
| }); | ||
|
|
||
| async function verifyConnectionIsUp(connection) { | ||
| assert.ok(await connection.isValidAsync(), 'Connection is not valid'); | ||
| await testUtil.executeCmdAsync(connection, 'Select 1'); | ||
| } | ||
|
|
||
| async function verifyConnectionIsNotUp(connection, message = 'Unable to perform operation because a connection was never established.') { | ||
| assert.ok(!(connection.isUp()), 'Connection should not be up'); | ||
| try { | ||
| await testUtil.executeCmdAsync(connection, 'Select 1'); | ||
| assert.fail('Expected error was not thrown'); | ||
| } catch (error) { | ||
| assert.strictEqual(error.message, message); | ||
| } | ||
| } | ||
|
|
||
| async function destroyConnection(connection) { | ||
| if (connection !== undefined && connection.isUp()) { | ||
| await testUtil.destroyConnectionAsync(connection); | ||
| } | ||
| } | ||
|
|
||
| function execWithTimeout(command, args, timeout = 5000) { | ||
| return new Promise((resolve, reject) => { | ||
| const child = spawn(command, args, { shell: true }); | ||
|
|
||
| let stdout = ''; | ||
| let stderr = ''; | ||
|
|
||
| child.stdout.on('data', (data) => { | ||
| stdout += data; | ||
| }); | ||
|
|
||
| child.stderr.on('data', (data) => { | ||
| stderr += data; | ||
| }); | ||
|
|
||
| child.on('error', (err) => { | ||
| reject(err); | ||
| }); | ||
|
|
||
| child.on('close', (code) => { | ||
| if (code !== 0) { | ||
| reject(new Error(`Process exited with code: ${code}, error: ${stderr}`)); | ||
| } else { | ||
| resolve({ stdout, stderr }); | ||
| } | ||
| }); | ||
|
|
||
| setTimeout(() => { | ||
| child.kill(); | ||
| reject(new Error('Process timed out')); | ||
| }, timeout); | ||
| }); | ||
| } |
Oops, something went wrong.