dory 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49a33137371df2a16e439572e7089d10516ae490
-  data.tar.gz: 6a4b080407d2e8a6bbb5d6b8097f395c2aa79fad
+  metadata.gz: 453ef08977df972322e1995689d8b358cb6f345d
+  data.tar.gz: 40e16950427429b82d877302f465183f71ced5b8
 SHA512:
-  metadata.gz: 3dbe85b3861e2ff536c0039d99c8c5447b41d7b337623f8fbe4bc0c1b51b686cb7b82f45c7d153cefb0462662d1535e23eb2019e0ebc7e2908b89635f4fdb61b
-  data.tar.gz: 0ba2bdcd799e4cfe2537f860283b57c21d3fad48d67a69913e8bbef8bb94a70acfcca1ad32d7c10389f756eb6172132f3c5d5de124a8a74761c88a0130ec4603
+  metadata.gz: 8d883026dd79a18d5ec040e4df9ff81fd055f4b517071eb1ebd936f250343f71063aa05f258a0f6db084a7287a746af97a2bc457e2a4daa2b85e91f473a1e13a
+  data.tar.gz: d35f5e27adebcca7de68609ab7dab69e8aae9fc31705c40441a3c4f6c753d21beda006bfd5fb335b29b0a301bb7ada397f62e3c295319096812136dda2fe1400

data/lib/dory/config.rb

@@ -20,13 +20,19 @@ module Dory
           # doesn't exist.
           dnsmasq:
             enabled: true
-            domains:              # array of domains that will be resolved to the specified address
+            domains:               # array of domains that will be resolved to the specified address
               - domain: docker     # you can set '#' for a wilcard
                 address: 127.0.0.1 # return for queries against the domain
               - domain: dev
                 address: 127.0.0.1
             container_name: dory_dnsmasq
             port: 53  # port to listen for dns requests on.  must be 53 on linux. can be anything that's open on macos
+            # kill_others: kill processes bound to the port we need (see previous setting 'port')
+            #   Possible values:
+            #     ask (prompt about killing each time. User can accept/reject)
+            #     yes|true (go aheand and kill without asking)
+            #     no|false (don't kill, and don't even ask)
+            kill_others: ask
           nginx_proxy:
             enabled: true
             container_name: dory_dinghy_http_proxy
@@ -88,6 +94,9 @@ module Dory
         newsettings[:dory][:dnsmasq].delete(:address)
       end
 
+      # Add the option to skip prompts
+      newsettings[:dory][:dnsmasq][:kill_others] = 'ask'
+
       newsettings
     end
   end

data/lib/dory/dnsmasq.rb

@@ -4,7 +4,11 @@ module Dory
   class Dnsmasq
     extend Dory::DockerService
 
+    #
+    # I really hate these globals.  It would be great to refactor these out
+    #
     @@first_attempt_failed = false
+    @@handle_systemd_services = false
 
     def self.dnsmasq_image_name
       'freedomben/dory-dnsmasq:1.1.0'
@@ -15,11 +19,15 @@ module Dory
 
       # we don't want to hassle the user with checking the port unless necessary
       if @@first_attempt_failed
+        @@handle_systemd_services = self.has_systemd? && self.has_services_that_block_dnsmasq?
+        self.down_systemd_services if @@handle_systemd_services
+
         puts "[DEBUG] First attempt failed.  Checking port #{self.port}" if Dory::Config.debug?
         listener_list = self.check_port(self.port)
         unless listener_list.empty?
           return self.offer_to_kill(listener_list)
         end
+
         return false
       else
         puts "[DEBUG] Skipping preconditions on first run" if Dory::Config.debug?
@@ -27,6 +35,11 @@ module Dory
       end
     end
 
+    def self.run_postconditions
+      puts "[DEBUG] dnsmasq service running postconditions" if Dory::Config.debug?
+      self.up_systemd_services if @@handle_systemd_services
+    end
+
     def self.handle_error(command_output)
       puts "[DEBUG] handling dnsmasq start error" if Dory::Config.debug?
       # If we've already tried to handle failure, prevent infinite recursion
