Skip to content

ServerKit is a lightweight, modern server control panel for managing web applications, databases, and services on your VPS or dedicated server. Built with Python/Flask backend and React frontend.

Move this round's new tests onto shared factories

Juan Denis7c47c8ece410
diff --git a/backend/tests/test_app_host_binding_fields.py b/backend/tests/test_app_host_binding_fields.py
index afe2f9cc..2e854520 100644
--- a/backend/tests/test_app_host_binding_fields.py
+++ b/backend/tests/test_app_host_binding_fields.py
@@ -5,27 +5,14 @@ from unittest.mock import patch
import pytest
-
-def _mk_user(db, username, role):
- from app.models import User
- from werkzeug.security import generate_password_hash
- u = User(email=f'{username}@t.local', username=username,
- password_hash=generate_password_hash('x'), role=role, is_active=True)
- db.session.add(u)
- db.session.commit()
- return u
-
-
-def _token(user_id):
- from flask_jwt_extended import create_access_token
- return {'Authorization': f'Bearer {create_access_token(identity=user_id)}'}
+from factories import headers_for, make_user
@pytest.fixture
def users(app):
from app import db
- return {'dev': _mk_user(db, 'hb_dev', 'developer').id,
- 'admin': _mk_user(db, 'hb_admin', 'admin').id}
+ return {'dev': make_user(db, 'hb_dev', 'developer').id,
+ 'admin': make_user(db, 'hb_admin', 'admin').id}
@pytest.mark.parametrize('field,value', [
@@ -36,14 +23,14 @@ def users(app):
])
def test_developer_cannot_create_with_host_fields(client, users, field, value):
from app.models import Application
- resp = client.post('/api/v1/apps', headers=_token(users['dev']),
+ resp = client.post('/api/v1/apps', headers=headers_for(users['dev']),
json={'name': f'hb-{field}', 'app_type': 'docker', field: value})
assert resp.status_code == 403
assert Application.query.filter_by(name=f'hb-{field}').first() is None
def test_create_slugs_the_name(client, users):
- resp = client.post('/api/v1/apps', headers=_token(users['dev']),
+ resp = client.post('/api/v1/apps', headers=headers_for(users['dev']),
json={'name': 'My App; }\nserver {', 'app_type': 'php'})
assert resp.status_code == 201
assert resp.get_json()['app']['name'] == 'my-app-server'
@@ -51,20 +38,20 @@ def test_create_slugs_the_name(client, users):
def test_create_refuses_a_taken_name(client, users):
body = {'name': 'hb-taken', 'app_type': 'php'}
- assert client.post('/api/v1/apps', headers=_token(users['dev']), json=body).status_code == 201
- assert client.post('/api/v1/apps', headers=_token(users['dev']), json=body).status_code == 400
+ assert client.post('/api/v1/apps', headers=headers_for(users['dev']), json=body).status_code == 201
+ assert client.post('/api/v1/apps', headers=headers_for(users['dev']), json=body).status_code == 400
@pytest.fixture
def dev_app(client, users):
- resp = client.post('/api/v1/apps', headers=_token(users['dev']),
+ resp = client.post('/api/v1/apps', headers=headers_for(users['dev']),
json={'name': 'hb-own', 'app_type': 'docker'})
return resp.get_json()['app']['id']
def test_owner_cannot_repoint_host_fields(client, users, dev_app):
from app.models import Application
- resp = client.put(f'/api/v1/apps/{dev_app}', headers=_token(users['dev']),
+ resp = client.put(f'/api/v1/apps/{dev_app}', headers=headers_for(users['dev']),
json={'root_path': '/', 'compose_file': 'x.yml'})
assert resp.status_code == 403
app = Application.query.get(dev_app)
@@ -72,7 +59,7 @@ def test_owner_cannot_repoint_host_fields(client, users, dev_app):
def test_admin_can_set_host_fields(client, users, dev_app):
- resp = client.put(f'/api/v1/apps/{dev_app}', headers=_token(users['admin']),
+ resp = client.put(f'/api/v1/apps/{dev_app}', headers=headers_for(users['admin']),
json={'root_path': '/srv/hb-own'})
assert resp.status_code == 200
assert resp.get_json()['app']['root_path'] == '/srv/hb-own'
@@ -80,13 +67,13 @@ def test_admin_can_set_host_fields(client, users, dev_app):
@pytest.mark.parametrize('name', ['../../etc/passwd', 'Has Space', 'x;y', ''])
def test_rename_must_be_a_slug(client, users, dev_app, name):
- resp = client.put(f'/api/v1/apps/{dev_app}', headers=_token(users['dev']),
+ resp = client.put(f'/api/v1/apps/{dev_app}', headers=headers_for(users['dev']),
json={'name': name})
assert resp.status_code == 400
def test_owner_can_still_update_safe_fields(client, users, dev_app):
- resp = client.put(f'/api/v1/apps/{dev_app}', headers=_token(users['dev']),
+ resp = client.put(f'/api/v1/apps/{dev_app}', headers=headers_for(users['dev']),
json={'name': 'hb-renamed', 'port': 8123})
assert resp.status_code == 200
assert resp.get_json()['app']['name'] == 'hb-renamed'
diff --git a/backend/tests/test_app_process_env.py b/backend/tests/test_app_process_env.py
index b6a25c65..3a0d465f 100644
--- a/backend/tests/test_app_process_env.py
+++ b/backend/tests/test_app_process_env.py
@@ -75,15 +75,16 @@ def test_python_app_commands(panel_env, monkeypatch, tmp_path):
_assert_clean(seen['env'])
-def test_custom_build_commands(panel_env, monkeypatch, tmp_path):
- from app.services import build_service
+def test_custom_build_commands(panel_env, fake_subprocess, tmp_path):
+ from subprocess_stub import FakeProc
+ from app.services.build_service import BuildService
seen = {}
- def popen(cmd, **kwargs):
+ def bash(argv, kwargs):
seen['env'] = kwargs['env']
- raise OSError('stop here')
- monkeypatch.setattr(build_service.subprocess, 'Popen', popen)
- build_service.BuildService.build_with_custom_command(
+ return FakeProc(returncode=0, args=argv)
+ fake_subprocess.when(['bash'], bash)
+ BuildService.build_with_custom_command(
1, str(tmp_path), 'npm run build', env_vars={'NODE_ENV': 'production'})
_assert_clean(seen['env'])
assert seen['env']['NODE_ENV'] == 'production'
diff --git a/backend/tests/test_backup_db_gzip.py b/backend/tests/test_backup_db_gzip.py
index b48a4d03..b7ca2193 100644
--- a/backend/tests/test_backup_db_gzip.py
+++ b/backend/tests/test_backup_db_gzip.py
@@ -6,12 +6,10 @@ piped compressed bytes into mysql/psql. These run real child processes —
small Python stand-ins for mysqldump/mysql — so the bytes really cross a pipe.
"""
import gzip
-import subprocess
import sys
import pytest
-from app.utils import system
from app.utils.system import run_from_gzip, run_to_gzip
_ROW = "INSERT INTO t VALUES (1), (2);\n"
@@ -73,14 +71,14 @@ def fake_clients(tmp_path, monkeypatch):
'mysqldump': WRITE_SQL,
'mysql': f'import sys; open({str(received)!r}, "wb").write(sys.stdin.buffer.read())',
}
- real_popen = subprocess.Popen
- def popen(cmd, *args, **kwargs):
- if cmd[0] in stand_ins:
- cmd = [sys.executable, '-c', stand_ins[cmd[0]]]
- return real_popen(cmd, *args, **kwargs)
+ def stand_in(runner):
+ # Swap the binary, keep the real runner: the bytes still cross a pipe.
+ return lambda cmd, *args, **kwargs: runner(
+ [sys.executable, '-c', stand_ins[cmd[0]]], *args, **kwargs)
- monkeypatch.setattr(system.subprocess, 'Popen', popen)
+ monkeypatch.setattr('app.services.backup_service.run_to_gzip', stand_in(run_to_gzip))
+ monkeypatch.setattr('app.services.backup_service.run_from_gzip', stand_in(run_from_gzip))
monkeypatch.setattr('app.services.backup_service.is_command_available', lambda c: True)
return received
diff --git a/backend/tests/test_env_secret_masking.py b/backend/tests/test_env_secret_masking.py
index 217f04fd..50cb00f1 100644
--- a/backend/tests/test_env_secret_masking.py
+++ b/backend/tests/test_env_secret_masking.py
@@ -2,36 +2,20 @@
masking used to be opt-in from the client via ?mask=true."""
import pytest
-SECRET = 's3cr3t-db-password'
-
-
-def _mk_user(db, username, role):
- from app.models import User
- from werkzeug.security import generate_password_hash
- u = User(email=f'{username}@t.local', username=username,
- password_hash=generate_password_hash('x'), role=role, is_active=True)
- db.session.add(u)
- db.session.commit()
- return u
+from factories import headers_for, make_application, make_user
-
-def _token(user_id):
- from flask_jwt_extended import create_access_token
- return {'Authorization': f'Bearer {create_access_token(identity=user_id)}'}
+SECRET = 's3cr3t-db-password'
@pytest.fixture
def shared_app(app):
from app import db
- from app.models import Application
from app.services.env_service import EnvService
from app.services.resource_grant_service import ResourceGrantService
- owner = _mk_user(db, 'esm_owner', 'developer')
- viewer = _mk_user(db, 'esm_viewer', 'developer')
- editor = _mk_user(db, 'esm_editor', 'developer')
- application = Application(name='esm-app', app_type='docker', user_id=owner.id)
- db.session.add(application)
- db.session.commit()
+ owner = make_user(db, 'esm_owner', 'developer')
+ viewer = make_user(db, 'esm_viewer', 'developer')
+ editor = make_user(db, 'esm_editor', 'developer')
+ application = make_application(db, name='esm-app', user_id=owner.id)
ResourceGrantService.grant(viewer.id, 'application', application.id, role='viewer')
ResourceGrantService.grant(editor.id, 'application', application.id, role='editor')
EnvService.set_env_var(application.id, 'DB_PASSWORD', SECRET, is_secret=True)
@@ -48,14 +32,14 @@ def _urls(app_id):
def test_viewer_never_sees_secret_values(client, shared_app):
for url in _urls(shared_app['id']):
- resp = client.get(url, headers=_token(shared_app['viewer']))
+ resp = client.get(url, headers=headers_for(shared_app['viewer']))
assert resp.status_code == 200, url
assert SECRET not in resp.get_data(as_text=True), url
def test_viewer_still_sees_plain_values(client, shared_app):
resp = client.get(f"/api/v1/apps/{shared_app['id']}/env",
- headers=_token(shared_app['viewer']))
+ headers=headers_for(shared_app['viewer']))
values = {v['key']: v['value'] for v in resp.get_json()['env_vars']}
assert values['LOG_LEVEL'] == 'info'
@@ -63,8 +47,8 @@ def test_viewer_still_sees_plain_values(client, shared_app):
@pytest.mark.parametrize('who', ['owner', 'editor'])
def test_editors_can_read_secrets(client, shared_app, who):
resp = client.get(f"/api/v1/apps/{shared_app['id']}/env/DB_PASSWORD",
- headers=_token(shared_app[who]))
+ headers=headers_for(shared_app[who]))
assert resp.get_json()['env_var']['value'] == SECRET
resp = client.get(f"/api/v1/apps/{shared_app['id']}/env/export",
- headers=_token(shared_app[who]))
+ headers=headers_for(shared_app[who]))
assert SECRET in resp.get_json()['content']
diff --git a/backend/tests/test_server_workspace_access.py b/backend/tests/test_server_workspace_access.py
index 8e247ff3..9c6e00e3 100644
--- a/backend/tests/test_server_workspace_access.py
+++ b/backend/tests/test_server_workspace_access.py
@@ -4,36 +4,20 @@ from unittest.mock import patch
import pytest
-
-def _mk_user(db, username, role):
- from app.models import User
- from werkzeug.security import generate_password_hash
- u = User(email=f'{username}@t.local', username=username,
- password_hash=generate_password_hash('x'), role=role, is_active=True)
- db.session.add(u)
- db.session.commit()
- return u
-
-
-def _token(user_id):
- from flask_jwt_extended import create_access_token
- return {'Authorization': f'Bearer {create_access_token(identity=user_id)}'}
+from factories import headers_for, make_server, make_user
@pytest.fixture
def setup(app):
from app import db
- from app.models.server import Server
from app.services.workspace_service import WorkspaceService
- admin = _mk_user(db, 'swa_admin', 'admin')
- member = _mk_user(db, 'swa_member', 'developer')
- outsider = _mk_user(db, 'swa_outsider', 'developer')
+ admin = make_user(db, 'swa_admin', 'admin')
+ member = make_user(db, 'swa_member', 'developer')
+ outsider = make_user(db, 'swa_outsider', 'developer')
ws = WorkspaceService.create_workspace({'name': 'SWA'}, admin.id)
WorkspaceService.add_member(ws.id, member.id)
mine = WorkspaceService.create_workspace({'name': 'SWA-out'}, outsider.id)
- server = Server(name='swa-box', workspace_id=ws.id)
- db.session.add(server)
- db.session.commit()
+ server = make_server(db, name='swa-box', workspace_id=ws.id)
return {'server': server.id, 'member': member.id, 'outsider': outsider.id,
'admin': admin.id, 'own_ws': mine.id}
@@ -54,7 +38,7 @@ def test_outsider_is_refused(client, setup, method, url, body):
with patch('app.api.servers.TerminalService.create_session',
return_value={'success': True}) as create:
resp = getattr(client, method)(url.format(sid=setup['server']), json=body,
- headers=_token(setup['outsider']))
+ headers=headers_for(setup['outsider']))
assert resp.status_code == 404
create.assert_not_called()
after = Server.query.get(setup['server'])
@@ -67,14 +51,14 @@ def test_member_and_admin_can_open_terminal(client, setup, who):
with patch('app.api.servers.TerminalService.create_session',
return_value={'success': True, 'session_id': 's1'}) as create:
resp = client.post(f"/api/v1/servers/{setup['server']}/terminal", json={},
- headers=_token(setup[who]))
+ headers=headers_for(setup[who]))
assert resp.status_code == 200
create.assert_called_once()
-def test_member_can_regenerate_token(client, setup):
+def test_member_can_regenerateheaders_for(client, setup):
resp = client.post(f"/api/v1/servers/{setup['server']}/regenerate-token",
- json={}, headers=_token(setup['member']))
+ json={}, headers=headers_for(setup['member']))
assert resp.status_code == 200
assert resp.get_json()['registration_token']
@@ -83,14 +67,11 @@ def test_default_workspace_servers_stay_shared(client, setup):
"""Servers created without a context land in the Default workspace, which
nobody joins — developers keep operating them."""
from app import db
- from app.models.server import Server
from app.services.workspace_service import WorkspaceService
- server = Server(name='swa-default',
- workspace_id=WorkspaceService.ensure_default_workspace().id)
- db.session.add(server)
- db.session.commit()
+ server = make_server(db, name='swa-default',
+ workspace_id=WorkspaceService.ensure_default_workspace().id)
with patch('app.api.servers.TerminalService.create_session',
return_value={'success': True, 'session_id': 's2'}):
resp = client.post(f'/api/v1/servers/{server.id}/terminal', json={},
- headers=_token(setup['outsider']))
+ headers=headers_for(setup['outsider']))
assert resp.status_code == 200