Updated angel3 migration

doc/deployment/docker/README.md

@@ -30,12 +30,12 @@ The required applications by the framework can be run using the docker compose f
     psql --username postgres
     ```
 
-### Create database, user and access
+### Create PostgreSQL database, user and grant access
 
-    ```psql
-    postgres=# create database orm_test;
-    postgres=# create user test with encrypted password 'test123';
-    postgres=# grant all privileges on database orm_test to test;
+    ```sql
+    create database orm_test;
+    create user test with encrypted password 'test123';
+    grant all privileges on database orm_test to test;
     ```
 
 ## MariaDB
@@ -59,6 +59,20 @@ The required applications by the framework can be run using the docker compose f
     docker logs maria-mariadb-1 -f
     ```
 
+### Create MariaDB database, user and grant access
+
+    ```sql
+    create database orm_test;
+    
+    -- Granting localhost access only
+    create user 'test'@'localhost' identified by 'test123';
+    grant all privileges on orm_test.* to 'test'@'localhost';
+
+    -- Granting localhost and remote access
+    create user 'test'@'%' identified by 'test123';
+    grant all privileges on orm_test.* to 'test'@'%';
+    ```
+
 ## MySQL
 
 ### Starting the MySQL container
@@ -80,6 +94,20 @@ The required applications by the framework can be run using the docker compose f
     docker logs mysql-mysql-1 -f
     ```
 
+### Create MySQL database, user and grant access
+
+    ```sql
+    create database orm_test;
+    
+    -- Granting localhost access only
+    create user 'test'@'localhost' identified by 'test123';
+    grant all privileges on orm_test.* to 'test'@'localhost';
+
+    -- Granting localhost and remote access
+    create user 'test'@'%' identified by 'test123';
+    grant all privileges on orm_test.* to 'test'@'%';
+    ```
+
 ## MongoDB
 
 ### Starting the MongoDB container

doc/deployment/docker/docker-compose-pg.yml

@@ -10,7 +10,7 @@ services:
     volumes:
       - "db:/var/lib/postgresql/data"
     networks:
-      - webnet
+      - appnet
 
   pgadmin4:
     image: dpage/pgadmin4:latest

packages/orm/angel_migration_runner/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 8.2.1
 
 * Updated README
+* Updated examples
 * Added test cases for `PostgreSQL`
 * Added test cases for `MySQL`
 * Added test cases for `MariaDB`

packages/orm/angel_migration_runner/example/main.dart

@@ -2,13 +2,23 @@ import 'dart:io';
 
 import 'package:angel3_migration/angel3_migration.dart';
 import 'package:angel3_migration_runner/angel3_migration_runner.dart';
+import 'package:angel3_migration_runner/mysql.dart';
 import 'package:angel3_migration_runner/postgres.dart';
 import 'package:angel3_orm/angel3_orm.dart';
