refactor: improved unit tests (#23)

* cmake unit tests use mock

* add more cmake unit tests

* add cmake install location search path test

* add ninja unit tests

* unit test: do not pull ANDROID_HOME from env var

* update changelog

---------

Author: jasaw

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 0.2.1
 
 - support configuring cmake/ninja versions and android NDK version
+- mock cmake/ninja when testing
 
 ## 0.2.0
 

lib/src/builder/user_config.dart

@@ -40,9 +40,10 @@ class UserConfig {
     String? androidHome,
     bool? preferAndroidCmake,
     bool? preferAndroidNinja,
+    bool envVarAndroidHomeAsDefault = true,
   }) : preferAndroidCmake = preferAndroidCmake ?? targetOS == OS.android,
        preferAndroidNinja = preferAndroidNinja ?? targetOS == OS.android,
-       androidHome = androidHome ?? Platform.environment['ANDROID_HOME'];
+       androidHome = androidHome ?? (envVarAndroidHomeAsDefault ? Platform.environment['ANDROID_HOME'] : null);
 
   UserConfig copyWith({
     OS? targetOS,

lib/src/native_toolchain/cmake.dart

@@ -4,6 +4,7 @@ import 'dart:io';
 
 import 'package:code_assets/code_assets.dart';
 import 'package:logging/logging.dart';
+import 'package:meta/meta.dart';
 import 'package:pub_semver/pub_semver.dart';
 
 import '../builder/user_config.dart';
@@ -14,13 +15,16 @@ import '../tool/tool_resolver.dart';
 /// CMake.
 final cmake = Tool(name: 'CMake', defaultResolver: _CmakeResolver());
 
+@visibleForTesting
+CliVersionResolver? unitTestCmakeAndroidResolver;
+@visibleForTesting
+CliVersionResolver? unitTestCmakeSystemResolver;
+
 class _CmakeResolver implements ToolResolver {
   final executableName = OS.current.executableFileName('cmake');
 
-  @override
-  Future<List<ToolInstance>> resolve({required Logger? logger, UserConfig? userConfig}) async {
-    // here, we always try to find android cmake first and filter out unsatisfied versions
-    final androidResolver = CliVersionResolver(
+  CliVersionResolver _getAndroidResolver({UserConfig? userConfig}) {
+    return unitTestCmakeAndroidResolver ?? CliVersionResolver(
       wrappedResolver: ToolResolvers([
         InstallLocationResolver(
           toolName: 'CMake',
@@ -33,12 +37,22 @@ class _CmakeResolver implements ToolResolver {
         ),
       ]),
     );
-    final androidCmakeInstances = await androidResolver.resolve(logger: logger);
-    logger?.info('Found Android CMake: ${androidCmakeInstances.map((e) => e.toString()).join(', ')}');
+  }
 
-    final systemResolver = CliVersionResolver(
+  CliVersionResolver _getSystemResolver() {
+    return unitTestCmakeSystemResolver ?? CliVersionResolver(
       wrappedResolver: PathToolResolver(toolName: 'CMake', executableName: 'cmake'),
     );
+  }
+
+  @override
+  Future<List<ToolInstance>> resolve({required Logger? logger, UserConfig? userConfig}) async {
+    // here, we always try to find android cmake first and filter out unsatisfied versions
+    final androidResolver = _getAndroidResolver(userConfig: userConfig);
+    final androidCmakeInstances = await androidResolver.resolve(logger: logger);
+    logger?.info('Found Android CMake: ${androidCmakeInstances.map((e) => e.toString()).join(', ')}');
+
+    final systemResolver = _getSystemResolver();
     final systemCmakeInstances = await systemResolver.resolve(logger: logger);
     logger?.info('Found System CMake: ${systemCmakeInstances.map((e) => e.toString()).join(', ')}');
 

lib/src/native_toolchain/ninja.dart

@@ -4,6 +4,7 @@ import 'dart:io';
 
 import 'package:code_assets/code_assets.dart';
 import 'package:logging/logging.dart';
+import 'package:meta/meta.dart';
 import 'package:native_toolchain_cmake/src/tool/tool_instance.dart';
 import 'package:pub_semver/pub_semver.dart';
 
@@ -13,12 +14,16 @@ import '../tool/tool_resolver.dart';
 
 final ninja = Tool(name: 'Ninja', defaultResolver: _NinjaResolver());
 
+@visibleForTesting
+CliVersionResolver? unitTestNinjaAndroidResolver;
+@visibleForTesting
+CliVersionResolver? unitTestNinjaSystemResolver;
+
 class _NinjaResolver implements ToolResolver {
   final executableName = OS.current.executableFileName('ninja');
 
-  @override
-  Future<List<ToolInstance>> resolve({required Logger? logger, UserConfig? userConfig}) async {
-    final androidResolver = CliVersionResolver(
+  CliVersionResolver _getAndroidResolver({UserConfig? userConfig}) {
+    return unitTestNinjaAndroidResolver ?? CliVersionResolver(
       wrappedResolver: ToolResolvers([
         InstallLocationResolver(
           toolName: 'Ninja',
@@ -31,12 +36,21 @@ class _NinjaResolver implements ToolResolver {
         ),
       ]),
     );
-    final androidNinjaInstances = await androidResolver.resolve(logger: logger);
-    logger?.info('Found Android Ninja: ${androidNinjaInstances.map((e) => e.toString()).join(', ')}');
+  }
 
-    final systemResolver = CliVersionResolver(
+  CliVersionResolver _getSystemResolver() {
+    return unitTestNinjaSystemResolver ?? CliVersionResolver(
       wrappedResolver: PathToolResolver(toolName: 'Ninja', executableName: 'ninja'),
     );
+  }
+
+  @override
+  Future<List<ToolInstance>> resolve({required Logger? logger, UserConfig? userConfig}) async {
+    final androidResolver = _getAndroidResolver(userConfig: userConfig);
+    final androidNinjaInstances = await androidResolver.resolve(logger: logger);
+    logger?.info('Found Android Ninja: ${androidNinjaInstances.map((e) => e.toString()).join(', ')}');
+
+    final systemResolver = _getSystemResolver();
     final systemNinjaInstances = await systemResolver.resolve(logger: logger);
     logger?.info('Found System Ninja: ${systemNinjaInstances.map((e) => e.toString()).join(', ')}');
 

lib/src/tool/tool_resolver.dart

@@ -9,6 +9,7 @@ import 'package:code_assets/code_assets.dart';
 import 'package:glob/glob.dart';
 import 'package:glob/list_local_fs.dart';
 import 'package:logging/logging.dart';
+import 'package:meta/meta.dart';
 import 'package:pub_semver/pub_semver.dart';
 
 import '../builder/user_config.dart';
@@ -182,6 +183,9 @@ class InstallLocationResolver implements ToolResolver {
 
   static const home = r'$HOME';
 
+  @visibleForTesting
+  static Future<List<Uri>> Function(String)? unitTestTryResolvePath;
+
   /// [userConfig] is ignored.
   @override
   Future<List<ToolInstance>> resolve({required Logger? logger, UserConfig? userConfig}) async {
@@ -203,6 +207,10 @@ class InstallLocationResolver implements ToolResolver {
   }
 
   Future<List<Uri>> tryResolvePath(String path) async {
+    if (unitTestTryResolvePath != null) {
+      return unitTestTryResolvePath!(path);
+    }
+
     String pathNew = path;
     if (path.startsWith(home)) {
       final homeDir_ = homeDir;

pubspec.yaml

@@ -26,3 +26,4 @@ dependencies:
 dev_dependencies:
   collection: ^1.19.1
   test: ^1.21.0
+  mocktail: ^1.0.3

test/mock_components.dart

@@ -0,0 +1,4 @@
+import 'package:mocktail/mocktail.dart';
+import 'package:native_toolchain_cmake/src/tool/tool_resolver.dart';
+
+class MockCliVersionResolver extends Mock implements CliVersionResolver {}