1singularity(1) singularity(1)
2
6 singularity-test - Run the user-defined tests within a container
7
11 singularity test [exec options...]
12
16 The 'test' command allows you to execute a testscript (if available)
17 inside of
18 a given container
19 NOTE:
22 For instances if there is a daemon process running inside the
23 container,
24 then subsequent container commands will all run within the same
25 namespaces. This means that the --writable and --contain options
26 will not
27 be honored as the namespaces have already been configured by the
28 'singularity start' command.
29
33 --add-caps="" a comma separated capability list to add
34 --allow-setuid[=false] allow setuid binaries in container (root
37 only)
38 --app="" set an application to run inside a container
41 --apply-cgroups="" apply cgroups from file for container processes
44 (root only)
45 -B, --bind=[] a user-bind path specification. spec has the format
48 src[:dest[:opts]], where src and dest are outside and inside paths. If
49 dest is not given, it is set equal to src. Mount options ('opts') may
50 be specified as 'ro' (read-only) or 'rw' (read/write, which is the de‐
51 fault). Multiple bind paths can be given by a comma separated list.
52 -e, --cleanenv[=false] clean environment before running container
55 -c, --contain[=false] use minimal /dev and empty other directories
58 (e.g. /tmp and $HOME) instead of sharing filesystems from your host
59 -C, --containall[=false] contain not only file systems, but also
62 PID, IPC, and environment
63 --disable-cache[=false] dont use cache, and dont create cache
66 --dns="" list of DNS server separated by commas to add in re‐
69 solv.conf
70 --docker-login[=false] login to a Docker Repository interactively
73 --drop-caps="" a comma separated capability list to drop
76 --env=[] pass environment variable to contained process
79 --env-file="" pass environment variables from file to contained
82 process
83 -f, --fakeroot[=false] run container in new user namespace as uid
86 0
87 --fusemount=[] A FUSE filesystem mount specification of the form
90 ': ' - where is 'container' or 'host', specifying where the mount will
91 be performed ('container-daemon' or 'host-daemon' will run the FUSE
92 process detached). is the path to the FUSE executable, plus options
93 for the mount. is the location in the container to which the FUSE
94 mount will be attached. E.g. 'container:sshfs 10.0.0.1:/ /sshfs'. Im‐
95 plies --pid.
96 -h, --help[=false] help for test
99 -H, --home="/builddir" a home directory specification. spec can
102 either be a src path or src:dest pair. src is the source path of the
103 home directory outside the container and dest overrides the home direc‐
104 tory within the container.
105 --hostname="" set container hostname
108 -i, --ipc[=false] run container in a new IPC namespace
111 --keep-privs[=false] let root user keep privileges in container
114 (root only)
115 -n, --net[=false] run container in a new network namespace (sets
118 up a bridge network interface by default)
119 --network="bridge" specify desired network type separated by com‐
122 mas, each network will bring up a dedicated interface inside container
123 --network-args=[] specify network arguments to pass to CNI plugins
126 --no-home[=false] do NOT mount users home directory if /home is
129 not the current working directory
130 --no-init[=false] do NOT start shim process with --pid
133 --no-mount=[] disable one or more mount xxx options set in singu‐
136 larity.conf
137 --no-privs[=false] drop all privileges from root user in con‐
140 tainer)
141 --no-umask[=false] do not propagate umask to the container, set
144 default 0022 umask
145 --nohttps[=false] do NOT use HTTPS with the docker:// transport
148 (useful for local docker registries without a certificate)
149 --nonet[=false] disable VM network handling
152 --nv[=false] enable experimental Nvidia support
155 -o, --overlay=[] use an overlayFS image for persistent data stor‐
158 age or as read-only layer of container
159 --passphrase[=false] prompt for an encryption passphrase
162 --pem-path="" enter an path to a PEM formated RSA key for an en‐
165 crypted container
166 -p, --pid[=false] run container in a new PID namespace
169 --pwd="" initial working directory for payload process inside the
172 container
173 --rocm[=false] enable experimental Rocm support
176 -S, --scratch=[] include a scratch directory within the container
179 that is linked to a temporary dir (use -W to force location)
180 --security=[] enable security features (SELinux, Apparmor, Sec‐
183 comp)
184 -u, --userns[=false] run container in a new user namespace, allow‐
187 ing Singularity to run completely unprivileged on recent kernels. This
188 disables some features of Singularity, for example it only works with
189 sandbox images.
190 --uts[=false] run container in a new UTS namespace
193 --vm[=false] enable VM support
196 --vm-cpu="1" number of CPU cores to allocate to Virtual Machine
199 (implies --vm)
200 --vm-err[=false] enable attaching stderr from VM
203 --vm-ip="dhcp" IP Address to assign for container usage. Defaults
206 to DHCP within bridge network.
207 --vm-ram="1024" amount of RAM in MiB to allocate to Virtual Ma‐
210 chine (implies --vm)
211 -W, --workdir="" working directory to be used for /tmp, /var/tmp
214 and $HOME (if -c/--contain was also used)
215 -w, --writable[=false] by default all Singularity containers are
218 available as read only. This option makes the file system accessible as
219 read/write.
220 --writable-tmpfs[=false] makes the file system accessible as
223 read-write with non persistent data (with overlay support only)
224
228 Set the '%test' section with a definition file like so:
229 %test
230 echo "hello from test" "$@"
231 $ singularity test /tmp/debian.sif command
233 hello from test command
234 For additional help, please visit our public documentation pages which are
236 found at:
237 https://www.sylabs.io/docs/
239
244 singularity(1)
245
249 23-Jul-2022 Auto generated by spf13/cobra
250Auto generated by spf13/cobra Jul 2022 singularity(1)