devdnsd 3.0.7 → 3.0.8

data/doc/_index.html

@@ -237,7 +237,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Mar  8 11:03:19 2014 by
+  Generated on Sat Mar  8 15:25:56 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/file.README.html

@@ -105,7 +105,7 @@
 
 <h2 id="configuration">Configuration</h2>
 
-<p>By defaults, DevDNSd uses a configuration file in <code>~/.devdnsd_config</code>, but you can change the path using the <code>--config</code> switch.</p>
+<p>By defaults, DevDNSd uses a configuration file in <code>~/.devdnsd/default.conf</code>, but you can change the path using the <code>--config</code> switch.</p>
 
 <p>The file is a plain Ruby file with a single <code>config</code> object that supports the following directives.</p>
 
@@ -166,7 +166,7 @@ This argument is ignored if you pass the block, as it assumes that the second ar
 </div></div>
 
     <div id="footer">
-  Generated on Sat Mar  8 11:03:19 2014 by
+  Generated on Sat Mar  8 15:25:56 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/index.html

@@ -105,7 +105,7 @@
 
 <h2 id="configuration">Configuration</h2>
 
-<p>By defaults, DevDNSd uses a configuration file in <code>~/.devdnsd_config</code>, but you can change the path using the <code>--config</code> switch.</p>
+<p>By defaults, DevDNSd uses a configuration file in <code>~/.devdnsd/default.conf</code>, but you can change the path using the <code>--config</code> switch.</p>
 
 <p>The file is a plain Ruby file with a single <code>config</code> object that supports the following directives.</p>
 
@@ -166,7 +166,7 @@ This argument is ignored if you pass the block, as it assumes that the second ar
 </div></div>
 
     <div id="footer">
-  Generated on Sat Mar  8 11:03:19 2014 by
+  Generated on Sat Mar  8 15:25:56 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Mar  8 11:03:19 2014 by
+  Generated on Sat Mar  8 15:25:56 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.1.0).
 </div>

data/lib/devdnsd/application.rb

@@ -73,7 +73,7 @@ module DevDNSd
       # @param command [String] The command to execute.
       # @return [Boolean] `true` if command succeeded, `false` otherwise.
       def execute_command(command)
-        system(command)
+        system("#{command} 2&>1 > /dev/null")
       end
 
       # Updates DNS cache.
@@ -81,7 +81,15 @@ module DevDNSd
       # @return [Boolean] `true` if command succeeded, `false` otherwise.
       def dns_update
         @logger.info(i18n.dns_update)
-        execute_command("dscacheutil -flushcache")
+
+        script = Tempfile.new("devdnsd-dns-cache-script")
+        script.write("dscacheutil -flushcache 2&>1 > /dev/null\n")
+        script.write("killall -9 mDNSResponder 2&>1 > /dev/null\n")
+        script.write("killall -9 mDNSResponderHelper 2&>1 > /dev/null\n")
+        script.close
+
+        Kernel.system("/usr/bin/osascript -e 'do shell script \"sh #{script.path}\" with administrator privileges' 2&>1 > /dev/null")
+        script.unlink
       end
 
       # Checks if we are running on MacOS X.
@@ -160,6 +168,8 @@ module DevDNSd
         # @return [Boolean] `true` if operation succeeded, `false` otherwise.
         def manage_installation(launch_agent, resolver_path, first_operation, second_operation, third_operation)
           rv = check_agent_available
+
+          logger.warn(replace_markers(i18n.admin_privileges_warning))
           rv = send(first_operation, launch_agent, resolver_path) if rv
           rv = send(second_operation, launch_agent, resolver_path) if rv
           rv = send(third_operation, launch_agent, resolver_path) if rv
@@ -203,33 +213,36 @@ module DevDNSd
         # @return [Boolean] `true` if operation succeeded, `false` otherwise.
         def create_resolver(_, resolver_path)
           begin
-            logger.info(i18n.resolver_creating(resolver_path))
+            logger.info(replace_markers(i18n.resolver_creating(resolver_path)))
 
