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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
"""
@copyright: 2012 Carsten Grohmann
@license: MIT (see license.txt) - THIS PROGRAM COMES WITH NO WARRANTY
"""
# import general python modules
import cStringIO
import difflib
import glob
import os.path
import unittest
# import project modules
import common
class WXGladeBaseTest(unittest.TestCase):
"""\
Provide basic functions for all tests
All test cases uses an own implementation to L{common.save_file()} to
catch the results. This behaviour is limitied to single file
creation.
"""
vFiles = {}
"""\
Dictionary to store the content of the files generated by the code
generators.
The filename is the key and the content is a StringIO instance.
"""
origSaveFile = None
"""\
Reference to the original I{save_file()} implementation
"""
caseDirectory = 'casefiles'
"""\
Directory with input files and result files
"""
def setUp(self):
"""\
Initialise parts of wxGlade only
"""
# don't import wxPython
common.use_gui = False
# use_gui has to be set before importing config
import config
config.init_preferences()
common.load_code_writers()
common.load_widgets()
common.load_sizers()
# don't add timestamps to the files to generate
config.preferences.write_timestamp = False
# initiate empty structure to store files and there content
self.vFiles = {}
# replace original save_file() by test specific implementation
self.origSaveFile = common.save_file
common.save_file = self.save_file
# set own version string to prevent diff mismatches
common.version = '"faked test version"'
# Determinate case directory
self.caseDirectory = os.path.join(
os.path.dirname(__file__),
self.caseDirectory,
)
def save_file(self, filename, content, which='wxg'):
"""\
Test specific implementation of L{common.save_file()} to get the
result of the code generation without file creation.
The file content is stored in a StringIO instance. It's
accessible at L{self.vFiles} using the filename as key.
@note: The signature is as same as L{wxglade.common.save_file()} but
the functionality differs.
@param filename: Name of the file to create
@param content: String to store into 'filename'
@param which: Kind of backup: 'wxg' or 'codegen'
"""
self.failIf(
filename in self.vFiles,
"Virtual file %s already exists" % filename
)
self.failUnless(
filename,
"No filename given",
)
outfile = cStringIO.StringIO()
outfile.write(content)
self.vFiles[filename] = outfile
def loadFile(self, casename, extension):
"""\
Load a file need by a test case.
@param casename: Name of the test case
@type casename: String
@param extension: File extension e.g. I{.wxg} or I{.py}
@type extension: String
@return: File content
@rtype: String
"""
if extension == '.wxg':
filetype = 'input'
else:
filetype = 'result'
file_list = glob.glob(
os.path.join(self.caseDirectory, "%s*%s" % (casename, extension))
)
self.failIf(
len(file_list) == 0,
'No %s file for case "%s" found!' % (filetype, casename)
)
self.failIf(
len(file_list) > 1,
'More than one %s file for case "%s" found!' % (filetype, casename)
)
fh = open(file_list[0])
content = fh.read()
fh.close()
# replacing path entries
content = content % {
'wxglade_path': common.wxglade_path,
'docs_path': common.docs_path,
'icons_path': common.icons_path,
'widgets_path': common.widgets_path,
'templates_path': common.templates_path,
'tutorial_file': common.tutorial_file,
}
return content
def diff(self, text1, text2):
"""\
Compare two lists, tailing spaces will be removed
@param text1: Expected text
@type text1: String
@param text2: Generated text
@type text2: String
@return: Changes formatted as unified diff
@rtype: String
"""
self.assertEqual(type(text1), type(""))
self.assertEqual(type(text2), type(""))
# split into lists, because difflib needs lists and remove
# tailing spaces
list1 = [x.rstrip() for x in text1.splitlines()]
list2 = [x.rstrip() for x in text2.splitlines()]
# compare source files
diff_gen = difflib.unified_diff(
list1,
list2,
fromfile='expected source',
tofile='created source',
lineterm=''
)
return '\n'.join(diff_gen)
def tearDown(self):
"""\
Cleanup
"""
# cleanup virtual files
for filename in self.vFiles:
self.vFiles[filename].close()
self.vFiles = {}
# restore original save_file() implementation
common.save_file = self.origSaveFile
|
