feat(cat-voices): Tests for validating proposal node ids (#2298)

* feat: add tests

* feat: unify document templates, stop using flutter custom templates

* fix: docs loading

Author: dt-iohk

catalyst_voices/Earthfile

@@ -1,5 +1,6 @@
 VERSION 0.8
 
+IMPORT ../ AS repo-ci
 IMPORT ../catalyst-gateway AS catalyst-gateway
 IMPORT github.com/input-output-hk/catalyst-ci/earthly/flutter:v3.3.3 AS flutter-ci
 
@@ -9,6 +10,8 @@ repo-catalyst-voices:
     FROM scratch
     WORKDIR /repo
     COPY --dir . .
+    # Copy docs as some doc files are used for test inputs
+    COPY repo-ci+copy-docs/docs ./docs
 
     SAVE ARTIFACT /repo repo
 

catalyst_voices/packages/internal/catalyst_voices_assets/assets/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json

@@ -5,5 +5,3 @@ export 'package:catalyst_voices_assets/src/assets_ext.dart';
 export 'package:catalyst_voices_assets/src/catalyst_image.dart';
 export 'package:catalyst_voices_assets/src/catalyst_svg_icon.dart';
 export 'package:catalyst_voices_assets/src/catalyst_svg_picture.dart';
-
-export 'voices_documents_templates.dart';

catalyst_voices/packages/internal/catalyst_voices_assets/assets/document_templates/proposal/F14-Generic/example.proposal.json

@@ -30,7 +30,6 @@ flutter:
     - assets/icons/
     - assets/lottie/
     - assets/videos/
-    - assets/document_templates/proposal/F14-Generic/
   fonts:
     - family: SF-Pro
       fonts:

catalyst_voices/packages/internal/catalyst_voices_assets/lib/src/catalyst_voices_assets.dart

@@ -28,6 +28,23 @@ final class ProposalDocument extends Equatable {
       DocumentNodeId.fromString('milestones.milestones.milestone_list');
   static final tagNodeId = DocumentNodeId.fromString('theme.theme.grouped_tag');
 
+  /// A list of all [DocumentNodeId] that are expected to appear
+  /// in the proposal template schema.
+  ///
+  /// The app builds custom logic on top of these node ids.
+  static final allNodeIds = [
+    titleNodeId,
+    descriptionNodeId,
+    requestedFundsNodeId,
+    durationNodeId,
+    authorNameNodeId,
+    categoryNodeId,
+    categoryDetailsNodeId,
+    milestonesNodeId,
+    milestoneListNodeId,
+    tagNodeId,
+  ];
+
   static const String exportFileExt = 'json';
 
   final ProposalMetadata metadata;

catalyst_voices/packages/internal/catalyst_voices_assets/lib/src/voices_documents_templates.dart

@@ -0,0 +1,54 @@
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:collection/collection.dart';
+
+class VoicesDocumentsTemplates {
+  static final Future<Map<String, dynamic>> proposalF14Schema =
+      _getJsonAssetFromDocs(
+    '/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json',
+  );
+
+  static final Future<Map<String, dynamic>> proposalF14Document =
+      _getJsonAssetFromDocs(
+    '/src/architecture/08_concepts/document_templates/proposal/F14-Generic/example.proposal.json',
+  );
+
+  static final Future<Map<String, dynamic>> commentF14Schema =
+      _getJsonAssetFromDocs(
+    '/src/architecture/08_concepts/document_templates/F14-Comments/0b8424d4-ebfd-46e3-9577-1775a69d290c.schema.json',
+  );
+
+  VoicesDocumentsTemplates._();
+
+  /// Starting from current dir go upwards until current dir will contain
+  /// `/docs` folder and return the `/docs` [Directory].
+  static Future<Directory> _getDocsRoot() async {
+    var dir = Directory.current;
+
+    while (true) {
+      final list = dir.listSync();
+      final docs = list.firstWhereOrNull((e) => e.path.endsWith('/docs'));
+      if (docs != null) {
+        return Directory(docs.path);
+      } else {
+        final parentDir = dir.parent;
+        if (dir.path == parentDir.path) {
+          throw StateError(
+            'Cannot find /docs directory in the repo. '
+            'Started lookup from ${Directory.current.path}.',
+          );
+        } else {
+          dir = dir.parent;
+        }
+      }
+    }
+  }
+
+  static Future<Map<String, dynamic>> _getJsonAssetFromDocs(String name) async {
+    final docsRoot = await _getDocsRoot();
+    final encodedData = await File(docsRoot.path + name).readAsString();
+    final decodedData = json.decode(encodedData) as Map<String, dynamic>;
+    return decodedData;
+  }
+}