Generator tests

.github/workflows/test.yml

@@ -1,6 +1,12 @@
 name: Dart CI
 
-on: push
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
 
 jobs:
   format:
@@ -57,6 +63,17 @@ jobs:
           flutter test -j 1
         working-directory: packages/isar_test
 
+  test_generator:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: subosito/flutter-action@v2
+      - name: Run Generator Unit tests
+        run: |
+          dart pub get
+          dart test
+        working-directory: packages/isar_generator
+
   drive_ios:
     strategy:
       matrix:

packages/isar_generator/lib/src/isar_analyzer.dart

@@ -10,7 +10,9 @@ import 'package:isar_generator/src/object_info.dart';
 
 class IsarAnalyzer {
   ObjectInfo analyze(Element modelClass) {
-    if (modelClass is! ClassElement) {
+    if (modelClass is! ClassElement ||
+        modelClass.isEnum ||
+        modelClass.isMixin) {
       err('Only classes may be annotated with @Collection.', modelClass);
     }
 

packages/isar_generator/pubspec.yaml

@@ -18,4 +18,7 @@ dependencies:
   source_gen: ^1.2.2
 
 dev_dependencies:
+  build_test: ^2.1.5
+  matcher: ^0.12.12
+  test: ^1.21.0
   very_good_analysis: ^3.0.1

packages/isar_generator/test/error_test.dart

@@ -0,0 +1,33 @@
+import 'dart:io';
+
+import 'package:build/build.dart';
+import 'package:build_test/build_test.dart';
+import 'package:isar_generator/isar_generator.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('Error case', () {
+    for (final file in Directory('test/errors').listSync(recursive: true)) {
+      if (file is! File || !file.path.endsWith('.dart')) continue;
+
+      test(file.path, () async {
+        final content = await file.readAsLines();
+
+        final errorMessage = content.first.split('//').last.trim();
+
+        var error = '';
+        try {
+          await testBuilder(
+            getIsarGenerator(BuilderOptions.empty),
+            {'a|${file.path}': content.join('\n')},
+            reader: await PackageAssetReader.currentIsolate(),
+          );
+        } catch (e) {
+          error = e.toString();
+        }
+
+        expect(error.toLowerCase(), contains(errorMessage.toLowerCase()));
+      });
+    }
+  });
+}

packages/isar_generator/test/errors/class/abstract.dart

@@ -0,0 +1,8 @@
+// must not be abstract
+
+import 'package:isar/isar.dart';
+
+@Collection()
+abstract class Model {
+  int? id;
+}

packages/isar_generator/test/errors/class/constructor_named.dart

@@ -0,0 +1,10 @@
+// unnamed constructor
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Model {
+  Model.create();
+
+  int? id;
+}

packages/isar_generator/test/errors/class/constructor_unknown_parameter.dart

@@ -0,0 +1,13 @@
+// constructor parameter does not match a property
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Model {
+  // ignore: avoid_unused_constructor_parameters
+  Model(this.prop1, String somethingElse);
+
+  int? id;
+
+  final String prop1;
+}

packages/isar_generator/test/errors/class/constructor_wrong_parameter.dart

@@ -0,0 +1,13 @@
+// constructor parameter type does not match property type
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Model {
+  // ignore: avoid_unused_constructor_parameters
+  Model(int prop1);
+
+  int? id;
+
+  String prop1 = '5';
+}

packages/isar_generator/test/errors/class/enum.dart

@@ -0,0 +1,7 @@
+// only classes
+
+import 'package:isar/isar.dart';
+
+// ignore: invalid_annotation_target
+@Collection()
+enum Test { a, b, c }

packages/isar_generator/test/errors/class/invalid_name.dart

@@ -0,0 +1,8 @@
+// must not be abstract
+
+import 'package:isar/isar.dart';
+
+@Collection()
+abstract class Model {
+  int? id;
+}

packages/isar_generator/test/errors/class/mixin.dart

@@ -0,0 +1,7 @@
+// only classes
+
+import 'package:isar/isar.dart';
+
+// ignore: invalid_annotation_target
+@Collection()
+mixin Test {}

packages/isar_generator/test/errors/class/private.dart

@@ -0,0 +1,9 @@
+// must be public
+
+import 'package:isar/isar.dart';
+
+@Collection()
+// ignore: unused_element
+class _Model {
+  int? id;
+}

packages/isar_generator/test/errors/class/variable.dart

@@ -0,0 +1,7 @@
+// only classes
+
+import 'package:isar/isar.dart';
+
+// ignore: invalid_annotation_target
+@Collection()
+const t = 'hello';

packages/isar_generator/test/errors/id/converter.dart

@@ -0,0 +1,24 @@
+// Converters are not allowed for ids
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Test {
+  @Id()
+  @Converter()
+  late String id;
+}
+
+class Converter extends TypeConverter<String, int> {
+  const Converter();
+
+  @override
+  String fromIsar(int object) {
+    return object.toString();
+  }
+
+  @override
+  int toIsar(String object) {
+    return int.parse(object);
+  }
+}

packages/isar_generator/test/errors/id/duplicate.dart

@@ -0,0 +1,12 @@
+// Two or more properties annotated with @Id()
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Test {
+  @Id()
+  int? id1;
+
+  @Id()
+  int? id2;
+}

packages/isar_generator/test/errors/id/missing.dart

@@ -0,0 +1,8 @@
+// no int property named "id"
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Test {
+  late String name;
+}

packages/isar_generator/test/errors/id/not_long.dart

@@ -0,0 +1,9 @@
+// Only int ids are allowed
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Test {
+  @Id()
+  String? id;
+}

packages/isar_generator/test/errors/id/not_long2.dart

@@ -0,0 +1,10 @@
+// Only int ids are allowed
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Test {
+  @Id()
+  @Size32()
+  int? id;
+}

packages/isar_generator/test/errors/index/duplicate_name.dart

@@ -0,0 +1,14 @@
+// same name
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Model {
+  int? id;
+
+  @Index(name: 'myindex')
+  String? prop1;
+
+  @Index(name: 'myindex')
+  String? prop2;
+}

packages/isar_generator/test/errors/link/duplicate_name.dart

@@ -0,0 +1,18 @@
+// same name
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Model {
+  int? id;
+
+  final IsarLink<Model2> prop1 = IsarLink();
+
+  @Name('prop1')
+  final IsarLinks<Model2> prop2 = IsarLinks();
+}
+
+@Collection()
+class Model2 {
+  int? id;
+}

packages/isar_generator/test/errors/link/late.dart

@@ -0,0 +1,15 @@
+// must not be late
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Model {
+  int? id;
+
+  late IsarLink<Model2> link;
+}
+
+@Collection()
+class Model2 {
+  int? id;
+}

packages/isar_generator/test/errors/link/nullable.dart

@@ -0,0 +1,15 @@
+// must not be nullable
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Model {
+  int? id;
+
+  IsarLink<Model2>? link;
+}
+
+@Collection()
+class Model2 {
+  int? id;
+}

packages/isar_generator/test/errors/property/duplicate_name.dart

@@ -0,0 +1,13 @@
+// same name
+
+import 'package:isar/isar.dart';
+
+@Collection()
+class Model {
+  int? id;
+
+  String? prop1;
+
+  @Name('prop1')
+  String? prop2;
+}