feat: get docker-compose to work as the backend for Cypress tests (#31796)
This commit is contained in:
Maxime Beauchemin
GitHub
parent
2874096e27
commit
840773e626
|
|
@ -89,6 +89,8 @@ services:
|
|||
restart: unless-stopped
|
||||
ports:
|
||||
- 8088:8088
|
||||
# When in cypress-mode ->
|
||||
- 8081:8081
|
||||
extra_hosts:
|
||||
- "host.docker.internal:host-gateway"
|
||||
user: *superset-user
|
||||
|
|
|
|||
|
|
@ -26,11 +26,13 @@ if [ "$DEV_MODE" == "true" ]; then
|
|||
fi
|
||||
fi
|
||||
REQUIREMENTS_LOCAL="/app/docker/requirements-local.txt"
|
||||
PORT=${PORT:-8088}
|
||||
# If Cypress run – overwrite the password for admin and export env variables
|
||||
if [ "$CYPRESS_CONFIG" == "true" ]; then
|
||||
export SUPERSET_CONFIG=tests.integration_tests.superset_test_config
|
||||
export SUPERSET_TESTENV=true
|
||||
export SUPERSET__SQLALCHEMY_DATABASE_URI=postgresql+psycopg2://superset:superset@db:5432/superset
|
||||
export POSTGRES_DB=superset_cypress
|
||||
export SUPERSET__SQLALCHEMY_DATABASE_URI=postgresql+psycopg2://superset:superset@db:5432/superset_cypress
|
||||
PORT=8081
|
||||
fi
|
||||
if [[ "$DATABASE_DIALECT" == postgres* ]] ; then
|
||||
echo "Installing postgres requirements"
|
||||
|
|
@ -65,7 +67,7 @@ case "${1}" in
|
|||
;;
|
||||
app)
|
||||
echo "Starting web app (using development server)..."
|
||||
flask run -p 8088 --with-threads --reload --debugger --host=0.0.0.0
|
||||
flask run -p $PORT --with-threads --reload --debugger --host=0.0.0.0
|
||||
;;
|
||||
app-gunicorn)
|
||||
echo "Starting web app..."
|
||||
|
|
|
|||
|
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# Licensed to the Apache Software Foundation (ASF) under one
|
||||
# or more contributor license agreements. See the NOTICE file
|
||||
# distributed with this work for additional information
|
||||
# regarding copyright ownership. The ASF licenses this file
|
||||
# to you under the Apache License, Version 2.0 (the
|
||||
# "License"); you may not use this file except in compliance
|
||||
# with the License. You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing,
|
||||
# software distributed under the License is distributed on an
|
||||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
# KIND, either express or implied. See the License for the
|
||||
# specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
# ------------------------------------------------------------------------
|
||||
# Creates the examples database and respective user. This database location
|
||||
# and access credentials are defined on the environment variables
|
||||
# ------------------------------------------------------------------------
|
||||
set -e
|
||||
|
||||
psql -v ON_ERROR_STOP=1 --username "${POSTGRES_USER}" <<-EOSQL
|
||||
CREATE DATABASE superset_cypress;
|
||||
EOSQL
|
||||
|
|
@ -30,24 +30,18 @@ fi
|
|||
|
||||
echo_step() {
|
||||
cat <<EOF
|
||||
|
||||
######################################################################
|
||||
|
||||
|
||||
Init Step ${1}/${STEP_CNT} [${2}] -- ${3}
|
||||
|
||||
|
||||
######################################################################
|
||||
|
||||
EOF
|
||||
}
|
||||
ADMIN_PASSWORD="${ADMIN_PASSWORD:-admin}"
|
||||
# If Cypress run – overwrite the password for admin and export env variables
|
||||
if [ "$CYPRESS_CONFIG" == "true" ]; then
|
||||
ADMIN_PASSWORD="general"
|
||||
export SUPERSET_CONFIG=tests.integration_tests.superset_test_config
|
||||
export SUPERSET_TESTENV=true
|
||||
export SUPERSET__SQLALCHEMY_DATABASE_URI=postgresql+psycopg2://superset:superset@db:5432/superset
|
||||
export POSTGRES_DB=superset_cypress
|
||||
export SUPERSET__SQLALCHEMY_DATABASE_URI=postgresql+psycopg2://superset:superset@db:5432/superset_cypress
|
||||
fi
|
||||
# Initialize the database
|
||||
echo_step "1" "Starting" "Applying DB migrations"
|
||||
|
|
|
|||
|
|
@ -22,6 +22,7 @@
|
|||
#
|
||||
import logging
|
||||
import os
|
||||
import sys
|
||||
|
||||
from celery.schedules import crontab
|
||||
from flask_caching.backends.filesystemcache import FileSystemCache
|
||||
|
|
@ -107,6 +108,18 @@ SQLLAB_CTAS_NO_LIMIT = True
|
|||
log_level_text = os.getenv("SUPERSET_LOG_LEVEL", "INFO")
|
||||
LOG_LEVEL = getattr(logging, log_level_text.upper(), logging.INFO)
|
||||
|
||||
if os.getenv("CYPRESS_CONFIG") == "true":
|
||||
# When running the service as a cypress backend, we need to import the config
|
||||
# located @ tests/integration_tests/superset_test_config.py
|
||||
base_dir = os.path.dirname(__file__)
|
||||
module_folder = os.path.abspath(
|
||||
os.path.join(base_dir, "../../tests/integration_tests/")
|
||||
)
|
||||
sys.path.insert(0, module_folder)
|
||||
from superset_test_config import * # noqa
|
||||
|
||||
sys.path.pop(0)
|
||||
|
||||
#
|
||||
# Optionally import superset_config_docker.py (which will have been included on
|
||||
# the PYTHONPATH) in order to allow for local settings to be overridden
|
||||
|
|
|
|||
|
|
@ -643,71 +643,6 @@ To run a single test file:
|
|||
npm run test -- path/to/file.js
|
||||
```
|
||||
|
||||
### Integration Testing
|
||||
|
||||
We use [Cypress](https://www.cypress.io/) for integration tests. To open Cypress and explore tests first setup and run test server:
|
||||
|
||||
```bash
|
||||
export SUPERSET_CONFIG=tests.integration_tests.superset_test_config
|
||||
export SUPERSET_TESTENV=true
|
||||
export CYPRESS_BASE_URL="http://localhost:8081"
|
||||
superset db upgrade
|
||||
superset load_test_users
|
||||
superset load-examples --load-test-data
|
||||
superset init
|
||||
superset run --port 8081
|
||||
```
|
||||
|
||||
Run Cypress tests:
|
||||
|
||||
```bash
|
||||
cd superset-frontend
|
||||
npm run build-instrumented
|
||||
|
||||
cd cypress-base
|
||||
npm install
|
||||
|
||||
# run tests via headless Chrome browser (requires Chrome 64+)
|
||||
npm run cypress-run-chrome
|
||||
|
||||
# run tests from a specific file
|
||||
npm run cypress-run-chrome -- --spec cypress/e2e/explore/link.test.ts
|
||||
|
||||
# run specific file with video capture
|
||||
npm run cypress-run-chrome -- --spec cypress/e2e/dashboard/index.test.js --config video=true
|
||||
|
||||
# to open the cypress ui
|
||||
npm run cypress-debug
|
||||
|
||||
# to point cypress to a url other than the default (http://localhost:8088) set the environment variable before running the script
|
||||
# e.g., CYPRESS_BASE_URL="http://localhost:9000"
|
||||
CYPRESS_BASE_URL=<your url> npm run cypress open
|
||||
```
|
||||
|
||||
See [`superset-frontend/cypress_build.sh`](https://github.com/apache/superset/blob/master/superset-frontend/cypress_build.sh).
|
||||
|
||||
As an alternative you can use docker compose environment for testing:
|
||||
|
||||
Make sure you have added below line to your /etc/hosts file:
|
||||
`127.0.0.1 db`
|
||||
|
||||
If you already have launched Docker environment please use the following command to ensure a fresh database instance:
|
||||
`docker compose down -v`
|
||||
|
||||
Launch environment:
|
||||
|
||||
`CYPRESS_CONFIG=true docker compose up --build`
|
||||
|
||||
It will serve the backend and frontend on port 8088.
|
||||
|
||||
Run Cypress tests:
|
||||
|
||||
```bash
|
||||
cd cypress-base
|
||||
npm install
|
||||
npm run cypress open
|
||||
```
|
||||
|
||||
### Debugging Server App
|
||||
|
||||
#### Local
|
||||
|
|
|
|||
|
|
@ -225,22 +225,10 @@ npm run test -- path/to/file.js
|
|||
|
||||
### e2e Integration Testing
|
||||
|
||||
For e2e testing, we recommend that you use a `docker-compose` backed-setup
|
||||
|
||||
Alternatively, you can go lower level and set things up in your
|
||||
development environment by following these steps:
|
||||
|
||||
First set up a python/flask backend:
|
||||
For e2e testing, we recommend that you use a `docker compose` backend
|
||||
|
||||
```bash
|
||||
export SUPERSET_CONFIG=tests.integration_tests.superset_test_config
|
||||
export SUPERSET_TESTENV=true
|
||||
export CYPRESS_BASE_URL="http://localhost:8081"
|
||||
superset db upgrade
|
||||
superset load_test_users
|
||||
superset init
|
||||
superset load-examples --load-test-data
|
||||
superset run --port 8081
|
||||
CYPRESS_CONFIG=true docker compose up
|
||||
```
|
||||
|
||||
In another terminal, prepare the frontend and run Cypress tests:
|
||||
|
|
@ -255,6 +243,9 @@ npm install
|
|||
# run tests via headless Chrome browser (requires Chrome 64+)
|
||||
npm run cypress-run-chrome
|
||||
|
||||
# use interactive mode to run tests, while keeping memory usage contained (default is 50!)
|
||||
npx cypress open --config numTestsKeptInMemory=3
|
||||
|
||||
# run tests from a specific file
|
||||
npm run cypress-run-chrome -- --spec cypress/e2e/explore/link.test.ts
|
||||
|
||||
|
|
|
|||
|
|
@ -55,7 +55,9 @@ def run_cypress_for_test_file(
|
|||
group_id = f"matrix{group}-file{i}-{attempt}"
|
||||
cmd = (
|
||||
f"{XVFB_PRE_CMD} "
|
||||
f'{cypress_cmd} --spec "{test_file}" --browser {browser} '
|
||||
f'{cypress_cmd} --spec "{test_file}" '
|
||||
f"--config numTestsKeptInMemory=0 "
|
||||
f"--browser {browser} "
|
||||
f"--record --group {group_id} --tag {REPO},{GITHUB_EVENT_NAME} "
|
||||
f"--ci-build-id {build_id} "
|
||||
f"-- {chrome_flags}"
|
||||
|
|
@ -64,7 +66,9 @@ def run_cypress_for_test_file(
|
|||
os.environ.pop("CYPRESS_RECORD_KEY", None)
|
||||
cmd = (
|
||||
f"{XVFB_PRE_CMD} "
|
||||
f"{cypress_cmd} --browser {browser} "
|
||||
f"{cypress_cmd} "
|
||||
f"--browser {browser} "
|
||||
f"--config numTestsKeptInMemory=0 "
|
||||
f'--spec "{test_file}" '
|
||||
f"-- {chrome_flags}"
|
||||
)
|
||||
|
|
|
|||
|
|
@ -26,8 +26,9 @@ export default eyesPlugin(
|
|||
defineConfig({
|
||||
chromeWebSecurity: false,
|
||||
defaultCommandTimeout: 8000,
|
||||
numTestsKeptInMemory: 0,
|
||||
experimentalFetchPolyfill: true,
|
||||
numTestsKeptInMemory: 5,
|
||||
// Disabled after realizing this MESSES UP rison encoding in intricate ways
|
||||
experimentalFetchPolyfill: false,
|
||||
experimentalMemoryManagement: true,
|
||||
requestTimeout: 10000,
|
||||
video: false,
|
||||
|
|
@ -62,6 +63,7 @@ export default eyesPlugin(
|
|||
}
|
||||
return launchOptions;
|
||||
});
|
||||
|
||||
// eslint-disable-next-line global-require
|
||||
require('@cypress/code-coverage/task')(on, config);
|
||||
on('task', verifyDownloadTasks);
|
||||
|
|
@ -70,6 +72,7 @@ export default eyesPlugin(
|
|||
},
|
||||
baseUrl: 'http://localhost:8088',
|
||||
excludeSpecPattern: [],
|
||||
experimentalRunAllSpecs: true,
|
||||
specPattern: [
|
||||
'cypress/e2e/**/*.{js,jsx,ts,tsx}',
|
||||
'cypress/applitools/**/*.{js,jsx,ts,tsx}',
|
||||
|
|
|
|||
|
|
@ -26,6 +26,7 @@ import {
|
|||
visitSampleChartFromList,
|
||||
saveChartToDashboard,
|
||||
interceptFiltering,
|
||||
interceptFavoriteStatus,
|
||||
} from '../explore/utils';
|
||||
import { interceptGet as interceptDashboardGet } from '../dashboard/utils';
|
||||
|
||||
|
|
@ -49,8 +50,10 @@ function confirmDelete() {
|
|||
|
||||
function visitChartList() {
|
||||
interceptFiltering();
|
||||
interceptFavoriteStatus();
|
||||
cy.visit(CHART_LIST);
|
||||
cy.wait('@filtering');
|
||||
cy.wait('@favoriteStatus');
|
||||
}
|
||||
|
||||
describe('Charts list', () => {
|
||||
|
|
@ -78,20 +81,15 @@ describe('Charts list', () => {
|
|||
cy.wait('@get');
|
||||
});
|
||||
|
||||
it('should show the newly added dashboards in a tooltip', () => {
|
||||
it.only('should show the newly added dashboards in a tooltip', () => {
|
||||
interceptDashboardGet();
|
||||
visitSampleChartFromList('1 - Sample chart');
|
||||
saveChartToDashboard('1 - Sample dashboard');
|
||||
saveChartToDashboard('2 - Sample dashboard');
|
||||
saveChartToDashboard('3 - Sample dashboard');
|
||||
visitChartList();
|
||||
|
||||
cy.getBySel('count-crosslinks').should('be.visible');
|
||||
cy.getBySel('crosslinks').first().trigger('mouseover');
|
||||
cy.get('.antd5-tooltip')
|
||||
.contains('3 - Sample dashboard')
|
||||
.invoke('removeAttr', 'target')
|
||||
.click();
|
||||
cy.wait('@get');
|
||||
});
|
||||
});
|
||||
|
||||
|
|
@ -116,7 +114,7 @@ describe('Charts list', () => {
|
|||
|
||||
it('should sort correctly in list mode', () => {
|
||||
cy.getBySel('sort-header').eq(1).click();
|
||||
cy.getBySel('table-row').first().contains('% Rural');
|
||||
cy.getBySel('table-row').first().contains('Area Chart');
|
||||
cy.getBySel('sort-header').eq(1).click();
|
||||
cy.getBySel('table-row').first().contains("World's Population");
|
||||
cy.getBySel('sort-header').eq(1).click();
|
||||
|
|
|
|||
|
|
@ -41,8 +41,10 @@ function openMenu() {
|
|||
}
|
||||
|
||||
function confirmDelete() {
|
||||
cy.getBySel('delete-modal-input').type('DELETE');
|
||||
cy.getBySel('modal-confirm-button').click();
|
||||
// Wait for modal dialog to be present and visible
|
||||
cy.get('[role="dialog"][aria-modal="true"]').should('be.visible');
|
||||
cy.getBySel('delete-modal-input').should('be.visible').clear().type('DELETE');
|
||||
cy.getBySel('modal-confirm-button').should('be.visible').click();
|
||||
}
|
||||
|
||||
describe('Dashboards list', () => {
|
||||
|
|
|
|||
|
|
@ -31,6 +31,10 @@ export function interceptDelete() {
|
|||
cy.intercept('DELETE', `/api/v1/chart/*`).as('delete');
|
||||
}
|
||||
|
||||
export function interceptFavoriteStatus() {
|
||||
cy.intercept('GET', '/api/v1/chart/favorite_status/*').as('favoriteStatus');
|
||||
}
|
||||
|
||||
export function interceptUpdate() {
|
||||
cy.intercept('PUT', `/api/v1/chart/*`).as('update');
|
||||
}
|
||||
|
|
@ -68,7 +72,10 @@ export function saveChartToDashboard(dashboardName: string) {
|
|||
interceptUpdate();
|
||||
interceptExploreGet();
|
||||
|
||||
cy.getBySel('query-save-button').click();
|
||||
cy.getBySel('query-save-button')
|
||||
.should('be.enabled')
|
||||
.should('not.be.disabled')
|
||||
.click();
|
||||
cy.getBySelLike('chart-modal').should('be.visible');
|
||||
cy.get(
|
||||
'[data-test="save-chart-modal-select-dashboard-form"] [aria-label="Select a dashboard"]',
|
||||
|
|
|
|||
|
|
@ -27,6 +27,10 @@ require('cy-verify-downloads').addCustomCommand();
|
|||
|
||||
// fail on console error, allow config to override individual tests
|
||||
// these exceptions are a little pile of tech debt
|
||||
//
|
||||
|
||||
// DISABLING FOR NOW
|
||||
/*
|
||||
const { getConfig, setConfig } = failOnConsoleError({
|
||||
consoleMessages: [
|
||||
/\[webpack-dev-server\]/,
|
||||
|
|
@ -35,7 +39,9 @@ const { getConfig, setConfig } = failOnConsoleError({
|
|||
'Error: Unknown Error',
|
||||
/Unable to infer path to ace from script src/,
|
||||
],
|
||||
includeConsoleTypes: ['error'],
|
||||
});
|
||||
*/
|
||||
|
||||
// Set individual tests to allow certain console errors to NOT fail, e.g
|
||||
// cy.allowConsoleErrors(['foo', /^some bar-regex.*/]);
|
||||
|
|
@ -161,7 +167,18 @@ Cypress.Commands.add('login', () => {
|
|||
url: '/login/',
|
||||
body: { username: 'admin', password: 'general' },
|
||||
}).then(response => {
|
||||
if (response.status === 302) {
|
||||
// If there's a redirect, follow it manually
|
||||
const redirectUrl = response.headers['location'];
|
||||
cy.request({
|
||||
method: 'GET',
|
||||
url: redirectUrl,
|
||||
}).then(finalResponse => {
|
||||
expect(finalResponse.status).to.eq(200);
|
||||
});
|
||||
} else {
|
||||
expect(response.status).to.eq(200);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ from superset.stats_logger import DummyStatsLogger
|
|||
from superset.superset_typing import CacheConfig
|
||||
from superset.tasks.types import ExecutorType
|
||||
from superset.utils import core as utils
|
||||
from superset.utils.core import is_test, NO_TIME_RANGE, parse_boolean_string
|
||||
from superset.utils.core import NO_TIME_RANGE, parse_boolean_string
|
||||
from superset.utils.encrypt import SQLAlchemyUtilsAdapter
|
||||
from superset.utils.log import DBEventLogger
|
||||
from superset.utils.logging_configurator import DefaultLoggingConfigurator
|
||||
|
|
@ -1931,7 +1931,7 @@ if CONFIG_PATH_ENV_VAR in os.environ:
|
|||
"Failed to import config for %s=%s", CONFIG_PATH_ENV_VAR, cfg_path
|
||||
)
|
||||
raise
|
||||
elif importlib.util.find_spec("superset_config") and not is_test():
|
||||
elif importlib.util.find_spec("superset_config"):
|
||||
try:
|
||||
# pylint: disable=import-error,wildcard-import,unused-wildcard-import
|
||||
import superset_config
|
||||
|
|
|
|||
|
|
@ -149,3 +149,4 @@ CUSTOM_TEMPLATE_PROCESSORS = {
|
|||
}
|
||||
|
||||
PRESERVE_CONTEXT_ON_EXCEPTION = False
|
||||
print("Loaded TEST config for INTEGRATION tests")
|
||||
|
|
|
|||
Loading…
Reference in New Issue