refactor(nextcloud): Migrate to nextcloud_test package

Signed-off-by: jld3103 <jld3103yt@gmail.com>

packages/nextcloud/pubspec.yaml

@@ -37,6 +37,10 @@ dev_dependencies:
     git:
       url: https://github.com/nextcloud/neon
       path: packages/neon_lints
+  nextcloud_test:
+    git:
+      url: https://github.com/nextcloud/neon
+      path: packages/nextcloud_test
   path: ^1.8.3
   process_run: ^0.13.3
   test: ^1.24.9

packages/nextcloud/pubspec_overrides.yaml

@@ -1,4 +1,4 @@
-# melos_managed_dependency_overrides: dynamite,dynamite_runtime,neon_lints
+# melos_managed_dependency_overrides: dynamite,dynamite_runtime,neon_lints,nextcloud_test
 dependency_overrides:
   dynamite:
     path: ../dynamite/dynamite
@@ -6,3 +6,5 @@ dependency_overrides:
     path: ../dynamite/dynamite_runtime
   neon_lints:
     path: ../neon_lints
+  nextcloud_test:
+    path: ../nextcloud_test

packages/nextcloud/test/core_test.dart

@@ -1,9 +1,8 @@
 import 'package:nextcloud/core.dart' as core;
 import 'package:nextcloud/nextcloud.dart';
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group(
     'core',
@@ -11,8 +10,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(container);
+        client = await TestNextcloudClient.create(container);
       });
       tearDown(() => container.destroy());
 

packages/nextcloud/test/dashboard_test.dart

@@ -1,9 +1,8 @@
 import 'package:nextcloud/dashboard.dart';
 import 'package:nextcloud/nextcloud.dart';
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group(
     'dashboard',
@@ -11,8 +10,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(container);
+        client = await TestNextcloudClient.create(container);
       });
       tearDown(() => container.destroy());
 

packages/nextcloud/test/helper.dart

@@ -1,196 +0,0 @@
-import 'dart:async';
-import 'dart:convert';
-import 'dart:math';
-
-import 'package:nextcloud/core.dart' as core;
-import 'package:nextcloud/nextcloud.dart';
-import 'package:process_run/cmd_run.dart';
-import 'package:test/test.dart';
-import 'package:universal_io/io.dart';
-
-const retryCount = 3;
-const timeout = Timeout(Duration(seconds: 30));
-
-class DockerContainer {
-  DockerContainer({
-    required this.id,
-    required this.port,
-  });
-
-  final String id;
-
-  final int port;
-
-  Future<void> runOccCommand(final List<String> args) async {
-    final result = await runExecutableArguments(
-      'docker',
-      [
-        'exec',
-        id,
-        'php',
-        '-f',
-        'occ',
-        ...args,
-      ],
-      stdout: stdout,
-      stderr: stderr,
-    );
-    if (result.exitCode != 0) {
-      throw Exception('Failed to run occ command');
-    }
-  }
-
-  void destroy() => unawaited(
-        runExecutableArguments(
-          'docker',
-          [
-            'kill',
-            id,
-          ],
-        ),
-      );
-
-  Future<String> serverLogs() async => (await runExecutableArguments(
-        'docker',
-        [
-          'logs',
-          id,
-        ],
-        stdoutEncoding: utf8,
-      ))
-          .stdout as String;
-
-  Future<String> nextcloudLogs() async => (await runExecutableArguments(
-        'docker',
-        [
-          'exec',
-          id,
-          'cat',
-          'data/nextcloud.log',
-        ],
-        stdoutEncoding: utf8,
-      ))
-          .stdout as String;
-
-  Future<String> allLogs() async => '${await serverLogs()}\n\n${await nextcloudLogs()}';
-}
-
-Future<NextcloudClient> getTestClient(
-  final DockerContainer container, {
-  final String? username = 'user1',
-  final AppType appType = AppType.unknown,
-  final String? userAgentOverride,
-}) async {
-  String? appPassword;
-  if (username != null) {
-    final inputStream = StreamController<List<int>>();
-    final process = runExecutableArguments(
-      'docker',
-      [
-        'exec',
-        '-i',
-        container.id,
-        'php',
-        '-f',
-        'occ',
-        'user:add-app-password',
-        username,
-      ],
-      stdin: inputStream.stream,
-    );
-    inputStream.add(utf8.encode(username));
-    await inputStream.close();
-
-    final result = await process;
-    if (result.exitCode != 0) {
-      throw Exception('Failed to run generate app password command\n${result.stderr}\n${result.stdout}');
-    }
-    appPassword = (result.stdout as String).split('\n')[1];
-  }
-
-  final client = NextcloudClient(
-    Uri(
-      scheme: 'http',
-      host: 'localhost',
-      port: container.port,
-    ),
-    loginName: username,
-    password: username,
-    appPassword: appPassword,
-    appType: appType,
-    userAgentOverride: userAgentOverride,
-    cookieJar: CookieJar(),
-  );
-
-  var i = 0;
-  while (true) {
-    try {
-      await client.core.getStatus();
-      break;
-    } catch (error) {
-      if (error is HttpException || error is DynamiteApiException) {
-        i++;
-        await Future<void>.delayed(const Duration(milliseconds: 100));
-        if (i >= 300) {
-          throw TimeoutException('Failed to get the status of the Server. $error');
-        }
-      } else {
-        rethrow;
-      }
-    }
-  }
-
-  return client;
-}
-
-Future<DockerContainer> getDockerContainer() async {
-  const dockerImageName = 'ghcr.io/nextcloud/neon/dev';
-
-  var result = await runExecutableArguments(
-    'docker',
-    [
-      'images',
-      '-q',
-      dockerImageName,
-    ],
-  );
-  if (result.exitCode != 0) {
-    throw Exception('Querying docker image failed: ${result.stderr}');
-  }
-  if (result.stdout.toString().isEmpty) {
-    throw Exception('Missing docker image $dockerImageName. Please build it using ./tool/build-dev-container.sh');
-  }
-
-  late int port;
-  while (true) {
-    port = randomPort();
-    result = await runExecutableArguments(
-      'docker',
-      [
-        'run',
-        '--rm',
-        '-d',
-        '--add-host',
-        'host.docker.internal:host-gateway',
-        '-p',
-        '$port:80',
-        dockerImageName,
-      ],
-    );
-    // 125 means the docker run command itself has failed which indicated the port is already used
-    if (result.exitCode != 125) {
-      break;
-    }
-  }
-
-  if (result.exitCode != 0) {
-    throw Exception('Failed to run docker container: ${result.stderr}');
-  }
-
-  return DockerContainer(
-    id: result.stdout.toString().replaceAll('\n', ''),
-    port: port,
-  );
-}
-
-int randomPort() => 1024 + Random().nextInt(65535 - 1024);

