Start of linting Android embedding (#8023)

* Add a tool for running Android SDK lint on Android embedding

shell/platform/android/AndroidManifest.xml

@@ -5,7 +5,7 @@
  -->
 <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="io.flutter.app" android:versionCode="1" android:versionName="0.0.1">
 
-    <uses-sdk android:minSdkVersion="14" android:targetSdkVersion="21" />
+    <uses-sdk android:minSdkVersion="16" android:targetSdkVersion="21" />
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
     <uses-feature android:name="android.hardware.sensor.accelerometer" android:required="true" />

tools/android_lint/.gitignore

+lint_report/

tools/android_lint/bin/main.dart

+// 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 'dart:io';
+
+import 'package:args/args.dart';
+import 'package:path/path.dart' as path;
+import 'package:process/process.dart';
+
+const LocalProcessManager processManager = LocalProcessManager();
+
+/// Runs the Android SDK Lint tool on flutter/shell/platform/android.
+///
+/// This script scans the flutter/shell/platform/android directory for Java
+/// files to build a `project.xml` file.  This file is then passed to the lint
+/// tool and HTML output is reqeusted in the directory for the `--out`
+/// parameter, which defaults to `lint_report`.
+///
+/// The `--in` parameter may be specified to force this script to scan a
+/// specific location for the engine repository, and expects to be given the
+/// `src` directory that contains both `third_party` and `flutter`.
+///
+/// At the time of this writing, the Android Lint tool doesn't work well with
+/// Java > 1.8.  This script will print a warning if you are not running
+/// Java 1.8.
+Future<void> main(List<String> args) async {
+  final ArgParser argParser = setupOptions();
+  await checkJava1_8();
+  final int exitCode = await runLint(argParser, argParser.parse(args));
+  exit(exitCode);
+}
+
+Future<int> runLint(ArgParser argParser, ArgResults argResults) async {
+  final Directory androidDir = Directory(path.join(
+    argResults['in'],
+    'flutter',
+    'shell',
+    'platform',
+    'android',
+  ));
+  if (!androidDir.existsSync()) {
+    print('This command must be run from the engine/src directory, '
+        'or be passed that directory as the --in parameter.\n');
+    print(argParser.usage);
+    return -1;
+  }
+
+  final Directory androidSdkDir = Directory(
+    path.join(argResults['in'], 'third_party', 'android_tools', 'sdk'),
+  );
+
+  if (!androidSdkDir.existsSync()) {
+    print('The Android SDK for this engine is missing from the '
+        'third_party/android_tools directory. Have you run gclient sync?\n');
+    print(argParser.usage);
+    return -1;
+  }
+
+  final IOSink projectXml = File('./project.xml').openWrite();
+  projectXml.write(
+      '''<!-- THIS FILE IS GENERATED. PLEASE USE THE INCLUDED DART PROGRAM  WHICH -->
+<!-- WILL AUTOMATICALLY FIND ALL .java FILES AND INCLUDE THEM HERE       -->
+<project>
+  <sdk dir="${androidSdkDir.path}" />
+  <module name="FlutterEngine" android="true" library="true" compile-sdk-version="android-P">
+  <manifest file="${path.join(androidDir.path, 'AndroidManifest.xml')}" />
+''');
+  for (final FileSystemEntity entity in androidDir.listSync(recursive: true)) {
+    if (!entity.path.endsWith('.java')) {
+      continue;
+    }
+    projectXml.writeln('    <src file="${entity.path}" />');
+  }
+
+  projectXml.write('''  </module>
+</project>
+''');
+  await projectXml.close();
+
+  print('Wrote project.xml, starting lint...');
+  final ProcessResult result = await processManager.run(
+    <String>[
+      path.join(androidSdkDir.path, 'tools', 'bin', 'lint'),
+      '--project',
+      './project.xml',
+      '--html',
+      argResults['out'],
+      '--showall',
+      '--exitcode', // Set non-zero exit code on errors
+      '-Wall',
+      '-Werror',
+    ],
+  );
+  if (result.stderr != null) {
+    print('Lint tool had internal errors:');
+    print(result.stderr);
+  }
+  print(result.stdout);
+  return result.exitCode;
+}
+
+ArgParser setupOptions() {
+  final ArgParser argParser = ArgParser();
+  argParser.addOption(
+    'in',
+    help: 'The path to `engine/src`.',
+    defaultsTo: path.relative(
+      path.join(
+        path.dirname(
+          path.dirname(path.dirname(path.fromUri(Platform.script))),
+        ),
+        '..',
+        '..',
+      ),
+    ),
+  );
+  argParser.addOption(
+    'out',
+    help: 'The path to write the generated the HTML report to.',
+    defaultsTo: 'lint_report',
+  );
+  argParser.addFlag(
+    'help',
+    help: 'Print usage of the command.',
+    negatable: false,
+    defaultsTo: false,
+  );
+
+  return argParser;
+}
+
+Future<void> checkJava1_8() async {
+  print('Checking Java version...');
+  final ProcessResult javaResult = await processManager.run(
+    <String>['java', '-version'],
+  );
+  if (javaResult.exitCode != 0) {
+    print('Could not run "java -version". '
+        'Ensure Java is installed and available on your path.');
+    print(javaResult.stderr);
+  }
+  final String javaVersionStdout = javaResult.stdout;
+  if (javaVersionStdout.contains('"1.8')) {
+    print('The Android SDK tools may not work properly with your Java version. '
+        'If this process fails, please retry using Java 1.8.');
+  }
+}

tools/android_lint/project.xml

+<!-- THIS FILE IS GENERATED. PLEASE USE THE INCLUDED DART PROGRAM  WHICH -->
+<!-- WILL AUTOMATICALLY FIND ALL .java FILES AND INCLUDE THEM HERE       -->
+<project>
+  <sdk dir="../../../third_party/android_tools/sdk" />
+  <module name="FlutterEngine" android="true" library="true" compile-sdk-version="android-P">
+  <manifest file="../../../flutter/shell/platform/android/AndroidManifest.xml" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/app/FlutterPluginRegistry.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/app/FlutterFragmentActivity.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/app/FlutterActivity.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/app/FlutterActivityEvents.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/app/FlutterApplication.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/app/FlutterActivityDelegate.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/util/Preconditions.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/util/Predicate.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/util/PathUtils.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/renderer/FlutterRenderer.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/renderer/OnFirstFrameRenderedListener.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/dart/DartExecutor.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/dart/PlatformMessageHandler.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/dart/DartMessenger.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/FlutterShellArgs.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/FlutterJNI.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/systemchannels/SettingsChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/systemchannels/NavigationChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/systemchannels/LocalizationChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/systemchannels/TextInputChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/systemchannels/AccessibilityChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/systemchannels/KeyEventChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/systemchannels/PlatformChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/systemchannels/SystemChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/systemchannels/LifecycleChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/android/AndroidTouchProcessor.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/android/FlutterActivity.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/android/FlutterView.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/android/FlutterTextureView.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/android/FlutterFragment.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/android/FlutterSurfaceView.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/android/AndroidKeyProcessor.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/embedding/engine/FlutterEngine.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/platform/PlatformViewsController.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/platform/PlatformViewRegistry.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/platform/VirtualDisplayController.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/platform/PlatformViewRegistryImpl.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/platform/SingleViewPresentation.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/platform/PlatformViewFactory.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/platform/PlatformView.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/BasicMessageChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/JSONMethodCodec.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/JSONUtil.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/PluginRegistry.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/MessageCodec.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/ErrorLogResult.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/JSONMessageCodec.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/ActivityLifecycleListener.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/BinaryCodec.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/FlutterException.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/StringCodec.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/StandardMessageCodec.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/StandardMethodCodec.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/MethodCodec.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/BinaryMessenger.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/MethodCall.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/EventChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/common/MethodChannel.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/editing/TextInputPlugin.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/plugin/editing/InputConnectionAdaptor.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/FlutterNativeView.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/ResourceUpdater.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/FlutterCallbackInformation.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/VsyncWaiter.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/FlutterView.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/FlutterMain.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/ResourceExtractor.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/TextureRegistry.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/ResourcePaths.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/ResourceCleaner.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/FlutterRunArguments.java" />
+    <src file="../../../flutter/shell/platform/android/io/flutter/view/AccessibilityBridge.java" />
+  </module>
+</project>

tools/android_lint/pubspec.yaml

+name: android_lint
+dependencies:
+  args: 1.5.0
+  path: ^1.6.2
+  process: ^3.0.9