1singularity(1) singularity(1)
2
6 singularity-test - Run the user-defined tests within a container
7
11 singularity test [exec options...] <image path>
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=""
34 a comma separated capability list to add
35 --allow-setuid[=false]
38 allow setuid binaries in container (root only)
39 --app=""
42 set an application to run inside a container
43 --apply-cgroups=""
46 apply cgroups from file for container processes (root only)
47 -B, --bind=[]
50 a user-bind path specification. spec has the format
51 src[:dest[:opts]], where src and dest are outside and inside paths. If
52 dest is not given, it is set equal to src. Mount options ('opts') may
53 be specified as 'ro' (read-only) or 'rw' (read/write, which is the
54 default). Multiple bind paths can be given by a comma separated list.
55 -e, --cleanenv[=false]
58 clean environment before running container
59 -c, --contain[=false]
62 use minimal /dev and empty other directories (e.g. /tmp and $HOME)
63 instead of sharing filesystems from your host
64 -C, --containall[=false]
67 contain not only file systems, but also PID, IPC, and environment
68 --disable-cache[=false]
71 dont use cache, and dont create cache
72 --dns=""
75 list of DNS server separated by commas to add in resolv.conf
76 --docker-login[=false]
79 login to a Docker Repository interactively
80 --drop-caps=""
83 a comma separated capability list to drop
84 -f, --fakeroot[=false]
87 run container in new user namespace as uid 0
88 -h, --help[=false]
91 help for test
92 -H, --home="/builddir"
95 a home directory specification. spec can either be a src path or
96 src:dest pair. src is the source path of the home directory outside
97 the container and dest overrides the home directory within the
98 container.
99 --hostname=""
102 set container hostname
103 -i, --ipc[=false]
106 run container in a new IPC namespace
107 --keep-privs[=false]
110 let root user keep privileges in container (root only)
111 -n, --net[=false]
114 run container in a new network namespace (sets up a bridge network
115 interface by default)
116 --network="bridge"
119 specify desired network type separated by commas, each network will
120 bring up a dedicated interface inside container
121 --network-args=[]
124 specify network arguments to pass to CNI plugins
125 --no-home[=false]
128 do NOT mount users home directory if home is not the current
129 working directory
130 --no-init[=false]
133 do NOT start shim process with --pid
134 --no-nv[=false]
137 --no-privs[=false]
140 drop all privileges from root user in container)
141 --nohttps[=false]
144 do NOT use HTTPS, for communicating with local docker registry
145 --nonet[=false]
148 Disable VM network handling
149 --nv[=false]
152 enable experimental Nvidia support
153 -o, --overlay=[]
156 use an overlayFS image for persistent data storage or as read-only
157 layer of container
158 --passphrase[=false]
161 Enter a passphrase for an encrypted contaner
162 --pem-path=""
165 Enter an path to a PEM formated RSA key for an encrypted container
166 -p, --pid[=false]
169 run container in a new PID namespace
170 --pwd=""
173 initial working directory for payload process inside the container
174 -S, --scratch=[]
177 include a scratch directory within the container that is linked to
178 a temporary dir (use -W to force location)
179 --security=[]
182 enable security features (SELinux, Apparmor, Seccomp)
183 -u, --userns[=false]
186 run container in a new user namespace, allowing Singularity to run
187 completely unprivileged on recent kernels. This disables some features
188 of Singularity, for example it only works with sandbox images.
189 --uts[=false]
192 run container in a new UTS namespace
193 --vm[=false]
196 enable VM support
197 --vm-cpu="1"
200 Number of CPU cores to allocate to Virtual Machine (implies --vm)
201 --vm-err[=false]
204 enable attaching stderr from VM
205 --vm-ip="dhcp"
208 IP Address to assign for container usage. Defaults to DHCP within
209 bridge network.
210 --vm-ram="1024"
213 Amount of RAM in MiB to allocate to Virtual Machine (implies --vm)
214 -W, --workdir=""
217 working directory to be used for /tmp, /var/tmp and $HOME (if
218 -c/--contain was also used)
219 -w, --writable[=false]
222 by default all Singularity containers are available as read only.
223 This option makes the file system accessible as read/write.
224 --writable-tmpfs[=false]
227 makes the file system accessible as read-write with non persistent
228 data (with overlay support only)
229
233 Set the '%test' section with a definition file like so:
234 %test
235 echo "hello from test" "$@"
236 $ singularity test /tmp/debian.sif command
238 hello from test command
239 For additional help, please visit our public documentation pages which are
241 found at:
242 https://www.sylabs.io/docs/
244
249 singularity(1)
250
254 21-Oct-2019 Auto generated by spf13/cobra
255Auto generated by spf13/cobra Oct 2019 singularity(1)