ODS V3 Pre-Release: Public testing and refinement ahead of the official V3 launch. Turn your PC, Mac, or Linux box into a private AI server.
Python ai-agentsamdcomfyuidockerllama-cppllmlocal-ain8nnvidiaopen-webuiragself-hostedspeech-to-textstrix-halotext-to-speechworkflow-automation
"""Verify the library's image selection with Docker's actual Compose client."""
import json
import os
from pathlib import Path
import shutil
import subprocess
import uuid
import time
import pytest
import yaml
ODS = Path(__file__).resolve().parents[1]
LIBRARY = ODS / 'extensions/library/services'
PYTHON_IMAGE = 'python:3.11-slim@sha256:e41613d42d4891e4930f79523f93f81bbc7632584ec65e36ab055f41a800b41e'
def docker(*args, timeout=60):
return subprocess.run(['docker', *args], check=True, capture_output=True,
text=True, encoding='utf-8', timeout=timeout).stdout
@pytest.mark.skipif(os.environ.get('ODS_RUN_DOCKER_SECURITY_TESTS') != '1',
reason='Requires an explicitly selected disposable Docker test host')
@pytest.mark.parametrize('service, assets', [
('it-tools', ['/', '/ITTOOLS-SOURCE.txt', '/ITTOOLS-LICENSE.txt', '/source/csv-rfc4180.patch']),
('redoc', ['/', '/ods-reader.js']),
])
def test_static_library_serves_private_build_context(tmp_path, service, assets):
# Extension materialization uses owner-private files. Build the real recipe
# with those modes, then check nginx as its declared non-root runtime user.
context = tmp_path / service
shutil.copytree(LIBRARY / service, context)
for source in context.rglob('*'):
if source.is_file():
source.chmod(0o600)
assert (context / 'nginx.conf').stat().st_mode & 0o777 == 0o600
identity = 'ods-private-static-' + uuid.uuid4().hex[:12]
image = identity + ':test'
try:
docker('build', '-t', image, str(context), timeout=600)
docker('run', '-d', '--name', identity, '--network', 'none',
'--read-only', '--cap-drop', 'ALL',
'--security-opt', 'no-new-privileges:true',
'--tmpfs', '/tmp:rw,noexec,nosuid,size=32m',
'--entrypoint', 'nginx', image, '-g', 'daemon off;')
for _ in range(30):
state = json.loads(docker('inspect', identity))[0]
if not state['State']['Running']:
logs = subprocess.run(['docker', 'logs', identity], text=True,
stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
timeout=30)
pytest.fail(logs.stdout)
ready = subprocess.run(
['docker', 'exec', identity, 'wget', '--spider', '-q',
'http://127.0.0.1:8080/'], capture_output=True, timeout=10)
if ready.returncode == 0:
break
time.sleep(0.2)
else:
pytest.fail('nginx did not serve the real extension')
assert state['Config']['User'] == '101:101'
for asset in assets:
body = docker('exec', identity, 'wget', '-qO-',
'http://127.0.0.1:8080' + asset)
assert body.strip(), asset
if service == 'it-tools':
docker('exec', identity, 'wget', '-qO', '/tmp/upstream.tar.gz',
'http://127.0.0.1:8080/source/upstream.tar.gz')
digest = docker('exec', identity, 'sha256sum', '/tmp/upstream.tar.gz').split()[0]
assert digest == '1829b78fdea40d9a4a9aaf0c6aa7131e33898351e713356af07941959d3407d4'
# The fix belongs in the image recipe, not by widening private inputs.
assert (context / 'nginx.conf').stat().st_mode & 0o777 == 0o600
finally:
subprocess.run(['docker', 'rm', '-f', identity], capture_output=True, timeout=30)
subprocess.run(['docker', 'image', 'rm', image], capture_output=True, timeout=30)
@pytest.mark.skipif(shutil.which('docker') is None, reason='Docker Compose CLI required; no daemon needed')
@pytest.mark.parametrize('backend, suffix', [('cpu', 'cpu'), ('amd', 'rocm'), ('nvidia', 'cuda')])
def test_compose_selects_invokeai_backend(backend, suffix):
recipe = LIBRARY / 'invokeai'
args = ['compose', '-f', str(recipe / 'compose.yaml')]
if backend != 'cpu':
args += ['-f', str(recipe / f'compose.{backend}.yaml')]
config = json.loads(docker(*args, 'config', '--format', 'json'))
service = config['services']['invokeai']
assert service['image'].startswith(f'ghcr.io/invoke-ai/invokeai:v6.11.1-{suffix}@sha256:')
assert '/api/v1/app/version' in service['healthcheck']['test'][-1]
assert service['ports'][0]['host_ip'] == '127.0.0.1'
if backend == 'amd':
assert service['environment']['RENDER_GROUP_ID']
assert {device['source'] for device in service['devices']} == {'/dev/dri', '/dev/kfd'}
elif backend == 'nvidia':
assert service['deploy']['resources']['reservations']['devices'][0]['driver'] == 'nvidia'
@pytest.mark.skipif(os.environ.get('ODS_RUN_DOCKER_SECURITY_TESTS') != '1',
reason='Requires an explicitly selected disposable Docker test host')
def test_local_library_policy_rebuilds_an_existing_untrusted_tag(tmp_path):
# Use the shipped policy, not an independently invented test setting.
recipe = yaml.safe_load((LIBRARY / 'audiobookshelf/compose.yaml').read_text())
policy = recipe['services']['audiobookshelf']['pull_policy']
project = 'ods-build-policy-' + uuid.uuid4().hex[:12]
image = 'ods/' + project + ':test'
container_name = project + '-app'
dockerfile = tmp_path / 'Dockerfile'
dockerfile.write_text(f'FROM {PYTHON_IMAGE}\nENV ODS_BUILD_ORIGIN=unreviewed\n', encoding='utf-8')
original_id = None
try:
docker('build', '-t', image, str(tmp_path), timeout=300)
original_id = docker('image', 'inspect', '--format', '{{.Id}}', image).strip()
dockerfile.write_text(f'FROM {PYTHON_IMAGE}\nENV ODS_BUILD_ORIGIN=reviewed\n', encoding='utf-8')
compose = tmp_path / 'compose.yaml'
compose.write_text(yaml.safe_dump({'services': {'app': {
'image': image, 'pull_policy': policy, 'build': {'context': '.'},
'container_name': container_name,
'command': ['python', '-c', 'import time; time.sleep(300)'],
'network_mode': 'none', 'read_only': True, 'cap_drop': ['ALL'],
'security_opt': ['no-new-privileges:true'],
}}}), encoding='utf-8')
docker('compose', '-p', project, '-f', str(compose), 'up', '-d', timeout=300)
container = json.loads(docker('inspect', container_name))[0]
assert container['State']['Running']
assert container['Image'] != original_id
assert 'ODS_BUILD_ORIGIN=reviewed' in container['Config']['Env']
assert 'ODS_BUILD_ORIGIN=unreviewed' not in container['Config']['Env']
finally:
# These random identities belong only to this fixture, never ODS itself.
subprocess.run(['docker', 'rm', '-f', container_name], capture_output=True, timeout=30)
subprocess.run(['docker', 'image', 'rm', image], capture_output=True, timeout=30)
if original_id:
subprocess.run(['docker', 'image', 'rm', original_id], capture_output=True, timeout=30)