1ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh"""Tests for distutils.cmd."""
2ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehimport unittest
3ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehimport os
4ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehfrom test.test_support import captured_stdout, run_unittest
5ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
6ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehfrom distutils.cmd import Command
7ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehfrom distutils.dist import Distribution
8ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehfrom distutils.errors import DistutilsOptionError
9ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehfrom distutils import debug
10ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
11ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehclass MyCmd(Command):
12ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def initialize_options(self):
13ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        pass
14ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
15ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehclass CommandTestCase(unittest.TestCase):
16ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
17ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def setUp(self):
18ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        dist = Distribution()
19ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.cmd = MyCmd(dist)
20ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
21ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def test_ensure_string_list(self):
22ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
23ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd = self.cmd
24ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.not_string_list = ['one', 2, 'three']
25ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.yes_string_list = ['one', 'two', 'three']
26ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.not_string_list2 = object()
27ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.yes_string_list2 = 'ok'
28ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.ensure_string_list('yes_string_list')
29ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.ensure_string_list('yes_string_list2')
30ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
31ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertRaises(DistutilsOptionError,
32ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh                          cmd.ensure_string_list, 'not_string_list')
33ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
34ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertRaises(DistutilsOptionError,
35ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh                          cmd.ensure_string_list, 'not_string_list2')
36ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
37ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def test_make_file(self):
38ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
39ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd = self.cmd
40ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
41ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        # making sure it raises when infiles is not a string or a list/tuple
42ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertRaises(TypeError, cmd.make_file,
43ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh                          infiles=1, outfile='', func='func', args=())
44ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
45ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        # making sure execute gets called properly
46ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        def _execute(func, args, exec_msg, level):
47ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh            self.assertEqual(exec_msg, 'generating out from in')
48ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.force = True
49ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.execute = _execute
50ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.make_file(infiles='in', outfile='out', func='func', args=())
51ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
52ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def test_dump_options(self):
53ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
54ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        msgs = []
55ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        def _announce(msg, level):
56ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh            msgs.append(msg)
57ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd = self.cmd
58ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.announce = _announce
59ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option1 = 1
60ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option2 = 1
61ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.user_options = [('option1', '', ''), ('option2', '', '')]
62ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.dump_options()
63ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
64ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        wanted = ["command options for 'MyCmd':", '  option1 = 1',
65ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh                  '  option2 = 1']
66ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertEqual(msgs, wanted)
67ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
68ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def test_ensure_string(self):
69ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd = self.cmd
70ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option1 = 'ok'
71ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.ensure_string('option1')
72ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
73ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option2 = None
74ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.ensure_string('option2', 'xxx')
75ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertTrue(hasattr(cmd, 'option2'))
76ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
77ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option3 = 1
78ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertRaises(DistutilsOptionError, cmd.ensure_string, 'option3')
79ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
80ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def test_ensure_string_list(self):
81ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd = self.cmd
82ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option1 = 'ok,dok'
83ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.ensure_string_list('option1')
84ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertEqual(cmd.option1, ['ok', 'dok'])
85ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
86ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option2 = ['xxx', 'www']
87ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.ensure_string_list('option2')
88ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
89ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option3 = ['ok', 2]
90ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertRaises(DistutilsOptionError, cmd.ensure_string_list,
91ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh                          'option3')
92ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
93ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def test_ensure_filename(self):
94ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd = self.cmd
95ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option1 = __file__
96ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.ensure_filename('option1')
97ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option2 = 'xxx'
98ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertRaises(DistutilsOptionError, cmd.ensure_filename, 'option2')
99ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
100ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def test_ensure_dirname(self):
101ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd = self.cmd
102ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option1 = os.path.dirname(__file__) or os.curdir
103ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.ensure_dirname('option1')
104ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd.option2 = 'xxx'
105ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertRaises(DistutilsOptionError, cmd.ensure_dirname, 'option2')
106ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
107ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    def test_debug_print(self):
108ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        cmd = self.cmd
109ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        with captured_stdout() as stdout:
110ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh            cmd.debug_print('xxx')
111ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        stdout.seek(0)
112ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        self.assertEqual(stdout.read(), '')
113ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
114ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        debug.DEBUG = True
115ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        try:
116ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh            with captured_stdout() as stdout:
117ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh                cmd.debug_print('xxx')
118ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh            stdout.seek(0)
119ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh            self.assertEqual(stdout.read(), 'xxx\n')
120ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh        finally:
121ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh            debug.DEBUG = False
122ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
123ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehdef test_suite():
124ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    return unittest.makeSuite(CommandTestCase)
125ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh
126ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehif __name__ == '__main__':
127ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh    run_unittest(test_suite())
128