Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Extract tools/lib/test_server.py 

This new module abstracts the setting up of a test
server for tests to run, pulling existing code from
casper and paving the way for API tests in the future.
This commit is contained in:
Steve Howell 2017-01-12 16:09:52 -08:00 committed by Tim Abbott
parent 29ef623ce9
commit c6b2d531ef
2 changed files with 101 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
frontend_tests/run-casper
View File

@ -1,8 +1,7 @@
#!/usr/bin/env python
from __future__ import print_function
import subprocess
import optparse
import time
import subprocess
import sys
import os
import glob
@ -10,8 +9,6 @@ try:
# We don't actually need typing, but it's a good guard for being
# outside a Zulip virtualenv.
from typing import Iterable
import requests
import django
except ImportError as e:
print("ImportError: {}".format(e))
print("You need to run the Zulip tests inside a Zulip dev environment.")
@ -26,7 +23,6 @@ except ImportError as e:
# on how to use remote debugging
#
os.environ["TORNADO_SERVER"] = "http://127.0.0.1:9983"
os.environ["CASPER_TESTS"] = "1"
os.environ["PHANTOMJS_EXECUTABLE"] = os.path.join(os.path.dirname(__file__), "../node_modules/.bin/phantomjs")
@ -53,9 +49,8 @@ parser.add_option('--remote-debug',
TOOLS_DIR = os.path.dirname(os.path.abspath(__file__))
sys.path.insert(0, os.path.dirname(TOOLS_DIR))
from tools.lib.test_script import (
get_provisioning_status,
)
from tools.lib.test_script import get_provisioning_status
from tools.lib.test_server import test_server_running
if not options.force:
ok, msg = get_provisioning_status()
@ -64,11 +59,6 @@ if not options.force:
print('If you really know what you are doing, use --force to run anyway.')
sys.exit(1)
from zerver.lib.test_fixtures import is_template_database_current
os.environ['DJANGO_SETTINGS_MODULE'] = 'zproject.test_settings'
django.setup()
os.environ['PYTHONUNBUFFERED'] = 'y'
os.chdir(os.path.join(os.path.dirname(os.path.realpath(__file__)), '..'))
subprocess.check_call('tools/setup/generate-test-credentials')
@ -84,23 +74,8 @@ if os.path.exists(LOG_FILE) and os.path.getsize(LOG_FILE) < 100000:
else:
log = open(LOG_FILE, 'w')
def assert_server_running(server):
# type: (subprocess.Popen) -> None
"""Get the exit code of the server, or None if it is still running."""
if server.poll() is not None:
raise RuntimeError('Server died unexpectedly! Check %s' % (LOG_FILE,))
def server_is_up(server):
# type: (subprocess.Popen) -> bool
assert_server_running(server)
try:
# We could get a 501 error if the reverse proxy is up but the Django app isn't.
return requests.get('http://127.0.0.1:9981/accounts/home').status_code == 200
except:
return False
def run_tests(realms_have_subdomains, files):
# type: (bool, Iterable[str]) -> None
def run_tests(realms_have_subdomains, files, external_host):
# type: (bool, Iterable[str], str) -> None
test_dir = os.path.join(os.path.dirname(__file__), '../frontend_tests/casper_tests')
test_files = []
for file in files:
@ -112,12 +87,6 @@ def run_tests(realms_have_subdomains, files):
file = os.path.join(test_dir, file)
test_files.append(os.path.abspath(file))
generate_fixtures_command = ['tools/setup/generate-fixtures']
if not is_template_database_current():
generate_fixtures_command.append('--force')
subprocess.check_call(generate_fixtures_command)
if not test_files:
test_files = sorted(glob.glob(os.path.join(test_dir, '*.js')))
@ -129,24 +98,8 @@ def run_tests(realms_have_subdomains, files):
if options.remote_debug:
remote_debug = "--remote-debugger-port=7777 --remote-debugger-autorun=yes"
# Run this not through the shell, so that we have the actual PID.
run_dev_server_command = ['tools/run-dev.py', '--test']
if options.force:
run_dev_server_command.append('--force')
server = subprocess.Popen(run_dev_server_command,
stdout=log, stderr=log)
ret = 1
try:
# Wait for the server to start up.
sys.stdout.write('Waiting for test server')
while not server_is_up(server):
sys.stdout.write('.')
sys.stdout.flush()
time.sleep(0.1)
sys.stdout.write('\n')
with test_server_running(options.force, external_host, log, dots=True):
ret = 1
for test_file in test_files:
cmd = "node_modules/.bin/casperjs %s test --subdomains=%s %s" % (
remote_debug, realms_have_subdomains, test_file)
@ -154,10 +107,6 @@ def run_tests(realms_have_subdomains, files):
ret = subprocess.call(cmd, shell=True)
if ret != 0:
break
finally:
assert_server_running(server)
server.terminate()
if ret != 0:
print("""
Oops, the frontend tests failed. Tips for debugging:
@ -168,14 +117,15 @@ Oops, the frontend tests failed. Tips for debugging:
sys.exit(ret)
os.environ["EXTERNAL_HOST"] = "localhost:9981"
external_host = "localhost:9981"
# First, run all tests with REALMS_HAVE_SUBDOMAINS set to False
run_tests(False, args)
run_tests(False, args, external_host)
# Now run a subset of the tests with REALMS_HAVE_SUBDOMAINS set to True
os.environ["REALMS_HAVE_SUBDOMAINS"] = "True"
os.environ["EXTERNAL_HOST"] = "zulipdev.com:9981"
external_host = "zulipdev.com:9981"
if len(args) == 0:
run_tests(True, ["00-realm-creation.js", "01-login.js", "02-site.js"])
run_tests(True, ["00-realm-creation.js", "01-login.js", "02-site.js"], external_host)
else:
run_tests(True, args)
run_tests(True, args, external_host)
sys.exit(0)

88
tools/lib/test_server.py Normal file
View File

@ -0,0 +1,88 @@
from __future__ import print_function
import os
import subprocess
import sys
import time
from contextlib import contextmanager
if False:
from typing import (Any, Iterator)
try:
import django
import requests
except ImportError as e:
print("ImportError: {}".format(e))
print("You need to run the Zulip tests inside a Zulip dev environment.")
print("If you are using Vagrant, you can `vagrant ssh` to enter the Vagrant guest.")
sys.exit(1)
TOOLS_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
if TOOLS_DIR not in sys.path:
sys.path.insert(0, os.path.dirname(TOOLS_DIR))
from zerver.lib.test_fixtures import is_template_database_current
def set_up_django(external_host):
# type: (str) -> None
os.environ['EXTERNAL_HOST'] = external_host
os.environ["TORNADO_SERVER"] = "http://127.0.0.1:9983"
os.environ['DJANGO_SETTINGS_MODULE'] = 'zproject.test_settings'
django.setup()
os.environ['PYTHONUNBUFFERED'] = 'y'
def assert_server_running(server):
# type: (subprocess.Popen) -> None
"""Get the exit code of the server, or None if it is still running."""
if server.poll() is not None:
raise RuntimeError('Server died unexpectedly!')
def server_is_up(server):
# type: (subprocess.Popen) -> bool
assert_server_running(server)
try:
# We could get a 501 error if the reverse proxy is up but the Django app isn't.
return requests.get('http://127.0.0.1:9981/accounts/home').status_code == 200
except:
return False
@contextmanager
def test_server_running(force=False, external_host='testserver', log=sys.stdout, dots=False):
# type: (bool, str, Any, bool) -> Iterator[None]
set_up_django(external_host)
generate_fixtures_command = ['tools/setup/generate-fixtures']
if not is_template_database_current():
generate_fixtures_command.append('--force')
subprocess.check_call(generate_fixtures_command)
# Run this not through the shell, so that we have the actual PID.
run_dev_server_command = ['tools/run-dev.py', '--test']
if force:
run_dev_server_command.append('--force')
server = subprocess.Popen(run_dev_server_command,
stdout=log, stderr=log)
try:
# Wait for the server to start up.
sys.stdout.write('Waiting for test server')
while not server_is_up(server):
if dots:
sys.stdout.write('.')
sys.stdout.flush()
time.sleep(0.1)
sys.stdout.write('\n')
# DO OUR ACTUAL TESTING HERE!!!
yield
finally:
assert_server_running(server)
server.terminate()
if __name__ == '__main__':
# The code below is for testing this module works
with test_server_running():
print('\n\n SERVER IS UP!\n\n')