packages/nextcloud/test/news_test.dart

@@ -2,10 +2,9 @@ import 'dart:async';
 
 import 'package:nextcloud/news.dart' as news;
 import 'package:nextcloud/nextcloud.dart';
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group(
     'news',
@@ -13,8 +12,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(container);
+        client = await TestNextcloudClient.create(container);
       });
       tearDown(() => container.destroy());
 

packages/nextcloud/test/notes_test.dart

@@ -1,10 +1,9 @@
 import 'package:nextcloud/core.dart' as core;
 import 'package:nextcloud/nextcloud.dart';
 import 'package:nextcloud/notes.dart' as notes;
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group(
     'notes',
@@ -12,8 +11,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(container);
+        client = await TestNextcloudClient.create(container);
       });
       tearDown(() => container.destroy());
 

packages/nextcloud/test/notifications_test.dart

@@ -2,17 +2,16 @@ import 'dart:async';
 
 import 'package:nextcloud/nextcloud.dart';
 import 'package:nextcloud/notifications.dart';
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group('notifications', () {
     late DockerContainer container;
     late NextcloudClient client;
     setUp(() async {
-      container = await getDockerContainer();
+      container = await DockerContainer.create();
-      client = await getTestClient(
+      client = await TestNextcloudClient.create(
         container,
         username: 'admin',
       );
@@ -110,8 +109,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(
+        client = await TestNextcloudClient.create(
           container,
           username: 'admin',
         );

packages/nextcloud/test/provisioning_api_test.dart

@@ -1,9 +1,8 @@
 import 'package:nextcloud/nextcloud.dart';
 import 'package:nextcloud/provisioning_api.dart';
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group(
     'provisioning_api',
@@ -11,8 +10,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(
+        client = await TestNextcloudClient.create(
           container,
           username: 'admin',
         );

packages/nextcloud/test/settings_test.dart

@@ -2,10 +2,9 @@ import 'dart:convert';
 
 import 'package:nextcloud/nextcloud.dart';
 import 'package:nextcloud/settings.dart';
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group(
     'settings',
@@ -13,8 +12,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(
+        client = await TestNextcloudClient.create(
           container,
           username: 'admin',
         );

packages/nextcloud/test/spreed_test.dart

@@ -5,10 +5,9 @@ import 'package:built_value/json_object.dart';
 import 'package:nextcloud/core.dart' as core;
 import 'package:nextcloud/nextcloud.dart';
 import 'package:nextcloud/spreed.dart' as spreed;
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group(
     'spreed',
@@ -16,8 +15,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client1;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client1 = await getTestClient(container);
+        client1 = await TestNextcloudClient.create(container);
       });
       tearDown(() => container.destroy());
 
@@ -360,7 +359,7 @@ void main() {
           final room1 = (await client1.spreed.room.joinRoom(token: room.token)).body.ocs.data;
           await client1.spreed.call.joinCall(token: room.token);
 
-          final client2 = await getTestClient(
+          final client2 = await TestNextcloudClient.create(
             container,
             username: 'user2',
           );

packages/nextcloud/test/uppush_test.dart

@@ -1,9 +1,8 @@
 import 'package:nextcloud/nextcloud.dart';
 import 'package:nextcloud/uppush.dart';
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group(
     'uppush',
@@ -11,8 +10,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(
+        client = await TestNextcloudClient.create(
           container,
           username: 'admin',
         );

packages/nextcloud/test/user_status_test.dart

@@ -1,9 +1,8 @@
 import 'package:nextcloud/nextcloud.dart';
 import 'package:nextcloud/user_status.dart' as user_status;
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 
-import 'helper.dart';
-
 void main() {
   group(
     'user_status',
@@ -11,8 +10,8 @@ void main() {
       late DockerContainer container;
       late NextcloudClient client;
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(container);
+        client = await TestNextcloudClient.create(container);
       });
       tearDown(() => container.destroy());
 

packages/nextcloud/test/webdav_test.dart

@@ -3,11 +3,10 @@ import 'dart:math';
 import 'dart:typed_data';
 
 import 'package:nextcloud/nextcloud.dart';
+import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 import 'package:universal_io/io.dart';
 
-import 'helper.dart';
-
 void main() {
   group('constructUri', () {
     for (final values in [
@@ -142,8 +141,8 @@ void main() {
       late NextcloudClient client;
 
       setUp(() async {
-        container = await getDockerContainer();
+        container = await DockerContainer.create();
-        client = await getTestClient(container);
+        client = await TestNextcloudClient.create(container);
       });
       tearDown(() => container.destroy());