vhost_generator 0.2.0 → 0.2.1

data/bin/foreman-export-vhost

@@ -0,0 +1,260 @@
+#!/usr/bin/env ruby
+
+=begin
+Wraps "foreman export" and "vhost-generator" in a single command.
+TODO: rewrite as a real application, not just a glorified shell script.
+=end
+
+require 'optparse'
+require 'ostruct'
+require 'shellwords'
+
+class ForemanExportApplication
+  def initialize(output_stream)
+    @output_stream = output_stream
+  end
+
+  def run(argv)
+    standard_exception_handling do
+      handle_arguments!(argv)
+      apply_defaults_and_sanitize_config
+      config.instance_ports = InstancePortCalculator.new(config).apply
+      commands = String(ShellBuilder.new(config, argv).apply)
+      if config.dry_run
+        puts commands
+        puts "# Now, try to run this script again without the --dry-run switch!"
+      else
+        exec commands
+      end
+    end
+  end
+
+  protected
+
+  def config
+    @config ||= OpenStruct.new
+  end
+
+  def handle_arguments!(argv)
+    OptionParser.new do |opts|
+      opts.banner = "Usage: foreman-export-vhost FORMAT LOCATION"
+
+      opts.separator ""
+      opts.separator "Foreman options:"
+      foreman_options.each { |args| opts.on(*args) }
+
+      opts.separator ""
+      opts.separator "Vhost-generator options:"
+      generator_options.each { |args| opts.on(*args) }
+
+      opts.separator ""
+
+      opts.on_tail("-h", "--help", "-H", "Display this help message.") do
+        puts opts
+        exit(true)
+      end
+    end.parse!(argv)
+  end
+
+  def foreman_options
+    [
+      ['-a', '--app=APP', lambda { |value| config.app = value }],
+      ['-l', '--log=LOG', lambda { |value| config.log = value }],
+      ['-e', '--env=ENV',
+             '# Specify an environment file to load, defaults to .env',
+             lambda { |value| config.env = value }],
+      ['-p', '--port=N',
+             '# Default: 5000',
+             lambda { |value| config.port = Integer(value) }],
+      ['-u', '--user=USER', lambda { |value| config.user = value }],
+      ['-t', '--template=TEMPLATE', lambda { |value| config.template = value }],
+      ['-c', '--concurrency=alpha=5,bar=3',
+             lambda { |value| config.concurrency = value }],
+      ['-f', '--procfile=PROCFILE',
+             '# Default: Procfile',
+             lambda { |value| config.procfile = value }],
+      ['-d', '--root=ROOT',
+             '# Default: Procfile directory',
+             lambda { |value| config.root = value }],
+    ].freeze
+  end
+
+  def generator_options
+    [
+      ['-F', '--static-folder=FOLDER',
+             '# Default: "public" folder in Procfile directory',
+             lambda { |value| config.static_folder = value }],
+      ['-L', '--server-ports=PORTS',
+             '# Default: 80',
+             lambda { |value| config.server_ports = value }],
+      ['-S', '--server-names=NAMES',
+             '# Default: localhost',
+             lambda { |value| config.server_names = value }],
+      ['-K', '--foreman-process-type=TYPE',
+             '# 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)',
+             lambda { |value| config.generator = value }],
+      ['-N', '--dry-run', lambda { |value| config.dry_run = true }],
+      ['-R', '--stop-start-service',
+             '# Starts and stops APP service (may not work everywhere)',
+             lambda { |value| config.service = true }],
+    ].freeze
+  end
+
+  def apply_defaults_and_sanitize_config
+    config.app ||= 'myapp'
+    config.port ||= 5000
+    config.procfile ||= 'Procfile'
+    config.procfile = File.expand_path(config.procfile)
+    config.root ||= File.dirname(config.procfile)
+    config.root = File.expand_path(config.root)
+    config.static_folder ||= File.join(config.root, 'public')
+    config.static_folder = File.expand_path(config.static_folder)
+    config.generator ||= 'nginx'
+    config.process_type ||= 'web'
+  end
+
+  class InstancePortCalculator
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def apply
+      c = process_concurrency(config.concurrency, config.process_type)
+      o = process_offset(config.procfile, config.process_type)
+      raise ArgumentError, "Can't find process type %s in %s, sorry." % [
+        config.process_type.inspect, config.procfile.inspect
+      ] unless o
+      base_port = config.port + 100 * o
+      (base_port...base_port + c).to_a.join(',')
+    end
+
+    def process_concurrency(concurrency, process_type)
+      if concurrency && process_type
+        per_type = Hash[concurrency.split(',').map { |v| v.split('=', 2) }]
+        Integer(per_type[process_type] || 1)
+      else
+        1
+      end
+    end
+
+    def process_offset(procfile, process_type)
+      process_type_re = %r(#{Regexp.escape(process_type)}:)
+      File.read(procfile).lines.each_with_index do |l,i|
+        return i if l =~ process_type_re
+      end
+      nil # not found
+    end
+  end
+
+  class ShellBuilder
+    def initialize(config, argv, commands=Array.new)
+      @config = config
+      @argv = argv
+      @commands = commands
+    end
+
+    def to_str
+      commands.collect { |c| c.join(' ') }.join($/)
+    end
+
+    def apply
+      commands << %w(bundle exec foreman run vhost-generator) +
+                  escape(generator_flags) +
+                  %w(| sudo tee) + escape(vhost_config)
+      commands << %w(sudo service) + escape(service) + %w(reload)
+      commands << %w(sudo service) + escape(app) +
+                  %w(stop >/dev/null 2>&1 || true) if config.service
+      commands << %w(sudo rm -rf) +
+                  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."']
+      self
+    end
+
+    protected
+
+    attr_reader :config, :argv, :commands
+
+    def generator_flags(flags=Array.new)
+      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
+    end
+
+    def foreman_flags(flags=Array.new)
+      flags << '-a' << config.app if config.app
+      flags << '-l' << config.log if config.log
+      flags << '-e' << config.env if config.env
+      flags << '-p' << String(config.port) if config.port
+      flags << '-u' << config.user if config.user
+      flags << '-t' << config.template if config.template
+      flags << '-c' << config.concurrency if config.concurrency
+      flags << '-f' << config.procfile if config.procfile
+      flags << '-d' << config.root if config.root
+    end
+
+    def app
+      config.app
+    end
+
+    def service
+      config.generator # nginx
+    end
+
+    def target
+      argv[1] # eg. /etc/init
+    end
+
+    def vhost_config
+      "/etc/#{service}/sites-enabled/rails-#{app}.conf"
+    end
+
+    def escape(args)
+      Array(args).map { |c| Shellwords.shellescape(c) }
+    end
+  end
+
+  private
+
+  def puts(*args)
+    @output_stream.puts(*args)
+  end
+
+  # Provide standard exception handling for the given block.
+  def standard_exception_handling
+    begin
+      yield
+    rescue SystemExit => ex
+      # Exit silently with current status
+      raise
+    rescue OptionParser::InvalidOption => ex
+      $stderr.puts ex.message
+      exit(false)
+    rescue Exception => ex
+      # Exit with error message
+      display_error_message(ex)
+      exit(false)
+    end
+  end
+
+  # Display the error message that caused the exception.
+  def display_error_message(ex)
+    $stderr.puts "#{@name} aborted!"
+    $stderr.puts ex.message
+    $stderr.puts ex.backtrace.join("\n")
+  end
+end
+
+ForemanExportApplication.new($stdout).run(ARGV)
+

data/features/foreman-export-vhost.feature

@@ -0,0 +1,62 @@
+Feature: Wrap "foreman export"
+
+  In order to generate and install a foreman web application to a virtualhost
+  As a user of the library
+  I want to run "foreman export" and "vhost-generator" together with DRY arguments.
+
+  Scenario: display help
+    When I run `bundle exec foreman-export-vhost --help`
+    Then it should pass with:
+      """
+      Usage: foreman-export-vhost FORMAT LOCATION
+
+      Foreman options:
+          -a, --app=APP
+          -l, --log=LOG
+          -e, --env=ENV                    # Specify an environment file to load, defaults to .env
+          -p, --port=N                     # Default: 5000
+          -u, --user=USER
+          -t, --template=TEMPLATE
+          -c, --concurrency=alpha=5,bar=3
+          -f, --procfile=PROCFILE          # Default: Procfile
+          -d, --root=ROOT                  # Default: Procfile directory
+
+      Vhost-generator options:
+          -F, --static-folder=FOLDER       # Default: "public" folder in Procfile directory
+          -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)
+          -N, --dry-run
+          -R, --stop-start-service         # Starts and stops APP service (may not work everywhere)
+
+          -h, -H, --help                   Display this help message.
+      """
+
+  Scenario: display source that will be executed
+    Given a file named "Procfile" with:
+      """
+      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`
+    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
+      """
+    And the output should contain:
+      """
+      sudo service nginx reload
+      sudo service MYAPP stop >/dev/null 2>&1 || true
+      sudo rm -rf /etc/init/MYAPP-*.conf
+      """
+    And the output should match:
+      """
+      sudo bundle exec foreman export upstart /etc/init -a MYAPP -p 6000 -u MYUSER -c clock\\=1,web\\=2 -f /.*/Procfile -d /.*$
+      """
+    And the output should contain:
+      """
+      sudo service MYAPP start
+      echo "Finished, now open your browser and see if all works."
+      # Now, try to run this script again without the --dry-run switch!
+      """

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.0
+      vhost-generator, version 0.2.1
       """

data/lib/vhost_generator/version.rb

@@ -1,3 +1,3 @@
 module VhostGenerator
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vhost_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-01 00:00:00.000000000 Z
+date: 2012-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,7 @@ description: vhost_generator outputs a general-purpose VirtualHost configuration
 email:
 - julien.perville@mingalar.fr
 executables:
+- foreman-export-vhost
 - vhost-generator
 extensions: []
 extra_rdoc_files: []
@@ -89,7 +90,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/foreman-export-vhost
 - bin/vhost-generator
+- features/foreman-export-vhost.feature
 - features/help.feature
 - features/output-nginx.feature
 - features/step_definitions/dev_steps.rb
@@ -123,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -418120369
+      hash: -251905965
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -418120369
+      hash: -251905965
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -141,6 +144,7 @@ specification_version: 3
 summary: vhost_generator outputs nginx or apache VirtualHost configurations to run
   your web application
 test_files:
+- features/foreman-export-vhost.feature
 - features/help.feature
 - features/output-nginx.feature
 - features/step_definitions/dev_steps.rb