Automatic logging to stdout when running migrations

lib/hanami/model/migrator.rb

@@ -237,9 +237,9 @@ def self.version
       #
       # @since 0.7.0
       # @api private
-      def initialize(configuration: self.class.configuration)
+      def initialize(configuration: self.class.configuration, stream: $stdout)
         @configuration = configuration
-        @adapter       = Adapter.for(configuration)
+        @adapter       = Adapter.for(configuration, stream)
       end
 
       # @since 0.7.0

lib/hanami/model/migrator/adapter.rb

@@ -1,5 +1,6 @@
 require 'uri'
 require 'shellwords'
+require 'hanami/model/migrator/logger'
 
 module Hanami
   module Model
@@ -25,8 +26,8 @@ class Adapter
         #
         # @since 0.4.0
         # @api private
-        def self.for(configuration) # rubocop:disable Metrics/MethodLength
-          connection = connection_for(configuration)
+        def self.for(configuration, stream) # rubocop:disable Metrics/MethodLength
+          connection = connection_for(configuration, stream)
 
           case connection.database_type
           when :sqlite
@@ -48,9 +49,10 @@ class << self
 
           # @since 0.7.0
           # @api private
-          def connection_for(configuration)
+          def connection_for(configuration, stream)
             Sequel.connect(
-              configuration.url
+              configuration.url,
+              loggers: [Hanami::Model::Migrator::Logger.new(stream)]
             )
           rescue Sequel::AdapterNotFound
             raise MigrationError.new("Current adapter (#{configuration.adapter.type}) doesn't support SQL database operations.")

lib/hanami/model/migrator/logger.rb

@@ -0,0 +1,33 @@
+require 'hanami/logger'
+
+module Hanami
+  module Model
+    class Migrator
+      # Automatic logger for migrations
+      #
+      # @since x.x.x
+      # @api private
+      class Logger < Hanami::Logger
+        # Formatter for migrations logger
+        #
+        # @since x.x.x
+        # @api private
+        class Formatter < Hanami::Logger::Formatter
+          private
+
+          # @since x.x.x
+          # @api private
+          def _format(hash)
+            "[migration] [#{hash.fetch(:severity)}] #{hash.fetch(:message)}\n"
+          end
+        end
+
+        # @since x.x.x
+        # @api private
+        def initialize(stream)
+          super(nil, stream: stream, formatter: Formatter.new)
+        end
+      end
+    end
+  end
+end

test/integration/migration/mysql.rb

@@ -3,7 +3,7 @@
     @schema     = Pathname.new("#{__dir__}/../../../tmp/schema.sql").expand_path
     @connection = Sequel.connect(ENV['HANAMI_DATABASE_URL'])
 
-    Hanami::Model::Migrator::Adapter.for(Hanami::Model.configuration).dump
+    Hanami::Model::Migrator::Adapter.for(Hanami::Model.configuration, TestIO.stream).dump
   end
 
   describe 'columns' do

test/integration/migration/postgresql.rb

@@ -3,7 +3,7 @@
     @schema     = Pathname.new("#{__dir__}/../../../tmp/schema.sql").expand_path
     @connection = Sequel.connect(ENV['HANAMI_DATABASE_URL'])
 
-    Hanami::Model::Migrator::Adapter.for(Hanami::Model.configuration).dump
+    Hanami::Model::Migrator::Adapter.for(Hanami::Model.configuration, TestIO.stream).dump
   end
 
   describe 'columns' do

test/integration/migration/sqlite.rb

@@ -3,7 +3,7 @@
     @schema     = Pathname.new("#{__dir__}/../../../tmp/schema.sql").expand_path
     @connection = Sequel.connect(ENV['HANAMI_DATABASE_URL'])
 
-    Hanami::Model::Migrator::Adapter.for(Hanami::Model.configuration).dump
+    Hanami::Model::Migrator::Adapter.for(Hanami::Model.configuration, TestIO.stream).dump
   end
 
   describe 'columns' do

test/migrator/mysql.rb

@@ -2,7 +2,7 @@
 
 describe 'MySQL Database migrations' do
   let(:migrator) do
-    Hanami::Model::Migrator.new(configuration: configuration)
+    Hanami::Model::Migrator.new(configuration: configuration, stream: TestIO.stream)
   end
 
   let(:random) { SecureRandom.hex(4) }
@@ -250,7 +250,7 @@
       it 'creates database, loads schema and migrate' do
         # Simulate already existing schema.sql, without existing database and pending migrations
         connection = Sequel.connect(url)
-        Hanami::Model::Migrator::Adapter.for(configuration).dump
+        Hanami::Model::Migrator::Adapter.for(configuration, TestIO.stream).dump
 
         migration = target_migrations.join('20160831095616_create_abuses.rb')
         File.open(migration, 'w+') do |f|

test/migrator/postgresql.rb

@@ -2,7 +2,7 @@
 
 describe 'PostgreSQL Database migrations' do
   let(:migrator) do
-    Hanami::Model::Migrator.new(configuration: configuration)
+    Hanami::Model::Migrator.new(configuration: configuration, stream: TestIO.stream)
   end
 
   let(:random) { SecureRandom.hex(4) }
@@ -298,7 +298,7 @@
       it 'creates database, loads schema and migrate' do
         # Simulate already existing schema.sql, without existing database and pending migrations
         connection = Sequel.connect(url)
-        Hanami::Model::Migrator::Adapter.for(configuration).dump
+        Hanami::Model::Migrator::Adapter.for(configuration, TestIO.stream).dump
 
         migration = target_migrations.join('20160831095616_create_abuses.rb')
         File.open(migration, 'w+') do |f|

test/migrator/sqlite.rb

@@ -2,7 +2,7 @@
 
 describe 'Filesystem SQLite Database migrations' do
   let(:migrator) do
-    Hanami::Model::Migrator.new(configuration: configuration)
+    Hanami::Model::Migrator.new(configuration: configuration, stream: TestIO.stream)
   end
 
   let(:random) { SecureRandom.hex }
@@ -236,7 +236,7 @@
       it 'creates database, loads schema and migrate' do
         # Simulate already existing schema.sql, without existing database and pending migrations
         connection = Sequel.connect(url)
-        Hanami::Model::Migrator::Adapter.for(configuration).dump
+        Hanami::Model::Migrator::Adapter.for(configuration, TestIO.stream).dump
 
         migration = target_migrations.join('20160831095616_create_abuses.rb')
         File.open(migration, 'w+') do |f|

test/support/database/strategies/sql.rb

@@ -39,8 +39,10 @@ def after
       end
 
       def migrate
-        require 'hanami/model/migrator'
-        Hanami::Model::Migrator.migrate
+        TestIO.with_stdout do
+          require 'hanami/model/migrator'
+          Hanami::Model::Migrator.migrate
+        end
       end
 
       def credentials

test/support/test_io.rb

@@ -0,0 +1,14 @@
+module TestIO
+  def self.with_stdout
+    stdout  = $stdout
+    $stdout = stream
+    yield
+  ensure
+    $stdout.close
+    $stdout = stdout
+  end
+
+  def self.stream
+    File.new(ENV['HANAMI_DATABASE_LOGGER'], "a+")
+  end
+end

test/test_helper.rb

@@ -11,6 +11,7 @@
 $LOAD_PATH.unshift 'lib'
 require 'hanami/model'
 
+require_relative './support/test_io'
 require_relative './support/platform'
 require_relative './support/database'
 require_relative './support/fixtures'