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
|
# Copyright 2015 IBM Corp.
#
# All Rights Reserved.
#
# 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 abc
import six
import testtools
import pypowervm.tests.test_fixtures as fx
from pypowervm.tests.test_utils import pvmhttp
@six.add_metaclass(abc.ABCMeta)
class TestWrapper(testtools.TestCase):
"""Superclass for wrapper test cases; provides loading of data files.
A single subclass tests a single wrapper class on a single file.
Usage:
- Subclass this class.
- Provide the name of the data file to load, e.g.
file = 'ssp.txt'
- Indicate the wrapper class to be tested, e.g.
wrapper_class_to_test = clust.SSP
- If your tests will make use of traits, you must provide
mock_adapter_fx_args, resulting in AdapterFx being constructed with those
args and used via useFixture. Your tests may access the adapter via
self.adpt and the fixture itself via self.adptfx.
- No __init__ or setUp is necessary.
- In your test cases, make use of the following variables:
- self.resp: The raw Response object from
load_pvm_resp().get_response(). May represent an entry or a feed.
- self.dwrap: A single instance of the wrapper_class_to_test extracted
from self.resp. If self.resp was a feed, this is the first entry.
- self.entries: The result of wrap(response) of the wrapper class.
May be a single wrapper instance, in which case it's (nearly*)
equivalent to self.dwrap, or a list of such wrappers.
* Note that wrap(response) injects each entry's etag into the
wrapper instance.
"""
# Load the response file just once
_pvmfile = None
@abc.abstractproperty
def file(self):
"""Data file name, relative to pypowervm/tests/wrappers/data/."""
return None
@abc.abstractproperty
def wrapper_class_to_test(self):
"""Indicates the type (Wrapper subclass) produced by self.dwrap."""
return None
# Arguments to test_fixtures.AdapterFx(), used to create a mock adapter.
# Must be represented as a dict. For example:
# mock_adapter_fx_args = {}
# or:
# mock_adapter_fx_args = dict(session=mock_session,
# traits=test_fixtures.LocalPVMTraits)
mock_adapter_fx_args = None
def setUp(self):
super(TestWrapper, self).setUp()
self.adptfx = None
self.adpt = None
adptfx_args = self.mock_adapter_fx_args or {}
self.adptfx = self.useFixture(fx.AdapterFx(**adptfx_args))
self.adpt = self.adptfx.adpt
# Load the file just once...
if self.__class__._pvmfile is None:
self.__class__._pvmfile = pvmhttp.PVMFile(self.file)
# ...but reconstruct the PVMResp every time
self.resp = pvmhttp.PVMResp(pvmfile=self.__class__._pvmfile,
adapter=self.adpt).get_response()
# Some wrappers don't support etag. Subclasses testing those wrappers
# should not be using self.entries, so ignore.
try:
self.entries = self.wrapper_class_to_test.wrap(self.resp)
except TypeError:
pass
if self.resp.feed:
self.dwrap = self.wrapper_class_to_test.wrap(
self.resp.feed.entries[0])
else:
self.dwrap = self.wrapper_class_to_test.wrap(self.resp.entry)
|
