1
diff --git a/doc/rtd/topics/tests.rst b/doc/rtd/topics/tests.rst
2
index 0663811..a088e64 100644
3
--- a/doc/rtd/topics/tests.rst
4
+++ b/doc/rtd/topics/tests.rst
5
@@ -47,20 +47,23 @@ The test configuration is a YAML file such as *ntp_server.yaml* below:
6
47
        cat /etc/ntp.conf | grep '^server'
47
        cat /etc/ntp.conf | grep '^server'
7
48
48
8
49
49
10
50
There are two keys, 1 required and 1 optional, in the YAML file:
50
There are several keys, 1 required and some optional, in the YAML file:
11
51
51
12
52
1. The required key is ``cloud_config``. This should be a string of valid
52
1. The required key is ``cloud_config``. This should be a string of valid
13
53
   YAML that is exactly what would normally be placed in a cloud-config file,
53
   YAML that is exactly what would normally be placed in a cloud-config file,
14
54
   including the cloud-config header. This essentially sets up the scenario
54
   including the cloud-config header. This essentially sets up the scenario
15
55
   under test.
55
   under test.
16
56
56
18
57
2. The optional key is ``collect_scripts``. This key has one or more
57
2. One optional key is ``collect_scripts``. This key has one or more
19
58
   sub-keys containing strings of arbitrary commands to execute (e.g.
58
   sub-keys containing strings of arbitrary commands to execute (e.g.
20
59
   ```cat /var/log/cloud-config-output.log```). In the example above the
59
   ```cat /var/log/cloud-config-output.log```). In the example above the
21
60
   output of dpkg is captured, grep for ntp, and the number of lines
60
   output of dpkg is captured, grep for ntp, and the number of lines
22
61
   reported. The name of the sub-key is important. The sub-key is used by
61
   reported. The name of the sub-key is important. The sub-key is used by
23
62
   the verification script to recall the output of the commands ran.
62
   the verification script to recall the output of the commands ran.
24
63
63
25
64
3. The optinal key ``enabled`` enables or disables the test case. By defaul
26
65
   the test case will be enabled.
27
66
28
64
Default Collect Scripts
67
Default Collect Scripts
29
65
-----------------------
68
-----------------------
30
66
69
31
@@ -109,15 +112,25 @@ Here is a breakdown of the unit test file:
32
109
112
33
110
* The import statement allows access to the output files.
113
* The import statement allows access to the output files.
34
111
114
36
112
* The class can be named anything, but must import the ``base.CloudTestCase``
115
* The class can be named anything, but must import the ``base.CloudTestCase``,
37
116
  either directly or via another test class.
38
113
117
39
114
* There can be 1 to N number of functions with any name, however only
118
* There can be 1 to N number of functions with any name, however only
40
115
  tests starting with ``test_*`` will be executed.
119
  tests starting with ``test_*`` will be executed.
41
116
120
42
121
* There can be 1 to N number of classes in a test module, however only classes
43
122
  inheriting from ``base.CloudTestCase`` will be loaded.
44
123
45
117
* Output from the commands can be accessed via
124
* Output from the commands can be accessed via
46
118
  ``self.get_data_file('key')`` where key is the sub-key of
125
  ``self.get_data_file('key')`` where key is the sub-key of
47
119
  ``collect_scripts`` above.
126
  ``collect_scripts`` above.
48
120
127
49
128
* The cloud config that the test ran with can be accessed via
50
129
  ``self.cloud_config``, or any entry from the cloud config can be accessed via
51
130
  ``self.get_config_entry('key')``.
