invoker 0.1.2 → 1.0.0

data/lib/invoker/power/config.rb

@@ -0,0 +1,53 @@
+require "yaml"
+module Invoker
+  module Power
+    # Save and Load Invoker::Power config
+    class ConfigExists < StandardError; end
+    class Config
+      CONFIG_LOCATION = File.join(ENV['HOME'], ".invoker")
+      def self.has_config?
+        File.exists?(CONFIG_LOCATION)
+      end
+
+      def self.create(options = {})
+        if has_config?
+          raise ConfigExists, "Config file already exists at location #{CONFIG_LOCATION}"
+        end
+        config = new(options)
+        config.save
+      end
+
+      def initialize(options = {})
+        @config = options
+      end
+
+      def self.load_config
+        config_hash = File.open(CONFIG_LOCATION, "r") { |fl| YAML.load(fl) }
+        new(config_hash)
+      end
+
+      def dns_port=(dns_port)
+        @config[:dns_port] = dns_port
+      end
+
+      def http_port=(http_port)
+        @config[:http_port] = http_port
+      end
+
+      def ipfw_rule_number=(ipfw_rule_number)
+        @config[:ipfw_rule_number] = ipfw_rule_number
+      end
+
+      def dns_port; @config[:dns_port]; end
+      def http_port; @config[:http_port]; end
+      def ipfw_rule_number; @config[:ipfw_rule_number]; end
+
+      def save
+        File.open(CONFIG_LOCATION, "w") do |fl|
+          YAML.dump(@config, fl)
+        end
+        self
+      end
+    end
+  end
+end

data/lib/invoker/power/dns.rb

@@ -0,0 +1,37 @@
+require "logger"
+
+module Invoker
+
+  module Power
+
+    class DNS
+      IN = Resolv::DNS::Resource::IN
+      def self.server_ports
+        [
+          [:udp, '127.0.0.1', Invoker::CONFIG.dns_port],
+          [:tcp, '127.0.0.1', Invoker::CONFIG.dns_port]
+        ]
+      end
+
+      def self.run_dns
+        RubyDNS::run_server(:listen => server_ports) do
+          on(:start) do
+            @logger.level = ::Logger::WARN
+          end
+
+          # For this exact address record, return an IP address
+          match(/.*\.dev/, IN::A) do |transaction|
+            transaction.respond!("127.0.0.1")
+          end
+
+          # Default DNS handler
+          otherwise do |transaction|
+            transaction.failure!(:NXDomain)
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/invoker/power/port_finder.rb

@@ -0,0 +1,49 @@
+module Invoker
+  module Power
+    class PortFinder
+      STARTING_PORT = 23400
+      attr_accessor :dns_port, :http_port, :starting_port
+      def initialize
+        @starting_port = STARTING_PORT
+        @ports = []
+        @dns_port = nil
+        @http_port = nil
+      end
+
+      def find_ports
+        STARTING_PORT.upto(STARTING_PORT + 100) do |port|
+          break if @ports.size > 2
+          if check_if_port_is_open(port)
+            @ports << port
+          else
+            next
+          end
+        end
+        @dns_port = @ports[0]
+        @http_port = @ports[1]
+      end
+
+      private
+      def check_if_port_is_open(port)
+        socket_flag = true
+        sockets = nil
+        begin
+          sockets = Socket.tcp_server_sockets(port)
+          socket_flag = false if sockets.size <= 1
+        rescue Errno::EADDRINUSE
+          socket_flag = false
+        end
+        sockets && close_socket_pairs(sockets)
+        socket_flag
+      end
+
+      def close_socket_pairs(sockets)
+        sockets.each { |s| s.close }
+      rescue
+        nil
+      end
+
+
+    end
+  end
+end

data/lib/invoker/power/powerup.rb

@@ -0,0 +1,26 @@
+module Invoker
+  # power is really a stupid pun on pow.
+  module Power
+    class Powerup
+      def self.fork_and_start
+        powerup = new()
+        fork { powerup.run }
+      end
+
+      def run
+        EM.epoll
+        EM.run {
+          trap("TERM") { stop }
+          trap("INT") { stop }
+          DNS.run_dns()
+          Balancer.run()
+        }
+      end
+
+      def stop
+        Invoker::Logger.puts "Terminating Proxy/Server"
+        EventMachine.stop
+      end
+    end
+  end
+end

data/lib/invoker/power/setup.rb

