b85de3cd9e
A couple of things going on, but I think it makes sense to do them atomically. The NodeBase.create() argument "results" is the global state dictionary that will be saved to "state.json", and re-loaded in later phases and passed to them as the argument "state". So for consistency, call this argument "state" (this fits with the change out to start building the state dictionary earlier in the PluginBase.__init__() calls). Since the "state" is a pretty important part of how everything works, move it into a separate object. This is treated as essentially a singleton. It bundles it nicely together for some added documentation [1]. We move instantiation of this object out of the generic BlockDevice.__init__() call and into the actual cmd_* drivers. This is because there's two distinct instantiation operations -- creating a new state (during cmd_create) and loading an existing state (other cmd_*). This is also safer -- since we know the cmd_* arguments are looking for an existing state.json, we will fail if it somehow goes missing. To more fully unit test this, some testing plugins and new entry-points are added. These add known state values which we check for. These should be a good basis for further tests. [1] as noted, we could probably do some fun things in the future like make this implement a dictionary and have some saftey features like r/o keys. Change-Id: I90eb711b3e9b1ce139eb34bdf3cde641fd06828f
160 lines
6.3 KiB
Python
160 lines
6.3 KiB
Python
# 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 logging
|
|
|
|
from diskimage_builder.block_device.config import config_tree_to_graph
|
|
from diskimage_builder.block_device.config import create_graph
|
|
from diskimage_builder.block_device.exception import \
|
|
BlockDeviceSetupException
|
|
from diskimage_builder.block_device.tests.test_base import TestBase
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class TestConfig(TestBase):
|
|
"""Helper for setting up and reading a config"""
|
|
def setUp(self):
|
|
super(TestConfig, self).setUp()
|
|
|
|
# reset all globals for each test.
|
|
# XXX: remove globals :/
|
|
import diskimage_builder.block_device.level2.mkfs
|
|
diskimage_builder.block_device.level2.mkfs.file_system_labels = set()
|
|
import diskimage_builder.block_device.level3.mount
|
|
diskimage_builder.block_device.level3.mount.mount_points = {}
|
|
diskimage_builder.block_device.level3.mount.sorted_mount_points = None
|
|
|
|
|
|
class TestGraphGeneration(TestConfig):
|
|
"""Extra helper class for testing graph generation"""
|
|
def setUp(self):
|
|
super(TestGraphGeneration, self).setUp()
|
|
|
|
self.fake_default_config = {
|
|
'build-dir': '/fake',
|
|
'image-size': '1000',
|
|
'image-dir': '/fake',
|
|
'mount-base': '/fake',
|
|
}
|
|
|
|
|
|
class TestConfigParsing(TestConfig):
|
|
"""Test parsing config file into a graph"""
|
|
|
|
# test an entry in the config not being a valid plugin
|
|
def test_config_bad_plugin(self):
|
|
config = self.load_config_file('bad_plugin.yaml')
|
|
self.assertRaises(BlockDeviceSetupException,
|
|
config_tree_to_graph,
|
|
config)
|
|
|
|
# test a config that has multiple keys for a top-level entry
|
|
def test_config_multikey_node(self):
|
|
config = self.load_config_file('multi_key_node.yaml')
|
|
self.assertRaisesRegexp(BlockDeviceSetupException,
|
|
"Config entry top-level should be a single "
|
|
"dict:",
|
|
config_tree_to_graph,
|
|
config)
|
|
|
|
# a graph should remain the same
|
|
def test_graph(self):
|
|
graph = self.load_config_file('simple_graph.yaml')
|
|
parsed_graph = config_tree_to_graph(graph)
|
|
self.assertItemsEqual(parsed_graph, graph)
|
|
|
|
# equivalence of simple tree to graph
|
|
def test_simple_tree(self):
|
|
tree = self.load_config_file('simple_tree.yaml')
|
|
graph = self.load_config_file('simple_graph.yaml')
|
|
parsed_graph = config_tree_to_graph(tree)
|
|
self.assertItemsEqual(parsed_graph, graph)
|
|
|
|
# equivalence of a deeper tree to graph
|
|
def test_deep_tree(self):
|
|
tree = self.load_config_file('deep_tree.yaml')
|
|
graph = self.load_config_file('deep_graph.yaml')
|
|
parsed_graph = config_tree_to_graph(tree)
|
|
self.assertItemsEqual(parsed_graph, graph)
|
|
|
|
# equivalence of a complicated multi-partition tree to graph
|
|
def test_multipart_tree(self):
|
|
tree = self.load_config_file('multiple_partitions_tree.yaml')
|
|
graph = self.load_config_file('multiple_partitions_graph.yaml')
|
|
parsed_graph = config_tree_to_graph(tree)
|
|
logger.debug(parsed_graph)
|
|
self.assertItemsEqual(parsed_graph, graph)
|
|
|
|
|
|
class TestCreateGraph(TestGraphGeneration):
|
|
|
|
# Test a graph with bad edge pointing to an invalid node
|
|
def test_invalid_missing(self):
|
|
config = self.load_config_file('bad_edge_graph.yaml')
|
|
self.assertRaisesRegexp(BlockDeviceSetupException,
|
|
"Edge not defined: this_is_not_a_node",
|
|
create_graph,
|
|
config, self.fake_default_config)
|
|
|
|
# Test a graph with bad edge pointing to an invalid node
|
|
def test_duplicate_name(self):
|
|
config = self.load_config_file('duplicate_name.yaml')
|
|
self.assertRaisesRegexp(BlockDeviceSetupException,
|
|
"Duplicate node name: "
|
|
"this_is_a_duplicate",
|
|
create_graph,
|
|
config, self.fake_default_config)
|
|
|
|
# Test digraph generation from deep_graph config file
|
|
def test_deep_graph_generator(self):
|
|
config = self.load_config_file('deep_graph.yaml')
|
|
|
|
graph, call_order = create_graph(config, self.fake_default_config)
|
|
|
|
call_order_list = [n.name for n in call_order]
|
|
|
|
# manually created from deep_graph.yaml
|
|
# Note unlike below, the sort here is stable because the graph
|
|
# doesn't have multiple paths with only one partition
|
|
call_order_names = ['image0', 'root', 'mkfs_root',
|
|
'mount_mkfs_root',
|
|
'fstab_mount_mkfs_root']
|
|
|
|
self.assertListEqual(call_order_list, call_order_names)
|
|
|
|
# Test multiple parition digraph generation
|
|
def test_multiple_partitions_graph_generator(self):
|
|
config = self.load_config_file('multiple_partitions_graph.yaml')
|
|
|
|
graph, call_order = create_graph(config, self.fake_default_config)
|
|
call_order_list = [n.name for n in call_order]
|
|
|
|
# The sort creating call_order_list is unstable.
|
|
|
|
# We want to ensure we see the "partitions" object in
|
|
# root->var->var_log order
|
|
root_pos = call_order_list.index('root')
|
|
var_pos = call_order_list.index('var')
|
|
var_log_pos = call_order_list.index('var_log')
|
|
self.assertGreater(var_pos, root_pos)
|
|
self.assertGreater(var_log_pos, var_pos)
|
|
|
|
# Ensure mkfs happens after partition
|
|
mkfs_root_pos = call_order_list.index('mkfs_root')
|
|
self.assertLess(root_pos, mkfs_root_pos)
|
|
mkfs_var_pos = call_order_list.index('mkfs_var')
|
|
self.assertLess(var_pos, mkfs_var_pos)
|
|
mkfs_var_log_pos = call_order_list.index('mkfs_var_log')
|
|
self.assertLess(var_log_pos, mkfs_var_log_pos)
|