52
131
53
132
* See the base ``CloudTestCase`` for additional helper functions.
54
133
55
121
Layout
134
Layout
56
122
======
135
======
57
123
136
58
@@ -144,6 +157,23 @@ The sub-folders of bugs, examples, main, and modules help organize the
59
144
tests. View the README.md in each to understand in more detail each
157
tests. View the README.md in each to understand in more detail each
60
145
directory.
158
directory.
61
146
159
62
160
Test Creation Helper
63
161
====================
64
162
65
163
The integration testing suite has a built in helper to aid in test development.
66
164
Its help can be invoked via ``python3 -m tests.cloud_tests create --help``. It
67
165
can create a template testcase config file with user data passed in from the
68
166
command line, as well as a template testcase verifier module.
69
167
70
168
The following would create a testcase named ``example`` under the ``modules``
71
169
category with the given description, and cloud config data read in from
72
170
``/tmp/user_data``.
73
171
74
172
.. code-block:: bash
75
173
76
174
    $ python3 -m tests.cloud_tests create modules/example \
77
175
        -d "a simple example test case" -c "$(< /tmp/user_data)"
78
176
79
147
177
80
148
Development Checklist
178
Development Checklist
81
149
=====================
179
=====================
82
@@ -171,7 +201,7 @@ Development Checklist
83
171
Execution
201
Execution
84
172
=========
202
=========
85
173
203
87
174
Executing tests has three options:
204
Executing tests has several options:
88
175
205
89
176
* ``run`` an alias to run both ``collect`` and ``verify``
206
* ``run`` an alias to run both ``collect`` and ``verify``
90
177
207
91
@@ -182,6 +212,10 @@ Executing tests has three options:
92
182
* ``verify`` given a directory of test data, run the Python unit tests on
212
* ``verify`` given a directory of test data, run the Python unit tests on
93
183
  it to generate results.
213
  it to generate results.
94
184
214
95
215
* ``tree_run`` and ``tree_collect`` are helpers to run ``run`` or ``collect``
96
216
  respectively using a deb built from the copy of cloud-init in the current
97
217
  working tree.
98
218
99
185
Run
219
Run
100
186
---
220
---
101
187
The first example will provide a complete end-to-end run of data
221
The first example will provide a complete end-to-end run of data
102
@@ -238,6 +272,29 @@ without the more lengthy collect process. This can be done by running:
103
238
The above command will run the verify scripts on the data discovered in
272
The above command will run the verify scripts on the data discovered in
104
239
`/tmp/collection`.
273
`/tmp/collection`.
105
240
274
106
275
TreeRun and TreeCollect
107
276
-----------------------
108
277
109
278
If working on a cloud-init feature or resolving a bug, it may be useful to run
110
279
the current copy of cloud-init in the integration testing environment. The
111
280
integration testing suite can automatically build a deb based on the current
112
281
working tree of cloud-init and run the test suite using this deb.
113
282
114
283
The ``tree_run`` and ``tree_collect`` commands take the same arguments as the
115
284
``run`` and ``collect`` commands. These commands will build a deb and write it
116
285
into a tempfile, then start the test suite and pass that deb in. To build a
117
286
deb only, and not run the test suite, the ``bddeb`` command can be used.
118
287
119
288
Note that code in the cloud-init working tree that has not been committed
120
289
when the cloud-init deb is built will still be included. To build a cloud-init
121
290
deb from or use the ``tree_run`` command using a copy of cloud-init located in
122
291
a different directory, use the option ``--cloud-init /path/to/cloud-init``.
123
292
124
293
.. code-block:: bash
125
294
126
295
    $ python3 -m tests.cloud_tests tree_run -n xenial -n zesty \
127
296
        -t modules/final_message -t modules/write_files -v -r /tmp/result.yaml
128
297
129
241
Run via tox
298
Run via tox
130
242
-----------
299
-----------
131
243
In order to avoid the need for dependencies and ease the setup and
300
In order to avoid the need for dependencies and ease the setup and
132
@@ -256,11 +313,13 @@ arguments.
133
256
Architecture
313
Architecture
134
257
============
314
============
135
258
315
137
259
The following outlines the process flow during a complete end-to-end LXD-backed test.
316
The following outlines the process flow during a complete end-to-end
138
317
LXD-backed test.
139
260
318
140
261
1. Configuration
319
1. Configuration
141
262
    * The back end and specific OS releases are verified as supported
320
    * The back end and specific OS releases are verified as supported
143
263
    * The test or tests that need to be run are determined either by directory or by individual yaml
321
    * The test or tests that need to be run are determined either by
144
322
      directory or by individual yaml
145
264
323
146
265
2. Image Creation
324
2. Image Creation
147
266
    * Acquire the daily LXD image
325
    * Acquire the daily LXD image
148
@@ -285,5 +344,5 @@ The following outlines the process flow during a complete end-to-end LXD-backed 
149
285
344
150
286
5. Results
345
5. Results
151
287
    * If any failures were detected the test suite returns a failure
346
    * If any failures were detected the test suite returns a failure
154
288
347
    * Results can be dumped in yaml format to a specified file using the
155
289
348
      ``-r <result_file_name>.yaml`` option
156
diff --git a/tests/cloud_tests/__init__.py b/tests/cloud_tests/__init__.py
157
index 099c357..7959bd9 100644
158
--- a/tests/cloud_tests/__init__.py
159
+++ b/tests/cloud_tests/__init__.py
160
@@ -6,6 +6,7 @@ import os
161
6
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
6
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
162
7
TESTCASES_DIR = os.path.join(BASE_DIR, 'testcases')
7
TESTCASES_DIR = os.path.join(BASE_DIR, 'testcases')
163
8
TEST_CONF_DIR = os.path.join(BASE_DIR, 'configs')
8
TEST_CONF_DIR = os.path.join(BASE_DIR, 'configs')
164
9
TREE_BASE = os.sep.join(BASE_DIR.split(os.sep)[:-2])
165
9
10
166
10
11
167
11
def _initialize_logging():
12
def _initialize_logging():
168
diff --git a/tests/cloud_tests/__main__.py b/tests/cloud_tests/__main__.py
169
index ef7d187..74f29f6 100644
170
--- a/tests/cloud_tests/__main__.py
171
+++ b/tests/cloud_tests/__main__.py
172
@@ -2,11 +2,9 @@
173
2
2
174
3
import argparse
3
import argparse
175
4
import logging
4
import logging
176
5
import shutil
177
6
import sys
5
import sys
178
7
import tempfile
179
8
6
181
9
from tests.cloud_tests import (args, collect, manage, verify)
7
from tests.cloud_tests import args, bddeb, collect, manage, run_funcs, verify
182
10
from tests.cloud_tests import LOG
8
from tests.cloud_tests import LOG
183
11
9
184
12
10
185
@@ -22,28 +20,6 @@ def configure_log(args):
186
22
    LOG.setLevel(level)
20
    LOG.setLevel(level)
187
23
21
188
24
22
189
25
def run(args):
190
26
    """
191
27
    run full test suite
192
28
    """
193
29
    failed = 0
194
30
    args.data_dir = tempfile.mkdtemp(prefix='cloud_test_data_')
195
31
    LOG.debug('using tmpdir %s', args.data_dir)
196
32
    try:
197
33
        failed += collect.collect(args)
198
34
        failed += verify.verify(args)
199
35
    except Exception:
200
36
        failed += 1
201
37
        raise
202
38
    finally:
203
39
        # TODO: make this configurable via environ or cmdline
204
40
        if failed:
205
41
            LOG.warn('some tests failed, leaving data in %s', args.data_dir)
206
42
        else:
207
43
            shutil.rmtree(args.data_dir)
208
44
    return failed
209
45
210
46
211
47
def main():
23
def main():
212
48
    """
24
    """
213
49
    entry point for cloud test suite
25
    entry point for cloud test suite
214
@@ -80,9 +56,12 @@ def main():
215
80
    # run handler
56
    # run handler
216
81
    LOG.debug('running with args: %s\n', parsed)
