junov@chromium.org | 777442d | 2012-06-12 14:56:36 +0000 | [diff] [blame] | 1 | ''' |
| 2 | Compares the rendererings of serialized SkPictures to expected images. |
| 3 | |
| 4 | Launch with --help to see more information. |
| 5 | |
| 6 | |
| 7 | Copyright 2012 Google Inc. |
| 8 | |
| 9 | Use of this source code is governed by a BSD-style license that can be |
| 10 | found in the LICENSE file. |
| 11 | ''' |
| 12 | # common Python modules |
| 13 | import os |
| 14 | import optparse |
| 15 | import sys |
| 16 | import shutil |
| 17 | import tempfile |
| 18 | |
keyar@chromium.org | d1dc920 | 2012-07-09 18:32:08 +0000 | [diff] [blame] | 19 | USAGE_STRING = 'Usage: %s input... expectedDir' |
junov@chromium.org | 777442d | 2012-06-12 14:56:36 +0000 | [diff] [blame] | 20 | HELP_STRING = ''' |
| 21 | |
keyar@chromium.org | d1dc920 | 2012-07-09 18:32:08 +0000 | [diff] [blame] | 22 | Compares the renderings of serialized SkPicture files and directories specified |
| 23 | by input with the images in expectedDir. Note, files in directoriers are |
| 24 | expected to end with .skp. |
junov@chromium.org | 777442d | 2012-06-12 14:56:36 +0000 | [diff] [blame] | 25 | ''' |
| 26 | |
| 27 | def RunCommand(command): |
| 28 | """Run a command. |
| 29 | |
| 30 | @param command the command as a single string |
| 31 | """ |
| 32 | print 'running command [%s]...' % command |
| 33 | os.system(command) |
| 34 | |
| 35 | |
| 36 | def FindPathToProgram(program): |
| 37 | """Return path to an existing program binary, or raise an exception if we |
| 38 | cannot find one. |
| 39 | |
| 40 | @param program the name of the program that is being looked for |
| 41 | """ |
| 42 | trunk_path = os.path.abspath(os.path.join(os.path.dirname(__file__), |
| 43 | os.pardir)) |
| 44 | possible_paths = [os.path.join(trunk_path, 'out', 'Release', program), |
| 45 | os.path.join(trunk_path, 'out', 'Debug', program)] |
| 46 | for try_path in possible_paths: |
| 47 | if os.path.isfile(try_path): |
| 48 | return try_path |
| 49 | raise Exception('cannot find %s in paths %s; maybe you need to ' |
| 50 | 'build %s?' % (program, possible_paths, program)) |
| 51 | |
| 52 | |
keyar@chromium.org | d1dc920 | 2012-07-09 18:32:08 +0000 | [diff] [blame] | 53 | def RenderImages(inputs, render_dir): |
junov@chromium.org | 777442d | 2012-06-12 14:56:36 +0000 | [diff] [blame] | 54 | """Renders the serialized SkPictures. |
| 55 | |
| 56 | Uses the render_pictures program to do the rendering. |
| 57 | |
keyar@chromium.org | d1dc920 | 2012-07-09 18:32:08 +0000 | [diff] [blame] | 58 | @param inputs the location(s) to read the serlialized SkPictures |
junov@chromium.org | 777442d | 2012-06-12 14:56:36 +0000 | [diff] [blame] | 59 | @param render_dir the location to write out the rendered images |
| 60 | """ |
| 61 | renderer_path = FindPathToProgram('render_pictures') |
keyar@chromium.org | d1dc920 | 2012-07-09 18:32:08 +0000 | [diff] [blame] | 62 | inputs_as_string = " ".join(inputs) |
| 63 | RunCommand('%s %s %s' % (renderer_path, inputs_as_string, render_dir)) |
junov@chromium.org | 777442d | 2012-06-12 14:56:36 +0000 | [diff] [blame] | 64 | |
| 65 | |
| 66 | def DiffImages(expected_dir, comparison_dir, diff_dir): |
| 67 | """Diffs the rendered SkPicture images with the baseline images. |
| 68 | |
| 69 | Uses the skdiff program to do the diffing. |
| 70 | |
| 71 | @param expected_dir the location of the baseline images. |
| 72 | @param comparison_dir the location of the images to comapre with the |
| 73 | baseline |
| 74 | @param diff_dir the location to write out the diff results |
| 75 | """ |
| 76 | skdiff_path = FindPathToProgram('skdiff') |
keyar@chromium.org | a631819 | 2012-07-09 21:01:50 +0000 | [diff] [blame] | 77 | RunCommand('%s %s %s %s %s' % |
| 78 | (skdiff_path, expected_dir, comparison_dir, diff_dir, |
| 79 | '--noprintdirs')) |
junov@chromium.org | 777442d | 2012-06-12 14:56:36 +0000 | [diff] [blame] | 80 | |
| 81 | |
| 82 | def Cleanup(options, render_dir, diff_dir): |
| 83 | """Deletes any temporary folders and files created. |
| 84 | |
| 85 | @param options The OptionParser object that parsed if render_dir or diff_dir |
| 86 | was set |
| 87 | @param render_dir the directory where the rendered images were written |
| 88 | @param diff_dir the directory where the diff results were written |
| 89 | """ |
| 90 | if (not options.render_dir): |
| 91 | if (os.path.isdir(render_dir)): |
| 92 | shutil.rmtree(render_dir) |
| 93 | if (not options.diff_dir): |
| 94 | if (os.path.isdir(diff_dir)): |
| 95 | shutil.rmtree(diff_dir) |
| 96 | |
| 97 | |
| 98 | def Main(args): |
| 99 | """Allow other scripts to call this script with fake command-line args. |
| 100 | |
| 101 | @param The commandline argument list |
| 102 | """ |
| 103 | parser = optparse.OptionParser(USAGE_STRING % '%prog' + HELP_STRING) |
| 104 | parser.add_option('--render_dir', dest='render_dir', |
| 105 | help = ("specify the location to output the rendered files." |
| 106 | " Default is a temp directory.")) |
| 107 | parser.add_option('--diff_dir', dest='diff_dir', |
| 108 | help = ("specify the location to output the diff files." |
| 109 | " Default is a temp directory.")) |
| 110 | |
| 111 | options, arguments = parser.parse_args(args) |
| 112 | |
keyar@chromium.org | d1dc920 | 2012-07-09 18:32:08 +0000 | [diff] [blame] | 113 | if (len(arguments) < 3): |
| 114 | print("Expected at least one input and one ouput folder.") |
| 115 | parser.print_help() |
| 116 | sys.exit(-1) |
| 117 | |
| 118 | inputs = arguments[1:-1] |
| 119 | expected_dir = arguments[-1] |
junov@chromium.org | 777442d | 2012-06-12 14:56:36 +0000 | [diff] [blame] | 120 | |
| 121 | if (options.render_dir): |
| 122 | render_dir = options.render_dir |
| 123 | else: |
| 124 | render_dir = tempfile.mkdtemp() |
| 125 | |
| 126 | if (options.diff_dir): |
| 127 | diff_dir = options.diff_dir |
| 128 | else: |
| 129 | diff_dir = tempfile.mkdtemp() |
| 130 | |
| 131 | try: |
keyar@chromium.org | d1dc920 | 2012-07-09 18:32:08 +0000 | [diff] [blame] | 132 | RenderImages(inputs, render_dir) |
junov@chromium.org | 777442d | 2012-06-12 14:56:36 +0000 | [diff] [blame] | 133 | DiffImages(expected_dir, render_dir, diff_dir) |
| 134 | finally: |
| 135 | Cleanup(options, render_dir, diff_dir) |
| 136 | |
| 137 | if __name__ == '__main__': |
| 138 | Main(sys.argv) |