test: mock http.Client instead of using nock (#295)

invertase · May 12, 2022 · cd23798 · cd23798
1 parent d6beb1c
commit cd23798
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 16 deletions.
diff --git a/packages/melos/lib/src/common/http.dart b/packages/melos/lib/src/common/http.dart
@@ -0,0 +1,8 @@
+import 'package:http/http.dart' as http;
+import 'package:meta/meta.dart';
+
+@visibleForTesting
+http.Client? testClient;
+
+Future<http.Response> get(Uri url, {Map<String, String>? headers}) =>
+    testClient?.get(url, headers: headers) ?? http.get(url, headers: headers);
diff --git a/packages/melos/lib/src/package.dart b/packages/melos/lib/src/package.dart
@@ -22,7 +22,6 @@ import 'dart:io';
 import 'package:cli_util/cli_logging.dart';
 import 'package:collection/collection.dart';
 import 'package:glob/glob.dart';
-import 'package:http/http.dart' as http;
 import 'package:path/path.dart';
 import 'package:pool/pool.dart';
 import 'package:pub_semver/pub_semver.dart';
@@ -31,6 +30,7 @@ import 'package:pubspec/pubspec.dart';
 import '../version.g.dart';
 import 'common/git.dart';
 import 'common/glob.dart';
+import 'common/http.dart' as http;
 import 'common/platform.dart';
 import 'common/utils.dart';
 import 'common/validation.dart';

diff --git a/packages/melos/pubspec.yaml b/packages/melos/pubspec.yaml
@@ -33,7 +33,7 @@ dependencies:
   yaml_edit: ^2.0.2
 
 dev_dependencies:
-  nock: ^1.2.0
+  mockito: ^5.1.0
   test: ^1.17.5
 
 executables:

diff --git a/packages/melos/test/package_test.dart b/packages/melos/test/package_test.dart
@@ -1,10 +1,12 @@
 import 'dart:io';
 
 import 'package:glob/glob.dart';
+import 'package:http/http.dart' as http;
+import 'package:melos/src/common/http.dart';
 import 'package:melos/src/package.dart';
 import 'package:melos/src/workspace.dart';
 import 'package:melos/src/workspace_configs.dart';
-import 'package:nock/nock.dart';
+import 'package:mockito/mockito.dart';
 import 'package:platform/platform.dart';
 import 'package:test/test.dart';
 
@@ -23,11 +25,13 @@ const pubPackageJson = '''
 
 void main() {
   group('MelosPackage', () {
-    setUpAll(nock.init);
-
+    final httpClientMock = HttpClientMock();
     late MelosWorkspace workspace;
+
+    setUpAll(() => testClient = httpClientMock);
+
     setUp(() async {
-      nock.cleanAll();
+      reset(httpClientMock);
       IOOverrides.global = MockFs();
 
       final config = await MelosWorkspaceConfig.fromDirectory(
@@ -41,32 +45,33 @@ void main() {
       );
     });
 
-    tearDown(() {
-      IOOverrides.global = null;
-    });
+    tearDown(() => IOOverrides.global = null);
+
+    tearDownAll(() => testClient = null);
 
     test('requests published packages from pub.dev by default', () async {
-      final interceptor = nock('https://pub.dev').get('/packages/melos.json')
-        ..reply(200, pubPackageJson);
+      final uri = Uri.parse('https://pub.dev/packages/melos.json');
+      when(httpClientMock.get(uri))
+          .thenAnswer((_) async => http.Response(pubPackageJson, 200));
 
       final package = workspace.allPackages.values.first;
       await package.getPublishedVersions();
 
-      expect(interceptor.isDone, isTrue);
+      verify(httpClientMock.get(uri)).called(1);
     });
 
     test(
       'requests published packages from PUB_HOSTED_URL if present',
       withMockPlatform(
         () async {
-          final interceptor = nock('http://localhost:8080')
-              .get('/packages/melos.json')
-            ..reply(200, pubPackageJson);
+          final uri = Uri.parse('http://localhost:8080/packages/melos.json');
+          when(httpClientMock.get(uri))
+              .thenAnswer((_) async => http.Response(pubPackageJson, 200));
 
           final package = workspace.allPackages.values.first;
           await package.getPublishedVersions();
 
-          expect(interceptor.isDone, isTrue);
+          verify(httpClientMock.get(uri)).called(1);
         },
         platform: FakePlatform.fromPlatform(const LocalPlatform())
           ..environment['PUB_HOSTED_URL'] = 'http://localhost:8080',

diff --git a/packages/melos/test/utils.dart b/packages/melos/test/utils.dart
@@ -2,9 +2,11 @@ import 'dart:convert';
 import 'dart:io';
 
 import 'package:cli_util/cli_logging.dart';
+import 'package:http/http.dart' as http;
 import 'package:melos/melos.dart';
 import 'package:melos/src/common/platform.dart';
 import 'package:melos/src/yamlicious/yaml_writer.dart';
+import 'package:mockito/mockito.dart';
 import 'package:path/path.dart';
 import 'package:pub_semver/pub_semver.dart';
 import 'package:pubspec/pubspec.dart';
@@ -336,3 +338,13 @@ class _VirtualPackage {
 
   final String? path;
 }
+
+class HttpClientMock extends Mock implements http.Client {
+  @override
+  Future<http.Response> get(Uri? url, {Map<String, String>? headers}) {
+    return super.noSuchMethod(
+      Invocation.method(#get, [url], {#headers: headers}),
+      returnValue: Future.value(http.Response('', 200)),
+    ) as Future<http.Response>;
+  }
+}