@@ -0,0 +1,134 @@
+require "highline/import"
+
+module Invoker
+  module Power
+    class Setup
+      RESOLVER_FILE = "/etc/resolver/dev"
+      FIREWALL_PLIST_FILE = "/Library/LaunchDaemons/com.codemancers.invoker.firewall.plist"
+      def self.install
+        installer = new
+        unless installer.check_if_already_setup?
+          installer.setup_invoker
+        else
+          Invoker::Logger.puts("The setup has been already run.".color(:red))
+        end
+      end
+
+      def setup_invoker
+        if setup_resolver_file
+          find_open_ports
+          install_resolver(port_finder.dns_port)
+          install_firewall(port_finder.http_port)
+          flush_dns_rules()
+          # Before writing the config file, drop down to a normal user
+          drop_to_normal_user()
+          create_config_file()
+        else
+          Invoker::Logger.puts("Invoker is not configured to serve from subdomains".color(:red))
+        end
+        self
+      end
+
+      def drop_to_normal_user
+        EventMachine.set_effective_user(ENV["SUDO_USER"])
+      end
+
+      def flush_dns_rules
+        system("dscacheutil -flushcache")
+      end
+
+      def create_config_file
+        Invoker::Power::Config.create(
+          dns_port: port_finder.dns_port,
+          http_port: port_finder.http_port
+        )
+      end
+
+      def find_open_ports
+        port_finder.find_ports()
+      end
+
+      def port_finder
+        @port_finder ||= Invoker::Power::PortFinder.new()
+      end
+
+      def install_resolver(dns_port)
+        File.open(RESOLVER_FILE, "w") { |fl|
+          fl.write(resolve_string(dns_port))
+        }
+      rescue Errno::EACCES
+        Invoker::Logger.puts("Running setup requires root access, please rerun it with sudo".color(:red))
+        raise
+      end
+
+      def check_if_already_setup?
+        File.exists?(Invoker::Power::Config::CONFIG_LOCATION)
+      end
+
+      def install_firewall(balancer_port)
+        File.open(FIREWALL_PLIST_FILE, "w") { |fl|
+          fl.write(plist_string(balancer_port))
+        }
+        system("launchctl unload -w #{FIREWALL_PLIST_FILE} 2>/dev/null")
+        system("launchctl load -Fw #{FIREWALL_PLIST_FILE} 2>/dev/null")
+      end
+
+      # Ripped from POW code
+      def plist_string(balancer_port)
+        plist =<<-EOD
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+<key>Label</key>
+<string>com.codemancers.invoker</string>
+<key>ProgramArguments</key>
+<array>
+<string>sh</string>
+<string>-c</string>
+<string>#{firewall_command(balancer_port)}</string>
+</array>
+<key>RunAtLoad</key>
+<true/>
+<key>UserName</key>
+<string>root</string>
+</dict>
+</plist>
+        EOD
+        plist
+      end
+
+      def resolve_string(dns_port)
+        string =<<-EOD
+nameserver 127.0.0.1
+port #{dns_port}
+        EOD
+        string
+      end
+
+      # Ripped from Pow code
+      def firewall_command(balancer_port)
+        "ipfw add fwd 127.0.0.1,#{balancer_port} tcp from any to me dst-port 80 in"\
+          "&amp;&amp; sysctl -w net.inet.ip.forwarding=1"
+      end
+
+      def setup_resolver_file
+        return true unless File.exists?(RESOLVER_FILE)
+        Invoker::Logger.puts "Invoker has detected an existing Pow installation. We recommend "\
+          "that you uninstall pow and rerun this setup.".color(:red)
+
+        Invoker::Logger.puts "If you have already uninstalled Pow, proceed with installation"\
+          " by pressing y/n."
+
+        replace_resolver_flag = agree("Replace Pow configuration (y/n) : ")
+
+        if replace_resolver_flag
+          Invoker::Logger.puts "Invoker has overwritten one or more files created by Pow. "\
+          "If .dev domains still don't resolve locally. Try turning off the wi-fi"\
+          " and turning it on. It will force OSX to reload network configuration".color(:green)
+        end
+        replace_resolver_flag
+      end
+    end
+  end
+end

data/lib/invoker/runner.rb

@@ -14,6 +14,8 @@ module Invoker
     def self.run_command(selected_command)
       return unless selected_command
       case selected_command.command
+      when 'setup'
+        setup_pow(selected_command)
       when 'start'
         start_server(selected_command)
       when 'add'
@@ -29,8 +31,12 @@ module Invoker
       end
     end
 
+    def self.setup_pow(selected_command)
+      Invoker::Power::Setup.install()
+    end
+
     def self.start_server(selected_command)
-      config = Invoker::Parsers::Config.new(selected_command.file)
+      config = Invoker::Parsers::Config.new(selected_command.file, selected_command.port)
       Invoker.const_set(:CONFIG, config)
       warn_about_terminal_notifier()
       commander = Invoker::Commander.new()
@@ -71,7 +77,7 @@ module Invoker
       if RUBY_PLATFORM.downcase.include?("darwin")
         command_path = `which terminal-notifier`
         if !command_path || command_path.empty?
-          Invoker::Logger.puts("You can enable OSX notification for processes by installing terminal-notifier gem".red)
+          Invoker::Logger.puts("You can enable OSX notification for processes by installing terminal-notifier gem".color(:red))
         end
       end
     end

data/lib/invoker/version.rb

@@ -1,3 +1,3 @@
 module Invoker
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

data/readme.md

@@ -26,6 +26,35 @@ You need to start by creating a `ini` file which will define processes you want
     directory = /home/gnufied/god_particle
     command = zsh -c 'bundle exec ruby script/event_server'
 
+## Invoker as Pow alternative
+
+Invoker now supports pow like `.dev` subdomain. It will automatically
+make all your app servers defined on subdomain `label.dev`.
+
+To make it work though, you need to run following command, just once from anywhere:
+
+    ~> sudo invoker setup
+
+Now because invoker is making your app server available on a subdomain. It requires
+control over port on which your applications will be listening. This can be simply
+done by replacing specific port number in `ini` file with `$PORT`. For example:
+
+    [spree]
+    directory = /home/gnufied/spree
+    command = zsh -c 'bundle exec rails s -p $PORT'
+
+    [api]
+    directory = /home/gnufied/api
+    command = zsh -c 'bundle exec rails s -p $PORT'
+
+    [events]
+    directory = /home/gnufied/god_particle
+    command = zsh -c 'bundle exec ruby script/event_server'
+
+The subdomain feature won't work for apps which don't use `$PORT` placeholder.
+
+## Running Invoker
+
 After that you can start process manager via:
 
     ~> invoker start invoker.ini

data/spec/invoker/commander_spec.rb

@@ -23,6 +23,7 @@ describe "Invoker::Commander" do
 
     it "should find command by label and start it, if found" do
       invoker_config.stubs(:processes).returns([OpenStruct.new(:label => "resque", :cmd => "foo", :dir => "bar")])
+      invoker_config.expects(:process).returns(OpenStruct.new(:label => "resque", :cmd => "foo", :dir => "bar"))
       @commander.expects(:add_command).returns(true)
       
       @commander.add_command_by_label("resque")
@@ -97,8 +98,7 @@ describe "Invoker::Commander" do
 
       worker.should.not.equal nil
       worker.command_label.should.equal "sleep"
-      worker.color.should.equal "green"
-
+      worker.color.should.equal :green
 
       pipe_end_worker = @commander.open_pipes[worker.pipe_end.fileno]
       pipe_end_worker.should.not.equal nil

data/spec/invoker/config_spec.rb

@@ -16,12 +16,116 @@ command = ruby try_sleep.rb
         file.write(config_data)
         file.close
         lambda {
-          Invoker::Parsers::Config.new(file.path)
+          Invoker::Parsers::Config.new(file.path, 9000)
         }.should.raise(Invoker::Errors::InvalidConfig)
       ensure
         file.unlink()
       end
     end
   end
-end
 
+  describe "for ports" do
+    it "should replace port in commands" do
+      begin
+        file = Tempfile.new("invalid_config.ini")
+
+        config_data =<<-EOD
+[try_sleep]
+directory = /tmp
+command = ruby try_sleep.rb -p $PORT
+
+[ls]
+directory = /tmp
+command = ls -p $PORT
+
+[noport]
+directory = /tmp
+command = ls
+      EOD
+        file.write(config_data)
+        file.close
+
+        config = Invoker::Parsers::Config.new(file.path, 9000)
+        command1 = config.processes.first
+
+        command1.port.should == 9001
+        command1.cmd.should =~ /9001/
+
+        command2 = config.processes[1]
+
+        command2.port.should == 9002
+        command2.cmd.should =~ /9002/
+
+        command2 = config.processes[2]
+
+        command2.port.should == nil
+      ensure
+        file.unlink()
+      end
+    end
+
+    it "should use port from separate option" do
+      begin
+        file = Tempfile.new("invalid_config.ini")
+        config_data =<<-EOD
+[try_sleep]
+directory = /tmp
+command = ruby try_sleep.rb -p $PORT
+
+[ls]
+directory = /tmp
+port = 3000
+command = pwd
+
+[noport]
+directory = /tmp
+command = ls
+      EOD
+        file.write(config_data)
+        file.close
+
+        config = Invoker::Parsers::Config.new(file.path, 9000)
+        command1 = config.processes.first
+
+        command1.port.should == 9001
+        command1.cmd.should =~ /9001/
+
+        command2 = config.processes[1]
+
+        command2.port.should == 3000
+
+        command2 = config.processes[2]
+
+        command2.port.should == nil
+      ensure
+        file.unlink()
+      end
+    end
+  end
+
+  describe "loading power config" do
+    before do
+      @file = Tempfile.new("config.ini")
+    end
+
+    it "does not load config if platform is not darwin" do
+      Invoker.expects(:darwin?).returns(false)
+      Invoker::Power::Config.expects(:load_config).never
+      Invoker::Parsers::Config.new(@file.path, 9000)
+    end
+
+    it "does not load config if platform is darwin but there is no power config file" do
+      Invoker.expects(:darwin?).returns(true)
+      File.expects(:exists?).with(Invoker::Power::Config::CONFIG_LOCATION).returns(false)
+      Invoker::Power::Config.expects(:load_config).never
+      Invoker::Parsers::Config.new(@file.path, 9000)
+    end
+
+    it "loads config if platform is darwin and power config file exists" do
+      Invoker.expects(:darwin?).returns(true)
+      File.expects(:exists?).with(Invoker::Power::Config::CONFIG_LOCATION).returns(true)
+      Invoker::Power::Config.expects(:load_config).once
+      Invoker::Parsers::Config.new(@file.path, 9000)
+    end
+  end
+end