vhost_generator 0.2.2 → 0.3.0

data/bin/foreman-export-vhost

@@ -94,8 +94,11 @@ class ForemanExportApplication
              '# Default: web (must have entry of that name in Procfile)',
              lambda { |value| config.process_type = value }],
       ['-G', '--generator=GENERATOR',
-             '# Default: nginx (only supported for now)',
+             '# Default: "nginx" (try "apache" too)',
              lambda { |value| config.generator = value }],
+      ['-O', '--generator-options=OPTIONS',
+             '# Comma-separated list of key=value',
+             lambda { |value| config.generator_options = value }],
       ['-N', '--dry-run', lambda { |value| config.dry_run = true }],
       ['-R', '--stop-start-service',
              '# Starts and stops APP service (may not work everywhere)',
@@ -174,9 +177,14 @@ class ForemanExportApplication
                   Array(Shellwords.escape("#{target}/#{app}") + "-*.conf")
       commands << %w(sudo bundle exec foreman export) +
                   escape(argv + foreman_flags)
-      commands << %w(sudo service) + escape(app) + %w(start)
-      commands << ['echo',
-                   '"Finished, now open your browser and see if all works."']
+      message = 'Finished, now '
+      if config.service
+        commands << %w(sudo service) + escape(app) + %w(start)
+      else
+        message = "start the #{escape(app)} service, "
+      end
+      message << "open your browser and see if everything works."
+      commands << ['echo', '"' + message + '"']
       self
     end
 
@@ -185,12 +193,14 @@ class ForemanExportApplication
     attr_reader :config, :argv, :commands
 
     def generator_flags(flags=Array.new)
+      flags << '-a' << config.app if config.app
       flags << '-f' << config.static_folder if config.static_folder
       flags << '-l' << config.server_ports if config.server_ports
       flags << '-s' << config.server_names if config.server_names
       flags << '-p' << config.instance_ports if config.instance_ports
       flags << '-g' << config.generator if config.generator
-      flags << '-o' << "upstream=#{app}" if config.generator == 'nginx' && app
+      flags << '-o' << config.generator_options if config.generator_options
+      flags
     end
 
     def foreman_flags(flags=Array.new)
@@ -203,6 +213,7 @@ class ForemanExportApplication
       flags << '-c' << config.concurrency if config.concurrency
       flags << '-f' << config.procfile if config.procfile
       flags << '-d' << config.root if config.root
+      flags
     end
 
     def app
@@ -217,8 +228,18 @@ class ForemanExportApplication
       argv[1] # eg. /etc/init
     end
 
+    def vhost_dir
+      if config.generator == 'nginx'
+        '/etc/nginx/sites-enabled'
+      elsif config.generator == 'apache'
+        '/etc/apache2/sites-enabled'
+      else
+        raise RuntimeError, "Can't guess vhost_dir for generator=#{config.generator}"
+      end
+    end
+
     def vhost_config
-      "/etc/#{service}/sites-enabled/rails-#{app}.conf"
+      "#{vhost_dir}/vhost-#{app}.conf"
     end
 
     def escape(args)

data/features/foreman-export-vhost.feature

@@ -26,7 +26,8 @@ Feature: Wrap "foreman export"
           -L, --server-ports=PORTS         # Default: 80
           -S, --server-names=NAMES         # Default: localhost
           -K, --foreman-process-type=TYPE  # Default: web (must have entry of that name in Procfile)
-          -G, --generator=GENERATOR        # Default: nginx (only supported for now)
+          -G, --generator=GENERATOR        # Default: "nginx" (try "apache" too)
+          -O, --generator-options=OPTIONS  # Comma-separated list of key=value
           -N, --dry-run
           -R, --stop-start-service         # Starts and stops APP service (may not work everywhere)
 
@@ -39,10 +40,10 @@ Feature: Wrap "foreman export"
       clock:  ....
       web:   bundle exec webserver -p $PORT
       """
-    When I run `bundle exec foreman-export-vhost upstart /etc/init -a MYAPP -u MYUSER -p 6000 -c clock=1,web=2 -L 80,81 -S localhost,myapp.com -K web -G nginx -N -R`
+    When I run `bundle exec foreman-export-vhost upstart /etc/init -f Procfile -a MYAPP -u MYUSER -p 6000 -c clock=1,web=2 -L 80,81 -S localhost,myapp.com -K web -G nginx -O assets_expire_in=15d -N -R`
     Then the output should match:
       """
-      bundle exec foreman run vhost-generator -f /.*/public -l 80,81 -s localhost,myapp.com -p 6100,6101 -g nginx -o upstream=MYAPP | sudo tee /etc/nginx/sites-enabled/rails-MYAPP.conf
+      bundle exec foreman run vhost-generator -a MYAPP -f /.*/public -l 80,81 -s localhost,myapp.com -p 6100,6101 -g nginx -o assets_expire_in\\=15d \| sudo tee /etc/nginx/sites-enabled/vhost-MYAPP.conf
       """
     And the output should contain:
       """
@@ -57,6 +58,6 @@ Feature: Wrap "foreman export"
     And the output should contain:
       """
       sudo service MYAPP start
-      echo "Finished, now open your browser and see if all works."
+      echo "Finished, now open your browser and see if everything works."
       # Now, try to run this script again without the --dry-run switch!
       """

data/features/output-nginx.feature

@@ -5,11 +5,11 @@ Feature: Output nginx configuration file
   I want to output a nginx virtualhost configuration.
 
   Scenario: using command-line options
-    When I run `bundle exec vhost-generator -g nginx -o upstream=myupstream -f html -l 80,81 -s localhost,my.server -p 5000,5001,5002 -r /myapp`
+    When I run `bundle exec vhost-generator -g nginx -o assets_expire_in=15d -a testapp -f html -l 80,81 -s localhost,my.server -p 5000,5001,5002 -r /myapp`
     Then the output should match /FILE GENERATED BY.*EDIT AT YOUR OWN RISK/
     And the output should contain:
       """
-      upstream myupstream {
+      upstream testapp {
         server localhost:5000 fail_timeout=0;
         server localhost:5001 fail_timeout=0;
         server localhost:5002 fail_timeout=0;
@@ -34,14 +34,14 @@ Feature: Output nginx configuration file
           proxy_set_header X-Forwarded-Proto $scheme;
           proxy_set_header Host $http_host;
           proxy_redirect off;
-          proxy_pass http://myupstream;
+          proxy_pass http://testapp;
         }
       """
       And the output should contain:
       """
         location /myapp/assets {
           gzip_static on; # to serve pre-gzipped version
-          expires 60d;
+          expires 15d;
           add_header  Cache-Control public;
         }
       """
@@ -55,7 +55,8 @@ Feature: Output nginx configuration file
 
   Scenario: using environment variables
     When I set env variable "GENERATOR" to "nginx"
-    And I set env variable "GENERATOR_OPTIONS" to "upstream=myupstream"
+    And I set env variable "GENERATOR_OPTIONS" to "assets_expire_in=15d"
+    And I set env variable "APPLICATION" to "testapp"
     And I set env variable "STATIC_FOLDER" to "html"
     And I set env variable "SERVER_PORTS" to "80,81"
     And I set env variable "SERVER_NAMES" to "localhost,my.server"
@@ -65,7 +66,7 @@ Feature: Output nginx configuration file
     Then the output should match /FILE GENERATED BY.*EDIT AT YOUR OWN RISK/
     And the output should contain:
       """
-      upstream myupstream {
+      upstream testapp {
         server localhost:5000 fail_timeout=0;
         server localhost:5001 fail_timeout=0;
         server localhost:5002 fail_timeout=0;
@@ -90,14 +91,14 @@ Feature: Output nginx configuration file
           proxy_set_header X-Forwarded-Proto $scheme;
           proxy_set_header Host $http_host;
           proxy_redirect off;
-          proxy_pass http://myupstream;
+          proxy_pass http://testapp;
         }
       """
     And the output should contain:
       """
         location /myapp/assets {
           gzip_static on; # to serve pre-gzipped version
-          expires 60d;
+          expires 15d;
           add_header  Cache-Control public;
         }
       """

data/features/version.feature

@@ -8,5 +8,5 @@ Feature: Output program version
     When I run `bundle exec vhost-generator --version`
     Then it should pass with:
       """
-      vhost-generator, version 0.2.2
+      vhost-generator, version 0.3.0
       """

data/lib/vhost_generator/application.rb

@@ -33,6 +33,9 @@ module VhostGenerator
     end
 
     def handle_env(env)
+      if app = env['APPLICATION']
+        config.application = app
+      end
       if path = env['STATIC_FOLDER']
         config.static_folder = path
       end
@@ -90,6 +93,9 @@ module VhostGenerator
 
     def application_options
       [
+        ['-a', '--application APPLICATION',
+           %q{Unique name of your application (e.g. myapp)},
+           lambda { |value| config.application = value }],
         ['-f', '--static-folder STATIC_FOLDER',
                 %q{Path of your application's static folder (e.g. public/)},
                 lambda { |value| config.static_folder = value }],

data/lib/vhost_generator/capistrano.rb

@@ -0,0 +1,64 @@
+require 'shellwords'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :vhost do
+    _cset(:vhost_port) { 5000 }
+    _cset(:vhost_env) { nil }
+    _cset(:vhost_concurrency) { nil }
+    _cset(:vhost_procfile) { 'Procfile' }
+    _cset(:vhost_server_ports) { '80' }
+    _cset(:vhost_server_names) { 'localhost' }
+    _cset(:vhost_process) { abort "Please specify the foreman process type, set :vhost_process, 'web' (if you have 'web' in your Procfile)" }
+    _cset(:vhost_generator) { abort "Please specify the target web server, set :vhost_generator, 'nginx' (or 'apache')" }
+    _cset(:vhost_generator_options) { nil }
+
+    desc <<-DESC
+  Runs the "foreman-export-vhost" command to manage a foreman-enabled \
+application using upstart and generate nginx or apache virtualhost configuration \
+file to serve it to web clients.
+
+You can override any of these defaults by setting the variables shown below.
+
+    set :vhost_port,               #{vhost_port.inspect}
+    set :vhost_env,                #{vhost_env.inspect}
+    set :vhost_concurrency,        #{vhost_concurrency.inspect}
+    set :vhost_procfile,           #{vhost_procfile.inspect}
+    set :vhost_server_ports,       #{vhost_server_ports.inspect}
+    set :vhost_server_names,       #{vhost_server_names.inspect}
+    set :vhost_generator,
+    set :vhost_generator_options,  #{vhost_generator_options.inspect}
+    set :vhost_process
+    DESC
+    task :export do
+      cmdline = "foreman-export-vhost upstart /etc/init -u $USER"
+      cmdline << " -a #{application.shellescape}"
+      cmdline << " -p #{String(vhost_port).shellescape}"
+      cmdline << " -e #{vhost_env.shellescape}" if vhost_env
+      cmdline << " -f #{vhost_procfile.shellescape}" if vhost_procfile
+      cmdline << " -c #{vhost_concurrency.shellescape}" if vhost_concurrency
+      cmdline << " -K #{vhost_process.shellescape}"
+      cmdline << " -L #{vhost_server_ports.shellescape}" if vhost_server_ports
+      cmdline << " -S #{vhost_server_names.shellescape}" if vhost_server_names
+      cmdline << " -G #{vhost_generator.shellescape}" if vhost_generator
+      cmdline << " -O #{vhost_generator_options.shellescape}" if vhost_generator_options
+      run "cd #{release_path} && #{sudo} RAILS_ENV=#{rails_env} bundle exec #{cmdline}"
+    end
+
+    before 'deploy:create_symlink', 'vhost:export'
+  end
+
+  # Each application is turned into an upstart service by 'foreman export'.
+  namespace :deploy do
+    task :start do
+      run "#{sudo} service #{application.shellescape} start"
+    end
+
+    task :stop do
+      run "#{sudo} service #{application.shellescape} stop"
+    end
+
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      run "#{sudo} service #{application.shellescape} restart"
+    end
+  end
+end

data/lib/vhost_generator/cmdline_builder.rb

@@ -34,7 +34,7 @@ module VhostGenerator
       args << '-s' << @config.server_names.join(',')
       args << '-p' << @config.instance_ports.join(',')
       args << '-r' << @config.relative_root
-      args << '-g' << 'nginx' # FIXME use @config.generator when real registry
+      args << '-g' << @config.generator
       options = @config.generator_options.collect {|k,v| "#{k}=#{v}" }
       args << '-o' << options.join(',')
       args

data/lib/vhost_generator/nginx_generator.rb

@@ -9,7 +9,9 @@ module VhostGenerator
     attr_reader :cfg, :options
     def initialize(cfg, options={})
       @cfg = cfg
-      @options = OpenStruct.new(default_options.merge(options)).freeze
+      @options = OpenStruct.new(default_options.merge(options))
+      @options.upstream ||= cfg.application
+      @options.freeze
     end
 
     def render
@@ -20,7 +22,7 @@ module VhostGenerator
 
     def default_options
       Hash[ 'client_max_body_size' => '4G', 'keepalive_timeout' => '10',
-            'assets_expire_in' => '60d', 'upstream' => 'appservers' ].freeze
+            'assets_expire_in' => '60d' ].freeze
     end
 
     private

data/lib/vhost_generator/version.rb

@@ -1,3 +1,3 @@
 module VhostGenerator
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/vhost_generator/vhost_configuration.rb

@@ -8,14 +8,16 @@ module VhostGenerator
   # +env+ or +cmdline+ needed to render the configuration template.
   #
   class VhostConfiguration
-    attr_reader :static_folder, :server_ports, :server_names,
+    attr_reader :application, :static_folder, :server_ports, :server_names,
                 :instance_ports, :relative_root,
                 :generator, :generator_options
     attr_accessor :cmdline
 
-    def initialize(static_folder='public', server_ports='80',
-        server_names='localhost', instance_ports='', relative_root='/',
-        generator='nginx', generator_options='', cmdline=nil)
+    def initialize(application='myapp', static_folder='public',
+        server_ports='80', server_names='localhost', instance_ports='',
+        relative_root='/', generator='nginx', generator_options='',
+        cmdline=nil)
+      self.application = application
       self.static_folder = static_folder
       self.server_ports = server_ports
       self.server_names = server_names
@@ -26,6 +28,12 @@ module VhostGenerator
       self.generator_options = generator_options
     end
 
+    def application=(app)
+      app = String(app).strip.gsub(/\s+/, '_') # avoid blanks in app name.
+      raise ArgumentError, "application is required" unless app && !app.empty?
+      @application = app
+    end
+
     def static_folder=(folder)
       @static_folder = File.expand_path(folder)
     end
@@ -47,7 +55,8 @@ module VhostGenerator
     end
 
     def generator=(name)
-      @generator = generator_for(name)
+      generator_for(name) # ensure generator exists
+      @generator = name
     end
 
     def generator_options=(options)
@@ -59,7 +68,7 @@ module VhostGenerator
     end
 
     def output
-      self.generator.new(self, self.generator_options).render
+      generator_for(self.generator).new(self, self.generator_options).render
     end
 
     protected

data/spec/application_env_spec.rb

@@ -7,6 +7,7 @@ describe VhostGenerator::Application do
     before { subject.config = config }
 
     options = Hash[
+      'application'       => 'APPLICATION',
       'static_folder'     => 'STATIC_FOLDER',
       'server_ports'      => 'SERVER_PORTS',
       'server_names'      => 'SERVER_NAMES',

data/spec/application_options_spec.rb

@@ -7,6 +7,7 @@ describe VhostGenerator::Application do
     before { subject.config = config }
 
     options = Hash[
+      'application'       => %w(-a --application),
       'static_folder'     => %w(-f --static-folder),
       'server_ports'      => %w(-l --listen),
       'server_names'      => %w(-s --server-name),

data/spec/vhost_configuration_spec.rb

@@ -1,6 +1,24 @@
 require 'vhost_generator/vhost_configuration'
 
 describe VhostGenerator::VhostConfiguration do
+  describe "#application" do
+    it "is 'myapp' by default" do
+      expect(subject.application).to eql('myapp')
+    end
+
+    it "is normalized on the fly" do
+      expect {
+        subject.application = '  my   sanitized  app '
+      }.to change(subject, :application).to('my_sanitized_app')
+    end
+
+    it "is required" do
+      expect {
+        subject.application = ''
+      }.to raise_error(ArgumentError, /required/)
+    end
+  end
+
   describe "#static_folder" do
     it "is 'public/' by default" do
       expect(subject.static_folder).to eql(File.expand_path('public'))
@@ -84,12 +102,12 @@ describe VhostGenerator::VhostConfiguration do
       expect(subject.generator).to be
     end
 
-    it "is resolved into a generator plugin" do
+    it "is set when a generator plugin exists" do
       generator = double('generator')
       subject.send(:registry).merge!('test' => generator)
       expect {
         subject.generator = 'test'
-      }.to change(subject, :generator).to generator
+      }.to change(subject, :generator).to 'test'
     end
 
     it "complains when trying to set invalid values" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vhost_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,6 +100,7 @@ files:
 - features/version.feature
 - lib/vhost_generator.rb
 - lib/vhost_generator/application.rb
+- lib/vhost_generator/capistrano.rb
 - lib/vhost_generator/cmdline_builder.rb
 - lib/vhost_generator/nginx_generator.rb
 - lib/vhost_generator/version.rb
@@ -126,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 138630257
+      hash: 1022995219
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 138630257
+      hash: 1022995219
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23