feat: make test helpers globally available [#292]

shinyford · slightfoot · commit ec635fa55bdf · 2025-10-20T19:29:22.000+01:00
diff --git a/packages/clerk_auth/pubspec.yaml b/packages/clerk_auth/pubspec.yaml
@@ -24,4 +24,5 @@ dev_dependencies:
   json_serializable: ^6.8.0
   lints: ^3.0.0
   mocktail: ^1.0.4
-  test: ^1.25.5
+  clerk_test:
+    path: ../clerk_test
diff --git a/packages/clerk_auth/test/integration/clerk_api/environment_test.dart b/packages/clerk_auth/test/integration/clerk_api/environment_test.dart
@@ -1,7 +1,6 @@
 import 'package:clerk_auth/src/clerk_api/api.dart';
 import 'package:clerk_auth/src/utils/logging.dart';
-
-import '../../test_helpers.dart';
+import 'package:clerk_test/clerk_test.dart';
 
 void main() {
   late Api api;
diff --git a/packages/clerk_auth/test/integration/clerk_api/sign_in_test.dart b/packages/clerk_auth/test/integration/clerk_api/sign_in_test.dart
@@ -2,8 +2,7 @@ import 'package:clerk_auth/src/clerk_api/api.dart';
 import 'package:clerk_auth/src/models/api/api_response.dart';
 import 'package:clerk_auth/src/models/models.dart';
 import 'package:clerk_auth/src/utils/logging.dart';
-
-import '../../test_helpers.dart';
+import 'package:clerk_test/clerk_test.dart';
 
 void main() {
   late Api api;
diff --git a/packages/clerk_auth/test/integration/clerk_api/sign_up_test.dart b/packages/clerk_auth/test/integration/clerk_api/sign_up_test.dart
@@ -3,8 +3,7 @@ import 'package:clerk_auth/src/models/api/api_response.dart';
 import 'package:clerk_auth/src/models/client/strategy.dart';
 import 'package:clerk_auth/src/models/status.dart';
 import 'package:clerk_auth/src/utils/logging.dart';
-
-import '../../test_helpers.dart';
+import 'package:clerk_test/clerk_test.dart';
 
 void main() {
   late Api api;
diff --git a/packages/clerk_auth/test/integration/clerk_api/user_details_test.dart b/packages/clerk_auth/test/integration/clerk_api/user_details_test.dart
@@ -7,7 +7,7 @@ import 'package:clerk_auth/src/models/client/user.dart';
 import 'package:clerk_auth/src/models/enums.dart';
 import 'package:clerk_auth/src/utils/logging.dart';
 
-import '../../test_helpers.dart';
+import 'package:clerk_test/clerk_test.dart';
 
 // Note that these are integration tests with a live backend. The configuration of the backend
 // will affect the outcome of the tests. It is assumed that the account has been configured to
diff --git a/packages/clerk_auth/test/integration/clerk_auth/sign_in_test.dart b/packages/clerk_auth/test/integration/clerk_auth/sign_in_test.dart
@@ -3,8 +3,7 @@ import 'package:clerk_auth/src/models/client/strategy.dart';
 import 'package:clerk_auth/src/models/client/user.dart';
 import 'package:clerk_auth/src/models/status.dart';
 import 'package:clerk_auth/src/utils/logging.dart';
-
-import '../../test_helpers.dart';
+import 'package:clerk_test/clerk_test.dart';
 
 void main() {
   late Auth auth;
diff --git a/packages/clerk_auth/test/integration/clerk_auth/sign_up_test.dart b/packages/clerk_auth/test/integration/clerk_auth/sign_up_test.dart
@@ -5,8 +5,7 @@ import 'package:clerk_auth/src/models/client/strategy.dart';
 import 'package:clerk_auth/src/models/client/user.dart';
 import 'package:clerk_auth/src/models/status.dart';
 import 'package:clerk_auth/src/utils/logging.dart';
-
-import '../../test_helpers.dart';
+import 'package:clerk_test/clerk_test.dart';
 
 void main() {
   late Auth auth;
diff --git a/packages/clerk_auth/test/unit/clerk_api/clerk_api_test.dart b/packages/clerk_auth/test/unit/clerk_api/clerk_api_test.dart
@@ -1,8 +1,7 @@
 import 'dart:convert';
 
 import 'package:clerk_auth/src/clerk_api/api.dart';
-
-import '../../test_helpers.dart';
+import 'package:clerk_test/clerk_test.dart';
 
 void main() {
   group('Derive domain from publishable key', () {
diff --git a/packages/clerk_auth/test/unit/utils/logging_test.dart b/packages/clerk_auth/test/unit/utils/logging_test.dart
@@ -1,8 +1,8 @@
 import 'dart:async';
 
 import 'package:clerk_auth/src/utils/logging.dart';
+import 'package:clerk_test/clerk_test.dart';
 import 'package:mocktail/mocktail.dart';
-import 'package:test/test.dart';
 
 void main() {
   late final Printer printer;
diff --git a/packages/clerk_test/.gitignore b/packages/clerk_test/.gitignore
@@ -0,0 +1,45 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.build/
+.buildlog/
+.history
+.svn/
+.swiftpm/
+migrate_working_dir/
+
+# 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
+.pub-cache/
+.pub/
+/build/
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release
diff --git a/packages/clerk_test/.metadata b/packages/clerk_test/.metadata
@@ -0,0 +1,45 @@
+# 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: "d8a9f9a52e5af486f80d932e838ee93861ffd863"
+  channel: "stable"
+
+project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+      base_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+    - platform: android
+      create_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+      base_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+    - platform: ios
+      create_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+      base_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+    - platform: linux
+      create_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+      base_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+    - platform: macos
+      create_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+      base_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+    - platform: web
+      create_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+      base_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+    - platform: windows
+      create_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+      base_revision: d8a9f9a52e5af486f80d932e838ee93861ffd863
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'
diff --git a/packages/clerk_test/README.md b/packages/clerk_test/README.md
@@ -0,0 +1,3 @@
+# clerk_test
+
+A new Flutter project.
diff --git a/packages/clerk_test/analysis_options.yaml b/packages/clerk_test/analysis_options.yaml
@@ -0,0 +1 @@
+include: package:flutter_lints/flutter.yaml
diff --git a/packages/clerk_test/lib/clerk_test.dart b/packages/clerk_test/lib/clerk_test.dart
@@ -0,0 +1,13 @@
+import 'package:test/test.dart' as test show expect;
+
+export 'package:test/test.dart' hide expect;
+
+export 'src/test_auth_config.dart';
+export 'src/test_env.dart';
+export 'src/test_http_service.dart';
+export 'src/test_http_service_error.dart';
+export 'src/test_log_printer.dart';
+
+void expect(dynamic actual, [dynamic matcher = true]) {
+  test.expect(actual, matcher);
+}
diff --git a/packages/clerk_test/lib/src/test_auth_config.dart b/packages/clerk_test/lib/src/test_auth_config.dart
@@ -0,0 +1,52 @@
+import 'package:clerk_auth/clerk_auth.dart';
+import 'package:http/http.dart';
+
+class TestAuthConfig extends AuthConfig {
+  const TestAuthConfig({
+    required super.publishableKey,
+    super.httpService = const _NoneHttpService(),
+  }) : super(
+          sessionTokenPolling: false,
+          localesLookup: _localesLookup,
+          persistor: Persistor.none,
+          clientRefreshPeriod: Duration.zero,
+          telemetryPeriod: Duration.zero,
+        );
+
+  static List<String> _localesLookup() => const <String>['en'];
+}
+
+class _NoneHttpService implements HttpService {
+  const _NoneHttpService();
+
+  @override
+  Future<void> initialize() async {}
+
+  @override
+  void terminate() {}
+
+  @override
+  Future<bool> ping(Uri uri, {required Duration timeout}) => Future.value(true);
+
+  @override
+  Future<Response> send(
+    HttpMethod method,
+    Uri uri, {
+    Map<String, String>? headers,
+    Map<String, dynamic>? params,
+    String? body,
+  }) {
+    return Future.value(Response('', 200));
+  }
+
+  @override
+  Future<Response> sendByteStream(
+    HttpMethod method,
+    Uri uri,
+    ByteStream byteStream,
+    int length,
+    Map<String, String> headers,
+  ) {
+    return Future.value(Response('', 200));
+  }
+}
diff --git a/packages/clerk_test/lib/src/test_env.dart b/packages/clerk_test/lib/src/test_env.dart
@@ -0,0 +1,61 @@
+import 'dart:convert';
+
+import 'package:dart_dotenv/dart_dotenv.dart';
+
+class TestEnv {
+  TestEnv._(this._map);
+
+  factory TestEnv(
+    String filename, {
+    Map<String, dynamic>? overrides,
+  }) {
+    final dotEnv = DotEnv(filePath: filename);
+    final map = {
+      ...dotEnv.getDotEnv(),
+      if (overrides case final overrides?) //
+        for (final entry in overrides.entries) //
+          entry.key: entry.value.toString(),
+    };
+    return TestEnv._(map);
+  }
+
+  factory TestEnv.withOpenIdentifiers(String filename, String name) {
+    final id = base64Encode(name.codeUnits).replaceAll('=', '').toLowerCase();
+    return TestEnv(
+      filename,
+      overrides: {
+        'password': 'Ab$id%',
+        'username': 'user-$id',
+        'first_name': 'User',
+        'last_name': id[0].toUpperCase() + id.substring(1),
+        'email': 'user-$id+clerk_test@somedomain.com',
+        'phone_number': '+155555501${(name.hashCode % 90) + 10}',
+        'use_open_identifiers': true,
+      },
+    );
+  }
+
+  final Map<String, String> _map;
+
+  bool get recording => _map['recording'] == r'true';
+
+  bool get useOpenIdentifiers => _map['use_open_identifiers'] == 'true';
+
+  String get email => _map['email'] ?? r'user+clerk_test@somedomain.com';
+
+  String get emailForLink => _map['email_for_link'] ?? email;
+
+  String get phoneNumber => _map['phone_number'] ?? r'+15555550169';
+
+  String get password => _map['password'] ?? r'Password8$';
+
+  String get code => _map['code'] ?? r'424242';
+
+  String get publishableKey => _map['publishable_key'] ?? r'';
+
+  String get username => _map['username'] ?? r'testuser';
+
+  String get firstName => _map['first_name'] ?? r'Firstname';
+
+  String get lastName => _map['last_name'] ?? r'Lastname';
+}
diff --git a/packages/clerk_test/lib/src/test_http_service.dart b/packages/clerk_test/lib/src/test_http_service.dart
diff --git a/packages/clerk_test/lib/src/test_http_service_error.dart b/packages/clerk_test/lib/src/test_http_service_error.dart
diff --git a/packages/clerk_test/lib/src/test_log_printer.dart b/packages/clerk_test/lib/src/test_log_printer.dart
diff --git a/packages/clerk_test/pubspec.yaml b/packages/clerk_test/pubspec.yaml