-            ::File.open(resolver_path, "w") {|f|
-              f.write("nameserver 127.0.0.1\n")
-              f.write("port #{@config.port}")
-              f.flush
-            }
+            script = Tempfile.new("devdnsd-install-script")
+            script.write("mkdir -p '#{File.dirname(resolver_path)}'\n")
+            script.write("rm -rf '#{resolver_path}'\n")
+            script.write("echo 'nameserver 127.0.0.1\\nport #{@config.port}' >> '#{resolver_path}'")
+            script.close
 
+            Kernel.system("/usr/bin/osascript -e 'do shell script \"sh #{script.path}\" with administrator privileges' 2&>1 > /dev/null")
+            script.unlink
             true
-          rescue
+          rescue Exception
             logger.error(i18n.resolver_creating_error)
             false
           end
         end
 
-        # Writes a OSX resolver.
-        #
-        # @param resolver_path [String] The resolver path.
-        def write_resolver(resolver_path)
-        end
-
         # Deletes a OSX resolver.
         #
         # @param resolver_path [String] The resolver path.
         # @return [Boolean] `true` if operation succeeded, `false` otherwise.
         def delete_resolver(_, resolver_path)
-          delete_file(resolver_path, :resolver_deleting, :resolver_deleting_error)
+          begin
+            logger.info(i18n.resolver_deleting(resolver_path))
+            Kernel.system("/usr/bin/osascript -e 'do shell script \"rm #{resolver_path}\" with administrator privileges' 2&>1 > /dev/null")
+            true
+          rescue Exception
+            logger.warn(i18n.resolver_deleting_error)
+            false
+          end
         end
 
         # Creates a OSX system agent.
@@ -238,7 +251,7 @@ module DevDNSd
         # @return [Boolean] `true` if operation succeeded, `false` otherwise.
         def create_agent(launch_agent, _)
           begin
-            logger.info(i18n.agent_creating(launch_agent))
+            logger.info(replace_markers(i18n.agent_creating(launch_agent)))
             program, args = prepare_agent
 
             ::File.open(launch_agent, "w") {|f|
@@ -305,6 +318,14 @@ module DevDNSd
             false
           end
         end
+
+        # Replaces markers in a log message.
+        #
+        # @param message [String] The message to process.
+        # @return [String] The processed message.
+        def replace_markers(message)
+          @command.application.console.replace_markers(message)
+        end
     end
 
     # Methods to handle interfaces aliases.
@@ -464,7 +485,7 @@ module DevDNSd
           log_management(:run, prefix, type, locale.removing, locale.adding, address, config)
           rv = execute_command(command)
           labels = (type == :remove ? [locale.remove, locale.from] : [locale.add, locale.to])
-          @logger.error(@command.application.console.replace_markers(locale.general_error(labels[0], address, labels[1], config.interface))) if !rv
+          @logger.error(replace_markers(locale.general_error(labels[0], address, labels[1], config.interface))) if !rv
           rv
         end
 
@@ -480,7 +501,7 @@ module DevDNSd
         def log_management(message, prefix, type, remove_label, add_label, address, config)
           locale = i18n
           labels = (type == :remove ? [remove_label, locale.from] : [add_label, locale.to])
-          @logger.info(@command.application.console.replace_markers(i18n.send(message, prefix, labels[0], address, labels[1], config.interface)))
+          @logger.info(replace_markers(i18n.send(message, prefix, labels[0], address, labels[1], config.interface)))
         end
     end
 
@@ -624,7 +645,7 @@ module DevDNSd
       options = @command.application.get_options.reject {|_, v| v.nil? }
 
       # Setup logger
-      @logger = Bovem::Logger.create(Bovem::Logger.get_real_file(options["log_file"]) || Bovem::Logger.default_file, Logger::INFO)
+      create_logger(options)
 
       # Open configuration
       read_configuration(options)
@@ -687,18 +708,59 @@ module DevDNSd
     end
 
     private
+      # Creates a logger.
+      #
+      # @param options [Hash] The configuration to use.
+      def create_logger(options)
+        warn_failure = false
+        orig_file = file = Bovem::Logger.get_real_file(options["log_file"]) || Bovem::Logger.default_file
+
+        if file.is_a?(String) then
+          file = File.absolute_path(File.expand_path(file))
+
+          begin
+            FileUtils.mkdir_p(File.dirname(file))
+            @logger = Bovem::Logger.create(file, Logger::INFO)
+          rescue
+            file = $stdout
+            warn_failure = true
+          end
+        end
+
+        @logger = Bovem::Logger.create(file, Logger::INFO)
+        @logger.warn(replace_markers(i18n.logging_failed(orig_file))) if @logger && warn_failure
+        @logger
+      end
+
       # Reads configuration.
       #
       # @param options [Hash] The configuration to read.
       def read_configuration(options)
+        path = ::File.absolute_path(File.expand_path(options["configuration"]))
+
         begin
-          @config = DevDNSd::Configuration.new(options["configuration"], options, @logger)
+          @config = DevDNSd::Configuration.new(path, options, @logger)
+          ensure_directory_for(@config.log_file) if @config.log_file.is_a?(String)
+          ensure_directory_for(@config.pid_file)
+
           @logger = nil
           @logger = get_logger
         rescue Bovem::Errors::InvalidConfiguration => e
-          logger = Bovem::Logger.create("STDERR")
+          logger = Bovem::Logger.create($stderr)
           logger.fatal(e.message)
-          logger.warn(@command.application.console.replace_markers(i18n.application_create_config(options["configuration"])))
+          logger.warn(replace_markers(i18n.application_create_config(path)))
+          raise ::SystemExit
+        end
+      end
+
+      # Creates a folder for a file.
+      #
+      # @param [String] The path of the file.
+      def ensure_directory_for(path)
+        begin
+          FileUtils.mkdir_p(File.dirname(path))
+        rescue
+          @logger.warn(replace_markers(i18n.invalid_directory(File.dirname(path))))
           raise ::SystemExit
         end
       end

data/lib/devdnsd/configuration.rb

@@ -19,11 +19,11 @@ module DevDNSd
     # The TLD to manage. Default: `dev`.
     property :tld, default: "dev"
 
-    # The PID file to use. Default: `/var/run/devdnsd.pid`.
-    property :pid_file, default: "/var/log/devdnsd.pid"
+    # The PID file to use. Default: `~/.devdnsd/daemon.pid`.
+    property :pid_file, default: "~/.devdnsd/daemon.pid"
 
-    # The file to log to. Default: `/var/log/devdnsd.log`.
-    property :log_file, default: "/var/log/devdnsd.log"
+    # The file to log to. Default: `/var/log/daemon.log`.
+    property :log_file, default: "~/.devdnsd/daemon.log"
 
     # The minimum severity to log. Default: `Logger::INFO`.
     property :log_level, default: Logger::INFO
@@ -65,8 +65,13 @@ module DevDNSd
       super(file, overrides, logger)
 
       # Make sure some arguments are of correct type
-      self.log_file = $stdout if log_file == "STDOUT"
-      self.log_file = $stderr if log_file == "STDERR"
+      self.log_file = case log_file
+        when "STDOUT" then $stdout
+        when "STDERR" then $stderr
+        else File.absolute_path(File.expand_path(log_file))
+      end
+
+      self.pid_file = File.absolute_path(File.expand_path(pid_file))
       self.port = port.to_integer
       self.log_level = log_level.to_integer
 

data/lib/devdnsd/version.rb

@@ -16,7 +16,7 @@ module DevDNSd
     MINOR = 0
 
     # The patch version.
-    PATCH = 7
+    PATCH = 8
 
     # The current version number of DevDNSd.
     STRING = [MAJOR, MINOR, PATCH].compact.join(".")

data/lib/devdnsd.rb

@@ -12,6 +12,7 @@ require "mustache"
 require "ipaddr"
 require "fiber"
 require "plist"
+require "tempfile"
 
 Lazier.load!(:object)
 

data/locales/en.yml

@@ -17,6 +17,7 @@
     reply: "Reply is %1 with type %2."
     no_reply: "No reply found."
     no_agent: "Install DevDNSd as a local resolver is only available on MacOSX."
+    admin_privileges_warning: "Basing on your setup, the system might ask you up to twice to grant {mark=bright}osascript{/mark} application admin privileges."
     resolver_creating: "Creating the resolver in {mark=bright}%1{/mark} ..."
     resolver_creating_error: "Cannot create the resolver file."
     resolver_deleting: "Deleting the resolver %1 ..."
@@ -29,7 +30,8 @@
     agent_loading_error: "Cannot load the launch agent."
     agent_unloading: "Unloading the launch agent %1 ..."
     agent_unloading_error: "Cannot unload the launch agent."
-    logging_failed: "Cannot log to {mark=bright}%1{/mark}. Exiting..."
+    logging_failed: "Cannot log to {mark=bright}%1{/mark}. Logging to terminal..."
+    invalid_directory: "Cannot write on directory {mark=bright}%1{/mark}. Exiting..."
     application_description: "A small DNS server to enable local domain resolution."
     application_help_configuration: "The configuration file to use. Default is \"~/.devdnsd_config\"."
     application_help_tld: "The TLD to handle. Default is \"dev\"."

data/locales/it.yml

@@ -17,6 +17,7 @@
     reply: "La risposta è %1 con tipo %2."
     no_reply: "Nessuna risposta trovata."
     no_agent: "Installare DevDNSd come resolver locale è disponibile solo su MacOSX."
+    admin_privileges_warning: "In base alla tua configurazione, il sistema potrebbe chiederti fino a due volte di garantire all'applicazione {mark=bright}osascript{/mark} i privilegi di amministratore."
     resolver_creating: "Creo il resolver in {mark=bright}%1{/mark} ..."
     resolver_creating_error: "Impossible creare il file del resolver."
     resolver_deleting: "Cancello resolver %1 ..."
@@ -29,7 +30,8 @@
     agent_loading_error: "Impossibile avviare il launch agent."
     agent_unloading: "Fermo il launch agent %1 ..."
     agent_unloading_error: "Impossible fermare il launch agent."
-    logging_failed: "Impossibile eseguire il logging in {mark=bright}%1{/mark}. Esco..."
+    logging_failed: "Impossibile eseguire il logging in {mark=bright}%1{/mark}. Eseguo il logging nel terminale..."
+    invalid_directory: "Impossibile scrivere sulla directory {mark=bright}%1{/mark}. Esco..."
     application_description: "Un piccolo server DNS per abilitare la risoluzione di domini locali."
     application_help_configuration: "Il file di configurazione da usare. Il valore predefinito è \"~/.devdnsd_config\"."
     application_help_tld: "Il TLD da gestiere. Il valore predefinito è \"dev\"."

data/spec/devdnsd/application_spec.rb

@@ -17,7 +17,7 @@ describe DevDNSd::Application do
       option :configuration, [], {default: overrides["configuration"] || "/dev/null"}
       option :tld, [], {default: overrides["tld"] || "dev"}
       option :port, [], {type: Integer, default: overrides["port"] || 7771}
-      option :pid_file, [:P, "pid-file"], {type: String, default: "/var/run/devdnsd.pid"}
+      option :pid_file, [:P, "pid-file"], {type: String, default: overrides["pid_file"] || "/var/run/devdnsd.pid"}
       option :log_file, [:l, "log-file"], {default: overrides["log_file"] || "/dev/null"}
       option :log_level, [:L, "log-level"], {type: Integer, default: overrides["log_level"] || 1}
     }, :en)
@@ -35,6 +35,12 @@ describe DevDNSd::Application do
       expect(application.logger).not_to be_nil
     end
 
+    it "should fallback logger to STDOUT" do
+      allow_any_instance_of(DevDNSd::Application).to receive(:read_configuration)
+      expect(Bovem::Logger).to receive(:create).with($stdout, Logger::INFO)
+      create_application({"log_file" => "/invalid/logger"})
+    end
+
     it "should setup the configuration" do
       expect(application.config).not_to be_nil
     end
@@ -50,6 +56,12 @@ describe DevDNSd::Application do
       expect { create_application({"configuration" => file.path, "log_file" => log_file}) }.to raise_error(::SystemExit)
       ::File.unlink(path)
     end
+
+    it "should abort when the log file is invalid" do
+      allow_any_instance_of(Bovem::Logger).to receive(:fatal)
+      allow_any_instance_of(Bovem::Logger).to receive(:warn)
+      expect { create_application({"pid_file" => "/invalid/pid", "log_file" => log_file}) }.to raise_error(::SystemExit)
+    end
   end
 
   describe ".run" do
@@ -339,8 +351,8 @@ describe DevDNSd::Application do
 
   describe "#dns_update" do
     it "should update the DNS cache" do
-      allow(application).to receive(:execute_command).and_return("EXECUTED")
-      expect(application.dns_update).to eq("EXECUTED")
+      allow(Kernel).to receive(:system).and_return("EXECUTED")
+      application.dns_update
     end
   end
 