@@ -44,7 +57,7 @@ module Dory
     end
 
     def self.ip_from_dinghy?
-      Dory::Dinghy.match?(self.address(self.old_address)) || 
+      Dory::Dinghy.match?(self.address(self.old_address)) ||
         self.domains.any?{ |domain| Dory::Dinghy.match?(self.address(domain[:address])) }
     end
 
@@ -120,20 +133,118 @@ module Dory
 
     def self.offer_to_kill(listener_list, answer: nil)
       listener_list.each do |process|
-        puts "Process '#{process.command}' with PID '#{process.pid}' is listening on #{process.node} port #{self.port}."
+        puts "Process '#{process.command}' with PID '#{process.pid}' is listening on #{process.node} port #{self.port}.".yellow
       end
       pids = listener_list.uniq(&:pid).map(&:pid)
       pidstr = pids.join(' and ')
-      print "This interferes with Dory's dnsmasq container.  Would you like me to kill PID #{pidstr}? (Y/N): "
-      conf = answer ? answer : ENV['DORY_KILL_DNSMASQ']
+      print "This interferes with Dory's dnsmasq container.  Would you like me to kill PID #{pidstr}? (Y/N): ".yellow
+      conf = answer ? answer : answer_from_settings
       conf = STDIN.gets.chomp unless conf
       if conf =~ /y/i
-        puts "Requesting sudo to kill PID #{pidstr}"
+        puts "Requesting sudo to kill PID #{pidstr}".green
         return Sh.run_command("sudo kill #{pids.join(' ')}").success?
       else
         puts "OK, not killing PID #{pidstr}.  Please kill manually and try starting dory again.".red
         return false
       end
     end
+
+    def self.has_systemd?
+      Sh.run_command('which systemctl').success?
+    end
+
+    def self.systemd_service_installed?(service)
+      !(Sh.run_command("systemctl status #{service} | head -1").stdout =~ /unit.*not.*found/i)
+    end
+
+    def self.services_that_block_dnsmasq
+      %w[
+        NetworkManager.service
+        systemd-resolved.service
+      ]
+    end
+
+    def self.has_services_that_block_dnsmasq?
+      !self.enabled_services_that_block_dnsmasq.empty?
+    end
+
+    def self.enabled_services_that_block_dnsmasq
+      self.services_that_block_dnsmasq.select do |service|
+        self.systemd_service_installed?(service)
+      end
+    end
+
+    def self.down_systemd_services
+      puts "[DEBUG] Putting systemd services down" if Dory::Config.debug?
+
+      services = self.enabled_services_that_block_dnsmasq
+      conf = if ask_about_killing?
+               puts "You have some systemd services running that will race against us \n" \
+                    "to bind to port 53 (and usually they win):".yellow
+               puts "\n     #{services.join(', ')}\n".yellow
+               puts "If we don't stop these services temporarily while putting up the \n" \
+                    "dnsmasq container, starting it will likely fail.".yellow
+               print "Would you like me to put them down while we start dns \n" \
+                     "(I'll put them back up when finished)? (Y/N): ".yellow
+               STDIN.gets.chomp
+             else
+               answer_from_settings
+             end
+      @@handle_systemd_services = conf =~ /y/i
+      if @@handle_systemd_services
+        if services.all? { |service|
+          self.set_systemd_service(service: service, up: false)
+        }
+          puts "Putting down services succeeded".green
+        else
+          puts "One or more services failed to go down".red
+        end
+      else
+        puts 'OK, not putting down the services'.yellow
+      end
+    end
+
+    def self.up_systemd_services
+      if @@handle_systemd_services
+        puts "[DEBUG] Putting systemd services back up" if Dory::Config.debug?
+        services = self.enabled_services_that_block_dnsmasq
+        if services.reverse.all? { |service|
+          self.set_systemd_service(service: service, up: true)
+        }
+          puts "#{services.join(', ')} were successfully restarted".green
+        else
+          puts "#{services.join(', ')} failed to restart".red
+        end
+      else
+        puts "[DEBUG] Not putting systemd services back up cause skipped " if Dory::Config.debug?
+      end
+    end
+
+    def self.set_systemd_service(service:, up:)
+      action = up ? 'start' : 'stop'
+      puts "Requesting sudo to #{action} #{service}".green
+      Sh.run_command("sudo systemctl #{action} #{service}").success?
+    end
+
+    def self.ask_about_killing?
+      !self.answer_from_settings
+    end
+
+    def self.kill_others
+      Dory::Config.settings[:dory][:dnsmasq][:kill_others]
+    end
+
+    def self.answer_from_settings
+      # This `== true` is important because kill_others could be
+      # 'no' which would be a truthy value despite the fact that it
+      # should be falsey
+      if self.kill_others == true || self.kill_others =~ /yes/i
+        'Y'
+      elsif self.kill_others == false || self.kill_others =~ /no/i
+        'N'
+      else
+        nil
+      end
+    end
   end
 end

