minio_runner 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fee26785f28262a4b0f39f5020886edcddd996ca6040e5b1e952a9583199aa36
-  data.tar.gz: 19ba0e2e0a070b3caf5fbfc1ba04e4a5cca9a285e80b224626e112cbd45c0202
+  metadata.gz: 05673a80f366bbb670c2ceb4cce28d3d8d27b7b25c4418482d15d6030b6a5fe1
+  data.tar.gz: 6ecaa3cefbd2962e8eaf7fb7262c479ca5e6383bbe2e711d9f459c9987d492e5
 SHA512:
-  metadata.gz: 57fc047cd89912f6ad31b2fc5c349d74182c44fdc9bf6ef2e5cc5beb613eff56d99ff04914761047c0deb944bb433e581e8f0017000fdc8309a0a3af1628f1bd
-  data.tar.gz: 5a16f8c6d73deec031690b3bdb21d602d6e162ab22a8b56f4ab6abd874bfe0aa039bb4c31a1de79245c0116cabc7118d58ded7d9b499f1f8b018beabdd633aeb
+  metadata.gz: 9427c0521263fc9cf1ab467acc3af4aaf759802134b88a59f8105d0d14dd6a1c496d83b5a26744923666ec8a8688ececb62fc79670db63142450d2449cf6b141
+  data.tar.gz: ccc978d672db68a3b59b4feaa723581e8aa445fd4535770c2d6767c81a7255aac8ae6110b9af3e3a4f37c66854661b418eda627c732cd8aabd8dd679de757775

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minio_runner (0.1.0)
+    minio_runner (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/lib/minio_runner/mc_manager.rb

@@ -8,13 +8,19 @@ module MinioRunner
       end
 
       def bucket_exists?(alias_name, name)
-        system(*command.concat(["ls", "#{alias_name}/#{name}"]))
+        system(
+          *command.concat(["ls", "#{alias_name}/#{name}"]),
+          out: MinioServerManager.log_file_path,
+        )
       end
 
       def create_bucket(alias_name, name)
         MinioRunner.logger.debug("Creating bucket #{alias_name}/#{name}...")
         if !bucket_exists?(alias_name, name)
-          system(*command.concat(["mb", "#{alias_name}/#{name}"]))
+          system(
+            *command.concat(["mb", "#{alias_name}/#{name}"]),
+            out: MinioServerManager.log_file_path,
+          )
           MinioRunner.logger.debug("Created  #{alias_name}/#{name}.")
         else
           MinioRunner.logger.debug("Bucket #{alias_name}/#{name} already exists, doing nothing.")
@@ -34,6 +40,7 @@ module MinioRunner
               MinioRunner.config.minio_root_password,
             ],
           ),
+          out: MinioServerManager.log_file_path,
         )
         MinioRunner.logger.debug("Set alias #{name} to #{url}.")
       end
@@ -42,7 +49,10 @@ module MinioRunner
         MinioRunner.logger.debug(
           "Setting anonymous access for #{alias_name}/#{bucket} to policy #{policy}...",
         )
-        system(*command.concat(["anonymous", "set", policy, "#{alias_name}/#{bucket}"]))
+        system(
+          *command.concat(["anonymous", "set", policy, "#{alias_name}/#{bucket}"]),
+          out: MinioServerManager.log_file_path,
+        )
         MinioRunner.logger.debug("Anonymous access set for #{alias_name}/#{bucket}.")
       end
     end

data/lib/minio_runner/minio_health_check.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MinioRunner
+  ##
+  # Checks that the minio server is running on the configured port using
+  # the /minio/health/live endpoint with a limited number of retries.
+  #
+  # Also used to check whether /etc/hosts is configured properly; some platforms
+  # (read: macOS) have to be configured in a certain way to avoid this.
+  class MinioHealthCheck
+    class << self
+      def call(retries: 2, initial_retries: nil)
+        initial_retries ||= retries
+        begin
+          Network.get("#{MinioRunner.config.minio_server_url}/minio/health/live")
+        rescue StandardError, MinioRunner::Network::NetworkError
+          if retries.positive?
+            sleep 1
+            call(retries: retries - 1, initial_retries: initial_retries)
+          else
+            message =
+              "Minio server failed to start after #{initial_retries + 1} attempts. Check that /etc/hosts is configured properly."
+
+            if MinioRunner::System.mac? && MinioRunner.config.minio_domain.end_with?(".local")
+              message += "\n\n" + MinioRunner::Network::MAC_OS_LOCAL_DOMAIN_ERROR_MESSAGE
+            end
+
+            raise MinioRunner::Network::NetworkError.new(message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minio_runner/minio_server_manager.rb

@@ -18,6 +18,10 @@ module MinioRunner
         return if @server.nil?
         @server.stop
       end
+
+      def log_file_path
+        "#{MinioRunner.config.install_dir}/minio.log"
+      end
     end
 
     def start
@@ -38,13 +42,13 @@ module MinioRunner
             "MINIO_ROOT_PASSWORD" => MinioRunner.config.minio_root_password,
             "MINIO_DOMAIN" => MinioRunner.config.minio_domain,
           },
-          log_file: log_file_path,
+          log_file: MinioServerManager.log_file_path,
         )
 
       @process.start
 
       # Make sure the minio server is ready to accept requests.
-      health_check(retries: 3)
+      MinioRunner::MinioHealthCheck.call(retries: 2)
 
       MinioRunner.logger.debug("minio server running at pid #{@process.pid}!")
     end