@@ -559,6 +571,7 @@ describe DevDNSd::Application do
     before(:each) do
       allow(application).to receive(:is_osx?).and_return(true)
       allow(application).to receive(:execute_command)
+      expect(Kernel).to receive(:system).at_least(1)
     end
 
     it "should create the resolver" do
@@ -567,6 +580,7 @@ describe DevDNSd::Application do
       ::File.unlink(application.resolver_path) if ::File.exists?(application.resolver_path)
       ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
 
+      allow(application).to receive(:create_resolver) {|_, path| FileUtils.touch(path) }
       application.action_install
       expect(::File.exists?(resolver_path)).to be_true
 
@@ -607,6 +621,8 @@ describe DevDNSd::Application do
       ::File.unlink(application.resolver_path) if ::File.exists?(application.resolver_path)
       ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
 
+      allow(application).to receive(:create_agent).and_return(true)
+      expect_any_instance_of(R18n::Translation).to receive(:resolver_creating).and_raise(ArgumentError)
       expect(application.logger).to receive(:error).with("Cannot create the resolver file.")
       application.action_install
 
@@ -655,6 +671,7 @@ describe DevDNSd::Application do
     before(:each) do
       allow(application).to receive(:is_osx?).and_return(true)
       allow(application).to receive(:execute_command)
+      expect(Kernel).to receive(:system).at_least(1)
     end
 
     it "should remove the resolver" do
@@ -671,6 +688,23 @@ describe DevDNSd::Application do
       ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
     end
 
+    it "should not remove an invalid resolver" do
+      allow(application).to receive(:resolver_path).and_return("/invalid/resolver")
+      allow(application).to receive(:launch_agent_path).and_return("/invalid/agent")
+      ::File.unlink(application.resolver_path) if ::File.exists?(application.resolver_path)
+      ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+
+      allow(application).to receive(:unload_agent).and_return(true)
+      expect_any_instance_of(R18n::Translation).to receive(:resolver_deleting).and_raise(ArgumentError)
+      expect(application.logger).to receive(:warn)
+      expect(application.logger).to receive(:warn).with("Cannot delete the resolver file.")
+
+      application.action_uninstall
+
+      ::File.unlink(application.resolver_path) if ::File.exists?(application.resolver_path)
+      ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+    end
+
     it "should remove the agent" do
       allow(application).to receive(:resolver_path).and_return(resolver_path)
       allow(application).to receive(:launch_agent_path).and_return(launch_agent_path)

data/spec/devdnsd/configuration_spec.rb

@@ -14,11 +14,16 @@ describe DevDNSd::Configuration do
       expect(config.address).to eq("0.0.0.0")
       expect(config.port).to eq(7771)
       expect(config.tld).to eq("dev")
-      expect(config.log_file).to eq("/var/log/devdnsd.log")
+      expect(config.log_file).to eq(File.absolute_path(File.expand_path("~/.devdnsd/daemon.log")))
       expect(config.log_level).to eq(::Logger::INFO)
       expect(config.rules.count).to eq(1)
       expect(config.foreground).to eq(false)
     end
+
+    it "should log to standard output or standard error" do
+      expect(DevDNSd::Configuration.new(nil, log_file: "STDOUT").log_file).to eq($stdout)
+      expect(DevDNSd::Configuration.new(nil, log_file: "STDERR").log_file).to eq($stderr)
+    end
   end
 
   describe "#add_rule" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devdnsd
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 3.0.8
 platform: ruby
 authors:
 - Shogun
@@ -82,6 +82,7 @@ files:
 - ".travis-gemfile"
 - ".travis.yml"
 - ".yardopts"
+- '1'
 - CHANGELOG.md
 - Gemfile
 - README.md