+import 'package:mysql_client/mysql_client.dart';
 import 'package:postgres/postgres.dart';
 
 import 'todo.dart';
 
 void main(List<String> args) async {
+  // Run migration on PostgreSQL database
+  postgresqlMigration(args);
+
+  // Run migration on MySQL database
+  mysqlMigration(args);
+}
+
+void postgresqlMigration(List<String> args) async {
   var host = Platform.environment['DB_HOST'] ?? 'localhost';
   var database = Platform.environment['DB_NAME'] ?? 'demo';
   var username = Platform.environment['DB_USERNAME'] ?? 'demouser';
@@ -16,14 +26,16 @@ void main(List<String> args) async {
 
   print("$host $database $username $password");
 
-  Connection conn = await Connection.open(Endpoint(
-      host: host,
-      port: 5432,
-      database: database,
-      username: username,
-      password: password));
+  Connection conn = await Connection.open(
+      Endpoint(
+          host: host,
+          port: 5432,
+          database: database,
+          username: username,
+          password: password),
+      settings: ConnectionSettings(sslMode: SslMode.disable));
 
-  var postgresqlMigrationRunner = PostgresMigrationRunner(
+  var runner = PostgresMigrationRunner(
     conn,
     migrations: [
       UserMigration(),
@@ -32,17 +44,25 @@ void main(List<String> args) async {
     ],
   );
 
-  /*
+  runMigrations(runner, args);
+}
+
+void mysqlMigration(List<String> args) async {
+  var host = Platform.environment['MYSQL_HOST'] ?? 'localhost';
+  var database = Platform.environment['MYSQL_DB'] ?? 'orm_test';
+  var username = Platform.environment['MYSQL_USERNAME'] ?? 'test';
+  var password = Platform.environment['MYSQL_PASSWORD'] ?? 'test123';
+
   var mySQLConn = await MySQLConnection.createConnection(
       host: host,
       port: 3306,
       databaseName: database,
       userName: username,
       password: password,
-      secure: false);
+      secure: true);
 
   // ignore: unused_local_variable
-  var mysqlMigrationRunner = MySqlMigrationRunner(
+  var runner = MySqlMigrationRunner(
     mySQLConn,
     migrations: [
       UserMigration(),
@@ -50,9 +70,8 @@ void main(List<String> args) async {
       FooMigration(),
     ],
   );
-  */
 
-  runMigrations(postgresqlMigrationRunner, args);
+  runMigrations(runner, args);
 }
 
 class FooMigration extends Migration {

packages/orm/angel_migration_runner/lib/src/mariadb/runner.dart

@@ -7,6 +7,7 @@ import '../runner.dart';
 import '../util.dart';
 import 'schema.dart';
 
+/// A MariaDB database migration runner.
 class MariaDbMigrationRunner implements MigrationRunner {
   final _log = Logger('MariaDbMigrationRunner');
 

packages/orm/angel_migration_runner/lib/src/mariadb/schema.dart

@@ -5,6 +5,7 @@ import 'package:mysql1/mysql1.dart';
 
 import 'table.dart';
 
+/// A MariaDB database schema generator
 class MariaDbSchema extends Schema {
   final _log = Logger('MariaDbSchema');
 

packages/orm/angel_migration_runner/lib/src/mysql/runner.dart

@@ -7,6 +7,7 @@ import '../runner.dart';
 import '../util.dart';
 import 'schema.dart';
 
+/// A MySQL database migration runner.
 class MySqlMigrationRunner implements MigrationRunner {
   final _log = Logger('MysqlMigrationRunner');
 

packages/orm/angel_migration_runner/lib/src/mysql/schema.dart

@@ -5,6 +5,7 @@ import 'package:mysql_client/mysql_client.dart';
 
 import 'table.dart';
 
+/// A MySQL database schema generator
 class MySqlSchema extends Schema {
   final _log = Logger('MysqlSchema');
 

packages/orm/angel_migration_runner/lib/src/postgres/runner.dart

@@ -7,6 +7,7 @@ import '../runner.dart';
 import '../util.dart';
 import 'schema.dart';
 
+/// A PostgreSQL database migration runner
 class PostgresMigrationRunner implements MigrationRunner {
   final _log = Logger('PostgresMigrationRunner');
 
@@ -17,8 +18,10 @@ class PostgresMigrationRunner implements MigrationRunner {
 
   PostgresMigrationRunner(this.connection,
       {Iterable<Migration> migrations = const [], bool connected = false}) {
-    if (migrations.isNotEmpty == true) migrations.forEach(addMigration);
-    _connected = connected == true;
+    if (migrations.isNotEmpty) {
+      migrations.forEach(addMigration);
+    }
+    _connected = connected;
   }
 
   @override
@@ -26,17 +29,16 @@ class PostgresMigrationRunner implements MigrationRunner {
     _migrationQueue.addLast(migration);
   }
 
-  Future _init() async {
+  Future<void> _init() async {
     while (_migrationQueue.isNotEmpty) {
       var migration = _migrationQueue.removeFirst();
       var path = await absoluteSourcePath(migration.runtimeType);
       migrations.putIfAbsent(path.replaceAll('\\', '\\\\'), () => migration);
     }
 
+    _connected = connection.isOpen;
     if (!_connected) {
-      //await connection.open();
-      //Connection.open(_endpoint!, settings: _settings);
-      _connected = true;
+      throw Exception("PostgreSQL connection is not open");
     }
 
     await connection.execute('''
@@ -47,9 +49,10 @@ class PostgresMigrationRunner implements MigrationRunner {
       PRIMARY KEY(id)
     );
     ''').then((result) {
-      _log.info('Check and create "migrations" table');
+      _log.info('Created "migrations" table');
     }).catchError((e) {
       _log.severe('Failed to create "migrations" table.');
+      throw e;
     });
   }
 
@@ -73,8 +76,8 @@ class PostgresMigrationRunner implements MigrationRunner {
         var migration = migrations[k]!;
         var schema = PostgresSchema();
         migration.up(schema);
-        _log.info('Added "$k" into "migrations" table.');
-        await schema.run(connection).then((_) {
+
+        var result = await schema.run(connection).then((_) {
           return connection.runTx((ctx) async {
             var result = await ctx.execute(
                 "INSERT INTO MIGRATIONS (batch, path) VALUES ($batch, '$k')");
@@ -85,6 +88,9 @@ class PostgresMigrationRunner implements MigrationRunner {
           _log.severe('Failed to insert into "migrations" table.');
           return -1;
         });
+        if (result > 0) {
+          _log.info('Inserted "$k" into "migrations" table.');
+        }
       }
     } else {
       _log.warning('Nothing to add into "migrations" table.');

packages/orm/angel_migration_runner/lib/src/postgres/schema.dart

@@ -4,6 +4,7 @@ import 'package:postgres/postgres.dart';
 import 'package:logging/logging.dart';
 import 'table.dart';
 
+/// A PostgreSQL database schema generator
 class PostgresSchema extends Schema {
   final _log = Logger('PostgresSchema');
 

packages/orm/angel_migration_runner/test/mariadb_test.dart

@@ -1,12 +1,19 @@
 import 'dart:io';
 
+import 'package:angel3_migration_runner/angel3_migration_runner.dart';
+import 'package:angel3_migration_runner/mariadb.dart';
 import 'package:mysql1/mysql1.dart';
 import 'package:test/test.dart';
 
+import 'models/todo.dart';
+
 void main() async {
   late MySqlConnection conn;
+  late MigrationRunner runner;
 
   setUp(() async {
+    print("Setup...");
+
     var host = Platform.environment['MYSQL_HOST'] ?? 'localhost';
     var database = Platform.environment['MYSQL_DB'] ?? 'orm_test';
     var username = Platform.environment['MYSQL_USERNAME'] ?? 'test';
@@ -19,13 +26,26 @@ void main() async {
         user: username,
         password: password);
     conn = await MySqlConnection.connect(settings);
+
+    runner = MariaDbMigrationRunner(
+      conn,
+      migrations: [
+        UserMigration(),
+        TodoMigration(),
+        ItemMigration(),
+      ],
+    );
   });
 
   group('MariaDB', () {
-    test('migrate tables', () async {});
+    test('migrate tables', () async {
+      print("Test migration up");
+      runner.up();
+    });
   });
 
   tearDown(() async {
+    print("Teardown...");
     await conn.close();
   });
 }

packages/orm/angel_migration_runner/test/mysql_test.dart

@@ -1,19 +1,26 @@
 import 'dart:io';
 
+import 'package:angel3_migration_runner/angel3_migration_runner.dart';
+import 'package:angel3_migration_runner/mysql.dart';
 import 'package:mysql_client/mysql_client.dart';
 import 'package:test/test.dart';
 
+import 'models/todo.dart';
+
 void main() async {
   late MySQLConnection conn;
+  late MigrationRunner runner;
 
   setUp(() async {
+    print("Setup...");
+
     var host = Platform.environment['MYSQL_HOST'] ?? 'localhost';
     var database = Platform.environment['MYSQL_DB'] ?? 'orm_test';
     var username = Platform.environment['MYSQL_USERNAME'] ?? 'test';
     var password = Platform.environment['MYSQL_PASSWORD'] ?? 'test123';
-    var secure = !('false' == Platform.environment['MYSQL_SECURE']);
+    //var secure = !('false' == Platform.environment['MYSQL_SECURE']);
 
-    print("$host $database $username $password $secure");
+    print("$host $database $username $password");
 
     conn = await MySQLConnection.createConnection(
         databaseName: database,
@@ -21,14 +28,31 @@ void main() async {
         host: host,
         userName: username,
         password: password,
-        secure: secure);
+        secure: true);
+
+    await conn.connect();
+
+    runner = MySqlMigrationRunner(
+      conn,
+      migrations: [
+        UserMigration(),
+        TodoMigration(),
+        ItemMigration(),
+      ],
+    );
   });
 
-  group('Mysql', () {
-    test('migrate tables', () async {});
+  group('Mysql migrate tables', () {
+    test('up', () async {
+      print("Test migration up");
+      await runner.up();
+    });
   });
 
   tearDown(() async {
-    await conn.close();
+    print("Teardown...");
+    if (conn.connected) {
+      await conn.close();
+    }
   });
 }

packages/orm/angel_migration_runner/test/pg_test.dart

@@ -1,32 +1,59 @@
 import 'dart:io';
 
+import 'package:angel3_migration_runner/angel3_migration_runner.dart';
+import 'package:angel3_migration_runner/postgres.dart';
 import 'package:postgres/postgres.dart';
 import 'package:test/test.dart';
 
+import 'models/todo.dart';
+
 void main() async {
   late Connection conn;
+  late MigrationRunner runner;
 
   setUp(() async {
+    print("Setup...");
+
     var host = Platform.environment['POSTGRES_HOST'] ?? 'localhost';
     var database = Platform.environment['POSTGRES_DB'] ?? 'orm_test';
     var username = Platform.environment['POSTGRES_USERNAME'] ?? 'test';
     var password = Platform.environment['POSTGRES_PASSWORD'] ?? 'test123';
 
-    print("$host $database $username $password");
+    //print("$host $database $username $password");
 
-    conn = await Connection.open(Endpoint(
-        host: host,
-        port: 5432,
-        database: database,
-        username: username,
-        password: password));
+    conn = await Connection.open(
+        Endpoint(
+            host: host,
+            port: 5432,
+            database: database,
+            username: username,
+            password: password),
+        settings: ConnectionSettings(sslMode: SslMode.disable));
+
+    runner = PostgresMigrationRunner(
+      conn,
+      migrations: [
+        UserMigration(),
+        TodoMigration(),
+        ItemMigration(),
+      ],
+    );
   });
 
-  group('PostgreSQL', () {
-    test('migrate tables', () async {});
+  group('PostgreSQL migrate tables', () {
+    test('up', () async {
+      print("Test migration up");
+      await runner.up();
+    });
+
+    test('reset', () async {
+      print("Test migration reset");
+      await runner.reset();
+    });
   });
 
   tearDown(() async {
+    print("Teardown...");
     await conn.close();
   });
 }

packages/orm/angel_orm_postgres/test/common.dart

@@ -89,7 +89,9 @@ Future<PostgreSqlPoolExecutor> connectToPostgresPool(
     )
   ],
       settings: PoolSettings(
-          maxConnectionAge: Duration(hours: 1), maxConnectionCount: 5));
+          maxConnectionAge: Duration(hours: 1),
+          maxConnectionCount: 5,
+          sslMode: SslMode.disable));
 
   // Run sql to create the tables in a transaction
   await dbPool.runTx((conn) async {