redirus 0.1.0

data/lib/redirus/config.rb

@@ -0,0 +1,72 @@
+require 'yaml'
+
+ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+
+module Redirus
+  class Config
+    def initialize(path=nil)
+      if File.exists?(path)
+        @config = YAML.load_file(path)
+      else
+        @config = {}
+      end
+    end
+
+    def queues
+      @config['queues'] || ['default']
+    end
+
+    def redis_url
+      @config['redis_url'] || 'redis://localhost:6379'
+    end
+
+    def namespace
+      @config['namespace'] || 'redirus'
+    end
+
+    def nginx_pid_file
+      nginx_prop :pid, 'nginx.pid'
+    end
+
+    def configs_path
+      nginx_prop :configs_path, 'sites-enabled'
+    end
+
+    def http_template
+      nginx_prop :http_template, 'listen *:80;'
+    end
+
+    def https_template
+      nginx_prop :https_template, %q[listen *:443 ssl;
+ssl_certificate     /usr/share/ssl/certs/localhost/host.cert;
+ssl_certificate_key /usr/share/ssl/certs/localhost/host.key;
+]
+    end
+
+    def config_template
+      nginx_prop :config_template, %q[#{upstream}
+
+server {
+  #{listen}
+
+  server_name #{name}.localhost;
+  server_tokens off;
+
+  location / {
+    proxy_pass http://#{upstream_name};
+  }
+}]
+    end
+
+    def allowed_properties
+      nginx_prop :allowed_properties, []
+    end
+
+    private
+
+    def nginx_prop(type, default=nil)
+      value = @config['nginx'][type.to_s] if @config['nginx']
+      value || default
+    end
+  end
+end

data/lib/redirus/proxy.rb

@@ -0,0 +1,48 @@
+require 'sidekiq'
+
+module Redirus
+  class Proxy
+    include Sidekiq::Worker
+
+    def perform(*params)
+      begin
+        perform_action(*params)
+        restart_nginx
+      rescue Errno::EACCES => e
+        $stderr << "Error: Cannot write to config files - continuing\n"
+        $stderr << "#{e}\n"
+      rescue Errno::ENOENT => e
+        $stderr << "Error: Trying to remove non existing config files - continuing\n"
+        $stderr << "#{e}\n"
+      rescue Errno::ESRCH => e
+        $stderr << "Warning: Nginx is dead - continuing\n"
+        $stderr << "#{e}\n"
+      end
+    end
+
+    protected
+
+    def perform_action(*params)
+      #by default do nothing
+    end
+
+    def full_name(name, type)
+      "#{name}_#{type}"
+    end
+
+    def config_file_path(name, type)
+      File.join(config.configs_path, full_name(name, type))
+    end
+
+    def config
+      @config ||= Redirus.config
+    end
+
+    def restart_nginx
+      File.open(config.nginx_pid_file) do |file|
+        pid = file.read.to_i
+        Process.kill :SIGHUP, pid
+      end
+    end
+  end
+end

data/lib/redirus/server_cli.rb

@@ -0,0 +1,79 @@
+require 'optparse'
+require 'singleton'
+require 'sidekiq/cli'
+
+module Redirus
+  class ServerCLI
+    include Singleton
+
+    attr_reader :options
+
+    def parse(args = ARGV)
+      init_options(args)
+      validate!
+    end
+
+    def run
+      sidekiq_cli = Sidekiq::CLI.instance
+      args = queues + [
+        '-c', '1',
+        '-r', runner_path,
+        options[:config_path]
+      ]
+
+      sidekiq_cli.parse(args)
+      sidekiq_cli.run
+    end
+
+    private
+
+    def queues
+      Redirus.config.queues.inject([]) do |arr, q|
+        arr << '-q'
+        arr << q
+      end
+    end
+
+    def runner_path
+      module_path = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+      File.join(module_path, 'redirus.rb')
+    end
+
+    def init_options(args)
+      opts = parse_options(args)
+      opts[:config_path] ||= 'config.yml'
+
+      Redirus.config_path = opts[:config_path]
+
+      @options = opts
+    end
+
+    def parse_options(args)
+      opts = {}
+
+      OptionParser.new do |o|
+        o.banner = 'Usage: redirus [options]'
+
+        o.on('-c',
+             '--configuration PATH',
+             'Yaml redirus configuration path') do |arg|
+          opts[:config_path] = arg
+        end
+
+        o.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+      end.parse!
+
+      opts
+    end
+
+    def validate!
+      unless File.exist?(options[:config_path])
+        puts "ERROR: Configuration file #{options[:config_path]} does not exist"
+        exit(1)
+      end
+    end
+  end
+end

data/lib/redirus/version.rb

@@ -0,0 +1,3 @@
+module Redirus
+  VERSION = '0.1.0'
+end

data/lib/redirus/worker/add_proxy.rb

@@ -0,0 +1,51 @@
+module Redirus
+  module Worker
+    class AddProxy < Proxy
+
+      def perform_action(name, workers, type, props = nil)
+        params = config_propertie(name, workers, type, props)
+        File.open(config_file_path(name, type), 'w') do |file|
+          param_regexp = '#{\w*}'
+          file.write config.config_template
+            .gsub(/#{param_regexp}/) { |p| params[p[2..-2]] }
+        end
+      end
+
+      private
+
+      def config_propertie(name, workers, type, props)
+        {
+          'name' => name,
+          'listen' => https?(type) ? config.https_template : config.http_template,
+          'upstream' => upstream_conf(name, workers, type),
+          'upstream_name' => full_name(name, type),
+          'properties' => location_properties(props)
+        }
+      end
+
+      def https?(type)
+        type.to_s == 'https'
+      end
+
+      def upstream_conf(name, workers, type)
+        "upstream #{name}_#{type} {\n#{workers_conf(workers)}\}\n"
+      end
+
+      def workers_conf(workers)
+        workers.collect { |worker| "  server #{worker};\n" }.join
+      end
+
+      def location_properties(props)
+        props.inject([]) do |tab, prop|
+          tab << "#{prop};\n" if allowed? prop
+          tab
+        end.join('') if props
+      end
+
+      def allowed?(prop)
+        config.allowed_properties
+          .any? { |prop_regexp| /#{prop_regexp}/.match(prop) }
+      end
+    end
+  end
+end

data/lib/redirus/worker/rm_proxy.rb

@@ -0,0 +1,10 @@
+module Redirus
+  module Worker
+    class RmProxy < Proxy
+
+      def perform_action(name, type)
+        File.delete(config_file_path(name, type))
+      end
+    end
+  end
+end

data/lib/redirus/worker.rb

@@ -0,0 +1,22 @@
+require 'sidekiq'
+
+module Redirus
+  module Worker
+    autoload :AddProxy, 'redirus/worker/add_proxy'
+    autoload :RmProxy,  'redirus/worker/rm_proxy'
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.redis = {
+    namespace: Redirus.config.namespace,
+    url: Redirus.config.redis_url
+  }
+end
+
+Sidekiq.configure_client do |c|
+  c.redis = {
+    namespace: Redirus.config.namespace,
+    url: Redirus.config.redis_url
+  }
+end

data/lib/redirus.rb

@@ -0,0 +1,24 @@
+require 'sidekiq'
+
+module Redirus
+  autoload :Version,   'redirus/version'
+  autoload :Config,    'redirus/config'
+  autoload :Proxy,     'redirus/proxy'
+  autoload :CLI,       'redirus/cli'
+  autoload :ServerCLI, 'redirus/server_cli'
+
+  def self.config
+    @@config ||= Redirus::Config.new(config_path)
+  end
+
+  def self.config_path
+    @@config_path ||= ARGV[0] || 'config.yml'
+  end
+
+  def self.config_path=(path)
+    @@config_path = path
+    @@config = nil
+  end
+end
+
+require 'redirus/worker'

data/redirus.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redirus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redirus'
+  spec.version       = Redirus::VERSION
+  spec.authors       = ['Marek Kasztelnik']
+  spec.email         = ['mkasztelnik@gmail.com']
+  spec.description   = %q{Redirus}
+  spec.summary       = %q{Redirus is responsible for managing http/https redirections}
+  spec.homepage      = 'https://github.com/dice-cyfronet/redirus'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sidekiq'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'rspec-sidekiq'
+  spec.add_development_dependency 'coveralls'
+end

data/spec/redirus/config_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Redirus::Config do
+
+  context 'loading default values' do
+    let(:config) { Redirus::Config.new 'nonexisting_config_file' }
+
+    it 'returns redis config' do
+      expect(config.queues).to eq ['default']
+      expect(config.redis_url).to eq 'redis://localhost:6379'
+      expect(config.namespace).to eq 'redirus'
+    end
+
+    it 'returns nginx files location' do
+      expect(config.nginx_pid_file).to eq 'nginx.pid'
+      expect(config.configs_path).to eq 'sites-enabled'
+      expect(config.http_template).to eq 'listen *:80;'
+      expect(config.https_template).to start_with 'listen *:443 ssl;'
+      expect(config.config_template).to start_with '#{upstream}'
+      expect(config.allowed_properties).to eq []
+    end
+  end
+
+  context 'loading config from file' do
+    let(:config) { Redirus::Config.new File.join(SPEC_DIR, 'resources', 'config.yml') }
+
+    it 'returns redis config' do
+      expect(config.queues).to eq ['first', 'second']
+      expect(config.redis_url).to eq 'configfile-redis://localhost:6379'
+      expect(config.namespace).to eq 'configfile-redirus'
+    end
+
+    it 'returns nginx files location' do
+      expect(config.nginx_pid_file).to eq 'configfile-nginx.pid'
+      expect(config.configs_path).to eq 'configfile-sites-enabled'
+      expect(config.http_template).to eq 'listen *:8000;'
+      expect(config.https_template).to start_with 'listen *:8443 ssl;'
+      expect(config.config_template).to start_with '## configfile'
+      expect(config.allowed_properties).to eq ['proxy_send_timeout \d', 'proxy_read_timeout \d']
+    end
+  end
+end

data/spec/redirus/proxy_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Redirus::Proxy do
+  let(:nginx_pid_file) { double('nginx pid file') }
+  let(:config) {
+    double('worker configuration',
+      nginx_pid_file: 'nginx_pid_file'
+    )
+  }
+
+  before do
+    Redirus.stub(:config).and_return(config)
+    allow(File).to receive(:open).with('nginx_pid_file').and_yield(nginx_pid_file)
+    allow(nginx_pid_file).to receive(:read).and_return('123')
+  end
+
+  it 'invokes perform action' do
+    allow(Process).to receive(:kill).with(:SIGHUP, 123)
+    expect(subject).to receive(:perform_action).with('param', 123, :http)
+    subject.perform('param', 123, :http)
+  end
+
+  it 'restarts nginx' do
+    expect(Process).to receive(:kill).with(:SIGHUP, 123)
+    subject.perform('param')
+  end
+end

data/spec/redirus/worker/add_proxy_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Redirus::Worker::AddProxy do
+  let(:proxy_file) { double('proxy file') }
+  let(:nginx_pid_file) { double('nginx pid file') }
+  let(:config) {
+    double('worker configuration',
+      configs_path: 'configs_base_path',
+      http_template: 'http_section',
+      https_template: 'https_section',
+      base_server_name: 'localhost',
+      config_template: %q[#{upstream}
+        server {
+          #{listen}
+          server_name #{name}.my.server.pl;
+          location / {
+            proxy_pass http://#{upstream_name};
+            #{properties}
+          }
+        }
+      ],
+      allowed_properties: ['proxy_send_timeout \d', 'proxy_read_timeout \d'],
+      nginx_pid_file: 'nginx_pid_file'
+    )
+  }
+
+  before do
+    allow(Redirus).to receive(:config).and_return(config)
+    allow(File).to receive(:open).with('nginx_pid_file').and_yield(nginx_pid_file)
+    allow(nginx_pid_file).to receive(:read).and_return('123')
+    allow(Process).to receive(:kill)
+  end
+
+  context 'when http redirection is required' do
+    before do
+      allow(File).to receive(:open).with('configs_base_path/subdomain_http', 'w').and_yield(proxy_file)
+      allow(proxy_file).to receive(:write)
+      subject.perform('subdomain', ['10.100.10.112:80', '10.100.10.113:80'], :http)
+    end
+
+    it 'sets http listen section' do
+      expect(proxy_file).to have_received(:write).with(/.*http_section.*/)
+    end
+
+    it 'sets http upstream name in proxy pass section' do
+      expect(proxy_file).to have_received(:write).with(/.*proxy_pass http:\/\/subdomain_http;.*/)
+    end
+
+    it 'has http upstream section with 2 upstream servers' do
+      expect(proxy_file).to have_received(:write).with(/.*upstream subdomain_http {\n\s*server 10.100.10.112:80;\n\s*server 10.100.10.113:80;\n\s*}.*/)
+    end
+
+    it 'sets subdomain.my.server.pl server name' do
+      expect(proxy_file).to have_received(:write).with(/.*subdomain\.my\.server\.pl;.*/)
+    end
+
+    it 'restarts nginx' do
+      expect(Process).to have_received(:kill).with(:SIGHUP, 123)
+    end
+  end
+
+  context 'when https redirection is required' do
+    before do
+      allow(File).to receive(:open).with('configs_base_path/subdomain_https', 'w').and_yield(proxy_file)
+      allow(proxy_file).to receive(:write)
+      subject.perform('subdomain', ['10.100.10.112:80'], :https)
+    end
+
+    it 'sets https listen section' do
+      expect(proxy_file).to have_received(:write).with(/.*https_section.*/)
+    end
+
+    it 'sets https upstream name in proxy pass section' do
+      expect(proxy_file).to have_received(:write).with(/.*proxy_pass http:\/\/subdomain_https;.*/)
+    end
+
+    it 'has https upstream section with upstream server' do
+      expect(proxy_file).to have_received(:write).with(/.*upstream subdomain_https {\n\s*server 10.100.10.112:80;\n\s*}.*/)
+    end
+  end
+
+  context 'when redirection with properties is required' do
+    before do
+      allow(File).to receive(:open).with('configs_base_path/subdomain_http', 'w').and_yield(proxy_file)
+      allow(proxy_file).to receive(:write)
+    end
+
+    it 'writes static properties into location section' do
+      expect(proxy_file).to receive(:write).with(/location \/ {\s*.*\s*proxy_send_timeout 600;\s*proxy_read_timeout 600;\s*}/)
+
+      subject.perform('subdomain', ['10.100.10.112:80'], :http, ['proxy_send_timeout 600', 'proxy_read_timeout 600'])
+    end
+
+    it 'discard not allowed properties' do
+      expect(proxy_file).to_not receive(:write).with(/not allowed property/)
+
+      subject.perform('subdomain', ['10.100.10.112:80'], :http, ['not allowed property'])
+    end
+  end
+end

data/spec/redirus/worker/rm_proxy_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Redirus::Worker::RmProxy do
+  let(:proxy_file) { double('proxy file') }
+  let(:nginx_pid_file) { double('nginx pid file') }
+  let(:config) {
+    double('worker configuration',
+      configs_path: 'configs_base_path',
+      nginx_pid_file: 'nginx_pid_file'
+    )
+  }
+
+  before do
+    allow(Redirus).to receive(:config).and_return(config)
+    allow(File).to receive(:open).with('nginx_pid_file').and_yield(nginx_pid_file)
+    allow(nginx_pid_file).to receive(:read).and_return('123')
+    allow(Process).to receive(:kill).with(:SIGHUP, 123)
+    allow(File).to receive(:delete)
+  end
+
+
+  context 'when http redirection' do
+    before { subject.perform('subdomain', :http) }
+
+    it 'removes redirection configuration file' do
+      expect(File).to have_received(:delete).with('configs_base_path/subdomain_http')
+    end
+
+    it 'restarts nginx' do
+      expect(Process).to have_received(:kill).with(:SIGHUP, 123)
+    end
+  end
+
+  context 'when https redirection' do
+    before { subject.perform('subdomain', :https) }
+
+    it 'removes redirection configuration file' do
+      expect(File).to have_received(:delete).with('configs_base_path/subdomain_https')
+    end
+  end
+end

data/spec/resources/config.yml

@@ -0,0 +1,28 @@
+queues:
+  - first
+  - second
+redis_url: configfile-redis://localhost:6379
+namespace: configfile-redirus
+nginx:
+  pid: configfile-nginx.pid
+  configs_path: configfile-sites-enabled
+  http_template: 'listen *:8000;'
+  https_template: |
+    listen *:8443 ssl;
+    ssl_certificate     /usr/share/ssl/certs/localhost/host.cert;
+    ssl_certificate_key /usr/share/ssl/certs/localhost/host.key;
+  config_template: |
+    ## configfile
+    #{upstream}
+    server {
+      #{listen}
+      server_name #{name}.localhost;
+      server_tokens off;
+      location / {
+        proxy_pass http://#{upstream_name};
+        #{properties}
+      }
+    }
+  allowed_properties:
+    - proxy_send_timeout \d
+    - proxy_read_timeout \d

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'redirus'
+
+SPEC_DIR = File.dirname(__FILE__)
+Dir[SPEC_DIR + "/support/**/*.rb"].each {|f| require f}
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+RSpec.configure do |config|
+    # Disable the old-style object.should syntax.
+    config.expect_with :rspec do |c|
+      c.syntax = :expect
+    end
+
+    config.alias_example_to :expect_it
+end
+
+RSpec::Core::MemoizedHelpers.module_eval do
+  alias to should
+  alias to_not should_not
+end

data/spec/support/matchers.rb

@@ -0,0 +1,44 @@
+RSpec::Matchers.define :conf_be_empty do
+  match do |actual|
+    actual[:proxy] == ''
+    actual[:upstream] == ''
+  end
+end
+
+RSpec::Matchers.define :have_config do |path, proxy_pass|
+  match do |actual|
+    actual[:proxy] =~ /location "#{excape(path)}" {\n  proxy_pass "http:\/\/#{proxy_pass}\/";/
+  end
+
+  def excape(path)
+    path.gsub('/', '\/')
+  end
+end
+
+RSpec::Matchers.define :have_upstream_config do |proxy_pass, workers|
+  match do |actual|
+    expected = <<-ENTRY
+      upstream "#{proxy_pass}" {
+        #{workers_config(workers)}
+      }
+    ENTRY
+    actual[:upstream].gsub(/[\s\n]/, "").include? expected.gsub(/[\s\n]/, "")
+  end
+
+  def workers_config(workers)
+    workers.collect do |worker|
+      "server #{worker};\n"
+    end.join
+  end
+end
+
+RSpec::Matchers.define :have_property do |path, property|
+  match do |actual|
+
+    actual[:proxy] =~ /location \"#{excape(path)}\" {(\n.+)*#{excape(property)};/
+  end
+
+  def excape(path)
+    path.gsub('/', '\/')
+  end
+end

data/support/upstart/redirus-nginx.conf

@@ -0,0 +1,21 @@
+start on starting redirus
+stop on stopping redirus
+
+setuid CHANGEME_USER_NAME
+
+env DAEMON=CHANGEME_NGINX_PATH/sbin/nginx
+env PID=CHANGEME_NGINX_PATH/nginx.pid
+
+expect fork
+respawn
+respawn limit 10 5
+#oom never
+
+pre-start script
+        $DAEMON -t
+        if [ $? -ne 0 ]
+                then exit $?
+        fi
+end script
+
+exec $DAEMON