mirror of https://github.com/zulip/zulip.git
139 lines
4.8 KiB
Python
Executable File
139 lines
4.8 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
import argparse
|
|
import os
|
|
import shlex
|
|
import subprocess
|
|
import sys
|
|
|
|
sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
|
|
from scripts.lib.zulip_tools import ENDC, FAIL, OKGREEN
|
|
|
|
ZULIP_PATH = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
|
|
|
# Request the special webpack setup for frontend integration tests,
|
|
# where webpack assets are compiled up front rather than running in
|
|
# watch mode.
|
|
os.environ["PUPPETEER_TESTS"] = "1"
|
|
|
|
# The locale can have impact how Firefox does locale-aware sorting,
|
|
# which we do verify in some tests.
|
|
os.environ["LC_ALL"] = "en_US.UTF-8"
|
|
|
|
os.environ["CHROMIUM_EXECUTABLE"] = os.path.join(ZULIP_PATH, "node_modules/.bin/chromium")
|
|
os.environ.pop("http_proxy", "")
|
|
os.environ.pop("https_proxy", "")
|
|
|
|
usage = """test-js-with-puppeteer [options]
|
|
test-js-with-puppeteer # Run all test files
|
|
test-js-with-puppeteer 09-navigation.js # Run a single test file
|
|
test-js-with-puppeteer 09 # Run a single test file 09-navigation.js
|
|
test-js-with-puppeteer 01-login.js 03-narrow.js # Run a few test files
|
|
test-js-with-puppeteer 01 03 # Run a few test files, 01-login.js and 03-narrow.js here"""
|
|
|
|
sys.path.insert(0, ZULIP_PATH)
|
|
|
|
# check for the venv
|
|
from tools.lib import sanity_check
|
|
|
|
sanity_check.check_venv(__file__)
|
|
|
|
from typing import Iterable, Tuple
|
|
|
|
from tools.lib.test_script import (
|
|
add_provision_check_override_param,
|
|
assert_provisioning_status_ok,
|
|
find_js_test_files,
|
|
prepare_puppeteer_run,
|
|
)
|
|
from tools.lib.test_server import test_server_running
|
|
|
|
parser = argparse.ArgumentParser(usage)
|
|
|
|
parser.add_argument("--interactive", action="store_true", help="Run tests interactively")
|
|
add_provision_check_override_param(parser)
|
|
parser.add_argument("--firefox", action="store_true", help="Run tests with firefox.")
|
|
parser.add_argument(
|
|
"tests", nargs=argparse.REMAINDER, help="Specific tests to run; by default, runs all tests"
|
|
)
|
|
|
|
options = parser.parse_args()
|
|
|
|
|
|
def run_tests(files: Iterable[str], external_host: str) -> None:
|
|
test_dir = os.path.join(ZULIP_PATH, "frontend_tests/puppeteer_tests")
|
|
test_files = find_js_test_files(test_dir, files)
|
|
|
|
def run_tests(test_number: int = 0) -> Tuple[int, int]:
|
|
ret = 1
|
|
current_test_num = test_number
|
|
for test_file in test_files[test_number:]:
|
|
test_name = os.path.basename(test_file)
|
|
cmd = [
|
|
"node",
|
|
"--unhandled-rejections=strict",
|
|
os.path.join(ZULIP_PATH, "node_modules/.bin/ts-node"),
|
|
"--script-mode",
|
|
"--transpile-only",
|
|
test_file,
|
|
]
|
|
print(
|
|
"\n\n===================== {}\nRunning {}\n\n".format(
|
|
test_name, " ".join(map(shlex.quote, cmd))
|
|
),
|
|
flush=True,
|
|
)
|
|
ret = subprocess.call(cmd)
|
|
if ret != 0:
|
|
return ret, current_test_num
|
|
current_test_num += 1
|
|
return 0, -1
|
|
|
|
with test_server_running(False, external_host):
|
|
# Important: do this next call inside the `with` block, when Django
|
|
# will be pointing at the test database.
|
|
subprocess.check_call("tools/setup/generate-test-credentials")
|
|
if options.interactive:
|
|
response = input('Press Enter to run tests, "q" to quit: ')
|
|
ret = 1
|
|
failed_test_num = 0
|
|
while response != "q" and failed_test_num != -1:
|
|
ret, failed_test_num = run_tests(failed_test_num)
|
|
if ret != 0:
|
|
response = input('Tests failed. Press Enter to re-run tests, "q" to quit: ')
|
|
else:
|
|
ret = 1
|
|
ret = run_tests()[0]
|
|
if ret != 0:
|
|
print(
|
|
f"""
|
|
{FAIL}The Puppeteer frontend tests failed!{ENDC}
|
|
For help debugging, read:
|
|
https://zulip.readthedocs.io/en/latest/testing/testing-with-puppeteer.html
|
|
or report and ask for help in chat.zulip.org""",
|
|
file=sys.stderr,
|
|
)
|
|
if os.environ.get("GITHUB_ACTIONS"):
|
|
print("", file=sys.stderr)
|
|
print(
|
|
"""
|
|
See https://docs.github.com/en/rest/reference/actions#artifacts for information
|
|
on how to view the generated screenshots, which are uploaded as Artifacts.
|
|
Screenshots are extremely helpful for understanding puppeteer test failures.
|
|
""",
|
|
file=sys.stderr,
|
|
)
|
|
print("", file=sys.stderr)
|
|
else:
|
|
print(
|
|
"It's also worthy to see screenshots generated on failure stored under var/puppeteer/*.png"
|
|
)
|
|
sys.exit(ret)
|
|
|
|
|
|
external_host = "zulipdev.com:9981"
|
|
assert_provisioning_status_ok(options.skip_provision_check)
|
|
prepare_puppeteer_run(is_firefox=options.firefox)
|
|
run_tests(options.tests, external_host)
|
|
print(f"{OKGREEN}All tests passed!{ENDC}")
|
|
sys.exit(0)
|