summaryrefslogtreecommitdiff
path: root/cmdtest
blob: d2c682eb965aa5f1a32878cd2db53c28277731fb (plain)
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
#!/usr/bin/python
# Copyright 2011  Lars Wirzenius
# 
# 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 <http://www.gnu.org/licenses/>.


import cliapp
import glob
import logging
import os
import shutil
import sys
import tempfile
import ttystatus
import unittest

import cmdtestlib


class TestFailure(Exception):

    def __init__(self, test, msg):
        self.msg = 'FAIL: %s: %s' % (test.name, msg)
        
    def __str__(self):
        return self.msg


class CommandTester(cliapp.Application):

    def add_settings(self):
        self.settings.string(['command', 'c'], 
                             'ignored for backwards compatibility')
        self.settings.string_list(['test', 't'],
                                  'run only TEST (can be given many times)',
                                  metavar='TEST')

    def process_args(self, dirnames):
        self.setup_ttystatus()

        td = self.load_tests(dirnames)
        self.ts['tests'] = td.tests

        errors = 0
        self.setup_tempdir()
        self.run_script('', td.setup_once)
        for test in td.tests:
            self.ts['test'] = test
            self.run_script(test.name, td.setup)
            for e in self.run_test(test):
                logging.error(str(e))
                self.ts.clear()
                self.output.write('%s\n' % str(e))
                errors += 1
            self.run_script(test.name, td.teardown)
        self.run_script('', td.teardown_once)
        self.cleanup_tempdir()
                
        ok = len(td.tests) - errors
        self.ts.finish()
        self.output.write('%d/%d tests OK, %d failures\n' % 
                            (ok, len(td.tests), errors))
        if errors:
            sys.exit(1)

    def setup_ttystatus(self):
        self.ts = ttystatus.TerminalStatus(period=0.001)
        self.ts.add(ttystatus.Literal('test '))
        self.ts.add(ttystatus.Index('test', 'tests'))
        
    def load_tests(self, dirnames):
        td = cmdtestlib.TestDir()
        for dirname in dirnames:
            if self.settings['test']:
                filenames = self.find_requested_tests(dirname)
                td.scan(dirname, filenames)
            else:
                td.scan(dirname)
        return td

    def find_requested_tests(self, dirname):
        filenames = []
        for test in self.settings['test']:
            matches = glob.glob(os.path.join(dirname, test + '.*'))
            filenames += [os.path.basename(x) for x in matches]
        return filenames

    def setup_tempdir(self):
        self.tempdir = tempfile.mkdtemp()
        logging.info('Temporary directory %s' % self.tempdir)
        self.datadir = os.path.join(self.tempdir, 'data')
        os.mkdir(self.datadir)
        
    def cleanup_tempdir(self):
        logging.info('Removing temporary directory %s' % self.tempdir)
        shutil.rmtree(self.tempdir)

    def run_script(self, test_name, script_name):
        if script_name:
            self.runcmd([script_name], env=self.add_to_env(test_name))

    def add_to_env(self, test_name):
        env = dict(os.environ)
        env['SRCDIR'] = os.getcwd()
        env['DATADIR'] = self.datadir
        env['TESTNAME'] = test_name
        return env

    def run_test(self, test):
        logging.info('Test case: %s' % test.name)

        self.run_script(test.name, test.setup)

        if test.script:
            argv = [test.script]
        else:
            raise cliapp.AppException('Must have a .script file for test')

        stdout_name = test.path_prefix + '.stdout-actual'
        stderr_name = test.path_prefix + '.stderr-actual'
        with open(stdout_name, 'wb') as stdout:
            with open(stderr_name, 'wb') as stderr:
                if test.stdin:
                    stdin = open(test.stdin, 'rb')
                else:
                    stdin = None
                env = self.add_to_env(test.name)
                exit, out, err = self.runcmd_unchecked(argv, 
                                                       env=env,
                                                       stdin=stdin,
                                                       stdout=stdout,
                                                       stderr=stderr)
                if stdin is not None:
                    stdin.close()

        self.run_script(test.name, test.teardown)

        errors = []

        stdout_diff_name = test.path_prefix + '.stdout-diff'
        stdout_diff = self.diff(test.stdout or '/dev/null', stdout_name,
                                stdout_diff_name)
        if stdout_diff:
            errors.append(TestFailure(test, 'stdout diff:\n%s' % stdout_diff))

        stderr_diff_name = test.path_prefix + '.stderr-diff'
        stderr_diff = self.diff(test.stderr or '/dev/null', stderr_name,
                                stderr_diff_name)
        if stderr_diff:
            errors.append(TestFailure(test, 'stderr diff:\n%s' % stderr_diff))

        expected_exit = int(self.cat(test.exit or '/dev/null').strip() or '0')
        if exit != expected_exit:
            errors.append(TestFailure(test, 
                                      'got exit code %s, expected %s' %
                                        (exit, expected_exit)))

        if not errors:
            os.remove(stdout_name)
            os.remove(stderr_name)
            os.remove(stdout_diff_name)
            os.remove(stderr_diff_name)
        
        return errors

    def cat(self, filename):
        if os.path.exists(filename):
            with open(filename) as f:
                return f.read()
        else:
            return ''

    def lines(self, filename):
        return self.cat(filename).splitlines()

    def expand(self, strings):
        variables = {
            'datadir': self.datadir,
        }
        return [s % variables for s in strings]

    def diff(self, expected_name, actual_name, diff_name):
        exit, out, err = self.runcmd_unchecked(['diff', '-u', 
                                                 expected_name, actual_name])
        self.write_file(diff_name, out)
        return out

    def write_file(self, filename, content):
        with open(filename, 'w') as f:
            f.write(content)


if __name__ == '__main__':
    CommandTester(version=cmdtestlib.__version__).run()