rconf 0.6.5 → 0.6.10

data/bin/rconf

@@ -86,14 +86,20 @@ where [options] are:
         end
         exit 0
       end
+      Profile.reset if options[:force]
       ProgressReporter.report_to_stdout
       ProgressReporter.report_to_file(options[:output]) if options[:output]
       Command.set_verbose if options[:verbose]
       begin
         lang = Language.load(options[:config])
         report_fatal("Validation of configuration file failed:\n  -#{lang.validation_errors.join("\n  -").map(&:red)}") unless lang.validation_errors.empty?
-        Profile.reset if options[:force]
-        Dir.chdir(File.dirname(options[:config])) { lang.configurators.each(&:run) }
+        Dir.chdir(File.dirname(options[:config])) do
+          lang.configurators.each do |c|
+            c.run
+            break if c.aborting
+            c.post_process
+          end
+        end
         report("Successfully configured #{File.basename(options[:config], '.rc').blue} for #{Platform.family.to_s.blue}")
       rescue Exception => e
         raise if e.is_a?(SystemExit)

data/lib/rconf/configurator.rb

@@ -121,13 +121,23 @@ module RightConf
     def run(*args)
       init
       sha = Profile.configurator_signature(self.class.key)
-      if sha != signature
+      sig = signature
+      if sha != sig
         Platform.dispatch(*args) { :run }
-        Profile.set_configurator_signature(self.class.key, signature)
+        Profile.set_configurator_signature(self.class.key, sig)
       end
       true
     end
 
+    # Called even if configuration is already done for steps that must
+    # always happen, do nothing by default
+    #
+    # === Return
+    # true:: Always return true
+    def post_process
+      true
+    end
+
     # Calculate unique SHA for current settings
     #
     # === Return

data/lib/rconf/configurators/bundler_configurator.rb

@@ -49,7 +49,7 @@ module RightConf
     end
     alias :run_darwin :run_linux
 
-    # Not implemented on windows (no bundler gem there)
+    # Not implemented on windows
     #
     # === Raise
     # (Exception):: Always raise

data/lib/rconf/configurators/passenger_configurator.rb

