akaer 0.3.0 → 1.0.0

data/lib/akaer/configuration.rb

@@ -5,37 +5,52 @@
 #
 
 module Akaer
-  class Configuration < Hashie::Dash
+  # This class holds the configuration of the applicaton.
+  class Configuration < Bovem::Configuration
+    # The default interface to manage. Default: `lo0`.
     property :interface, :default => "lo0"
+
+    # The default list of aliases to add. Default: `[]`.
     property :addresses, :default => []
+
+    # The starting address for sequential aliases. Default: `10.0.0.1`.
     property :start_address, :default => "10.0.0.1"
+
+    # The number of aliases to add. Default: `5`.
     property :aliases, :default => 5
+
+    # The command to run for adding an alias. Default: `sudo ifconfig @INTERFACE@ alias @ALIAS@`.
+    property :add_command, :default => "sudo ifconfig @INTERFACE@ alias @ALIAS@"
+
+    # The command to run for removing an alias. Default: `sudo ifconfig @INTERFACE@ alias @ALIAS@`.
+    property :remove_command, :default => "sudo ifconfig @INTERFACE@ -alias @ALIAS@"
+
+    # The file to log to. Default is the standard output.
     property :log_file, :default => "STDOUT"
+
+    # The minimum severity to log. Default: `Logger::INFO`.
     property :log_level, :default => Logger::INFO
 
-    def self.load(file = nil, logger = nil)
-      if logger.blank? then
-        logger ||= Akaer::Logger.new($stderr)
-        logger.level = Logger::INFO
-      end
-
-      rv = self.new
-      if file.present? then
-        begin
-          # Open the file
-          path = Pathname.new(File.expand_path(file)).realpath
-          logger.debug("Using configuration file #{path}.")
-
-          rv.tap do |config|
-            eval(File.read(path))
-          end
-        rescue Errno::ENOENT, LoadError
-        rescue Exception
-          raise Akaer::Errors::InvalidConfiguration.new("Config file #{file.bright} is not valid.")
-        end
-      end
-
-      rv
+    # Only show which modifications will be done.
+    property :dry_run, :default => false
+
+    # Do not show any message.
+    property :quiet, :default => false
+
+    # Creates a new configuration.
+    #
+    # @param file [String] The file to read.
+    # @param overrides [Hash] A set of values which override those set in the configuration file.
+    # @param logger [Logger] The logger to use for notifications.
+    def initialize(file = nil, overrides = {}, logger = nil)
+      super(file, overrides, logger)
+
+      # Make sure some arguments are of correct type
+      self.log_file = $stdout if self.log_file == "STDOUT"
+      self.log_file = $stderr if self.log_file == "STDERR"
+      self.addresses = self.addresses.ensure_array
+      self.aliases = self.aliases.to_integer
+      self.log_level = self.log_level.to_integer
     end
   end
 end

data/lib/akaer/version.rb

@@ -5,11 +5,20 @@
 #
 
 module Akaer
+  # The current version of lazier, according to semantic versioning.
+  #
+  # @see http://semver.org
   module Version
-    MAJOR = 0
-    MINOR = 3
+    # The major version.
+    MAJOR = 1
+
+    # The minor version.
+    MINOR = 0
+
+    # The patch version.
     PATCH = 0
 
+    # The current version of akaer.
     STRING = [MAJOR, MINOR, PATCH].compact.join(".")
   end
 end

data/spec/akaer/application_spec.rb

@@ -7,5 +7,315 @@
 require "spec_helper"
 
 describe Akaer::Application do
