moved to tools

Author: gaaclarke

tools/compare_goldens/README.md

@@ -0,0 +1,28 @@
+# Compare Goldens
+
+This is a script that will let you check golden image diffs locally.
+
+The directories are scanned for png files that match in name, then the diff
+is written to `diff_<name of file>` in the CWD. This allows you to get
+results quicker than having to upload to skia gold.  By default it uses fuzzy
+RMSE to compare.
+
+## Usage
+
+```sh
+dart run compare_goldens <dir path> <dir path>
+```
+
+Here's the steps for using this with something like impeller golden tests:
+
+1) Checkout a base revision
+2) Build impeller_golden_tests
+3) Execute `impeller_golden_tests --working_dir=\<path a\>
+4) Checkout test revision
+5) Build impeller_golden_tests
+6) Execute `impeller_golden_tests --working_dir=\<path b\>
+7) Execute `compare_goldens \<path a\> \<path b\>
+
+## Requirements
+
+- ImageMagick is installed on $PATH

tools/compare_goldens/bin/compare_goldens.dart

@@ -0,0 +1,9 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:compare_goldens/compare_goldens.dart' as compare_goldens;
+
+void main(List<String> args) {
+  compare_goldens.run(args);
+}

testing/compare_goldens.dart renamed to tools/compare_goldens/lib/compare_goldens.dart

@@ -2,36 +2,14 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-// #############################################################################
-// This is a script that will let you check golden image diffs locally.
-//
-// Usage: compare_goldens.dart <dir path> <dir path>
-//
-// The directories are scanned for png files that match in name, then the diff
-// is written to `diff_<name of file>` in the CWD. This allows you to get
-// results quicker than having to upload to skia gold.  By default it uses fuzzy
-// RMSE to compare.
-//
-// Here's the steps for using this with something like impeller golden tests:
-// 1) Checkout a base revision
-// 2) Build impeller_golden_tests
-// 3) Execute `impeller_golden_tests --working_dir=<path a>
-// 4) Checkout test revision
-// 5) Build impeller_golden_tests
-// 6) Execute `impeller_golden_tests --working_dir=<path b>
-// 7) Execute `compare_goldens.dart <path a> <path b>
-//
-// Requirements: ImageMagick is installed on $PATH
-// #############################################################################
-
 import 'dart:io';
 
-bool hasCommandOnPath(String name) {
+bool _hasCommandOnPath(String name) {
   final ProcessResult result = Process.runSync('which', <String>[name]);
   return result.exitCode == 0;
 }
 
-List<String> findPairs(Set<String> as, Set<String> bs) {
+List<String> _findPairs(Set<String> as, Set<String> bs) {
   final List<String> result  = <String>[];
   for (final String a in as) {
     if (bs.contains(a)) {
@@ -50,19 +28,19 @@ List<String> findPairs(Set<String> as, Set<String> bs) {
   return result;
 }
 
-String basename(String path) {
+String _basename(String path) {
   return path.split(Platform.pathSeparator).last;
 }
 
-Set<String> grabPngFilenames(Directory dir) {
+Set<String> _grabPngFilenames(Directory dir) {
   return dir.listSync()
-    .map((e) => basename(e.path))
+    .map((e) => _basename(e.path))
     .where((e) => e.endsWith('.png'))
     .toSet();
 }
 
-void main(List<String> args) {
-  if (!hasCommandOnPath('compare')) {
+void run(List<String> args) {
+  if (!_hasCommandOnPath('compare')) {
     throw Exception(r'Could not find `compare` from ImageMagick on $PATH.');
   }
   if (args.length != 2) {
@@ -78,9 +56,9 @@ void main(List<String> args) {
     throw Exception('Unable to find $dirB');
   }
 
-  final Set<String> filesA = grabPngFilenames(dirA);
-  final Set<String> filesB = grabPngFilenames(dirB);
-  final List<String> pairs = findPairs(filesA, filesB);
+  final Set<String> filesA = _grabPngFilenames(dirA);
+  final Set<String> filesB = _grabPngFilenames(dirB);
+  final List<String> pairs = _findPairs(filesA, filesB);
 
   int count = 0;
   for (final String name in pairs) {

tools/compare_goldens/pubspec.yaml

@@ -0,0 +1,3 @@
+name: compare_goldens
+environment:
+  sdk: '^3.0.0'

tools/compare_goldens/test/compare_goldens_test.dart

@@ -0,0 +1,5 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+void main() {}