@@ -0,0 +1,320 @@
+# Copyright (C) 2011 RightScale, Inc, All Rights Reserved Worldwide.
+#
+# THIS PROGRAM IS CONFIDENTIAL AND PROPRIETARY TO RIGHTSCALE
+# AND CONSTITUTES A VALUABLE TRADE SECRET. Any unauthorized use,
+# reproduction, modification, or disclosure of this program is
+# strictly prohibited. Any use of this program by an authorized
+# licensee is strictly subject to the terms and conditions,
+# including confidentiality obligations, set forth in the applicable
+# License Agreement between RightScale.com, Inc. and
+# the licensee
+
+require 'fileutils'
+
+module RightConf
+
+  class PassengerConfigurator
+
+    PASSENGER_GEM_VERSION = '2.2.15'
+
+    DEFAULT_NGINX_INSTALL = ['/opt/nginx', File.join(ENV['HOME'], 'nginx')]
+
+    include Configurator
+
+    register :passenger
+
+    description "Installs and configure passenger with nginx\nNOTE: If the " +
+                'configuration file includes a ruby section before the ' +
+                'passenger section then that ruby will be used, otherwise ' +
+                'the default ruby will.'
+
+    settings :library_src_path => "Path to library sources, #{File.expand_path(File.join(Dir.getwd, '..', 'library'))} by default",
+             :gem_version  => "Passenger gem version #{PASSENGER_GEM_VERSION} by default",
+             :install_path => 'Path to nginx installation directory, uses /opt/nginx if it ' +
+                              'is writable by the current user or ~/nginx otherwise by default'
+     
+    # Install passenger gem in given ruby then run nginx install script
+    #
+    # === Return
+    # true:: Always return true
+    def run_linux
+      set_defaults
+      report_check("Checking for passenger gem #{gem_version}")
+      res = Command.execute('gem', 'list', 'passenger')
+      success = (res.output =~ /^passenger \(#{gem_version}\)$/)
+      report_result(success)
+      install_gem unless success
+      report_check('Checking for passenger+nginx')
+      res = Command.execute('which', 'nginx').success?
+      res = File.exists?(File.join(install_path, 'sbin', 'nginx')) unless res
+      report_result(res)
+      install_passenger unless res
+      true
+    end
+    alias :run_darwin :run_linux
+
+    # Not implemented on windows 
+    #
+    # === Raise
+    # (Exception):: Always raise
+    def run_windows
+      raise "Passenger is not supported on Windows!"
+    end
+
+    protected
+
+    # Set default values for settings
+    #
+    # === Return
+    # true:: Always return true
+    def set_defaults
+      right_site_src_path(Dir.getwd)
+      library_src_path(File.expand_path(File.join(Dir.getwd, '..', 'library'))) if library_src_path.nil?
+      gem_version(PASSENGER_GEM_VERSION) if gem_version.nil?
+      install_path(default_install_path) if install_path.nil?
+      user(ENV['USER']) if user.nil?
+      true
+    end
+
+    # Retrieve default install path
+    # Try /opt/nginx and revert to ~/nginx if not writable
+    #
+    # === Return
+    # path:: Default passenger+nginx install path
+    def default_install_path
+      path = if File.exist?('/opt')
+        if File.exist?('/opt/nginx')
+          pick_default_path(File.writable?('/opt/nginx'))
+        else
+          res = Command.execute('mkdir', '/opt/nginx')
+          pick_default_path(res.success?)
+        end
+      else
+        res = Command.execute('mkdir', '-p', '/opt/nginx')
+        pick_default_path(res.success?)
+      end
+    end
+
+    # First or second choice nginx install path
+    #
+    # === Parameter
+    # first_choice(TrueClass|FalseClass):: Whether to use first or second choice path
+    #
+    # === Return
+    # path(String):: Path
+    def pick_default_path(first_choice)
+      path = first_choice ? DEFAULT_NGINX_INSTALL[0] : DEFAULT_NGINX_INSTALL[1]
+    end
+
+    # Install passenger gem
+    #
+    # === Return
+    # true:: Always return true
+    def install_gem
+      report_check('Installing passenger gem')
+      Command.execute('gem', 'install', 'passenger', '-v', gem_version,
+                      :abort_on_failure => "Failed to install passenger gem version #{gem_version}")
+      report_success
+    end
+
+    # Install passenger+nginx
+    #
+    # === Return 
+    # true:: Always return true
+    def install_passenger
+      report_check('Installing passenger+nginx')
+      # Grrrrr passenger installer expect rake where it's not... HACK
+      ruby_dir = File.dirname(`which ruby`.chomp)
+      FileUtils.cp(`which rake`.chomp, ruby_dir) unless rake_exist = File.exist?(File.join(ruby_dir, 'rake'))
+      Command.execute('passenger-install-nginx-module', '--auto',
+                      '--auto-download', '--prefix', install_path,
+                      :abort_on_failure => "Failed to install nginx into #{install_path}")
+      FileUtils.mkdir_p(File.join(install_path, 'sites-enabled'))
+      FileUtils.mkdir_p(File.join(install_path, 'logs'))
+      File.open(File.join(install_path, 'conf', 'nginx.conf'), 'w') { |f| f.puts(nginx_config) }
+      File.open(File.join(install_path, 'sites-enabled', 'right_site'), 'w') { |f| f.puts(right_site_config) }
+      File.open(File.join(install_path, 'sites-enabled', 'library'), 'w') { |f| f.puts(library_config) }
+      if File.writable?('/etc/hosts') && IO.read('/etc/hosts') !~ /hosts_entry/
+        File.open('/etc/hosts', 'a') { |f| f.puts hosts_entry }
+      else
+        post_note "Please add the following line to your /etc/hosts file:\n#{hosts_entry}\n" +
+                  "\nThe following aliases may help too:\n" +
+                  "alias nrestart='kill -HUP `cat #{pid_path}/nginx.pid`'\n" +
+                  "alias nstart='#{install_path}/sbin/nginx'\n" +
+                  "alias nstop='#{install_path}/sbin/nginx -s stop'"
+      end
+      File.delete(File.join(ruby_dir, 'rake')) unless rake_exist
+      report_success
+    end
+
+    # Hosts entry in /etc/hosts
+    #
+    # === Return
+    # entry(String):: Hosts entry required to run local dev
+    def hosts_entry
+      '127.0.0.1       right-site.rightscale.local  library.rightscale.local  rightscale.local'
+    end
+
+    # Nginx error log path
+    def log_path
+      File.join(install_path, 'logs', 'nginx-error.log')
+    end
+    
+    # Nginx pid file path
+    def pid_path
+      File.join(install_path, 'logs', 'nginx.pid')
+    end
+
+    # Nginx config
+    #
+    # === Parameters
+    # username(String):: Username used to run nginx
+    #
+    # === Return
+    # config(String):: Nginx config
+    def nginx_config
+      ruby_bin = Command.execute('which', 'ruby').output.chomp
+      res = Command.execute('ruby', '-e', "require 'rubygems';puts Gem.source_index.find_name('passenger').detect { |g| g.version.to_s == '#{PASSENGER_GEM_VERSION}' }.full_gem_path",
+                            :abort_on_failure => 'Could not find passenger gem to build passenger_root')
+      passenger_root = res.output.chomp
+      report_fatal('Could not find passenger gem') if passenger_root.empty?
+      <<-EOS
+worker_processes  1;
+
+error_log  #{log_path} debug;
+pid        #{pid_path};
+
+events {
+    worker_connections  256;
+}
+
+http {
+    passenger_root #{passenger_root};
+    passenger_ruby #{ruby_bin};
+    passenger_max_pool_size 2;
+    passenger_pool_idle_time 0;
+    passenger_max_instances_per_app 1;
+
+    include       mime.types;
+    default_type  application/octet-stream;
+
+
+    sendfile          on;
+    keepalive_timeout 65;
+
+    gzip on;
+    gzip_buffers 16 8k;
+    gzip_disable "MSIE [1-6]\.";
+    gzip_proxied any;
+    gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;
+            
+    server {
+        ssi on;
+        listen 8080;
+        server_name right-site.rightscale.local;
+        root /Users/raphael/src/right_site/public;
+        passenger_enabled on;
+        rails_env development;
+    
+        # POST and AJAX requests need to proxied directly to the library app
+        #####################################################################
+        set $is_library_direct "";
+    
+        # provisioning routes to the library
+        if ($request_uri ~ ^/provisioning)
+        {
+        rewrite ^/provisioning(.*)$ /direct_library/provisioning$1 last;
+        }
+    
+        if ($request_uri ~ ^/aria_provisioning_callbacks)
+        {
+        rewrite ^/aria_provisioning_callbacks(.*)$ /direct_library/aria_provisioning_callbacks$1 last;
+        }
+    
+        # request is for a library related action      
+        if ($request_uri ~ ^/library/)
+        {
+            set $is_library_direct  L;
+        }
+    
+        # request is a POST
+        if ($request_method = POST)
+        {
+            set $is_library_direct "${is_library_direct}P";       
+        }
+    
+        # request is an AJAX
+        if ($http_x_requested_with = XMLHttpRequest)
+        {      
+            set $is_library_direct "${is_library_direct}A";
+        }
+    
+        # library post request should be directly proxied
+        if ($is_library_direct = LP)
+        {
+            rewrite  ^/library/(.*)$  /direct_library/$1  last;
+        }
+    
+        # library post ajax request should be directly proxied
+        if ($is_library_direct = LPA)
+        {
+            rewrite  ^/library/(.*)$  /direct_library/$1  last;
+        }
+    
+        # library ajax request should be directly proxied
+        if ($is_library_direct = LA)
+        {
+            rewrite  ^/library/(.*)$  /direct_library/$1  last;
+        }
+    #####################################################################
+    
+        location /direct_library/
+        {
+            proxy_pass http://library.rightscale.local:8081/;
+            proxy_set_header   X-Relative-Root    library;
+            proxy_set_header   X-Embedded         on;
+            proxy_set_header   X-Core-Site-Domain    right-site.rightscale.local;
+        }
+    
+        location ~ ^/library/users/(.+)/openid_consume
+        {
+            proxy_pass http://library.rightscale.local:8081/users/$1/openid_consume?$args;
+            proxy_set_header   X-Relative-Root    library;
+            proxy_set_header   X-Embedded         on;
+        }
+    
+    
+        location ~ ^/library/(.*).(css|js)
+        {
+          # library assets get proxied directly to the library app    
+          proxy_pass http://library.rightscale.local:8081/$1.$2;
+        }
+    
+        location /library_images/
+        {
+          proxy_pass http://library.rightscale.local:8081/library_images/;
+        }
+    
+    
+        location /library_rest/
+        {
+          proxy_pass http://127.0.0.1:87/;
+          proxy_set_header   X-Relative-Root    library;
+          proxy_set_header   X-Core-Site-Domain    right-site.rightscale.local;
+        }
+    }
+    server {
+        ssi on;
+        listen 8081;
+        server_name library.rightscale.local;
+        root #{library_src_path}/public;
+        passenger_enabled on;
+        rails_env development;
+    }
+}
+      EOS
+    end
+
+  end
+end
+

data/lib/rconf/configurators/ruby_configurator.rb

@@ -23,9 +23,9 @@ module RightConf
     description "Installs ruby interpreter and rubygems.\n" +
                 'Installs and uses rvm on supported (i.e. non-Windows) platforms'
 
-    settings :version  => 'Ruby version using rvm notation (see "rvm list known")',
-             :rubygems => 'Rubygems version, e.g. "1.3.7"',
-             :gemset   => 'Gemset to be used for platforms supporting rvm'
+    settings :version   => 'Ruby version using rvm notation (see "rvm list known")',
+             :rubygems  => 'Rubygems version, e.g. "1.3.7"',
+             :gemset    => 'Gemset to be used for platforms supporting rvm'
 
     validate_has_settings :version, :rubygems
 
@@ -54,7 +54,8 @@ module RightConf
         when /^Using /
           report_success
           check_rvmrc
-          post_note "Configuration required switching the active ruby\nPlease 'cd' into the project directory again to activate it"
+          post_note "Configuration required switching the active ruby\nPlease run " + 'cd ..;cd -'.blue + ' to activate it and re-run rconf'
+          aborting(true)
         else
           report_fatal("Failed to use #{version}:\n#{out}")
         end
@@ -78,7 +79,6 @@ module RightConf
                         :abort_on_failure => "Failed to switch to gemset '#{gemset}'") 
         report_success
       end
-      Command.set_prefix("rvm #{version}@#{gemset} exec --")
       true
     end
     alias :run_darwin :run_linux
@@ -91,6 +91,15 @@ module RightConf
     def run_windows
     end
 
+    # Set command prefix when already configured
+    #
+    # === Return
+    # true:: Always return true
+    def post_process
+      Command.set_prefix("rvm #{version}@#{gemset} exec --")
+      true
+    end
+
     protected
 
     # Check whether the right version of RVM is installed and install it if not
@@ -215,6 +224,7 @@ module RightConf
           FileUtils.mv(bashrc_path, bashrc_path + '.old')
           File.open(bashrc_path, 'w') { |f| f.puts content }
           post_note 'rvm was installed, please reload your shell to activate it and re-run rconf'
+          aborting(true)
         end
       else
         report_error("Failed to update bashrc to activate rvm, no bashrc found")

data/lib/rconf/profile.rb

@@ -57,6 +57,7 @@ module RightConf
     # true:: Always return true
     def reset
       File.delete(profile_path) if File.file?(profile_path)
+      @profile = {}
       true
     end
 

data/lib/rconf/version.rb

@@ -13,7 +13,7 @@ module RightConf
 
   MAJOR = 0
   MINOR = 6
-  BUILD = 5
+  BUILD = 10
 
   VERSION = [MAJOR, MINOR, BUILD].map(&:to_s).join('.')
 

data/spec/configurators/bundler_configurator_spec.rb

@@ -29,7 +29,7 @@ describe RightConf::BundlerConfigurator do
     flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
       'bundle', '--version').and_return(success_result('0'))
     flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'bundle', 'install', {:abort_on_failure=>"Failed to install gems"}).and_return(success_result)