@@ -80,22 +84,5 @@ module MinioRunner
 
       command
     end
-
-    def log_file_path
-      "#{MinioRunner.config.install_dir}/minio.log"
-    end
-
-    def health_check(retries:)
-      begin
-        Network.get("#{MinioRunner.config.minio_server_url}/minio/health/live")
-      rescue StandardError
-        if retries.positive?
-          sleep 1
-          health_check(retries: retries - 1)
-        else
-          raise "Minio server failed to start."
-        end
-      end
-    end
   end
 end

data/lib/minio_runner/network.rb

@@ -5,23 +5,55 @@ require "tempfile"
 
 module MinioRunner
   class Network
+    class NetworkError < StandardError
+    end
+
+    LONG_RESPONSE_TIME_SECONDS = 3
+    MAC_OS_LOCAL_DOMAIN_ERROR_MESSAGE = <<~END
+      For macOS, there are some issues which cause large delays for .local domain names. See
+      https://superuser.com/a/1297335/245469 and https://stackoverflow.com/a/17982964/875941. To
+      resolve this, you need to add IPV6 lookup addresses to the hosts file, and it helps to put
+      all the entries on one line.
+
+      ::1 minio.local testbucket.minio.local
+      fe80::1%lo0 minio.local testbucket.minio.local
+      127.0.0.1 minio.local testbucket.minio.local
+    END
+
     class << self
       def get(url)
         MinioRunner.logger.debug("Making network call to #{url}")
+        uri = URI(url)
+        response = nil
+        request_start_time = Time.now
 
         begin
-          response = Net::HTTP.get_response(URI(url))
-        rescue SocketError
-          raise "Can not reach #{url}"
+          Net::HTTP.start(
+            uri.host,
+            uri.port,
+            use_ssl: uri.scheme == "https",
+            open_timeout: MinioRunner::System.mac? ? 10 : 3,
+          ) { |http| response = http.get(uri.path) }
+        rescue SocketError, Net::OpenTimeout => err
+          MinioRunner.logger.debug(
+            "Connection error when checking minio server health: #{err.message}",
+          )
+          log_time_error(request_start_time)
+          raise MinioRunner::Network::NetworkError.new(
+                  "Connection error, cannot reach URL: #{url} (#{err.class})",
+                )
         end
 
         MinioRunner.logger.debug("Get response: #{response.inspect}")
 
         case response
         when Net::HTTPSuccess
+          log_time_error(request_start_time)
           response.body
         else
-          raise "#{response.class::EXCEPTION_TYPE}: #{response.code} \"#{response.message}\" with #{url}"
+          raise MinioRunner::Network::NetworkError.new(
+                  "#{response.class::EXCEPTION_TYPE}: #{response.code} \"#{response.message}\" with #{url}",
+                )
         end
       end
 
@@ -41,6 +73,13 @@ module MinioRunner
       ensure
         tempfile&.close!
       end
+
+      def log_time_error(request_start_time)
+        if (Time.now - request_start_time) > Network::LONG_RESPONSE_TIME_SECONDS &&
+             MinioRunner.config.minio_domain.end_with?(".local") && MinioRunner::System.mac?
+          MinioRunner.logger.warn(MAC_OS_LOCAL_DOMAIN_ERROR_MESSAGE)
+        end
+      end
     end
   end
 end

data/lib/minio_runner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MinioRunner
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/minio_runner.rb

@@ -7,11 +7,14 @@ require_relative "minio_runner/config"
 require_relative "minio_runner/minio_binary"
 require_relative "minio_runner/mc_binary"
 require_relative "minio_runner/binary_manager"
+require_relative "minio_runner/minio_health_check"
 require_relative "minio_runner/minio_server_manager"
 require_relative "minio_runner/mc_manager"
 
 module MinioRunner
   class << self
+    @@started = false
+
     def config(&block)
       @config ||= MinioRunner::Config.new
       if block_given?
@@ -38,12 +41,7 @@ module MinioRunner
             original_formatter = logger.formatter || Logger::Formatter.new
             logger.formatter =
               proc do |severity, time, progname, msg|
-                original_formatter.call(
-                  severity,
-                  time,
-                  progname,
-                  "[MinioRunner]: #{msg.strip.dump}",
-                )
+                original_formatter.call(severity, time, progname, "[MinioRunner]: #{msg.strip}")
               end
           end
     end
@@ -57,6 +55,12 @@ module MinioRunner
       setup_buckets
 
       logger.debug("Started minio_runner.")
+
+      @@started = true
+    end
+
+    def started?
+      @@started
     end
 
     def install_binaries
@@ -84,9 +88,11 @@ module MinioRunner
     end
 
     def stop
+      return if !started?
       logger.debug("Stopping minio_runner...")
       MinioRunner::MinioServerManager.stop
       logger.debug("Stopped minio_runner.")
+      @@started = false
     end
 
     def reset_config!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minio_runner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Martin Brennan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: syntax_tree
@@ -156,6 +156,7 @@ files:
 - lib/minio_runner/mc_binary.rb
 - lib/minio_runner/mc_manager.rb
 - lib/minio_runner/minio_binary.rb
+- lib/minio_runner/minio_health_check.rb
 - lib/minio_runner/minio_server_manager.rb
 - lib/minio_runner/network.rb
 - lib/minio_runner/system.rb