57
    LOG.debug('running with args: %s\n', parsed)
217
82
    return {
58
    return {
218
59
        'bddeb': bddeb.bddeb,
219
83
        'collect': collect.collect,
60
        'collect': collect.collect,
220
84
        'create': manage.create,
61
        'create': manage.create,
222
85
        'run': run,
62
        'run': run_funcs.run,
223
63
        'tree_collect': run_funcs.tree_collect,
224
64
        'tree_run': run_funcs.tree_run,
225
86
        'verify': verify.verify,
65
        'verify': verify.verify,
226
87
    }[parsed.subcmd](parsed)
66
    }[parsed.subcmd](parsed)
227
88
67
228
diff --git a/tests/cloud_tests/args.py b/tests/cloud_tests/args.py
229
index b68cc98..d051737 100644
230
--- a/tests/cloud_tests/args.py
231
+++ b/tests/cloud_tests/args.py
232
@@ -3,9 +3,24 @@
233
3
import os
3
import os
234
4
4
235
5
from tests.cloud_tests import config, util
5
from tests.cloud_tests import config, util
237
6
from tests.cloud_tests import LOG
6
from tests.cloud_tests import LOG, TREE_BASE
238
7
7
239
8
ARG_SETS = {
8
ARG_SETS = {
240
9
    'BDDEB': (
241
10
        (('--bddeb-args',),
242
11
         {'help': 'args to pass through to bddeb',
243
12
          'action': 'store', 'default': None, 'required': False}),
244
13
        (('--build-os',),
245
14
         {'help': 'OS to use as build system (default is xenial)',
246
15
          'action': 'store', 'choices': config.list_enabled_distros(),
247
16
          'default': 'xenial', 'required': False}),
248
17
        (('--build-platform',),
249
18
         {'help': 'platform to use for build system (default is lxd)',
250
19
          'action': 'store', 'choices': config.list_enabled_platforms(),
251
20
          'default': 'lxd', 'required': False}),
252
21
        (('--cloud-init',),
253
22
         {'help': 'path to base of cloud-init tree', 'metavar': 'DIR',
254
23
          'action': 'store', 'required': False, 'default': TREE_BASE}),),
255
9
    'COLLECT': (
24
    'COLLECT': (
256
10
        (('-p', '--platform'),
25
        (('-p', '--platform'),
257
11
         {'help': 'platform(s) to run tests on', 'metavar': 'PLATFORM',
26
         {'help': 'platform(s) to run tests on', 'metavar': 'PLATFORM',
258
@@ -42,6 +57,10 @@ ARG_SETS = {
259
42
        (('-d', '--data-dir'),
57
        (('-d', '--data-dir'),
260
43
         {'help': 'directory to store test data in',
58
         {'help': 'directory to store test data in',
261
44
          'action': 'store', 'metavar': 'DIR', 'required': True}),),
59
          'action': 'store', 'metavar': 'DIR', 'required': True}),),
262
60
    'OUTPUT_DEB': (
263
61
        (('--deb',),
264
62
         {'help': 'path to write output deb to', 'metavar': 'FILE',
265
63
          'action': 'store', 'required': True}),),
266
45
    'RESULT': (
64
    'RESULT': (
267
46
        (('-r', '--result'),
65
        (('-r', '--result'),
268
47
         {'help': 'file to write results to',
66
         {'help': 'file to write results to',
269
@@ -66,10 +85,16 @@ ARG_SETS = {
270
66
}
85
}
271
67
86
272
68
SUBCMDS = {
87
SUBCMDS = {
273
88
    'bddeb': ('build cloud-init deb from tree',
274
89
              ('BDDEB', 'OUTPUT_DEB', 'INTERFACE')),
275
69
    'collect': ('collect test data',
90
    'collect': ('collect test data',
276
70
                ('COLLECT', 'INTERFACE', 'OUTPUT', 'RESULT', 'SETUP')),
91
                ('COLLECT', 'INTERFACE', 'OUTPUT', 'RESULT', 'SETUP')),
277
71
    'create': ('create new test case', ('CREATE', 'INTERFACE')),
92
    'create': ('create new test case', ('CREATE', 'INTERFACE')),
278
72
    'run': ('run test suite', ('COLLECT', 'INTERFACE', 'RESULT', 'SETUP')),
93
    'run': ('run test suite', ('COLLECT', 'INTERFACE', 'RESULT', 'SETUP')),
279
94
    'tree_collect': ('collect using current working tree',
280
95
                     ('BDDEB', 'COLLECT', 'INTERFACE', 'OUTPUT', 'RESULT')),
281
96
    'tree_run': ('run using current working tree',
282
97
                 ('BDDEB', 'COLLECT', 'INTERFACE', 'RESULT')),
283
73
    'verify': ('verify test data', ('INTERFACE', 'OUTPUT', 'RESULT')),
98
    'verify': ('verify test data', ('INTERFACE', 'OUTPUT', 'RESULT')),
284
74
}
99
}
285
75
100
286
@@ -81,6 +106,20 @@ def _empty_normalizer(args):
287
81
    return args
106
    return args
288
82
107
289
83
108
290
109
def normalize_bddeb_args(args):
291
110
    """
292
111
    normalize BDDEB arguments
293
112
    args: parsed args
294
113
    return_value: updated args, or None if errors encountered
295
114
    """
296
115
    # make sure cloud-init dir is accessible
297
116
    if not (args.cloud_init and os.path.isdir(args.cloud_init)):
298
117
        LOG.error('invalid cloud-init tree path')
299
118
        return None
300
119
301
120
    return args
302
121
303
122
304
84
def normalize_create_args(args):
123
def normalize_create_args(args):
305
85
    """
124
    """
306
86
    normalize CREATE arguments
125
    normalize CREATE arguments
307
@@ -185,6 +224,17 @@ def normalize_output_args(args):
308
185
    return args
224
    return args
309
186
225
310
187
226
311
227
def normalize_output_deb_args(args):
312
228
    """
313
229
    normalize OUTPUT_DEB arguments
314
230
    args: parsed args
315
231
    return_value: updated args, or None if erros occurred
316
232
    """
317
233
    # make sure to use abspath for deb
318
234
    args.deb = os.path.abspath(args.deb)
319
235
    return args
320
236
321
237
322
188
def normalize_setup_args(args):
238
def normalize_setup_args(args):
323
189
    """
239
    """
324
190
    normalize SETUP arguments
240
    normalize SETUP arguments
325
@@ -210,10 +260,12 @@ def normalize_setup_args(args):
326
210
260
327
211
261
328
212
NORMALIZERS = {
262
NORMALIZERS = {
329
263
    'BDDEB': normalize_bddeb_args,
330
213
    'COLLECT': normalize_collect_args,
264
    'COLLECT': normalize_collect_args,
331
214
    'CREATE': normalize_create_args,
265
    'CREATE': normalize_create_args,
332
215
    'INTERFACE': _empty_normalizer,
266
    'INTERFACE': _empty_normalizer,
333
216
    'OUTPUT': normalize_output_args,
267
    'OUTPUT': normalize_output_args,
334
268
    'OUTPUT_DEB': normalize_output_deb_args,
335
217
    'RESULT': _empty_normalizer,
269
    'RESULT': _empty_normalizer,
336
218
    'SETUP': normalize_setup_args,
270
    'SETUP': normalize_setup_args,
337
219
}
271
}
338
diff --git a/tests/cloud_tests/bddeb.py b/tests/cloud_tests/bddeb.py
339
220
new file mode 100644
272
new file mode 100644
340
index 0000000..3b79cd2
341
--- /dev/null
342
+++ b/tests/cloud_tests/bddeb.py
343
@@ -0,0 +1,124 @@
344
1
# This file is part of cloud-init. See LICENSE file for license information.
345
2
346
3
from tests.cloud_tests import (config, LOG)
347
4
from tests.cloud_tests import (platforms, images, snapshots, instances)
348
5
from tests.cloud_tests.stage import (PlatformComponent, run_stage, run_single)
349
6
350
7
from cloudinit import util as c_util
351
8
352
9
from functools import partial
353
10
import os
354
11
355
12
build_deps = ['devscripts', 'equivs', 'git', 'tar']
356
13
357
14
358
15
def _out(cmd_res):
359
16
    """
360
17
    get clean output from cmd result
361
18
    """
362
19
    return cmd_res[0].strip()
363
20
364
21
365
22
def build_deb(args, instance):
366
23
    """
367
24
    build deb on system and copy out to location at args.deb
368
25
    args: cmdline arguments
369
26
    return_value: tuple of results and fail count
370
27
    """
371
28
    # update remote system package list and install build deps
372
29
    LOG.debug('installing build deps')
373
30
    pkgs = ' '.join(build_deps)
374
31
    cmd = 'apt-get update && apt-get install --yes {}'.format(pkgs)
375
32
    instance.execute(['/bin/sh', '-c', cmd])
376
33
    instance.execute(['mk-build-deps', '--install', '-t',
377
34
                      'apt-get --no-install-recommends --yes', 'cloud-init'])
378
35
379
36
    # local tmpfile that must be deleted
380
37
    local_tarball = _out(c_util.subp(['mktemp'], capture=True))
381
38
382
39
    try:
383
40
        # paths to use in remote system
384
41
        remote_tarball = _out(instance.execute(['mktemp']))
385
42
        extract_dir = _out(instance.execute(['mktemp', '--directory']))
386
43
        bddeb_path = os.path.join(extract_dir, 'packages', 'bddeb')
387
44
        output_link = '/cloud-init_all.deb'
388
45
        git_env = {'GIT_DIR': os.path.join(extract_dir, '.git'),
389
46
                   'GIT_WORK_TREE': extract_dir}
390
47
391
48
        # create a tarball of cloud init tree and copy to remote system
392
49
        LOG.debug('creating tarball of cloud-init at: %s', local_tarball)
393
50
        c_util.subp(['tar', 'cf', local_tarball, '--owner', 'root',
394
51
                     '--group', 'root', '-C', args.cloud_init, '.'])
395
52
        LOG.debug('copying to remote system at: %s', remote_tarball)
396
53
        instance.push_file(local_tarball, remote_tarball)
397
54
398
55
        # extract tarball in remote system and commit anything uncommitted
399
56
        LOG.debug('extracting tarball in remote system at: %s', extract_dir)
400
57
        instance.execute(['tar', 'xf', remote_tarball, '-C', extract_dir])
401
58
        instance.execute(['git', 'commit', '-a', '-m', 'tmp', '--allow-empty'],
402
59
                         env=git_env)
403
60
404
61
        # build the deb, ignoring missing deps (flake8)
405
62
        LOG.debug('building deb in remote system at: %s', output_link)
406
63
        bddeb_args = args.bddeb_args.split() if args.bddeb_args else []
407
64
        instance.execute([bddeb_path, '-d'] + bddeb_args, env=git_env)
408
65
409
66
        # copy the deb back to the host system
410
67
        LOG.debug('copying built deb to host at: %s', args.deb)
411
68
        instance.pull_file(output_link, args.deb)
412
69
413
70
    finally:
414
71
        os.remove(local_tarball)
415
72
416
73
417
74
def setup_build(args):
418
75
    """
419
76
    set build system up then run build
420
77
    args: cmdline arguments
421
78
    return_value: tuple of results and fail count
422
79
    """
423
80
    res = ({}, 1)
424
81
425
82
    # set up platform
426
83
    LOG.info('setting up platform: %s', args.build_platform)
427
84
    platform_config = config.load_platform_config(args.build_platform)
428
85
    platform_call = partial(platforms.get_platform, args.build_platform,
429
86
                            platform_config)
430
87
    with PlatformComponent(platform_call) as platform:
431
88
432
89
        # set up image
433
90
        LOG.info('acquiring image for os: %s', args.build_os)
434
91
        img_conf = config.load_os_config(args.build_os)
435
92
        image_call = partial(images.get_image, platform, img_conf)
436
93
        with PlatformComponent(image_call) as image:
437
94
438
95
            # set up snapshot
439
96
            snapshot_call = partial(snapshots.get_snapshot, image)
440
97
            with PlatformComponent(snapshot_call) as snapshot:
441
98
442
99
                # create instance with cloud-config to set it up
443
100
                LOG.info('creating instance to build deb in')
444
101
                empty_cloud_config = "#cloud-config\n{}"
445
102
                instance_call = partial(
446
103
                    instances.get_instance, snapshot, empty_cloud_config,
447
104
                    use_desc='build cloud-init deb')
448
105
                with PlatformComponent(instance_call) as instance:
449
106
450
107
                    # build the deb
451
108
                    res = run_single('build deb on system',
452
109
                                     partial(build_deb, args, instance))
453
110
454
111
    return res
455
112
456
113
457
114
def bddeb(args):
458
115
    """
459
116
    entry point for build deb
460
117
    args: cmdline arguments
461
118
    return_value: fail count
462
119
    """
463
120
    LOG.info('preparing to build cloud-init deb')
464
121
    (res, failed) = run_stage('build deb', [partial(setup_build, args)])
465
122
    return failed
466
123
467
124
# vi: ts=4 expandtab
468
diff --git a/tests/cloud_tests/instances/base.py b/tests/cloud_tests/instances/base.py
469
index 9559d28..1782c1d 100644
470
--- a/tests/cloud_tests/instances/base.py
471
+++ b/tests/cloud_tests/instances/base.py
472
@@ -51,7 +51,7 @@ class Instance(object):
473
51
        copy file at 'remote_path', from instance to 'local_path'
51
        copy file at 'remote_path', from instance to 'local_path'
474
52
        """
52
        """
475
53
        with open(local_path, 'wb') as fp:
53
        with open(local_path, 'wb') as fp:
477
54
            fp.write(self.read_data(remote_path), encode=True)
54
            fp.write(self.read_data(remote_path))
478
55
55
479
56
    def push_file(self, local_path, remote_path):
56
    def push_file(self, local_path, remote_path):
480
57
        """
57
        """
481
diff --git a/tests/cloud_tests/run_funcs.py b/tests/cloud_tests/run_funcs.py
482
58
new file mode 100644
58
new file mode 100644
483
index 0000000..683a3f6
484
--- /dev/null
485
+++ b/tests/cloud_tests/run_funcs.py
486
@@ -0,0 +1,65 @@
487
1
# This file is part of cloud-init. See LICENSE file for license information.
488
2
489
3
from tests.cloud_tests import bddeb, collect, util, verify
490
4
491
5
import os
492
6
493
7
494
8
def tree_collect(args):
495
9
    """
496
10
    collect data using deb build from current tree
497
11
    args: cmdline args
498
12
    return_value: fail count
499
13
    """
500
14
    failed = 0
501
15
502
16
    with util.TempDir(args) as tmpdir:
503
17
        args.deb = os.path.join(tmpdir, 'cloud-init.deb')
504
18
        try:
505
19
            failed += bddeb.bddeb(args)
506
20
            failed += collect.collect(args)
507
21
        except Exception:
508
22
            failed += 1
509
23
            raise
510
24
511
25
    return failed
512
26
513
27
514
28
def tree_run(args):
515
29
    """
516
30
    run test suite using deb build from current tree
517
31
    args: cmdline args
518
32
    return_value: fail count
519
33
    """
520
34
    failed = 0
521
35
522
36
    with util.TempDir(args) as tmpdir:
523
37
        args.deb = os.path.join(tmpdir, 'cloud-init.deb')
524
38
        try:
525
39
            failed += bddeb.bddeb(args)
526
40
            failed += run(args)
527
41
        except Exception:
528
42
            failed += 1
529
43
            raise
530
44
531
45
    return failed
532
46
533
47
534
48
def run(args):
535
49
    """
536
50
    run test suite
537
51
    """
538
52
    failed = 0
539
53
540
54
    with util.TempDir(args) as tmpdir:
541
55
        args.data_dir = tmpdir
542
56
        try:
543
57
            failed += collect.collect(args)
544
58
            failed += verify.verify(args)
545
59
        except Exception:
546
60
            failed += 1
547
61
            raise
548
62
549
63
    return failed
550
64
551
65
# vi: ts=4 expandtab
552
diff --git a/tests/cloud_tests/util.py b/tests/cloud_tests/util.py
553
index 64a8667..18f54b4 100644
554
--- a/tests/cloud_tests/util.py
555
+++ b/tests/cloud_tests/util.py
556
@@ -3,6 +3,7 @@
557
3
import glob
3
import glob
558
4
import os
4
import os
559
5
import random
5
import random
560
6
import shutil
561
6
import string
7
import string
562
7
import tempfile
8
import tempfile
563
8
import yaml
9
import yaml
564
@@ -160,4 +161,36 @@ def write_file(*args, **kwargs):
565
160
    """
161
    """
566
161
    c_util.write_file(*args, **kwargs)
162
    c_util.write_file(*args, **kwargs)
567
162
163
568
164
569
165
class TempDir(object):
570
166
    """
571
167
    temporary directory like tempfile.TemporaryDirectory, but configurable
572
168
    """
573
169
574
170
    def __init__(self, args):
575
171
        """
576
172
        setup and store args
577
173
        args: cmdline arguments
578
174
        """
579
175
        self.args = args
580
176
        self.tmpdir = None
581
177
582
178
    def __enter__(self):
583
179
        """
584
180
        create tempdir
585
181
        return_value: tempdir path
586
182
        """
587
183
        self.tmpdir = tempfile.mkdtemp(prefix='cloud_test_')
588
184
        LOG.debug('using tmpdir: %s', self.tmpdir)
589
185
        return self.tmpdir
590
186
591
187
    def __exit__(self, etype, value, trace):
592
188
        """
593
189
        destroy tempdir if no errors occurred
594
190
        """
595
191
        if etype:
596
192
            LOG.warn('erros occurred, leaving data in %s', self.tmpdir)
597
193
        else:
598
194
            shutil.rmtree(self.tmpdir)
599
195
600
163
# vi: ts=4 expandtab
196
# vi: ts=4 expandtab
Status:	Merged
Merged at revision:	76d58265e34851b78e952a7f275340863c90a9f5
Proposed branch:	~wesley-wiedenmeier/cloud-init:integration-testing-invocation-cleanup
Merge into:	cloud-init:master
Diff against target:	600 lines (+349/-36) 8 files modified doc/rtd/topics/tests.rst (+67/-8) tests/cloud_tests/__init__.py (+1/-0) tests/cloud_tests/__main__.py (+5/-26) tests/cloud_tests/args.py (+53/-1) tests/cloud_tests/bddeb.py (+124/-0) tests/cloud_tests/instances/base.py (+1/-1) tests/cloud_tests/run_funcs.py (+65/-0) tests/cloud_tests/util.py (+33/-0)
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Server Team CI bot	continuous-integration		Approve on 2017-03-19
Joshua Powers (community)			Approve on 2017-01-12
cloud-init Commiters		2017-01-11	Pending
Review via email: mp+314496@code.launchpad.net