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 --dns=""
71 list of DNS server separated by commas to add in resolv.conf
72 --docker-login[=false]
75 login to a Docker Repository interactively
76 --drop-caps=""
79 a comma separated capability list to drop
80 -h, --help[=false]
83 help for test
84 -H, --home="/builddir"
87 a home directory specification. spec can either be a src path or
88 src:dest pair. src is the source path of the home directory outside
89 the container and dest overrides the home directory within the
90 container.
91 --hostname=""
94 set container hostname
95 -i, --ipc[=false]
98 run container in a new IPC namespace
99 --keep-privs[=false]
102 let root user keep privileges in container (root only)
103 -n, --net[=false]
106 run container in a new network namespace (sets up a bridge network
107 interface by default)
108 --network="bridge"
111 specify desired network type separated by commas, each network will
112 bring up a dedicated interface inside container
113 --network-args=[]
116 specify network arguments to pass to CNI plugins
117 --no-home[=false]
120 do NOT mount users home directory if home is not the current
121 working directory
122 --no-init[=false]
125 do NOT start shim process with --pid
126 --no-privs[=false]
129 drop all privileges from root user in container
130 --nohttps[=false]
133 do NOT use HTTPS, for communicating with local docker registry
134 --nv[=false]
137 enable experimental Nvidia support
138 -o, --overlay=[]
141 use an overlayFS image for persistent data storage or as read-only
142 layer of container
143 -p, --pid[=false]
146 run container in a new PID namespace
147 --pwd=""
150 initial working directory for payload process inside the container
151 -S, --scratch=[]
154 include a scratch directory within the container that is linked to
155 a temporary dir (use -W to force location)
156 --security=[]
159 enable security features (SELinux, Apparmor, Seccomp)
160 -u, --userns[=false]
163 run container in a new user namespace, allowing Singularity to run
164 completely unprivileged on recent kernels. This disables some features
165 of Singularity, for example it only works with sandbox images.
166 --uts[=false]
169 run container in a new UTS namespace
170 --vm[=false]
173 enable VM support
174 --vm-cpu="1"
177 Number of CPU cores to allocate to Virtual Machine (implies --vm)
178 --vm-err[=false]
181 enable attaching stderr from VM
182 --vm-ram="1024"
185 Amount of RAM in MiB to allocate to Virtual Machine (implies --vm)
186 -W, --workdir=""
189 working directory to be used for /tmp, /var/tmp and $HOME (if
190 -c/--contain was also used)
191 -w, --writable[=false]
194 by default all Singularity containers are available as read only.
195 This option makes the file system accessible as read/write.
196 --writable-tmpfs[=false]
199 makes the file system accessible as read-write with non persistent
200 data (with overlay support only)
201
205 Set the '%test' section with a definition file like so:
206 %test
207 echo "hello from test" "$@"
208 $ singularity test /tmp/debian.sif command
210 hello from test command
211 For additional help, please visit our public documentation pages which are
213 found at:
214 https://www.sylabs.io/docs/
216
221 singularity(1)
222
226 29-May-2019 Auto generated by spf13/cobra
227Auto generated by spf13/cobra May 2019 singularity(1)