-  pending "To all."
+  before(:each) do
+    Bovem::Logger.stub(:default_file).and_return("/dev/null")
+  end
+
+  let(:log_file) { "/dev/null" }
+  let(:application){ Akaer::Application.instance({:"log-file" => log_file}, true) }
+  let(:launch_agent_path) { "/tmp/akaer-test-agent-#{Time.now.strftime("%Y%m%d-%H%M%S")}" }
+
+  describe "#initialize" do
+    it("should setup the logger") do
+      expect(application.logger).not_to be_nil
+    end
+
+    it("should setup the configuration") do
+      expect(application.config).not_to be_nil
+    end
+
+    it("should abort with an invalid configuration") do
+      path = "/tmp/akaer-test-#{Time.now.strftime("%Y%m%d-%H:%M:%S")}"
+      file = ::File.new(path, "w")
+      file.write("config.aliases = ")
+      file.close
+
+      expect { Akaer::Application.new({:config => file.path, :"log-file" => log_file}) }.to raise_error(::SystemExit)
+      ::File.unlink(path)
+    end
+  end
+
+  describe "#launch_agent_path" do
+    it "should return the agent file with a default name" do
+      expect(application.launch_agent_path).to eq(ENV["HOME"] + "/Library/LaunchAgents/it.cowtech.akaer.plist")
+    end
+
+    it "should return the agent file with a specified name" do
+      expect(application.launch_agent_path("foo")).to eq(ENV["HOME"] + "/Library/LaunchAgents/foo.plist")
+    end
+  end
+
+  describe "#pad_number" do
+    it "correctly pads numbers" do
+      expect(application.pad_number(3)).to eq("03")
+      expect(application.pad_number(300)).to eq("300")
+      expect(application.pad_number(3, 3)).to eq("003")
+      expect(application.pad_number(nil)).to eq("00")
+      expect(application.pad_number(3, -3)).to eq("03")
+      expect(application.pad_number(3, "A")).to eq("03")
+    end
+  end
+
+  describe "#is_ipv4?" do
+    it "correctly detects valid IPv4 address" do
+      expect(application.is_ipv4?("10.0.0.1")).to be_true
+      expect(application.is_ipv4?("255.0.0.1")).to be_true
+      expect(application.is_ipv4?("192.168.0.1")).to be_true
+    end
+
+    it "rejects other values" do
+      expect(application.is_ipv4?("10.0.0.256")).to be_false
+      expect(application.is_ipv4?("10.0.0.-1")).to be_false
+      expect(application.is_ipv4?("::1")).to be_false
+      expect(application.is_ipv4?("INVALID")).to be_false
+      expect(application.is_ipv4?(nil)).to be_false
+    end
+  end
+
+  describe "#is_ipv6?" do
+    it "correctly detects valid IPv4 address" do
+      expect(application.is_ipv6?("2001:0db8:0000:0000:0000:1428:57ab")).to be_true
+      expect(application.is_ipv6?("2001:0db8:0:000:00:1428:57ab")).to be_true
+      expect(application.is_ipv6?("2001:0db8:0::1428:57ab")).to be_true
+      expect(application.is_ipv6?("2001::")).to be_true
+      expect(application.is_ipv6?("::1")).to be_true
+      expect(application.is_ipv6?("::2:1")).to be_true
+      expect(application.is_ipv6?("2011::10.0.0.1")).to be_true
+      expect(application.is_ipv6?("2011::0:10.0.0.1")).to be_true
+    end
+
+    it "rejects other values" do
+      expect(application.is_ipv6?("::H")).to be_false
+      expect(application.is_ipv6?("192.168.0.256")).to be_false
+      expect(application.is_ipv6?("INVALID")).to be_false
+      expect(application.is_ipv6?(nil)).to be_false
+    end
+  end
+
+  describe "#compute_addresses" do
+    describe "should use only the explicit list if given" do
+      let(:other_application){ Akaer::Application.new({:"log-file" => log_file, :addresses => ["10.0.0.1", "::1", "INVALID 1", "10.0.0.2", "INVALID 2", "2001:0db8:0::0:1428:57ab"]}) }
+
+      it "considering all address" do
+        expect(other_application.compute_addresses).to eq(["10.0.0.1", "::1", "10.0.0.2", "2001:0db8:0::0:1428:57ab"])
+      end
+
+      it "considering only IPv4" do
+        expect(other_application.compute_addresses(:ipv4)).to eq(["10.0.0.1", "10.0.0.2"])
+        expect(Akaer::Application.new({:"log-file" => log_file, :addresses => ["::1", "INVALID 1"]}).compute_addresses(:ipv4)).to eq([])
+      end
+
+      it "considering only IPv6" do
+        expect(other_application.compute_addresses(:ipv6)).to eq(["::1", "2001:0db8:0::0:1428:57ab"])
+        expect(Akaer::Application.new({:"log-file" => log_file, :addresses => ["10.0.0.1", "INVALID 1"]}).compute_addresses(:ipv6)).to eq([])
+      end
+    end
+
+    describe "should compute a sequential list of address" do
+      it "considering all address" do
+        expect(Akaer::Application.new({:"log-file" => log_file, :"start-address" => "10.0.1.1"}).compute_addresses).to eq(["10.0.1.1", "10.0.1.2", "10.0.1.3", "10.0.1.4", "10.0.1.5"])
+        expect(Akaer::Application.new({:"log-file" => log_file, :aliases => 3}).compute_addresses).to eq(["10.0.0.1", "10.0.0.2", "10.0.0.3"])
+        expect(Akaer::Application.new({:"log-file" => log_file, :"start-address" => "10.0.1.1", :aliases => -1}).compute_addresses).to eq(["10.0.1.1", "10.0.1.2", "10.0.1.3", "10.0.1.4", "10.0.1.5"])
+      end
+
+      it "considering only IPv4" do
+        expect(Akaer::Application.new({:"log-file" => log_file, :"start-address" => "::1"}).compute_addresses(:ipv4)).to eq([])
+      end
+
+      it "considering only IPv6" do
+        expect(Akaer::Application.new({:"log-file" => log_file, :"start-address" => "10.0.0.1"}).compute_addresses(:ipv6)).to eq([])
+      end
+    end
+  end
+
+  describe "#execute_command" do
+    it "should forward to system" do
+      Kernel.should_receive("system")
+      application.execute_command("echo OK")
+    end
+  end
+
+  describe "#manage" do
+    it "should show a right message to the user" do
+      application.logger.should_receive(:info).with(/.+.*03.*\/.*05.*.+ *Adding.* address .*10.0.0.3.* to interface .*lo0.*/)
+      application.manage(:add, "10.0.0.3")
+
+      application.logger.should_receive(:info).with(/.+.*03.*\/.*05.*.+ *Removing.* address .*10.0.0.3.* from interface .*lo0.*/)
+      application.manage(:remove, "10.0.0.3")
+    end
+
+    it "should call the right system command" do
+      application.should_receive(:execute_command).with("sudo ifconfig lo0 alias 10.0.0.3 > /dev/null 2>&1")
+      application.manage(:add, "10.0.0.3")
+
+      application.should_receive(:execute_command).with("sudo ifconfig lo0 -alias 10.0.0.3 > /dev/null 2>&1")
+      application.manage(:remove, "10.0.0.3")
+    end
+
+    it "should return true if the command succeded" do
+      other_application = Akaer::Application.new({:"add-command" => "echo @INTERFACE@", :quiet => true})
+      expect(other_application.manage(:add, "10.0.0.3")).to be_true
+    end
+
+    it "should return false if the command failed" do
+      expect(application.manage(:add, "10.0.0.256")).to be_false
+    end
+
+    it "should respect dry-run mode" do
+      other_application = Akaer::Application.new({:"log-file" => log_file, :"dry-run" => true})
+
+      other_application.logger.should_receive(:info).with(/.+.*03.*\/.*05.*.+ I will .*add.* address .*10.0.0.3.* to interface .*lo0.*/)
+      other_application.should_not_receive(:execute_command)
+      other_application.manage(:add, "10.0.0.3")
+
+      other_application.logger.should_receive(:info).with(/.+.*03.*\/.*05.*.+ I will .*remove.* address .*10.0.0.3.* from interface .*lo0.*/)
+      other_application.should_not_receive(:execute_command)
+      other_application.manage(:remove, "10.0.0.3")
+    end
+  end
+
+
+  describe "#action_add" do
+    it("should compute addresses to manage") do
+      application.should_receive(:compute_addresses)
+      application.action_add
+    end
+
+    it("should call #manage for every command") do
+      application.stub(:manage) do |operation, address|
+        address !~ /3$/
+      end
+
+      application.should_receive(:manage).at_most(application.compute_addresses.length).with(:add, /.+/)
+      application.action_add
+    end
+
+    it("should show an error there's no address to manage") do
+      application.stub(:compute_addresses).and_return([])
+      other_application = Akaer::Application.new({:"log-file" => log_file, :quiet => true})
+      other_application.stub(:compute_addresses).and_return([])
+
+      application.logger.should_receive(:error).with("No valid addresses to add to the interface found.")
+      application.action_add
+      other_application.logger.should_not_receive(:error)
+      other_application.action_add
+    end
+  end
+
+  describe "#action_remove" do
+    it("should compute addresses to manage") do
+      application.should_receive(:compute_addresses)
+      application.action_remove
+    end
+
+    it("should call #manage for every command") do
+      application.stub(:manage) do |operation, address|
+        address !~ /3$/
+      end
+
+      application.should_receive(:manage).at_most(application.compute_addresses.length).with(:remove, /.+/)
+      application.action_remove
+    end
+
+    it("should show an error there's no address to manage") do
+      application.stub(:compute_addresses).and_return([])
+      other_application = Akaer::Application.new({:"log-file" => log_file, :quiet => true})
+      other_application.stub(:compute_addresses).and_return([])
+
+      application.logger.should_receive(:error).with("No valid addresses to remove from the interface found.")
+      application.action_remove
+      other_application.logger.should_not_receive(:error)
+      other_application.action_remove
+    end
+  end
+
+  describe "#action_install" do
+    if ::Config::CONFIG['host_os'] =~ /^darwin/ then
+      it "should create the agent" do
+        application.stub(:launch_agent_path).and_return(launch_agent_path)
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+
+        application.action_install
+        expect(::File.exists?(application.launch_agent_path)).to be_true
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+      end
+
+      it "should not create and invalid agent" do
+        application.stub(:launch_agent_path).and_return("/invalid/agent")
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+
+        application.logger.should_receive(:error).with("Cannot create the launch agent.")
+        application.action_install
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+      end
+
+      it "should not load an invalid agent" do
+        application.stub(:execute_command) do |command|
+          command =~ /^launchctl/ ? raise(StandardError) : system(command)
+        end
+
+        application.stub(:launch_agent_path).and_return(launch_agent_path)
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+
+        application.logger.should_receive(:error).with("Cannot load the launch agent.")
+        application.action_install
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+      end
+    end
+
+    it "should raise an exception if not running on OSX" do
+      application.stub(:is_osx?).and_return(false)
+      application.logger.should_receive(:fatal).with("Install akaer on autolaunch is only available on MacOSX.")
+      expect(application.action_install).to be_false
+    end
+  end
+
+  describe "#action_uninstall" do
+    if ::Config::CONFIG['host_os'] =~ /^darwin/ then
+      it "should remove the agent" do
+        application.stub(:launch_agent_path).and_return(launch_agent_path)
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+
+        Bovem::Logger.stub(:default_file).and_return($stdout)
+        application.action_install
+        application.action_uninstall
+        expect(::File.exists?(application.launch_agent_path)).to be_false
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+      end
+
+      it "should not load delete an invalid resolver" do
+        application.stub(:launch_agent_path).and_return("/invalid/agent")
+
+        application.action_install
+        application.logger.should_receive(:warn).at_least(1)
+        application.action_uninstall
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+      end
+
+      it "should not delete an invalid agent" do
+        application.stub(:launch_agent_path).and_return("/invalid/agent")
+
+        application.action_install
+        application.logger.should_receive(:warn).at_least(1)
+        application.action_uninstall
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+      end
+
+      it "should not load delete invalid agent" do
+        application.stub(:launch_agent_path).and_return("/invalid/agent")
+
+        application.action_install
+        application.stub(:execute_command).and_raise(StandardError)
+        application.logger.should_receive(:warn).at_least(1)
+        application.action_uninstall
+        ::File.unlink(application.launch_agent_path) if ::File.exists?(application.launch_agent_path)
+      end
+    end
+
+    it "should raise an exception if not running on OSX" do
+      application.stub(:is_osx?).and_return(false)
+      application.logger.should_receive(:fatal).with("Install akaer on autolaunch is only available on MacOSX.")
+      expect(application.action_uninstall).to be_false
+    end
+  end
 end

