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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
import io
import sys
from unittest.mock import patch
import agate
from csvkit.utilities.csvclean import CSVClean, launch_new_instance
from tests.utils import CSVKitTestCase, EmptyFileTests, stdin_as_string
class TestCSVClean(CSVKitTestCase, EmptyFileTests):
Utility = CSVClean
default_args = ['--length-mismatch']
def assertCleaned(self, args, output_rows, error_rows=[]):
output_file = io.StringIO()
error_file = io.StringIO()
utility = CSVClean(args, output_file, error_file)
if error_rows:
with self.assertRaises(SystemExit) as e:
utility.run()
self.assertEqual(e.exception.code, 1)
else:
utility.run()
output_file.seek(0)
error_file.seek(0)
if output_rows:
reader = agate.csv.reader(output_file)
for row in output_rows:
self.assertEqual(next(reader), row)
self.assertRaises(StopIteration, next, reader)
if error_rows:
reader = agate.csv.reader(error_file)
for row in error_rows:
self.assertEqual(next(reader), row)
self.assertRaises(StopIteration, next, reader)
output_file.close()
error_file.close()
def test_launch_new_instance(self):
with patch.object(sys, 'argv', [self.Utility.__name__.lower()] + self.default_args + ['examples/dummy.csv']):
launch_new_instance()
def test_options(self):
for args, message in (
(
[],
'No checks or fixes were enabled. See available options with: csvclean --help',
),
(
['--join-short-rows', '--fill-short-rows'],
'The --join-short-rows and --fill-short-rows options are mutually exclusive.',
),
):
with self.subTest(args=args):
self.assertError(launch_new_instance, args, message)
def test_skip_lines(self):
self.assertCleaned(
['--length-mismatch', '--omit-error-rows', '--skip-lines', '3', 'examples/bad_skip_lines.csv'],
[
['column_a', 'column_b', 'column_c'],
['0', 'mixed types.... uh oh', '17'],
], [
['line_number', 'msg', 'column_a', 'column_b', 'column_c'],
['1', 'Expected 3 columns, found 4 columns', '1', '27', '', "I'm too long!"],
['2', 'Expected 3 columns, found 2 columns', '', "I'm too short!"],
],
)
def test_simple(self):
self.assertCleaned(['--length-mismatch', '--omit-error-rows', 'examples/bad.csv'], [
['column_a', 'column_b', 'column_c'],
['0', 'mixed types.... uh oh', '17'],
], [
['line_number', 'msg', 'column_a', 'column_b', 'column_c'],
['1', 'Expected 3 columns, found 4 columns', '1', '27', '', "I'm too long!"],
['2', 'Expected 3 columns, found 2 columns', '', "I'm too short!"],
])
def test_no_header_row(self):
self.assertCleaned(['--length-mismatch', 'examples/no_header_row.csv'], [
['1', '2', '3'],
])
def test_header_normalize_space(self):
self.assertCleaned(['--header-normalize-space', 'examples/test_header_newline.csv'], [
['start end', 'b', 'c'],
['d', 'e', 'f'],
])
def test_join_short_rows(self):
self.assertCleaned(['--omit-error-rows', '--join-short-rows', 'examples/test_join_short_rows.csv'], [
['a', 'b', 'c'],
['1', 'cat\ndog', 'c'],
['3', 'b', 'c'],
])
def test_join_short_rows_separator(self):
self.assertCleaned(
['--omit-error-rows', '--join-short-rows', '--separator', 'XYZ', 'examples/test_join_short_rows.csv'],
[
['a', 'b', 'c'],
['1', 'catXYZdog', 'c'],
['3', 'b', 'c'],
],
)
def test_fill_short_rows(self):
self.assertCleaned(['--fill-short-rows', 'examples/test_join_short_rows.csv'], [
['a', 'b', 'c'],
['1', 'cat', ''],
['dog', 'c', ''],
['3', 'b', 'c'],
])
def test_fill_short_rows_separator(self):
self.assertCleaned(['--fill-short-rows', '--fillvalue', 'XYZ', 'examples/test_join_short_rows.csv'], [
['a', 'b', 'c'],
['1', 'cat', 'XYZ'],
['dog', 'c', 'XYZ'],
['3', 'b', 'c'],
])
def test_empty_columns(self):
self.assertCleaned(['--empty-columns', 'examples/test_empty_columns.csv'], [
['a', 'b', 'c', '', ''],
['a', '', '', '', ''],
['', '', 'c', ''],
['', '', '', '', ''],
], [
['line_number', 'msg', 'a', 'b', 'c', '', ''],
['1', "Empty columns named 'b', '', ''! Try: csvcut -C 2,4,5", '', '', '', '', ''],
])
def test_empty_columns_short_row(self):
self.assertCleaned(['--empty-columns', 'examples/test_empty_columns_short_row.csv'], [
['a', 'b', 'c'],
['', ''],
], [
['line_number', 'msg', 'a', 'b', 'c'],
['1', "Empty columns named 'a', 'b', 'c'! Try: csvcut -C 1,2,3", '', '', ''],
])
def test_empty_columns_long_row(self):
self.assertCleaned(['--empty-columns', 'examples/test_empty_columns_long_row.csv'], [
['a', 'b', 'c'],
['', '', '', ''],
], [
['line_number', 'msg', 'a', 'b', 'c'],
['1', "Empty columns named 'a', 'b', 'c'! Try: csvcut -C 1,2,3", '', '', ''],
])
def test_empty_columns_zero(self):
self.assertCleaned(['--empty-columns', '--zero', 'examples/test_empty_columns.csv'], [
['a', 'b', 'c', '', ''],
['a', '', '', '', ''],
['', '', 'c', ''],
['', '', '', '', ''],
], [
['line_number', 'msg', 'a', 'b', 'c', '', ''],
['1', "Empty columns named 'b', '', ''! Try: csvcut -C 1,3,4", '', '', '', '', ''],
])
def test_enable_all_checks(self):
self.assertCleaned(['-a', 'examples/test_empty_columns.csv'], [
['a', 'b', 'c', '', ''],
['a', '', '', '', ''],
['', '', 'c', ''],
['', '', '', '', ''],
], [
['line_number', 'msg', 'a', 'b', 'c', '', ''],
['2', 'Expected 5 columns, found 4 columns', '', '', 'c', ''],
['1', "Empty columns named 'b', '', ''! Try: csvcut -C 2,4,5", '', '', '', '', ''],
])
def test_label(self):
self.assertCleaned(['-a', '--label', 'xyz', 'examples/test_empty_columns.csv'], [
['a', 'b', 'c', '', ''],
['a', '', '', '', ''],
['', '', 'c', ''],
['', '', '', '', ''],
], [
['label', 'line_number', 'msg', 'a', 'b', 'c', '', ''],
['xyz', '2', 'Expected 5 columns, found 4 columns', '', '', 'c', ''],
['xyz', '1', "Empty columns named 'b', '', ''! Try: csvcut -C 2,4,5", '', '', '', '', ''],
])
def test_label_default(self):
self.assertCleaned(['-a', '--label', '-', 'examples/test_empty_columns.csv'], [
['a', 'b', 'c', '', ''],
['a', '', '', '', ''],
['', '', 'c', ''],
['', '', '', '', ''],
], [
['label', 'line_number', 'msg', 'a', 'b', 'c', '', ''],
['examples/test_empty_columns.csv', '2', 'Expected 5 columns, found 4 columns', '', '', 'c', ''],
['examples/test_empty_columns.csv', '1', "Empty columns named 'b', '', ''! Try: csvcut -C 2,4,5", '', '', '', '', ''], # noqa: E501
])
def test_label_default_stdin(self):
input_file = io.BytesIO(b'a,b,c\n,\n')
with stdin_as_string(input_file):
self.assertCleaned(['-a', '--label', '-'], [
['a', 'b', 'c'],
['', ''],
], [
['label', 'line_number', 'msg', 'a', 'b', 'c'],
['stdin', '1', 'Expected 3 columns, found 2 columns', '', ''],
['stdin', '1', "Empty columns named 'a', 'b', 'c'! Try: csvcut -C 1,2,3", '', '', ''],
])
def test_removes_optional_quote_characters(self):
self.assertCleaned(['--length-mismatch', 'examples/optional_quote_characters.csv'], [
['a', 'b', 'c'],
['1', '2', '3'],
])
def test_changes_line_endings(self):
self.assertCleaned(['--length-mismatch', 'examples/mac_newlines.csv'], [
['a', 'b', 'c'],
['1', '2', '3'],
['Once upon\na time', '5', '6'],
])
def test_changes_character_encoding(self):
self.assertCleaned(['--length-mismatch', '-e', 'latin1', 'examples/test_latin1.csv'], [
['a', 'b', 'c'],
['1', '2', '3'],
['4', '5', u'©'],
])
def test_removes_bom(self):
self.assertCleaned(['--length-mismatch', 'examples/test_utf8_bom.csv'], [
['foo', 'bar', 'baz'],
['1', '2', '3'],
['4', '5', 'ʤ'],
])
|
