improve tool with proper cli interface

schultek · Sep 14, 2022 · be13933 · be13933
1 parent 23bf1ea
commit be13933
Show file tree

Hide file tree

Showing 8 changed files with 206 additions and 153 deletions.
diff --git a/bin/stormberry.dart b/bin/stormberry.dart
@@ -1,155 +1,21 @@
-import 'dart:convert';
 import 'dart:io';
-import 'dart:isolate';
-
-import 'package:collection/collection.dart';
-import 'package:stormberry/stormberry.dart';
-import 'package:yaml/yaml.dart';
-
-import 'src/differentiator.dart';
-import 'src/output.dart';
-import 'src/patcher.dart';
-import 'src/schema.dart';
+import 'package:args/command_runner.dart';
+import 'package:stormberry/src/cli/runner.dart';
 
 Future<void> main(List<String> args) async {
-  bool dryRun = args.contains('--dry-run');
-  String? dbName = args.where((a) => a.startsWith('-db=')).map((a) => a.split('=')[1]).firstOrNull;
-  String? output = args.where((a) => a.startsWith('-o=')).map((a) => a.split('=')[1]).firstOrNull;
-  bool applyChanges = args.contains('--apply-changes');
-
-  var pubspecYaml = File('pubspec.yaml');
-
-  if (!pubspecYaml.existsSync()) {
-    print('Cannot find pubspec.yaml file in current directory.');
+  var runner = CommandRunner<void>(
+    'stormberry',
+    'Tool for migrating your database to the schema generated from your models.',
+  )..addCommand(MigrateCommand());
+
+  try {
+    await runner.run(args);
+    exit(0);
+  } on UsageException catch (e) {
+    print('${e.message}\n${e.usage}');
     exit(1);
-  }
-
-  var packageName = loadYaml(await pubspecYaml.readAsString())['name'] as String;
-
-  var buildYaml = File('build.yaml');
-
-  if (!buildYaml.existsSync()) {
-    print('Cannot find build.yaml file in current directory.');
+  } catch (e, st) {
+    print('$e\n$st');
     exit(1);
   }
-
-  var content = loadYaml(await buildYaml.readAsString());
-
-  List<String>? generateTargets = (content['targets'] as YamlMap?)
-      ?.values
-      .map((t) => t['builders']?['stormberry'])
-      .where((b) => b != null)
-      .expand((b) => b['generate_for'] as List)
-      .map((d) => d as String)
-      .toList();
-
-  if (generateTargets == null || generateTargets.isEmpty) {
-    print('Cannot find stormberry generation targets in build.yaml. '
-        'Make sure you have the stormberry builder configured with at least one generation target.');
-    exit(1);
-  }
-
-  var schema = DatabaseSchema.empty();
-
-  for (var target in generateTargets) {
-    var schemaPath = target.replaceFirst('.dart', '.runner.g.dart');
-    var file = File('.dart_tool/build/generated/$packageName/$schemaPath');
-    if (!file.existsSync()) {
-      print('Could not run migration for target $target. Did you run the build script?');
-      exit(1);
-    }
-
-    var port = ReceivePort();
-    await Isolate.spawnUri(
-      file.absolute.uri,
-      [],
-      port.sendPort,
-      packageConfig: Uri.parse('.packages'),
-    );
-
-    var schemaMap = jsonDecode(await port.first as String);
-    var targetSchema = DatabaseSchema.fromMap(schemaMap as Map<String, dynamic>);
-
-    schema = schema.mergeWith(targetSchema);
-  }
-
-  if (dbName == null && Platform.environment['DB_NAME'] == null) {
-    stdout.write('Select a database to update: ');
-    dbName = stdin.readLineSync(encoding: Encoding.getByName('utf-8')!);
-  }
-
-  var db = Database(database: dbName);
-
-  await db.open();
-
-  print('Getting schema changes of ${db.name}');
-  print('=========================');
-
-  var diff = await getSchemaDiff(db, schema);
-
-  if (diff.hasChanges) {
-    printDiff(diff);
-    print('=========================');
-
-    if (dryRun) {
-      print('DATABASE SCHEME HAS CHANGES, EXITING');
-      await db.close();
-      exit(1);
-    } else {
-      if (output == null) {
-        await db.startTransaction();
-
-        String? answerApplyChanges;
-        if (!applyChanges) {
-          stdout.write('Do you want to apply these changes? (yes/no): ');
-          answerApplyChanges = stdin.readLineSync(encoding: Encoding.getByName('utf-8')!);
-        }
-
-        if (applyChanges || answerApplyChanges == 'yes') {
-          print('Database schema changed, applying updates now:');
-
-          try {
-            db.debugPrint = true;
-            await patchSchema(db, diff);
-          } catch (_) {
-            db.cancelTransaction();
-          }
-        } else {
-          db.cancelTransaction();
-        }
-
-        var updateWasSuccessFull = await db.finishTransaction();
-
-        print('========================');
-        if (updateWasSuccessFull) {
-          print('---\nDATABASE UPDATE SUCCESSFUL');
-        } else {
-          print('---\nALL CHANGES REVERTED, EXITING');
-        }
-
-        await db.close();
-        exit(updateWasSuccessFull ? 0 : 1);
-      } else {
-        await db.close();
-        var dir = Directory(output);
-
-        String? answerApplyChanges;
-        if (!applyChanges) {
-          stdout.write('Do you want to write these migrations to ${dir.path}? (yes/no): ');
-          answerApplyChanges = stdin.readLineSync(encoding: Encoding.getByName('utf-8')!);
-        }
-
-        if (applyChanges || answerApplyChanges == 'yes') {
-
-          if (!dir.existsSync()) {
-            dir.createSync(recursive: true);
-          }
-
-          await outputSchema(dir, diff);
-        }
-      }
-    }
-  } else {
-    print('NO CHANGES, ALL DONE');
-  }
 }
diff --git a/bin/src/differentiator.dart → lib/src/cli/differentiator.dart b/bin/src/differentiator.dart → lib/src/cli/differentiator.dart
@@ -1,5 +1,5 @@
 import 'package:collection/collection.dart';
-import 'package:stormberry/stormberry.dart';
+import '../../stormberry.dart';
 
 import 'inspector.dart';
 import 'schema.dart';
@@ -162,8 +162,7 @@ class TableSchemaDiff {
 
   TableSchemaDiff(this.name);
 
-  bool get hasChanges =>
-      columns.hasChanges() || constraints.hasChanges() || indexes.hasChanges();
+  bool get hasChanges => columns.hasChanges() || constraints.hasChanges() || indexes.hasChanges();
 }
 
 class Diff<T, U> {

diff --git a/bin/src/inspector.dart → lib/src/cli/inspector.dart b/bin/src/inspector.dart → lib/src/cli/inspector.dart
@@ -1,4 +1,4 @@
-import 'package:stormberry/stormberry.dart';
+import '../../stormberry.dart';
 
 import 'schema.dart';
 

diff --git a/bin/src/output.dart → lib/src/cli/output.dart b/bin/src/output.dart → lib/src/cli/output.dart
diff --git a/bin/src/patcher.dart → lib/src/cli/patcher.dart b/bin/src/patcher.dart → lib/src/cli/patcher.dart
@@ -1,4 +1,4 @@
-import 'package:stormberry/stormberry.dart';
+import '../../stormberry.dart';
 
 import 'differentiator.dart';
 import 'schema.dart';

diff --git a/lib/src/cli/runner.dart b/lib/src/cli/runner.dart
@@ -0,0 +1,187 @@
+import 'dart:convert';
+import 'dart:io';
+import 'dart:isolate';
+
+import 'package:args/command_runner.dart';
+import 'package:yaml/yaml.dart';
+
+import '../../stormberry.dart';
+import 'differentiator.dart';
+import 'output.dart';
+import 'patcher.dart';
+import 'schema.dart';
+
+class MigrateCommand extends Command<void> {
+  MigrateCommand() {
+    argParser.addFlag(
+      'dry-run',
+      negatable: false,
+      help: 'Returns exit code 1 if there are any pending migrations. '
+          'Does not apply any changes to the database.',
+    );
+    argParser.addOption('db', help: 'Set the database name.');
+
+    argParser.addOption(
+      'output',
+      abbr: 'o',
+      help: 'Specify an output directory. This will write all migrations into .sql '
+          'files instead of writing to the database.',
+    );
+
+    argParser.addFlag(
+      'apply-changes',
+      negatable: false,
+      help: 'Applies all changes to the database without asking for confirmation.',
+    );
+  }
+
+  @override
+  String get description => 'Migrates the database to the generated schema.';
+
+  @override
+  String get name => 'migrate';
+
+  @override
+  Future<void> run() async {
+    bool dryRun = argResults!['dry-run'] as bool;
+    String? dbName = argResults!['db'] as String?;
+    String? output = argResults!['output'] as String?;
+    bool applyChanges = argResults!['apply-changes'] as bool;
+
+    var pubspecYaml = File('pubspec.yaml');
+
+    if (!pubspecYaml.existsSync()) {
+      print('Cannot find pubspec.yaml file in current directory.');
+      exit(1);
+    }
+
+    var packageName = loadYaml(await pubspecYaml.readAsString())['name'] as String;
+
+    var buildYaml = File('build.yaml');
+
+    if (!buildYaml.existsSync()) {
+      print('Cannot find build.yaml file in current directory.');
+      exit(1);
+    }
+
+    var content = loadYaml(await buildYaml.readAsString());
+
+    List<String>? generateTargets = (content['targets'] as YamlMap?)
+        ?.values
+        .map((t) => t['builders']?['stormberry'])
+        .where((b) => b != null)
+        .expand((b) => b['generate_for'] as List)
+        .map((d) => d as String)
+        .toList();
+
+    if (generateTargets == null || generateTargets.isEmpty) {
+      print('Cannot find stormberry generation targets in build.yaml. '
+          'Make sure you have the stormberry builder configured with at least one generation target.');
+      exit(1);
+    }
+
+    var schema = DatabaseSchema.empty();
+
+    for (var target in generateTargets) {
+      var schemaPath = target.replaceFirst('.dart', '.runner.g.dart');
+      var file = File('.dart_tool/build/generated/$packageName/$schemaPath');
+      if (!file.existsSync()) {
+        print('Could not run migration for target $target. Did you run the build script?');
+        exit(1);
+      }
+
+      var port = ReceivePort();
+      await Isolate.spawnUri(
+        file.absolute.uri,
+        [],
+        port.sendPort,
+        packageConfig: Uri.parse('.dart_tool/package_config.json'),
+        //automaticPackageResolution: true,
+      );
+
+      var schemaMap = jsonDecode(await port.first as String);
+      var targetSchema = DatabaseSchema.fromMap(schemaMap as Map<String, dynamic>);
+
+      schema = schema.mergeWith(targetSchema);
+    }
+
+    if (dbName == null && Platform.environment['DB_NAME'] == null) {
+      stdout.write('Select a database to update: ');
+      dbName = stdin.readLineSync(encoding: Encoding.getByName('utf-8')!);
+    }
+
+    var db = Database(database: dbName);
+
+    await db.open();
+
+    print('Getting schema changes of ${db.name}');
+    print('=========================');
+
+    var diff = await getSchemaDiff(db, schema);
+
+    if (diff.hasChanges) {
+      printDiff(diff);
+      print('=========================');
+
+      if (dryRun) {
+        print('DATABASE SCHEME HAS CHANGES, EXITING');
+        await db.close();
+        exit(1);
+      } else {
+        if (output == null) {
+          await db.startTransaction();
+
+          String? answerApplyChanges;
+          if (!applyChanges) {
+            stdout.write('Do you want to apply these changes? (yes/no): ');
+            answerApplyChanges = stdin.readLineSync(encoding: Encoding.getByName('utf-8')!);
+          }
+
+          if (applyChanges || answerApplyChanges == 'yes') {
+            print('Database schema changed, applying updates now:');
+
+            try {
+              db.debugPrint = true;
+              await patchSchema(db, diff);
+            } catch (_) {
+              db.cancelTransaction();
+            }
+          } else {
+            db.cancelTransaction();
+          }
+
+          var updateWasSuccessFull = await db.finishTransaction();
+
+          print('========================');
+          if (updateWasSuccessFull) {
+            print('---\nDATABASE UPDATE SUCCESSFUL');
+          } else {
+            print('---\nALL CHANGES REVERTED, EXITING');
+          }
+
+          await db.close();
+          exit(updateWasSuccessFull ? 0 : 1);
+        } else {
+          await db.close();
+          var dir = Directory(output);
+
+          String? answerApplyChanges;
+          if (!applyChanges) {
+            stdout.write('Do you want to write these migrations to ${dir.path}? (yes/no): ');
+            answerApplyChanges = stdin.readLineSync(encoding: Encoding.getByName('utf-8')!);
+          }
+
+          if (applyChanges || answerApplyChanges == 'yes') {
+            if (!dir.existsSync()) {
+              dir.createSync(recursive: true);
+            }
+
+            await outputSchema(dir, diff);
+          }
+        }
+      }
+    } else {
+      print('NO CHANGES, ALL DONE');
+    }
+  }
+}
diff --git a/bin/src/schema.dart → lib/src/cli/schema.dart b/bin/src/schema.dart → lib/src/cli/schema.dart
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -6,6 +6,7 @@ issue_tracker: https://github.com/schultek/stormberry/issues
 
 dependencies:
   analyzer: ^3.3.1
+  args: ^2.3.1
   build: ^2.2.1
   collection: ^1.16.0
   crypto: ^3.0.1