data/lib/dory/docker_service.rb

@@ -16,6 +16,11 @@ module Dory
       return true
     end
 
+    def run_postconditions
+      # Override if postconditions are needed
+      return true
+    end
+
     def handle_error(command_output)
       # Override to provide error handling
       return false
@@ -28,26 +33,10 @@ module Dory
         end
       else
         if docker_installed?
+          self.delete_container_if_exists
           self.run_preconditions
-          if self.container_exists?
-            puts "[DEBUG] Container '#{self.container_name}' exists.  Deleting" if Dory::Config.debug?
-            self.delete
-          end
-          begin
-            if Dory::Config.debug?
-              puts "[DEBUG] '#{self.container_name}' does not exist.  Creating/starting " \
-                   "'#{self.container_name}' with '#{self.run_command}'"
-            end
-            status = Sh.run_command(self.run_command)
-            unless status.success?
-              if !handle_error || !self.handle_error(status)
-                puts "Failed to start docker container '#{self.container_name}' " \
-                     ".  Command '#{self.run_command}' failed".red
-              end
-            end
-          rescue DinghyError => e
-            puts e.message.red
-          end
+          self.execute_run_command(handle_error: handle_error)
+          self.run_postconditions
         else
           err_msg = "Docker does not appear to be installed /o\\\n" \
             "Docker is required for DNS and Nginx proxy.  These can be " \
@@ -93,5 +82,31 @@ module Dory
     def start_cmd
       "docker start #{Shellwords.escape(self.container_name)}"
     end
+
+    def delete_container_if_exists
+      if self.container_exists?
+        puts "[DEBUG] Container '#{self.container_name}' exists.  Deleting" if Dory::Config.debug?
+        self.delete
+      end
+    end
+
+    def execute_run_command(handle_error:)
+      begin
+        if Dory::Config.debug?
+          puts "[DEBUG] '#{self.container_name}' does not exist.  Creating/starting " \
+               "'#{self.container_name}' with '#{self.run_command}'"
+        end
+        status = Sh.run_command(self.run_command)
+        unless status.success?
+          if !handle_error || !self.handle_error(status)
+            puts "Failed to start docker container '#{self.container_name}' " \
+                 ".  Command '#{self.run_command}' failed".red
+          end
+        end
+      rescue Dory::Dinghy::DinghyError => e
+        puts e.message.red
+      end
+      status
+    end
   end
 end

data/lib/dory/version.rb

@@ -1,4 +1,4 @@
 module Dory
-  VERSION = '0.4.2'
-  DATE    = '2016-02-08'
+  VERSION = '0.5.0'
+  DATE    = '2016-02-13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dory
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize