symbol collector CLI integration

scripts/flutter_symbol_collector/lib/src/symbol_collector_cli.dart

@@ -0,0 +1,96 @@
+import 'dart:io';
+
+import 'package:archive/archive.dart';
+import 'package:archive/archive_io.dart';
+import 'package:file/file.dart';
+import 'package:http/http.dart' as http;
+import 'package:logging/logging.dart';
+import 'package:meta/meta.dart';
+import 'package:platform/platform.dart';
+import 'package:posix/posix.dart' as posix;
+
+class SymbolCollectorCli {
+  late final Logger _log = Logger.root;
+  late bool _isExecutable;
+
+  // https://github.com/getsentry/symbol-collector/releases
+  @visibleForTesting
+  static const version = '1.12.0';
+
+  @visibleForTesting
+  late final String cli;
+
+  @visibleForTesting
+  static Platform platform = LocalPlatform();
+
+  SymbolCollectorCli._();
+
+  // Downloads the CLI to the given temporary directory and prepares it for use.
+  static Future<SymbolCollectorCli> setup(Directory tempDir) async {
+    late final String platformIdentifier;
+    final executableName = 'symbol-collector';
+
+    if (platform.isLinux) {
+      platformIdentifier = 'linux-x64';
+    } else if (platform.isMacOS) {
+      platformIdentifier = 'osx-x64';
+    } else {
+      throw UnsupportedError(
+          'Cannot run symbol-collector CLI on this platform - there\'s no binary available at this time.');
+    }
+
+    final self = SymbolCollectorCli._();
+
+    self._log.fine(
+        'Downloading symbol-collector CLI v$version for $platformIdentifier');
+    final zipData = await http.readBytes(Uri.parse(
+        'https://github.com/getsentry/symbol-collector/releases/download/$version/symbolcollector-console-$platformIdentifier.zip'));
+    self._log.fine(
+        'Download successful, received ${zipData.length} bytes; extracting the archive');
+
+    final archive = ZipDecoder().decodeBytes(zipData);
+    final stream = OutputStream();
+    archive.single.writeContent(stream);
+    stream.flush();
+
+    await tempDir.create();
+    final executableFile = await tempDir.childFile(executableName).create();
+    self.cli = executableFile.path;
+
+    executableFile.writeAsBytes(stream.getBytes(), flush: true);
+    self._log.fine(
+        'Symbol-collector CLI extracted to ${executableFile.path}: ${await executableFile.length()} bytes');
+    self._isExecutable = platform.isWindows;
+    return self;
+  }
+
+  void _makeExecutable() {
+    if (!_isExecutable) {
+      _isExecutable = true;
+      if (LocalPlatform().operatingSystem == platform.operatingSystem) {
+        if (platform.isLinux || platform.isMacOS) {
+          _log.fine('Making Symbol-collector CLI executable (chmod +x)');
+
+          posix.chmod(cli, '0666');
+        }
+      } else {
+        _log.warning(
+            'Symbol-collector CLI has been run with a platform that is not the current OS platform.'
+            'This should only be done in tests because we can\'t execute the downloaded program');
+      }
+    }
+  }
+
+  Future<String> getVersion() => _execute(['--version', '-h']);
+
+  Future<String> _execute(List<String> arguments) async {
+    var result = await Process.run(cli, arguments);
+    if (result.exitCode != 0) {
+      _log.shout(
+          'Symbol-collector CLI failed to execute $arguments with exit code ${result.exitCode}.');
+      _log.shout('Stderr: ${result.stderr}');
+      _log.shout('Stdout: ${result.stdout}');
+    }
+    return result.stdout;
+  }
+}

scripts/flutter_symbol_collector/pubspec.yaml

@@ -6,11 +6,16 @@ environment:
   sdk: ^3.0.0
 
 dependencies:
+  archive: ^3.4.6
+  file: ^7.0.0
   gcloud: ^0.8.11
   github: ^9.19.0
   http: ^1.1.0
   logging: ^1.2.0
+  meta: ^1.11.0
   path: ^1.8.3
+  platform: ^3.1.3
+  posix: ^5.0.0
 
 
 dev_dependencies:

scripts/flutter_symbol_collector/test/common.dart

@@ -0,0 +1,8 @@
+import 'package:logging/logging.dart';
+
+void setupLogging() {
+  Logger.root.level = Level.ALL;
+  Logger.root.onRecord.listen((record) {
+    print('${record.level.name}: ${record.time}: ${record.message}');
+  });
+}

scripts/flutter_symbol_collector/test/flutter_symbol_source_test.dart

@@ -1,9 +1,10 @@
 import 'package:flutter_symbol_collector/flutter_symbol_collector.dart';
-import 'package:logging/logging.dart';
 import 'package:test/test.dart';
 
+import 'common.dart';
+
 void main() {
-  Logger.root.level = Level.ALL;
+  setupLogging();
   late FlutterSymbolSource sut;
 
   setUp(() {

scripts/flutter_symbol_collector/test/flutter_version_test..dart

@@ -1,5 +1,4 @@
 import 'package:flutter_symbol_collector/flutter_symbol_collector.dart';
-import 'package:logging/logging.dart';
 import 'package:test/test.dart';
 
 void main() {

scripts/flutter_symbol_collector/test/symbol_collector_cli_test.dart

@@ -0,0 +1,42 @@
+import 'package:file/file.dart';
+import 'package:file/memory.dart';
+import 'package:flutter_symbol_collector/src/symbol_collector_cli.dart';
+import 'package:platform/platform.dart';
+import 'package:test/test.dart';
+
+import 'common.dart';
+
+void main() {
+  setupLogging();
+  late FileSystem fs;
+
+  setUp(() {
+    fs = MemoryFileSystem.test();
+  });
+
+  group('setup() downloads CLI on', () {
+    for (final platform in [Platform.macOS, Platform.linux]) {
+      test(platform, () async {
+        const path = 'temp/symbol-collector';
+
+        // make sure the file is overwritten if there's an older version
+        await fs
+            .file(path)
+            .create(recursive: true)
+            .then((file) => file.writeAsString('foo'));
+        expect(fs.file(path).lengthSync(), equals(3));
+
+        SymbolCollectorCli.platform = FakePlatform(operatingSystem: platform);
+        final sut = await SymbolCollectorCli.setup(fs.directory('temp'));
+        expect(sut.cli, equals(path));
+        expect(fs.file(path).existsSync(), isTrue);
+        expect(fs.file(path).lengthSync(), greaterThan(1000000));
+      });
+    }
+  });
+
+  test('exec() works', () async {
+    final sut = await SymbolCollectorCli.setup(fs.currentDirectory);
+    expect(sut.getVersion(), startsWith('${SymbolCollectorCli.version}+'));
+  }, skip: LocalPlatform().isWindows);
+}