1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
|
#!/bin/env python3
# crun - OCI runtime written in C
#
# Copyright (C) 2017, 2018, 2019 Giuseppe Scrivano <giuseppe@scrivano.org>
# crun is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# crun is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with crun. If not, see <http://www.gnu.org/licenses/>.
import os
from tests_utils import *
def test_fail_prestart():
conf = base_config()
conf['hooks'] = {"prestart" : [{"path" : "/bin/false"}]}
add_all_namespaces(conf)
try:
out, _ = run_and_get_output(conf, hide_stderr=True)
except:
return 0
return -1
def test_success_prestart():
conf = base_config()
conf['hooks'] = {"prestart" : [{"path" : "/bin/true"}]}
add_all_namespaces(conf)
try:
out, _ = run_and_get_output(conf, hide_stderr=True)
except:
return -1
return 0
def test_hook_env_inherit():
conf = base_config()
path = os.getenv("PATH")
hook = {"path" : "/bin/sh", "args" : ["/bin/sh", "-c", "test \"$PATH\" = %s" % path]}
conf['hooks'] = {"prestart" : [hook]}
add_all_namespaces(conf)
try:
out, _ = run_and_get_output(conf, hide_stderr=True)
except:
return -1
return 0
def test_hook_env_no_inherit():
conf = base_config()
hook = {"path" : "/bin/sh", "env": ["PATH=/foo"], "args" : ["/bin/sh", "-c", "/bin/test \"$PATH\" == '/foo'"]}
conf['hooks'] = {"prestart" : [hook]}
add_all_namespaces(conf)
try:
out, _ = run_and_get_output(conf, hide_stderr=True)
except:
return -1
return 0
def test_poststart_hook():
"""Test poststart hook is called after container starts."""
if is_rootless():
return (77, "requires root privileges")
import tempfile
conf = base_config()
add_all_namespaces(conf)
conf['process']['args'] = ['/init', 'pause']
cid = None
marker_file = None
try:
# Create a marker file path
with tempfile.NamedTemporaryFile(delete=False) as f:
marker_file = f.name
# Remove it so we can verify the hook creates it
os.unlink(marker_file)
hook = {
"path": "/bin/touch",
"args": ["/bin/touch", marker_file]
}
conf['hooks'] = {"poststart": [hook]}
_, cid = run_and_get_output(conf, hide_stderr=True, command='run', detach=True)
# Check if the marker file was created
if os.path.exists(marker_file):
return 0
logger.info("poststart hook did not create marker file")
return -1
except Exception as e:
logger.info("test failed: %s", e)
return -1
finally:
if cid is not None:
run_crun_command(["delete", "-f", cid])
if marker_file and os.path.exists(marker_file):
os.unlink(marker_file)
def test_poststop_hook():
"""Test poststop hook is called after container stops."""
if is_rootless():
return (77, "requires root privileges")
import tempfile
import time
conf = base_config()
add_all_namespaces(conf)
conf['process']['args'] = ['/init', 'true']
marker_file = None
try:
# Create a marker file path
with tempfile.NamedTemporaryFile(delete=False) as f:
marker_file = f.name
# Remove it so we can verify the hook creates it
os.unlink(marker_file)
hook = {
"path": "/bin/touch",
"args": ["/bin/touch", marker_file]
}
conf['hooks'] = {"poststop": [hook]}
# Run container that exits quickly
run_and_get_output(conf, hide_stderr=True)
# Give the hook time to execute
time.sleep(0.5)
# Check if the marker file was created
if os.path.exists(marker_file):
return 0
logger.info("poststop hook did not create marker file")
return -1
except Exception as e:
logger.info("test failed: %s", e)
return -1
finally:
if marker_file and os.path.exists(marker_file):
os.unlink(marker_file)
def test_createRuntime_hook():
"""Test createRuntime hook."""
conf = base_config()
add_all_namespaces(conf)
hook = {"path": "/bin/true"}
conf['hooks'] = {"createRuntime": [hook]}
try:
out, _ = run_and_get_output(conf, hide_stderr=True)
return 0
except Exception as e:
logger.info("test failed: %s", e)
return -1
def test_createContainer_hook():
"""Test createContainer hook."""
conf = base_config()
add_all_namespaces(conf)
hook = {"path": "/bin/true"}
conf['hooks'] = {"createContainer": [hook]}
try:
out, _ = run_and_get_output(conf, hide_stderr=True)
return 0
except Exception as e:
logger.info("test failed: %s", e)
return -1
def test_startContainer_hook():
"""Test startContainer hook (runs inside container namespace)."""
conf = base_config()
add_all_namespaces(conf)
# startContainer hook runs inside the container, so use /init
hook = {"path": "/init", "args": ["/init", "true"]}
conf['hooks'] = {"startContainer": [hook]}
try:
out, _ = run_and_get_output(conf, hide_stderr=True)
return 0
except Exception as e:
logger.info("test failed: %s", e)
return -1
def test_hook_with_timeout():
"""Test hook timeout is enforced."""
conf = base_config()
add_all_namespaces(conf)
# Hook that sleeps longer than timeout
hook = {
"path": "/bin/sleep",
"args": ["/bin/sleep", "10"],
"timeout": 1 # 1 second timeout
}
conf['hooks'] = {"prestart": [hook]}
try:
out, _ = run_and_get_output(conf, hide_stderr=True)
# If container ran successfully, timeout wasn't enforced properly
logger.info("hook timeout not enforced")
return -1
except:
# Expected - hook should timeout and fail
return 0
def test_hook_receives_state():
"""Test that hooks receive container state on stdin."""
if is_rootless():
return (77, "requires root privileges")
import tempfile
import json
conf = base_config()
add_all_namespaces(conf)
conf['process']['args'] = ['/init', 'true']
state_file = None
try:
# Create a temp file to capture state
with tempfile.NamedTemporaryFile(mode='w', delete=False, suffix='.json') as f:
state_file = f.name
# Hook script that saves stdin (state) to file
hook = {
"path": "/bin/sh",
"args": ["/bin/sh", "-c", "cat > " + state_file]
}
conf['hooks'] = {"prestart": [hook]}
run_and_get_output(conf, hide_stderr=True)
# Verify state was written and is valid JSON
if os.path.exists(state_file) and os.path.getsize(state_file) > 0:
with open(state_file) as f:
state = json.load(f)
# Basic validation of state structure
if 'ociVersion' in state or 'id' in state or 'bundle' in state:
return 0
logger.info("hook did not receive valid state")
return -1
except Exception as e:
logger.info("test failed: %s", e)
return -1
finally:
if state_file and os.path.exists(state_file):
os.unlink(state_file)
def test_multiple_hooks():
"""Test multiple hooks of the same type run in order."""
if is_rootless():
return (77, "requires root privileges")
import tempfile
conf = base_config()
add_all_namespaces(conf)
marker_file = None
try:
with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:
marker_file = f.name
# First hook writes "1", second appends "2"
hook1 = {
"path": "/bin/sh",
"args": ["/bin/sh", "-c", "echo -n 1 > " + marker_file]
}
hook2 = {
"path": "/bin/sh",
"args": ["/bin/sh", "-c", "echo -n 2 >> " + marker_file]
}
conf['hooks'] = {"prestart": [hook1, hook2]}
run_and_get_output(conf, hide_stderr=True)
# Verify both hooks ran in order
if os.path.exists(marker_file):
with open(marker_file) as f:
content = f.read()
if content == "12":
return 0
logger.info("hooks ran but order wrong: %s", content)
return -1
logger.info("marker file not created")
return -1
except Exception as e:
logger.info("test failed: %s", e)
return -1
finally:
if marker_file and os.path.exists(marker_file):
os.unlink(marker_file)
def test_annotation_hook_stdout_stderr():
"""Test run.oci.hooks.stdout and run.oci.hooks.stderr annotations."""
if is_rootless():
return (77, "requires root privileges")
import tempfile
conf = base_config()
add_all_namespaces(conf)
conf['process']['args'] = ['/init', 'true']
stdout_file = None
stderr_file = None
try:
# Create temp files for hook output
with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:
stdout_file = f.name
with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:
stderr_file = f.name
# Hook that writes to stdout and stderr
hook = {
"path": "/bin/sh",
"args": ["/bin/sh", "-c", "echo 'stdout message' && echo 'stderr message' >&2"]
}
conf['hooks'] = {"prestart": [hook]}
# Add annotations for hook output redirection
if 'annotations' not in conf:
conf['annotations'] = {}
conf['annotations']['run.oci.hooks.stdout'] = stdout_file
conf['annotations']['run.oci.hooks.stderr'] = stderr_file
run_and_get_output(conf, hide_stderr=True)
# Verify hook stdout was redirected
if not os.path.exists(stdout_file):
logger.info("hook stdout file not created")
return -1
with open(stdout_file) as f:
stdout_content = f.read()
if "stdout message" not in stdout_content:
logger.info("hook stdout not redirected properly: %s", stdout_content)
return -1
# Verify hook stderr was redirected
if not os.path.exists(stderr_file):
logger.info("hook stderr file not created")
return -1
with open(stderr_file) as f:
stderr_content = f.read()
if "stderr message" not in stderr_content:
logger.info("hook stderr not redirected properly: %s", stderr_content)
return -1
logger.info("hook stdout/stderr redirection successful")
return 0
except subprocess.CalledProcessError as e:
output = e.output.decode('utf-8', errors='ignore') if e.output else ''
if any(x in output.lower() for x in ["mount", "proc", "permission", "rootfs", "private", "busy"]):
return (77, "not available in nested namespaces")
logger.info("test failed: %s", e)
return -1
except Exception as e:
logger.info("test failed: %s", e)
return -1
finally:
if stdout_file and os.path.exists(stdout_file):
os.unlink(stdout_file)
if stderr_file and os.path.exists(stderr_file):
os.unlink(stderr_file)
all_tests = {
"test-fail-prestart" : test_fail_prestart,
"test-success-prestart" : test_success_prestart,
"test-hook-env-inherit" : test_hook_env_inherit,
"test-hook-env-no-inherit" : test_hook_env_no_inherit,
"test-poststart-hook": test_poststart_hook,
"test-poststop-hook": test_poststop_hook,
"test-createRuntime-hook": test_createRuntime_hook,
"test-createContainer-hook": test_createContainer_hook,
"test-startContainer-hook": test_startContainer_hook,
"test-hook-with-timeout": test_hook_with_timeout,
"test-hook-receives-state": test_hook_receives_state,
"test-multiple-hooks": test_multiple_hooks,
"test-annotation-hook-stdout-stderr": test_annotation_hook_stdout_stderr,
}
if __name__ == "__main__":
tests_main(all_tests)
|