~smoser/ubuntu/zesty/curtin/pkg

« back to all changes in this revision

Viewing changes to doc/devel/README-vmtest.txt

  • Committer: Scott Moser
  • Date: 2016-08-05 20:51:16 UTC
  • mfrom: (1.1.40)
  • Revision ID: smoser@ubuntu.com-20160805205116-hm08b4uokfhn92hv
* New upstream snapshot.
  - Add apt configuration features. (LP: #1574113)
  - mkfs.vfat: add force flag for formating whole disks (LP: #1597923)
  - block.mkfs: fix sectorsize flag (LP: #1597522)
  - block_meta: cleanup use of sys_block_path and handle cciss knames
    (LP: #1562249)
  - block.get_blockdev_sector_size: handle _lsblock multi result return
    (LP: #1598310)
  - util: add target (chroot) support to subp, add target_path helper
  - block_meta: fallback to parted if blkid does not produce output
    (LP: #1524031)
  - commands.block_wipe:  correct default wipe mode to 'superblock'

Show diffs side-by-side

added added

removed removed

Lines of Context:
90
90
    The tests themselves don't actually have to run as root, but the
91
91
    test setup does.
92
92
  * the 'tools' directory must be in your path.
93
 
  * test will set apt_proxy in the guests to the value of
94
 
    'apt_proxy' environment variable.  If that is not set it will 
 
93
  * test will set apt: { proxy } in the guests to the value of
 
94
    'apt_proxy' environment variable.  If that is not set it will
95
95
    look at the host's apt config and read 'Acquire::HTTP::Proxy'
96
96
 
97
97
== Environment Variables ==
98
98
Some environment variables affect the running of vmtest
99
 
  * apt_proxy: 
 
99
  * apt_proxy:
100
100
    test will set apt_proxy in the guests to the value of 'apt_proxy'.
101
101
    If that is not set it will look at the host's apt config and read
102
102
    'Acquire::HTTP::Proxy'
141
141
    'virbr0' or 'lxcbr0' to use those bridges and then be able to ssh
142
142
    in directly.
143
143
 
 
144
  * CURTIN_VMTEST_BOOT_TIMEOUT: default 300
 
145
    timeout before giving up on the boot of the installed system.
 
146
 
 
147
  * CURTIN_VMTEST_INSTALL_TIMEOUT: default 3000
 
148
    timeout before giving up on installation.
 
149
 
 
150
  * CURTIN_VMTEST_PARALLEL: default ''
 
151
    only supported through ./tools/jenkins-runner .
 
152
       -1 : then run one per core.
 
153
        0 or '': then run with no parallel
 
154
       >0 : run with N processes
 
155
    this modifies the  invocation of nosetets to add '--processes' and other
 
156
    necessary nose arguments (--process-timeout)
 
157
 
144
158
  * IMAGE_DIR: default /srv/images
145
159
    vmtest keeps a mirror of maas ephemeral images in this directory.
146
160
 
150
164
Environment 'boolean' values:
151
165
   For boolean environment variables the value is considered True
152
166
   if it is any value other than case insensitive 'false', '' or "0"
 
167
 
 
168
 
 
169
== Test Class Variables ==
 
170
The base VMBaseClass defines several variables that help creating a new test
 
171
easily. Among those the common ones are:
 
172
 
 
173
Generic:
 
174
- arch_skip
 
175
  If a test is not supported on an architecture it can list the arch in this
 
176
  variable to auto-skip the test if executed on that arch.
 
177
- conf_file
 
178
  The configuration that will be processed by this vmtest.
 
179
- extra_kern_args
 
180
  Extra arguments to the guest kernel on boot.
 
181
 
 
182
Data Collection:
 
183
- collect_scripts
 
184
  The commands run when booting into the installed environment to collect the
 
185
  data for the test to verify a proper execution.
 
186
- boot_cloudconf
 
187
  Extra cloud-init config content for the install phase.
 
188
  This allows to gather content of the install phase if needed for test
 
189
  verification.
 
190
 
 
191
 
 
192
Disk Setup:
 
193
- disk_block_size = 512
 
194
- disk_driver = 'virtio-blk'
 
195
  Used to set up the disks for the virtual environment used by the vmtest.
 
196
  Will set the values used in extra_disks if not specified there.
 
197
- extra_disks
 
198
  A list of extra disks to be created for the testcase. The definition is
 
199
  dpath:size:driver:block_size
 
200
- multipath = False
 
201
- multipath_num_paths = 2
 
202
  Details for the (virtual) multipath setup
 
203
- nvme_disks
 
204
  a shortcut to provide extra disks with the nvme driver
 
205
 
 
206
Timeouts:
 
207
- boot_timeout
 
208
- install_timeout
 
209
  Usually set via CURTIN_VMTEST_BOOT_TIMEOUT/CURTIN_VMTEST_INSTALL_TIMEOUT
 
210
  (see above) environment var, but can be overwritten by a testcase if needed.
 
211
 
 
212
Checks:
 
213
- disk_to_check
 
214
  A disk name that is verified to be existing after the installation.
 
215
- fstab_expected
 
216
 
 
217
Release:
 
218
- release = None
 
219
- krel = None
 
220
  Those two define the distribution and kernel release to be tested and are
 
221
  usually set by importing and inheriting from tests/vmtests/releases.py