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
|
# encoding=utf-8
# Copyright © 2017 Dylan Baker
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
"""Tests for alot.utils.argparse"""
import argparse
import contextlib
import os
import shutil
import tempfile
import unittest
from unittest import mock
from alot.utils import argparse as cargparse
# Good descriptive test names often don't fit PEP8, which is meant to cover
# functions meant to be called by humans.
# pylint: disable=invalid-name
# When using mock asserts its possible that many methods will not use self,
# that's fine
# pylint: disable=no-self-use
class TestValidatedStore(unittest.TestCase):
"""Tests for the ValidatedStore action class."""
def _argparse(self, args):
"""Create an argparse instance with a validator."""
def validator(args):
if args == 'fail':
raise cargparse.ValidationFailed
parser = argparse.ArgumentParser()
parser.add_argument(
'foo',
action=cargparse.ValidatedStoreAction,
validator=validator)
with mock.patch('sys.stderr', mock.Mock()):
return parser.parse_args(args)
def test_validates(self):
# Arparse will raise a SystemExit (calls sys.exit) rather than letting
# the exception cause the program to close.
with self.assertRaises(SystemExit):
self._argparse(['fail'])
@contextlib.contextmanager
def temporary_directory(suffix='', prefix='', dir=None): # pylint: disable=redefined-builtin
"""Python3 interface implementation.
Python3 provides a class that can be used as a context manager, which
creates a temporary directory and removes it when the context manager
exits. This function emulates enough of the interface of
TemporaryDirectory, for this module to use, and is designed as a drop in
replacement that can be replaced after the python3 port.
The only user visible difference is that this does not implement the
cleanup method that TemporaryDirectory does.
"""
directory = tempfile.mkdtemp(suffix=suffix, prefix=prefix, dir=dir)
yield directory
shutil.rmtree(directory)
class TestRequireFile(unittest.TestCase):
"""Tests for the require_file validator."""
def test_doesnt_exist(self):
with temporary_directory() as d:
with self.assertRaises(cargparse.ValidationFailed):
cargparse.require_file(os.path.join(d, 'doesnt-exist'))
def test_dir(self):
with temporary_directory() as d:
with self.assertRaises(cargparse.ValidationFailed):
cargparse.require_file(d)
def test_file(self):
with tempfile.NamedTemporaryFile() as f:
cargparse.require_file(f.name)
def test_char_special(self):
with self.assertRaises(cargparse.ValidationFailed):
cargparse.require_file('/dev/null')
def test_fifo(self):
with temporary_directory() as d:
path = os.path.join(d, 'fifo')
os.mkfifo(path)
with self.assertRaises(cargparse.ValidationFailed):
cargparse.require_file(path)
class TestRequireDir(unittest.TestCase):
"""Tests for the require_dir validator."""
def test_doesnt_exist(self):
with temporary_directory() as d:
with self.assertRaises(cargparse.ValidationFailed):
cargparse.require_dir(os.path.join(d, 'doesnt-exist'))
def test_dir(self):
with temporary_directory() as d:
cargparse.require_dir(d)
def test_file(self):
with tempfile.NamedTemporaryFile() as f:
with self.assertRaises(cargparse.ValidationFailed):
cargparse.require_dir(f.name)
def test_char_special(self):
with self.assertRaises(cargparse.ValidationFailed):
cargparse.require_dir('/dev/null')
def test_fifo(self):
with temporary_directory() as d:
path = os.path.join(d, 'fifo')
os.mkfifo(path)
with self.assertRaises(cargparse.ValidationFailed):
cargparse.require_dir(path)
class TestOptionalFileLike(unittest.TestCase):
"""Tests for the optional_file_like validator."""
def test_doesnt_exist(self):
with temporary_directory() as d:
cargparse.optional_file_like(os.path.join(d, 'doesnt-exist'))
def test_dir(self):
with temporary_directory() as d:
with self.assertRaises(cargparse.ValidationFailed):
cargparse.optional_file_like(d)
def test_file(self):
with tempfile.NamedTemporaryFile() as f:
cargparse.optional_file_like(f.name)
def test_char_special(self):
cargparse.optional_file_like('/dev/null')
def test_fifo(self):
with temporary_directory() as d:
path = os.path.join(d, 'fifo')
os.mkfifo(path)
cargparse.optional_file_like(path)
class TestIntOrPlusOrMinus(unittest.TestCase):
"""Tests for the is_int_or_pm validator."""
def test_int(self):
self.assertTrue(cargparse.is_int_or_pm('5'))
def test_pm(self):
self.assertTrue(cargparse.is_int_or_pm('+'))
self.assertTrue(cargparse.is_int_or_pm('-'))
def test_rubbish(self):
with self.assertRaises(cargparse.ValidationFailed):
cargparse.is_int_or_pm('XX')
|
