File: test_state.py

package info (click to toggle)
python-diskimage-builder 3.37.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,572 kB
  • sloc: sh: 7,380; python: 6,444; makefile: 37
file content (152 lines) | stat: -rw-r--r-- 5,527 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

import codecs
import fixtures
import json
import logging
import os

from stevedore import extension
from testtools.matchers import FileExists

import diskimage_builder.block_device.blockdevice as bd
import diskimage_builder.block_device.tests.test_base as tb

from diskimage_builder.block_device.exception import \
    BlockDeviceSetupException

logger = logging.getLogger(__name__)


class TestStateBase(tb.TestBase):

    def setUp(self):
        super(TestStateBase, self).setUp()

        # override the extensions to the test extensions
        test_extensions = extension.ExtensionManager(
            namespace='diskimage_builder.block_device.plugin_test',
            invoke_on_load=False)
        extensions_fixture = fixtures.MonkeyPatch(
            'diskimage_builder.block_device.config._extensions',
            test_extensions)
        self.useFixture(extensions_fixture)

        # status and other bits saved here
        self.build_dir = fixtures.TempDir()
        self.useFixture(self.build_dir)


class TestState(TestStateBase):

    # The the state generation & saving methods
    def test_state_create(self):
        params = {
            'build-dir': self.build_dir.path,
            'config': self.get_config_file('cmd_create.yaml')
        }

        bd_obj = bd.BlockDevice(params)

        bd_obj.cmd_init()
        bd_obj.cmd_create()

        # cmd_create should have persisted this to disk
        state_file = bd_obj.state_json_file_name
        self.assertThat(state_file, FileExists())

        # ensure we see the values put in by the test extensions
        # persisted
        with codecs.open(state_file, encoding='utf-8', mode='r') as fd:
            state = json.load(fd)
        self.assertDictEqual(state,
                             {'test_a': {'value': 'foo',
                                         'value2': 'bar'},
                              'test_b': {'value': 'baz'},
                              'test_init_state': 'here'})

        pickle_file = bd_obj.node_pickle_file_name
        self.assertThat(pickle_file, FileExists())

        # run umount, which should load the picked nodes and run in
        # reverse.  This will create some state in "test_b" that it
        # added to by "test_a" ... ensuring it was run backwards.  It
        # also checks the state was persisted through the pickling
        # process.
        bd_obj.cmd_umount()

    # Test state going missing between phases
    def test_missing_state(self):
        params = {
            'build-dir': self.build_dir.path,
            'config': self.get_config_file('cmd_create.yaml')
        }

        bd_obj = bd.BlockDevice(params)
        bd_obj.cmd_init()
        bd_obj.cmd_create()

        # cmd_create should have persisted this to disk
        state_file = bd_obj.state_json_file_name
        self.assertThat(state_file, FileExists())
        pickle_file = bd_obj.node_pickle_file_name
        self.assertThat(pickle_file, FileExists())

        # simulate the state somehow going missing, and ensure that
        # later calls notice
        os.unlink(state_file)
        os.unlink(pickle_file)
        # This reads from the state dump json file
        self.assertRaisesRegex(BlockDeviceSetupException,
                               "State dump not found",
                               bd_obj.cmd_getval, 'image-path')
        self.assertRaisesRegex(BlockDeviceSetupException,
                               "State dump not found",
                               bd_obj.cmd_writefstab)

        # this uses the pickled nodes
        self.assertRaisesRegex(BlockDeviceSetupException,
                               "Pickle file not found",
                               bd_obj.cmd_delete)
        self.assertRaisesRegex(BlockDeviceSetupException,
                               "Pickle file not found",
                               bd_obj.cmd_cleanup)

        # XXX: figure out unit test for umount

    # Test ordering of rollback calls if create() fails
    def test_rollback(self):
        params = {
            'build-dir': self.build_dir.path,
            'config': self.get_config_file('rollback.yaml'),
            'test_rollback': True
        }

        bd_obj = bd.BlockDevice(params)
        bd_obj.cmd_init()

        # The config file has flags in that tell the last node to
        # fail, which will trigger the rollback.
        self.assertRaises(RuntimeError, bd_obj.cmd_create)

        # cmd_create should have persisted this to disk even after the
        # failure
        state_file = bd_obj.state_json_file_name
        self.assertThat(state_file, FileExists())
        with codecs.open(state_file, encoding='utf-8', mode='r') as fd:
            state = json.load(fd)

        # ensure the rollback was called in order
        self.assertListEqual(state['rollback_test'],
                             ['never', 'gonna', 'give', 'you', 'up',
                              'never', 'gonna', 'let', 'you', 'down'])