+      'bundle', 'install', '_0_', {:abort_on_failure=>"Failed to install gems"}).and_return(success_result)
     @configurator.run_linux
   end
 
@@ -37,7 +37,7 @@ describe RightConf::BundlerConfigurator do
     flexmock(RightConf::Command.instance).should_receive(:execute).twice.with(
       'bundle', '--version').and_return(success_result('1'))
     flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
-      'bundle', 'install', {:abort_on_failure=>"Failed to install gems"}).and_return(success_result)
+      'bundle', 'install', '_0_', {:abort_on_failure=>"Failed to install gems"}).and_return(success_result)
     flexmock(RightConf::Command.instance).should_receive(:execute).once.with(
       'gem', 'uninstall', 'bundler', '-a', '-x').and_return(success_result)
     flexmock(RightConf::Command.instance).should_receive(:execute).once.with(

data/spec/configurators/passenger_configurator_spec.rb

@@ -0,0 +1,44 @@
+# Copyright (C) 2011 RightScale, Inc, All Rights Reserved Worldwide.
+#
+# THIS PROGRAM IS CONFIDENTIAL AND PROPRIETARY TO RIGHTSCALE
+# AND CONSTITUTES A VALUABLE TRADE SECRET. Any unauthorized use,
+# reproduction, modification, or disclosure of this program is
+# strictly prohibited. Any use of this program by an authorized
+# licensee is strictly subject to the terms and conditions,
+# including confidentiality obligations, set forth in the applicable
+# License Agreement between RightScale.com, Inc. and
+# the licensee
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RightConf::PassengerConfigurator do
+
+  before(:each) do
+    lang = RightConf::Language.parse('passenger {}')
+    @configurator = lang.configurators.first
+    [:report_check, :report_result, :report_fatal, :report_success].each do |meth|
+      flexmock(@configurator).should_receive(meth)
+    end
+  end
+
+  it 'should set defaults' do
+    @configurator.__send__(:set_defaults)
+    @configurator.right_site_src_path.should == Dir.getwd
+    @configurator.library_src_path.should == File.expand_path(File.join(Dir.getwd, '..', 'library'))
+    @configurator.gem_version.should == RightConf::PassengerConfigurator::PASSENGER_GEM_VERSION
+    @configurator.install_path.should == @configurator.__send__(:default_install_path)
+    @configurator.user.should == ENV['USER']
+  end
+
+  it 'should default to /opt/nginx when possible' do
+    to_check = File.exist?('/opt/nginx') ? '/opt/nginx' :
+      (File.exist?('/opt') ? '/opt' : '/')
+    if File.writable?(to_check)
+      @configurator.__send__(:default_install_path).should == '/opt/nginx'
+    else
+      pending '/opt/nginx not writable'
+    end
+  end
+
+end
+

metadata

@@ -2,7 +2,7 @@
 name: rconf
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.5
+  version: 0.6.10
 platform: ruby
 authors: 
 - Raphael Simon
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-08 00:00:00 -08:00
+date: 2011-03-11 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,6 +64,7 @@ files:
 - lib/rconf/configurator_registry.rb
 - lib/rconf/configurators/bundler_configurator.rb
 - lib/rconf/configurators/packages_configurator.rb
+- lib/rconf/configurators/passenger_configurator.rb
 - lib/rconf/configurators/ruby_configurator.rb
 - lib/rconf/language.rb
 - lib/rconf/platform.rb
@@ -84,6 +85,7 @@ files:
 - spec/configurator_spec.rb
 - spec/configurators/bundler_configurator_spec.rb
 - spec/configurators/packages_configurator_spec.rb
+- spec/configurators/passenger_configurator_spec.rb
 - spec/configurators/ruby_configurator_spec.rb
 - spec/language_spec.rb
 - spec/platform_spec.rb
@@ -126,6 +128,7 @@ test_files:
 - spec/configurator_spec.rb
 - spec/configurators/bundler_configurator_spec.rb
 - spec/configurators/packages_configurator_spec.rb
+- spec/configurators/passenger_configurator_spec.rb
 - spec/configurators/ruby_configurator_spec.rb
 - spec/language_spec.rb
 - spec/platform_spec.rb