feat(nextcloud_test): Add Matcher for checking all WebDAV props are parsed

Signed-off-by: provokateurin <[email protected]>

Author: provokateurin

packages/nextcloud/packages/nextcloud_test/lib/nextcloud_test.dart

@@ -1,3 +1,4 @@
 export 'src/fixtures.dart' hide appendFixture;
+export 'src/matchers/webdav_props.dart';
 export 'src/models/nextcloud_tester.dart';
 export 'src/presets.dart';

packages/nextcloud/packages/nextcloud_test/lib/src/matchers/webdav_props.dart

@@ -0,0 +1,72 @@
+import 'package:built_collection/built_collection.dart';
+import 'package:collection/collection.dart';
+import 'package:http/http.dart' as http;
+// ignore: implementation_imports
+import 'package:matcher/src/expect/async_matcher.dart';
+import 'package:nextcloud/webdav.dart';
+import 'package:nextcloud_test/src/models/models.dart';
+import 'package:test/test.dart';
+import 'package:xml/xml.dart';
+
+class _ContainsAllAvailableProps extends AsyncMatcher {
+  _ContainsAllAvailableProps(
+    this.tester,
+    this.uri,
+  );
+
+  final NextcloudTester tester;
+  final PathUri uri;
+
+  @override
+  Description describe(Description description) {
+    return description;
+  }
+
+  @override
+  Future<String?> matchAsync(dynamic item) async {
+    if (item is! XmlElement) {
+      return 'Expected XmlElement, got ${item.runtimeType}.';
+    }
+
+    final parsedProps = _getMultistatusPropNames(item);
+    if (parsedProps.isEmpty) {
+      return 'Parsed props were empty';
+    }
+
+    final streamedResponse = await tester.client.webdav.httpClient.send(tester.client.webdav.propfind_Request(uri));
+    if (streamedResponse.statusCode != 207) {
+      return 'PROPFIND response status code was not 207';
+    }
+    final rawResponse = await http.Response.fromStream(streamedResponse);
+
+    final expectedProps = _getMultistatusPropNames(XmlDocument.parse(rawResponse.body).rootElement);
+    if (expectedProps.isEmpty) {
+      return 'Expected props were empty';
+    }
+
+    if (parsedProps != expectedProps) {
+      return 'Missing props: ${expectedProps.where((p) => !parsedProps.contains(p)).join(', ')}';
+    }
+
+    return null;
+  }
+
+  BuiltList<String> _getMultistatusPropNames(XmlElement root) {
+    return root.firstElementChild!.childElements
+        .singleWhere(
+          (node) =>
+              node.name.local == 'propstat' &&
+              node.childElements.singleWhere((node) => node.name.local == 'status').innerText.contains('200 OK'),
+        )
+        .childElements
+        .singleWhere((node) => node.name.local == 'prop')
+        .childElements
+        .map((el) => '{${el.name.namespaceUri}}${el.name.local}')
+        .toList()
+        .sorted()
+        .toBuiltList();
+  }
+}
+
+/// Checks that all props have been parsed, by comparing them to a raw PROPFIND response of a request to [uri].
+Matcher containsAllAvailableProps(NextcloudTester tester, PathUri uri) => _ContainsAllAvailableProps(tester, uri);

packages/nextcloud/packages/nextcloud_test/pubspec.yaml

@@ -7,6 +7,7 @@ environment:
 
 dependencies:
   built_collection: ^5.1.1
+  collection: ^1.0.0
   cookie_store:
     git:
       url: https://github.com/nextcloud/neon
@@ -17,6 +18,7 @@ dependencies:
     git:
       url: https://github.com/nextcloud/neon
       path: packages/interceptor_http_client
+  matcher: ^0.12.0
   meta: ^1.0.0
   nextcloud: ^8.1.0
   path: ^1.9.0
@@ -25,6 +27,7 @@ dependencies:
   test_api: ^0.7.0
   universal_io: ^2.0.0
   version: ^3.0.0
+  xml: ^6.0.0
 
 dev_dependencies:
   neon_lints: