From 7e42a7e31757208c8b3cf3ef7054d43502aa8b24 Mon Sep 17 00:00:00 2001 From: Thomas Hii Date: Sat, 20 Jul 2024 10:23:45 +0800 Subject: [PATCH] Updated angel3 migration --- doc/deployment/docker/README.md | 38 +++++++++++++--- doc/deployment/docker/docker-compose-pg.yml | 2 +- .../orm/angel_migration_runner/CHANGELOG.md | 1 + .../angel_migration_runner/example/main.dart | 43 +++++++++++++----- .../lib/src/mariadb/runner.dart | 1 + .../lib/src/mariadb/schema.dart | 1 + .../lib/src/mysql/runner.dart | 1 + .../lib/src/mysql/schema.dart | 1 + .../lib/src/postgres/runner.dart | 24 ++++++---- .../lib/src/postgres/schema.dart | 1 + .../test/mariadb_test.dart | 22 ++++++++- .../test/mysql_test.dart | 36 ++++++++++++--- .../angel_migration_runner/test/pg_test.dart | 45 +++++++++++++++---- .../orm/angel_orm_postgres/test/common.dart | 4 +- 14 files changed, 176 insertions(+), 44 deletions(-) diff --git a/doc/deployment/docker/README.md b/doc/deployment/docker/README.md index c363f1be..9b9b201d 100644 --- a/doc/deployment/docker/README.md +++ b/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 diff --git a/doc/deployment/docker/docker-compose-pg.yml b/doc/deployment/docker/docker-compose-pg.yml index b0e21a6b..e89b67ae 100644 --- a/doc/deployment/docker/docker-compose-pg.yml +++ b/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 diff --git a/packages/orm/angel_migration_runner/CHANGELOG.md b/packages/orm/angel_migration_runner/CHANGELOG.md index 08f41f70..b0da4f72 100755 --- a/packages/orm/angel_migration_runner/CHANGELOG.md +++ b/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` diff --git a/packages/orm/angel_migration_runner/example/main.dart b/packages/orm/angel_migration_runner/example/main.dart index d0ec7fe8..61ff0cd7 100755 --- a/packages/orm/angel_migration_runner/example/main.dart +++ b/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 args) async { + // Run migration on PostgreSQL database + postgresqlMigration(args); + + // Run migration on MySQL database + mysqlMigration(args); +} + +void postgresqlMigration(List 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 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 args) async { ], ); - /* + runMigrations(runner, args); +} + +void mysqlMigration(List 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 args) async { FooMigration(), ], ); - */ - runMigrations(postgresqlMigrationRunner, args); + runMigrations(runner, args); } class FooMigration extends Migration { diff --git a/packages/orm/angel_migration_runner/lib/src/mariadb/runner.dart b/packages/orm/angel_migration_runner/lib/src/mariadb/runner.dart index 73ad3710..4a4623a1 100644 --- a/packages/orm/angel_migration_runner/lib/src/mariadb/runner.dart +++ b/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'); diff --git a/packages/orm/angel_migration_runner/lib/src/mariadb/schema.dart b/packages/orm/angel_migration_runner/lib/src/mariadb/schema.dart index 90a04d4f..0fccfbe7 100644 --- a/packages/orm/angel_migration_runner/lib/src/mariadb/schema.dart +++ b/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'); diff --git a/packages/orm/angel_migration_runner/lib/src/mysql/runner.dart b/packages/orm/angel_migration_runner/lib/src/mysql/runner.dart index 29d606ab..ad50fe56 100644 --- a/packages/orm/angel_migration_runner/lib/src/mysql/runner.dart +++ b/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'); diff --git a/packages/orm/angel_migration_runner/lib/src/mysql/schema.dart b/packages/orm/angel_migration_runner/lib/src/mysql/schema.dart index 20ab4ad0..8aff3a19 100644 --- a/packages/orm/angel_migration_runner/lib/src/mysql/schema.dart +++ b/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'); diff --git a/packages/orm/angel_migration_runner/lib/src/postgres/runner.dart b/packages/orm/angel_migration_runner/lib/src/postgres/runner.dart index 8f1b33bc..58590110 100755 --- a/packages/orm/angel_migration_runner/lib/src/postgres/runner.dart +++ b/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 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 _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.'); diff --git a/packages/orm/angel_migration_runner/lib/src/postgres/schema.dart b/packages/orm/angel_migration_runner/lib/src/postgres/schema.dart index d287a983..279b6055 100755 --- a/packages/orm/angel_migration_runner/lib/src/postgres/schema.dart +++ b/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'); diff --git a/packages/orm/angel_migration_runner/test/mariadb_test.dart b/packages/orm/angel_migration_runner/test/mariadb_test.dart index 6b9bbc47..088affdf 100644 --- a/packages/orm/angel_migration_runner/test/mariadb_test.dart +++ b/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(); }); } diff --git a/packages/orm/angel_migration_runner/test/mysql_test.dart b/packages/orm/angel_migration_runner/test/mysql_test.dart index a30c9fd2..8d2e49f7 100644 --- a/packages/orm/angel_migration_runner/test/mysql_test.dart +++ b/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(); + } }); } diff --git a/packages/orm/angel_migration_runner/test/pg_test.dart b/packages/orm/angel_migration_runner/test/pg_test.dart index 8d0db4b0..25c3f962 100644 --- a/packages/orm/angel_migration_runner/test/pg_test.dart +++ b/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(); }); } diff --git a/packages/orm/angel_orm_postgres/test/common.dart b/packages/orm/angel_orm_postgres/test/common.dart index 6464b73f..0b04bcd7 100644 --- a/packages/orm/angel_orm_postgres/test/common.dart +++ b/packages/orm/angel_orm_postgres/test/common.dart @@ -89,7 +89,9 @@ Future 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 {