Added imitation game benchmarks

packages/imitation_game/README.md

@@ -0,0 +1,93 @@
+# Imitation Game
+
+## Description
+
+`imitation_game` is a platform for performing automated tests to compare the
+performance of different UI frameworks.  For example, how much memory does the
+same app written in Flutter and UIKit take?
+
+## Running all the tests
+
+You need a mobile device plugged into your computer and setup for development.
+The mobile device and the computer need to be on the same network, one that
+allows communication between computers since that's how the mobile phone will
+report its results to the computer.
+
+```sh
+dart imitation_game.dart
+```
+
+## Dependencies
+
+In order to run the tests you will need the union of all the platforms being
+tested.  As new tests are added please add to this list:
+
+### iOS
+
+- Flutter
+- Xcode
+- [ios_deploy](https://github.com/ios-control/ios-deploy) - used to launch apps
+  on the attached iOS device.
+
+## Example File Layout
+
+```text
+./
+├─ imitation_game.dart
+└─ tests/
+   ├─ smiley/
+   │  ├─ README.md
+   │  ├─ flutter/
+   │  │  ├─ run_ios.sh
+   │  │  └─ <flutter project files>
+   │  └─ uikit/
+   │     ├─ run_ios.sh
+   │     └─ <uikit project files>
+   └─ memory/
+      ├─ README.md
+      ├─ flutter/
+      │  ├─ run_ios.sh
+      │  └─ <flutter project files>
+      └─ uikit/
+         ├─ run_ios.sh
+         └─ <uikit project files>
+```
+
+Here there are 2 different tests with 2 different platform implementations.  The
+tests are named `smiley` and `memory`, they are both implemented on the
+platforms `flutter` and `uikit`.
+
+### Adding a test
+
+Tests should comprise of implementations on one or more platform.  The directory
+for the test should be added to `./tests`.  Inside that directory there should
+be a directory of implementations and a `README.md` file that explains the test.
+
+### Adding an implementation to a test
+
+An implementation has to follow these rules:
+
+- It needs to perform the same operations as the other implementations and
+  follow the description in the test's `README.md`.
+- It needs to contain a `run_ios.sh` script that will build and launch the test
+  on the connected device.
+- It should contain a file named `ip.txt` which will be overwritten by
+  `imitation_game.dart` with the ip address and port that should be used to
+  report results to.
+- It needs to report its results to the ip and port in the `ip.txt` via an HTTP
+  POST of JSON data.
+
+## Data format for results
+
+```json
+{
+  "test": "name_of_test",
+  "platform": "name_of_platform",
+  "results": {
+    "some_result_name": 1.23,
+    "some_result_name2": 4.56,
+  }
+}
+```
+
+A single test run can report multiple numbers.

packages/imitation_game/imitation_game.dart

@@ -0,0 +1,170 @@
+import 'dart:async';
+import 'dart:convert';
+import 'dart:io';
+
+const int _port = 4040;
+
+Future<String> _findIpAddress() async {
+  String result;
+  final List<NetworkInterface> interfaces = await NetworkInterface.list();
+  for (NetworkInterface interface in interfaces) {
+    for (InternetAddress address in interface.addresses) {
+      if (address.type == InternetAddressType.IPv4) {
+        // TODO(gaaclarke): Implment having multiple addresses.
+        assert(result == null);
+        result = address.address;
+      }
+    }
+  }
+  return result;
+}
+
+typedef FileFilter = bool Function(FileSystemEntity);
+Future<List<FileSystemEntity>> findFiles(Directory dir, {FileFilter where}) {
+  final List<FileSystemEntity> files = <FileSystemEntity>[];
+  final Completer<List<FileSystemEntity>> completer =
+      Completer<List<FileSystemEntity>>();
+  final Stream<FileSystemEntity> lister = dir.list(recursive: true);
+  lister.listen((FileSystemEntity file) {
+    if (where == null || where(file)) {
+      files.add(file);
+    }
+  }, onDone: () => completer.complete(files));
+  return completer.future;
+}
+
+class _Script {
+  _Script({this.path});
+  String path;
+}
+
+class _ScriptRunner {
+  _ScriptRunner(this._scriptPaths);
+
+  final List<String> _scriptPaths;
+  Process _currentProcess;
+  StreamSubscription<String> _stdoutSubscription;
+  StreamSubscription<String> _stderrSubscription;
+
+  Future<_Script> runNext() async {
+    if (_currentProcess != null) {
+      _stdoutSubscription.cancel();
+      _stderrSubscription.cancel();
+      _currentProcess.kill();
+      _currentProcess = null;
+    }
+
+    if (_scriptPaths.isEmpty) {
+      return null;
+    } else {
+      final String path = _scriptPaths.last;
+      print('running: $path');
+      _scriptPaths.removeLast();
+      _currentProcess = await Process.start('sh', <String>[path]);
+      // TODO(gaaclarke): Implement a timeout.
+      _stdoutSubscription =
+          _currentProcess.stdout.transform(utf8.decoder).listen((String data) {
+        print(data);
+      });
+      _stderrSubscription =
+          _currentProcess.stderr.transform(utf8.decoder).listen((String data) {
+        print(data);
+      });
+      return _Script(path: path);
+    }
+  }
+}
+
+class _ImitationGame {
+  final Map<String, dynamic> results = <String, dynamic>{};
+  _ScriptRunner _scriptRunner;
+  _Script _currentScript;
+
+  Future<bool> start(List<String> iosScripts) {
+    _scriptRunner = _ScriptRunner(iosScripts);
+    return _runNext();
+  }
+
+  Future<bool> handleResult(Map<String, dynamic> data) {
+    final String test = data['test'];
+    final String platform = data['platform'];
+    if (!results.containsKey(test)) {
+      results[test] = <String, dynamic>{};
+    }
+    if (!results[test].containsKey(platform)) {
+      results[test][platform] = <String, dynamic>{};
+    }
+    data['results'].forEach((String k, dynamic v) {
+      results[test][platform][k] = v as double;
+    });
+    return _runNext();
+  }
+
+  Future<bool> handleTimeout() {
+    return _runNext();
+  }
+
+  Future<bool> _runNext() async {
+    _currentScript = await _scriptRunner.runNext();
+    return _currentScript != null;
+  }
+}
+
+Future<void> main() async {
+  final HttpServer server = await HttpServer.bind(
+    InternetAddress.anyIPv4,
+    _port,
+  );
+  final String ipaddress = await _findIpAddress();
+  print('Listening on $ipaddress:${server.port}');
+
+  for (FileSystemEntity entity in await findFiles(Directory.current,
+      where: (FileSystemEntity f) => f.path.endsWith('ip.txt'))) {
+    final File file = File(entity.path);
+    file.writeAsStringSync('$ipaddress:${server.port}');
+  }
+
+  final List<String> iosScripts = (await findFiles(Directory.current,
+          where: (FileSystemEntity f) => f.path.endsWith('run_ios.sh')))
+      .map((FileSystemEntity e) => e.path)
+      .toList();
+
+  if (iosScripts.isEmpty) {
+    return;
+  }
+
+  final _ImitationGame game = _ImitationGame();
+  bool keepRunning = await game.start(iosScripts);
+
+  while (keepRunning) {
+    try {
+      final Stream<HttpRequest> timeoutServer = server.timeout(
+          const Duration(minutes: 5), onTimeout: (EventSink<HttpRequest> sink) {
+        print('TIMEOUT!');
+        throw TimeoutException('timeout');
+      });
+      await for (HttpRequest request in timeoutServer) {
+        print('got request: ${request.method}');
+        if (request.method == 'POST') {
+          final String content = await utf8.decoder.bind(request).join();
+          final Map<String, dynamic> data =
+              jsonDecode(content) as Map<String, dynamic>;
+          print('$data');
+          keepRunning = await game.handleResult(data);
+          if (!keepRunning) {
+            break;
+          }
+        } else {
+          request.response.write('use post');
+        }
+        await request.response.close();
+      }
+    } on TimeoutException catch (_) {
+      keepRunning = await game.handleTimeout();
+    }
+  }
+  const JsonEncoder encoder = JsonEncoder.withIndent('  ');
+  final String jsonResults = encoder.convert(game.results);
+  print('$jsonResults');
+  await server.close(force: true);
+}

packages/imitation_game/tests/smiley/README.md

@@ -0,0 +1,11 @@
+# Smiley
+
+This test is an app that just draws one large image to the screen `smiley.png`,
+stretched to fit inside the screen.
+
+The following things are measured:
+
+- 'startupTime' - The time between the start of the process and the rendering of
+  the image to the screen.
+- 'memory' - The amount of system memory the app is using after having rendered
+  the image to the screen.

packages/imitation_game/tests/smiley/flutter/run_ios.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+cd $( dirname "${BASH_SOURCE[0]}" )
+cd smiley
+flutter run --release

packages/imitation_game/tests/smiley/flutter/smiley/.gitignore

@@ -0,0 +1,44 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Exceptions to above rules.
+!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages

packages/imitation_game/tests/smiley/flutter/smiley/.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: 227990ab308574184e06944710bae000330412d0
+  channel: unknown
+
+project_type: app

packages/imitation_game/tests/smiley/flutter/smiley/README.md

@@ -0,0 +1,16 @@
+# smiley
+
+A new Flutter project.
+
+## Getting Started
+
+This project is a starting point for a Flutter application.
+
+A few resources to get you started if this is your first Flutter project:
+
+- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
+- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
+
+For help getting started with Flutter, view our
+[online documentation](https://flutter.dev/docs), which offers tutorials,
+samples, guidance on mobile development, and a full API reference.

packages/imitation_game/tests/smiley/flutter/smiley/android/.gitignore

@@ -0,0 +1,11 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties