def test_stop_broken_orderly_web():
path = "config/breaking"
try:
start_failed = False
try:
orderly_web.start(path)
except docker.errors.APIError:
start_failed = True
assert start_failed
stop_failed = False
try:
orderly_web.stop("config/breaking")
except OrderlyWebConfigError:
stop_failed = True
assert stop_failed
with docker_client() as cl:
assert container_exists(cl, "orderly_web_orderly")
finally:
orderly_web.stop(path, force=True, network=True, volumes=True)
with docker_client() as cl:
assert not container_exists(cl, "orderly_web_orderly")
def test_can_start_with_prepared_volume():
path = "config/basic"
options = {"orderly": {"initial": None}}
cfg = build_config(path, options=options)
# ensure this test behaves sensibly if state is a bit messy:
with docker_client() as cl:
remove_volume(cl, cfg.volumes["orderly"])
image = str(cfg.images["orderly"])
mounts = [docker.types.Mount("/orderly", cfg.volumes["orderly"])]
args = ["Rscript", "-e", "orderly:::create_orderly_demo('/orderly')"]
cl.containers.run(image,
entrypoint=args,
mounts=mounts,
auto_remove=True)
try:
f = io.StringIO()
with redirect_stdout(f):
res = orderly_web.start(path, options=options)
assert res
out = f.getvalue()
expected = 'orderly volume already contains data - not initialising'
assert expected in out.splitlines()
finally:
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_vault_github_login_with_mount_path():
os.environ["VAULT_AUTH_GITHUB_TOKEN"] = os.environ["VAULT_TEST_GITHUB_PAT"]
with vault_dev.server() as s:
cl = s.client()
enable_github_login(cl, path="github-custom")
cl.write("secret/db/password", value="s3cret")
path = "config/vault"
vault_addr = "http://localhost:{}".format(s.port)
options = {
"vault": {
"addr": vault_addr,
"auth": {
"method": "github",
"args": {
"mount_point": "github-custom"
}
}
}
}
orderly_web.start(path, options=options)
cfg = fetch_config(path)
container = cfg.get_container("orderly")
res = string_from_container(container, "/root/.Renviron")
assert "ORDERLY_DB_PASS=s3cret" in res
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_can_pull_on_deploy():
path = "config/noproxy"
migrate_image = orderly_web.config.build_config(path).images["migrate"]
with docker_client() as cl:
try:
cl.images.remove(str(migrate_image), noprune=True)
except docker.errors.ImageNotFound:
pass
res = orderly_web.start(path, pull_images=True)
img = cl.images.get(str(migrate_image))
assert str(migrate_image) in img.tags
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_no_devmode_no_ports():
path = "config/noproxy"
options = {"web": {"dev_mode": False, "url": "http://localhost"}}
try:
orderly_web.start(path, options=options)
cfg = fetch_config(path)
assert not cfg.web_dev_mode
web = cfg.get_container("web")
assert web.attrs["HostConfig"]["PortBindings"] is None
finally:
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_notifies_slack_on_success():
with patch.object(Notifier, 'post', return_value=None) as mock_notify:
path = "config/basic"
try:
orderly_web.start(path)
finally:
orderly_web.stop(path, kill=True, volumes=True, network=True)
calls = [
call("*Starting* deploy to https://localhost"),
call("*Completed* deploy to https://localhost :shipit:")
]
mock_notify.assert_has_calls(calls)
def test_notifies_slack_on_fail():
with patch.object(Notifier, 'post', return_value=None) as mock_notify:
path = "config/breaking"
try:
orderly_web.start(path)
except docker.errors.APIError:
start_failed = True
finally:
orderly_web.stop(path, force=True, network=True, volumes=True)
calls = [
call("*Starting* deploy to https://localhost"),
call("*Failed* deploy to https://localhost :bomb:")
]
mock_notify.assert_has_calls(calls)
def test_vault_ssl():
with vault_dev.server() as s:
cl = s.client()
# Copy the certificates into the vault where we will later on
# pull from from.
cert = read_file("proxy/ssl/certificate.pem")
key = read_file("proxy/ssl/key.pem")
cl.write("secret/ssl/certificate", value=cert)
cl.write("secret/ssl/key", value=key)
cl.write("secret/db/password", value="s3cret")
cl.write("secret/github/id", value="ghid")
cl.write("secret/github/secret", value="ghs3cret")
cl.write("secret/ssh",
public="public-key-data",
private="private-key-data")
cl.write("secret/slack/webhook", value="http://webhook")
path = "config/complete"
vault_addr = "http://localhost:{}".format(s.port)
vault_auth = {"args": {"token": s.token}}
options = {"vault": {"addr": vault_addr, "auth": vault_auth}}
res = orderly_web.start(path, options=options)
dat = json.loads(http_get("https://localhost/api/v1"))
assert dat["status"] == "success"
cfg = fetch_config(path)
container = cfg.get_container("orderly")
res = string_from_container(container, "/root/.Renviron")
assert "ORDERLY_DB_PASS=s3cret" in res
private = string_from_container(container, "/root/.ssh/id_rsa")
assert private == "private-key-data"
public = string_from_container(container, "/root/.ssh/id_rsa.pub")
assert public == "public-key-data"
known_hosts = string_from_container(container,
"/root/.ssh/known_hosts")
assert "github.com" in known_hosts
web_container = cfg.get_container("web")
web_config = string_from_container(
web_container, "/etc/orderly/web/config.properties").split("\n")
assert "auth.github_key=ghid" in web_config
assert "auth.github_secret=ghs3cret" in web_config
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_error_if_orderly_not_initialised():
path = "config/basic"
options = {"orderly": {"initial": None}}
cfg = build_config(path, options=options)
# ensure this test behaves sensibly if state is a bit messy:
with docker_client() as cl:
remove_volume(cl, cfg.volumes["orderly"])
try:
with pytest.raises(Exception, match="Orderly volume not initialised"):
res = orderly_web.start(path, options=options)
finally:
orderly_web.stop(path,
force=True,
network=True,
volumes=True,
kill=True)
def test_status_from_broken_orderly_web():
path = "config/breaking"
try:
start_failed = False
try:
orderly_web.start(path)
except docker.errors.APIError:
start_failed = True
assert start_failed
status = orderly_web.status(path)
assert str(status) == "Cannot read status from orderly-web because " \
"it has not started successfully or is in an error state."
finally:
orderly_web.stop(path, force=True, network=True, volumes=True)
def test_start_with_custom_styles():
path = "config/customcss"
try:
options = {"web": {"url": "http://localhost:8888"}}
res = orderly_web.start(path, options=options)
assert res
st = orderly_web.status(path)
assert st.containers["orderly"]["status"] == "running"
assert st.containers["web"]["status"] == "running"
assert st.volumes["css"] == "orderly_web_css"
assert "documents" not in st.volumes
assert st.network == "orderly_web_network"
cfg = fetch_config(path)
# check that the style volume is really mounted
api_client = docker.client.from_env().api
details = api_client.inspect_container(cfg.containers["web"])
assert len(details['Mounts']) == 3
css_volume = [
v for v in details['Mounts']
if v['Type'] == "volume" and v['Name'] == "orderly_web_css"
][0]
assert css_volume['Name'] == "orderly_web_css"
assert css_volume['Destination'] == "/static/public/css"
# check that the style files have been compiled with the custom vars
web_container = cfg.get_container("web")
style = string_from_container(web_container,
"/static/public/css/style.css")
assert "/* Example custom config */" in style
# check that js files are there also
res = requests.get("http://localhost:8888/js/index.bundle.js")
assert res.status_code == 200
# check that the custom logo is mounted and appears on the page
logo_mount = [v for v in details['Mounts'] if v['Type'] == "bind"][0]
expected_destination = "/static/public/img/logo/my-test-logo.png"
assert logo_mount['Destination'] == expected_destination
res = requests.get("http://localhost:8888")
assert """<img src="http://localhost:8888/img/logo/my-test-logo.png"""\
in res.text
res = requests.get("http://localhost:8888/img/logo/my-test-logo.png")
assert res.status_code == 200
finally:
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_without_github_app_for_montagu():
path = "config/basic"
options = {
"web": {
"auth": {
"montagu": True,
"montagu_url": "montagu",
"montagu_api_url": "montagu/api",
"github_key": None,
"github_secret": None
}
}
}
res = orderly_web.start(path, options=options)
assert res
st = orderly_web.status(path)
assert st.containers["orderly"]["status"] == "running"
assert st.containers["web"]["status"] == "running"
assert st.network == "orderly_web_network"
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_start_with_montagu_config():
path = "config/montagu"
try:
res = orderly_web.start(path)
assert res
st = orderly_web.status(path)
assert st.containers["orderly"]["status"] == "running"
assert st.containers["web"]["status"] == "running"
assert st.network == "orderly_web_network"
cfg = fetch_config(path)
web = cfg.get_container("web")
web_config = string_from_container(
web, "/etc/orderly/web/config.properties").split("\n")
assert "montagu.url=http://montagu" in web_config
assert "montagu.api_url=http://montagu/api" in web_config
assert 'auth.github_org=' in web_config
assert 'auth.github_team=' in web_config
finally:
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_admin_cli():
path = "config/basic"
try:
orderly_web.start(path)
result = orderly_web.add_users(path, ["*****@*****.**"])
expected = "Saved user with email '*****@*****.**' to the " \
"database"
assert expected in result
result = orderly_web.add_groups(path, ["funders"])
assert "Saved user group 'funders' to the database" in result
result = orderly_web.add_members(path, "funders",
["*****@*****.**"])
expected = "Added user with email '*****@*****.**' to user " \
"group 'funders'"
assert expected in result
result = orderly_web.grant(path, "funders", ["*/reports.read"])
expected = "Gave user group 'funders' the permission '*/reports.read'"
assert expected in result
result = orderly_web.grant(path, "funders", ["*/nonsense"])
assert "Unknown permission : 'nonsense'" in result
finally:
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_vault_github_login_with_prompt():
if "VAULT_AUTH_GITHUB_TOKEN" in os.environ:
del os.environ["VAULT_AUTH_GITHUB_TOKEN"]
with mock.patch('builtins.input',
return_value=os.environ["VAULT_TEST_GITHUB_PAT"]):
with vault_dev.server() as s:
cl = s.client()
enable_github_login(cl)
cl.write("secret/db/password", value="s3cret")
path = "config/vault"
vault_addr = "http://localhost:{}".format(s.port)
options = {"vault": {"addr": vault_addr}}
orderly_web.start(path, options=options)
cfg = fetch_config(path)
container = cfg.get_container("orderly")
res = string_from_container(container, "/root/.Renviron")
assert "ORDERLY_DB_PASS=s3cret" in res
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_start_and_stop_multiple_workers():
options = {"orderly": {"workers": 2}}
path = "config/basic"
try:
res = orderly_web.start(path, options=options)
assert res
st = orderly_web.status(path)
assert st.containers["orderly"]["status"] == "running"
assert st.containers["redis"]["status"] == "running"
assert st.containers["web"]["status"] == "running"
assert len(st.container_groups) == 1
assert "orderly_worker" in st.container_groups
assert st.container_groups["orderly_worker"]["count"] == 2
assert len(st.container_groups["orderly_worker"]["status"]) == 2
assert re.match(
r"orderly_web_orderly_worker_\w+",
st.container_groups["orderly_worker"]["status"][0]["name"])
assert st.container_groups["orderly_worker"]["status"][0]["status"] ==\
"running"
assert re.match(
r"orderly_web_orderly_worker_\w+",
st.container_groups["orderly_worker"]["status"][1]["name"])
assert st.container_groups["orderly_worker"]["status"][1]["status"] ==\
"running"
# Bring the whole lot down:
orderly_web.stop(path, kill=True, volumes=True, network=True)
st = orderly_web.status(path)
assert not st.is_running
assert st.containers["orderly"]["status"] == "missing"
assert st.containers["redis"]["status"] == "missing"
assert st.containers["web"]["status"] == "missing"
assert st.container_groups["orderly_worker"]["count"] == 0
assert len(st.container_groups["orderly_worker"]["status"]) == 0
finally:
orderly_web.stop(path, kill=True, volumes=True, network=True)
def test_stop_broken_orderly_web_with_option():
path = "config/breaking"
options = [{"network": "ow_broken_test"}]
try:
start_failed = False
try:
orderly_web.start(path, options=options)
except docker.errors.APIError:
start_failed = True
assert start_failed
with docker_client() as cl:
assert container_exists(cl, "orderly_web_orderly")
assert network_exists(cl, "ow_broken_test")
finally:
orderly_web.stop(path,
force=True,
network=True,
volumes=True,
options=options)
with docker_client() as cl:
assert not container_exists(cl, "orderly_web_orderly")
assert not network_exists(cl, "ow_broken_test")
def test_stop_broken_orderly_web_with_extra():
path = "config/breaking"
extra = "extra" # defines network as "ow_broken_extra_test"
try:
start_failed = False
try:
orderly_web.start(path, extra=extra)
except docker.errors.APIError:
start_failed = True
assert start_failed
with docker_client() as cl:
assert container_exists(cl, "orderly_web_orderly")
assert network_exists(cl, "ow_broken_extra_test")
finally:
orderly_web.stop(path,
force=True,
network=True,
volumes=True,
extra=extra)
with docker_client() as cl:
assert not container_exists(cl, "orderly_web_orderly")
assert not network_exists(cl, "ow_broken_extra_test")
def test_start_and_stop():
path = "config/basic"
try:
res = orderly_web.start(path)
assert res
st = orderly_web.status(path)
assert st.containers["orderly"]["status"] == "running"
assert st.containers["redis"]["status"] == "running"
assert st.containers["web"]["status"] == "running"
assert len(st.container_groups) == 1
assert "orderly_worker" in st.container_groups
assert st.container_groups["orderly_worker"]["scale"] == 1
assert st.container_groups["orderly_worker"]["count"] == 1
assert len(st.container_groups["orderly_worker"]["status"]) == 1
assert re.match(
r"orderly_web_orderly_worker_\w+",
st.container_groups["orderly_worker"]["status"][0]["name"])
assert st.container_groups["orderly_worker"]["status"][0]["status"] ==\
"running"
assert st.volumes["orderly"] == "orderly_web_volume"
assert st.volumes["documents"] == "orderly_web_documents"
assert st.volumes["redis"] == "orderly_web_redis_data"
assert st.network == "orderly_web_network"
f = io.StringIO()
with redirect_stdout(f):
res = orderly_web.start(path)
msg = f.getvalue().strip()
assert not res
assert msg.endswith("please run orderly-web stop")
cfg = fetch_config(path)
web = cfg.get_container("web")
ports = web.attrs["HostConfig"]["PortBindings"]
assert list(ports.keys()) == ["8888/tcp"]
dat = json.loads(http_get("http://localhost:8888/api/v1"))
assert dat["status"] == "success"
web_config = string_from_container(
web, "/etc/orderly/web/config.properties").split("\n")
assert "app.url=https://localhost" in web_config
assert "auth.github_key=notarealid" in web_config
assert "auth.github_secret=notarealsecret" in web_config
assert "orderly.server=http://orderly_web_orderly:8321" in web_config
# Trivial check that the proxy container works too:
proxy = cfg.get_container("proxy")
ports = proxy.attrs["HostConfig"]["PortBindings"]
assert set(ports.keys()) == set(["443/tcp", "80/tcp"])
dat = json.loads(http_get("http://localhost/api/v1"))
assert dat["status"] == "success"
dat = json.loads(http_get("https://localhost/api/v1"))
assert dat["status"] == "success"
# Orderly volume contains only the stripped down example from
# the URL, not the whole demo:
orderly = cfg.get_container("orderly")
src = exec_safely(orderly, ["ls", "/orderly/src"])[1]
src_contents = src.decode("UTF-8").strip().split("\n")
assert set(src_contents) == set(["README.md", "example"])
# Bring the whole lot down:
orderly_web.stop(path, kill=True, volumes=True, network=True)
st = orderly_web.status(path)
assert not st.is_running
assert st.containers["orderly"]["status"] == "missing"
assert st.containers["redis"]["status"] == "missing"
assert st.containers["web"]["status"] == "missing"
assert st.container_groups["orderly_worker"]["scale"] == 1
assert st.container_groups["orderly_worker"]["count"] == 0
assert len(st.container_groups["orderly_worker"]["status"]) == 0
assert st.volumes == {}
assert st.network is None
# really removed?
with docker_client() as cl:
assert not network_exists(cl, cfg.network)
assert not volume_exists(cl, cfg.volumes["orderly"])
assert not container_exists(cl, cfg.containers["proxy"])
finally:
orderly_web.stop(path, kill=True, volumes=True, network=True)