opencontainers/runtime-tools

Name: runtime-tools

Owner: Open Container Initiative

Description: OCI Runtime Tools

Created: 2016-01-13 20:10:21.0

Updated: 2018-05-24 08:50:12.0

Pushed: 2018-05-24 15:45:09.0

Homepage: https://www.opencontainers.org/

Size: 8658

Language: Go

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

oci-runtime-tool Build Status Go Report Card

oci-runtime-tool is a collection of tools for working with the OCI runtime specification. To build from source code, runtime-tools requires Go 1.7.x or above.

Generating an OCI runtime spec configuration files

oci-runtime-tool generate generates configuration JSON for an OCI bundle. OCI-compatible runtimes like runC expect to read the configuration from config.json.

i-runtime-tool generate --output config.json
t config.json

    "ociVersion": "0.5.0",
    ?

Validating an OCI bundle

oci-runtime-tool validate validates an OCI bundle. The error message will be printed if the OCI bundle failed the validation procedure.

i-runtime-tool generate
i-runtime-tool validate
[0000] Bundle validation succeeded.
Testing OCI runtimes

The runtime validation suite uses node-tap, which is packaged for some distributions (for example, it is in Debian's node-tap package). If your distribution does not package node-tap, you can install npm (for example, from Gentoo's nodejs package) and use it:

m install tap

Build the validation executables:

ke runtimetest validation-executables

Runtime validation currently only supports the OCI Runtime Command Line Interface. If we add support for alternative APIs in the future, runtime validation will gain an option to select the desired runtime API. For the command line interface, the RUNTIME option selects the runtime command (funC in the OCI Runtime Command Line Interface).

do make RUNTIME=runc localvalidation
IME=runc tap validation/pidfile.t validation/linux_cgroups_hugetlb.t validation/linux_cgroups_memory.t validation/linux_rootfs_propagation_shared.t validation/kill.t validation/create.t validation/poststart.t validation/linux_cgroups_network.t validation/poststop_fail.t validation/linux_readonly_paths.t validation/prestart_fail.t validation/hooks_stdin.t validation/default.t validation/linux_masked_paths.t validation/poststop.t validation/misc_props.t validation/prestart.t validation/poststart_fail.t validation/mounts.t validation/linux_cgroups_relative_pids.t validation/process_user.t validation/process.t validation/hooks.t validation/process_capabilities_fail.t validation/process_rlimits_fail.t validation/linux_cgroups_relative_cpus.t validation/process_rlimits.t validation/linux_cgroups_relative_blkio.t validation/linux_sysctl.t validation/linux_seccomp.t validation/linux_devices.t validation/start.t validation/linux_cgroups_pids.t validation/process_capabilities.t validation/process_oom_score_adj.t validation/linux_cgroups_relative_hugetlb.t validation/linux_cgroups_cpus.t validation/linux_cgroups_relative_memory.t validation/state.t validation/root_readonly_true.t validation/linux_cgroups_blkio.t validation/linux_rootfs_propagation_unbindable.t validation/delete.t validation/linux_cgroups_relative_network.t validation/hostname.t validation/killsig.t validation/linux_uid_mappings.t
dation/pidfile.t .failed to create the container
ainer_linux.go:348: starting container process caused "process_linux.go:402: container init caused \"process_linux.go:367: setting cgroup config for procHooks process caused \\\"failed to write 56892210544640 to hugetlb.1GB.limit_in_bytes: open /sys/fs/cgroup/hugetlb/cgrouptest/hugetlb.1GB.limit_in_bytes: permission denied\\\"\""
 status 1
dation/pidfile.t .................................. 1/1 315ms
dation/linux_cgroups_hugetlb.t .................... 0/1
t ok validation/linux_cgroups_hugetlb.t
timeout: 30000
file: validation/linux_cgroups_hugetlb.t
command: validation/linux_cgroups_hugetlb.t
args: []
stdio:
  - 0
  - pipe
  - 2
cwd: /?/go/src/github.com/opencontainers/runtime-tools
exitCode: 1

dation/linux_cgroups_memory.t ..................... 9/9
dation/linux_rootfs_propagation_shared.t ...... 252/282
t ok shared root propogation exposes "/target348456609/mount892511628/example376408222"

ipped: 29
 /dev/null (default device) has unconfigured permissions

l ........................................... 4381/4962


81 passing (1m)
7 pending
 failing

: *** [Makefile:44: localvalidation] Error 1

You can also run an individual test executable directly:

NTIME=runc validation/default.t
version 13
 - has expected hostname
-

"actual": "mrsdalloway",
"expected": "mrsdalloway"

.

87 # SKIP linux.gidMappings not set
87

If you cannot install node-tap, you can probably run the test suite with another TAP consumer. For example, with prove:

do make TAP='prove -Q -j9' RUNTIME=runc VALIDATION_TESTS=validation/pidfile.t localvalidation
IME=runc prove -Q -j9 validation/pidfile.t
tests successful.
s=1, Tests=1,  0 wallclock secs ( 0.01 usr  0.01 sys +  0.03 cusr  0.03 csys =  0.08 CPU)
lt: PASS

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.