]> git.cworth.org Git - apitrace-tests/blob - cli_driver.py
Add some comments to the recently-added cli tests.
[apitrace-tests] / cli_driver.py
1 #!/usr/bin/env python
2
3 # Copyright 2012 Intel Corporation
4 #
5 # Permission is hereby granted, free of charge, to any person
6 # obtaining a copy of this software and associated documentation files
7 # (the "Software"), to deal in the Software without restriction,
8 # including without limitation the rights to use, copy, modify, merge,
9 # publish, distribute, sublicense, and/or sell copies of the Software,
10 # and to permit persons to whom the Software is furnished to do so,
11 # subject to the following conditions:
12 #
13 # The above copyright notice and this permission notice shall be
14 # included in all copies or substantial portions of the Software.
15 #
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20 # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 # SOFTWARE.
24
25 '''Test driver for scripts in the cli directory.'''
26
27 import json, errno, shutil, subprocess
28
29 from base_driver import *
30
31 class CliDriver(Driver):
32
33     def do_apitrace(self, args):
34         cmd = [self.options.apitrace] + args[1:]
35  
36         proc = subprocess.Popen(cmd, stdout = subprocess.PIPE)
37         self.output = proc.communicate()[0]
38
39         proc.wait()
40
41         if (self.expect_failure):
42             if (proc.returncode == 0):
43                 fail("Command unexpectedly passed when expecting failure:\n    " + " ".join(cmd))
44         else:
45             if (proc.returncode != 0):
46                 fail("Command failed (returned non-zero):\n    " + " ".join(cmd))
47
48     def do_expect(self, args):
49         expected = json.loads(" ".join(args[1:]))
50         if (self.output != expected):
51             fail("Unexpected output:\n    Expected: %s\n    Received: %s\n" % (expected, self.output))
52
53     def do_rm_and_mkdir(self, args):
54
55         # Operate only on local directories
56         dir = './' + args[1]
57
58         # Failing to delete a directory that doesn't exist is no failure
59         def rmtree_onerror(function, path, excinfo):
60             if excinfo[0] == OSError and excinfo[1].errno != errno.ENOENT:
61                 raise
62
63         shutil.rmtree(dir, onerror = rmtree_onerror)
64         os.makedirs(dir)
65
66     def unknown_command(self, args):
67         fail('Broken test script: Unknown command: %s' % (args[0]))
68
69     def run_script(self, cli_script):
70         "Execute the commands in the given cli script."
71
72         commands = {
73             'apitrace': self.do_apitrace,
74             'expect': self.do_expect,
75             'rm_and_mkdir': self.do_rm_and_mkdir
76         }
77
78         script = open(cli_script, 'rt')
79
80         while True:
81
82             self.expect_failure = False
83
84             line = script.readline()
85
86             # Exit loop on EOF
87             if (line == ''):
88                 break
89
90             cmd = line.split()
91
92             # Ignore blank lines and comments
93             if (len(cmd) == 0 or line[0] == '#'):
94                 continue
95
96             if (cmd[0] == 'EXPECT_FAILURE:'):
97                 self.expect_failure = True
98                 cmd.pop(0)
99
100             commands.get(cmd[0], self.unknown_command)(cmd)
101
102     def run(self):
103         self.parseOptions()
104
105         self.run_script(self.args[0])
106
107         pass_()
108
109 if __name__ == '__main__':
110     CliDriver().run()