Implement Support for ARM and Use Latest libpact_ffi Library (#19)

Author: matthewshirley

.github/workflows/ci.yml

@@ -4,25 +4,35 @@ on:
     branches:
       - "main"
   pull_request:
+  workflow_dispatch:
+
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: dart-lang/setup-dart@v1
+        with:
+          sdk: stable
       - name: Install dependencies
         run: dart pub get
       - name: Run analyzers and linters
         run: |
           dart format --set-exit-if-changed .
           dart analyze
+
   tests:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
-        sdk: [stable, 2.18.7, 2.17.7]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        sdk: [stable, 3.4.0, 3.0.0, 2.19.6, 2.18.7, 2.17.7]
+        exclude:
+          - os: windows-latest
+            sdk: 2.17.7
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: dart-lang/setup-dart@v1
         with:
           sdk: ${{ matrix.sdk }}
@@ -33,14 +43,26 @@ jobs:
         env:
           PACT_DART_LIB_DOWNLOAD_PATH: .
       - name: Run unit tests
-        run: dart test --coverage="coverage" test/
+        run: dart test -j 1 -r github --coverage="coverage" test/
         env:
           PACT_DART_LIB_DOWNLOAD_PATH: .
       - name: Format coverage
         run: dart run coverage:format_coverage --lcov --in=coverage --out=coverage.lcov --report-on=lib
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
         with:
           files: ./coverage.lcov
           token: ${{ secrets.CODECOV_TOKEN }}
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  publish-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dart-lang/setup-dart@v1
+        with:
+          sdk: stable
+      - name: Install dependencies
+        run: dart pub get
+      - name: Validate package for publishing
+        run: dart pub publish --dry-run

bin/install.dart

@@ -1,6 +1,10 @@
-/// Dart has no way to install native libraries during package installation
+/// Install the `libpact` dependency.
 ///
-/// Something to keep an eye on: https://github.com/dart-lang/pub/issues/39
+/// Currently, this is not managed by `pub` due to limitations:
+///   - https://github.com/dart-lang/pub/issues/39
+///   - https://github.com/dart-lang/pub/issues/3693
+
+import 'dart:ffi';
 import 'dart:io';
 import 'package:http/http.dart' as http;
 import 'package:path/path.dart' as path;
@@ -18,7 +22,7 @@ String getPlatformFileType() {
 
     default:
       throw UnsupportedError(
-          'Sorry! ${Platform.operatingSystem} is unsupported by pact_dart.');
+          '${Platform.operatingSystem} is unsupported by pact_dart.');
   }
 }
 
@@ -28,15 +32,55 @@ String getLibDirectory() {
     return env;
   }
 
-  return '/usr/local/lib';
+  switch (Platform.operatingSystem) {
+    case 'windows':
+      final programFiles =
+          Platform.environment['ProgramFiles'] ?? 'C:\\Program Files';
+      return '$programFiles\\PactDart';
+
+    case 'macos':
+    case 'linux':
+      return '/usr/local/lib';
+
+    default:
+      final home = Platform.environment['HOME'] ??
+          Platform.environment['USERPROFILE'] ??
+          '.';
+      return '$home/.pact_dart/lib';
+  }
+}
+
+String getArchitecture() {
+  final abi = Abi.current().toString();
+  final arch = abi.split('_').last;
+
+  switch (arch) {
+    case 'arm64':
+    case 'arm':
+      return 'aarch64';
+
+    case 'x64':
+      return 'x86_64';
+
+    case 'ia32':
+      return 'x86';
+
+    case 'riscv64':
+    case 'riscv32':
+      throw UnsupportedError('RISC-V is not currently supported');
+
+    default:
+      print('Warning: Unknown architecture: $arch, defaulting to x86_64');
+      return 'x86_64';
+  }
 }
 
 Uri generateDependencyLink(String name, String version, String fileType) {
-  final operatingSystem =
-      Platform.operatingSystem == 'macos' ? 'osx' : Platform.operatingSystem;
+  final architecture = getArchitecture();
+  final operatingSystem = Platform.operatingSystem;
 
   final path =
-      '/pact-foundation/pact-reference/releases/download/$name-v$version/$name-$operatingSystem-x86_64.$fileType.gz';
+      '/pact-foundation/pact-reference/releases/download/libpact_ffi-v$version/$name-$operatingSystem-$architecture.$fileType.gz';
 
   return Uri(scheme: 'https', host: 'github.com', path: path);
 }
@@ -45,21 +89,60 @@ Future<void> downloadDependency(String name, String version) async {
   final fileType = getPlatformFileType();
   final dependencyLink = generateDependencyLink(name, version, fileType);
 
-  final res = await http.get(dependencyLink);
-  final library = GZipCodec().decode(res.bodyBytes);
-
-  final libDir = getLibDirectory();
-  final libPath = path.join(libDir, '$name.$fileType');
-
-  final writeStream = File(libPath.toString()).openWrite();
-  writeStream.add(library);
-
-  await writeStream.close();
+  print('🛜 Downloading from: ${dependencyLink.toString()}');
+
+  try {
+    final res = await http.get(dependencyLink);
+    if (res.statusCode != 200) {
+      throw Exception('Download failed with status code ${res.statusCode}');
+    }
+
+    final library = GZipCodec().decode(res.bodyBytes);
+
+    final libDir = getLibDirectory();
+    final libDirFile = Directory(libDir);
+    await libDirFile.create(recursive: true);
+
+    final libPath = path.join(libDir, '$name.$fileType');
+    print('💾 Installing to: $libPath');
+
+    try {
+      await File(libPath).writeAsBytes(library, flush: true);
+      print('✅ Successfully installed $name v$version.');
+    } catch (e) {
+      throw Exception(
+          'Unable to write to $libPath. Try running with sudo or specify a different directory with PACT_DART_LIB_DOWNLOAD_PATH environment variable.');
+    }
+  } catch (e) {
+    print('😢 An error occurred during installation: $e');
+    rethrow;
+  }
 }
 
 void main() async {
   final dependencyName = Platform.isWindows ? 'pact_ffi' : 'libpact_ffi';
-  final dependencyVersion = '0.4.1';
+  final dependencyVersion = '0.4.27';
+  final libDir = getLibDirectory();
 
-  await downloadDependency(dependencyName, dependencyVersion);
+  print('🚀 Pact Dart Installation');
+  print('======================');
+  print(
+      'This script will install the $dependencyName library required by Pact Dart:');
+  print('- Library: $dependencyName v$dependencyVersion');
+  print('- Platform: ${Platform.operatingSystem} (${getArchitecture()})');
+  print('- Install directory: $libDir');
+  print('');
+  print(
+      'Note: You may need admin privileges to write to the installation directory.');
+  print(
+      'If installation fails, you can specify an alternative directory using');
+  print('the PACT_DART_LIB_DOWNLOAD_PATH environment variable.');
+  print('');
+
+  try {
+    await downloadDependency(dependencyName, dependencyVersion);
+  } catch (e) {
+    print('\nSomething went wrong: $e');
+    exit(1);
+  }
 }