data/spec/akaer/configuration_spec.rb

@@ -7,5 +7,17 @@
 require "spec_helper"
 
 describe Akaer::Configuration do
-  pending "To all."
+  describe "#initialize" do
+    it "sets default arguments and rules" do
+      config = Akaer::Configuration.new
+      expect(config.interface).to eq("lo0")
+      expect(config.addresses).to eq([])
+      expect(config.start_address).to eq("10.0.0.1")
+      expect(config.aliases).to eq(5)
+      expect(config.add_command).to eq("sudo ifconfig @INTERFACE@ alias @ALIAS@")
+      expect(config.remove_command).to eq("sudo ifconfig @INTERFACE@ -alias @ALIAS@")
+      expect(config.log_file).to eq($stdout)
+      expect(config.log_level).to eq(Logger::INFO)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -7,4 +7,10 @@
 require "rubygems"
 require "bundler/setup"
 require "coverage_helper"
-require "akaer"
+require "akaer"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: akaer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,32 +9,32 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2012-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cowtech-extensions
+  name: bovem
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: cowtech-lib
+  name: gli
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,39 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: rainbow
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,33 +96,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.10
-- !ruby/object:Gem::Dependency
-  name: net-dns
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -223,12 +175,9 @@ files:
 - lib/akaer.rb
 - lib/akaer/application.rb
 - lib/akaer/configuration.rb
-- lib/akaer/errors.rb
-- lib/akaer/logger.rb
 - lib/akaer/version.rb
 - spec/akaer/application_spec.rb
 - spec/akaer/configuration_spec.rb
-- spec/akaer/logger_spec.rb
 - spec/coverage_helper.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ShogunPanda/akaer
@@ -245,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4554862059516849580
+      hash: -4081054337891207421
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -254,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4554862059516849580
+      hash: -4081054337891207421
 requirements: []
 rubyforge_project: akaer
 rubygems_version: 1.8.24
@@ -264,7 +213,6 @@ summary: A small utility to add aliases to network interfaces.
 test_files:
 - spec/akaer/application_spec.rb
 - spec/akaer/configuration_spec.rb
-- spec/akaer/logger_spec.rb
 - spec/coverage_helper.rb
 - spec/spec_helper.rb
 has_rdoc: