web_server_config_generator 0.0.1

data/bin/web_server_setup

@@ -0,0 +1,513 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'pp'
+require 'find'
+require 'digest/sha1'
+require 'pathname'
+require 'rubygems'
+require 'highline/import'
+require 'optparse'
+require 'yaml'
+$:.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+require 'web_server_config_generator'
+require 'web_server_config_generator/project_directory'
+require 'web_server_config_generator/sub_uri_project'
+
+
+$ENVS = []
+$TEST_MODE = false
+$CREATE_WEB_SERVER_FILES_DIR = false
+$PRINT_HOSTS = false
+$WEB_SERVER_FILES_DIR = nil
+$ADD_HOSTS = nil
+$RESTART_NGINX = nil
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [project(s) dir] [options]"
+
+  opts.separator ""
+  opts.separator "This will generate web server configuration files for your projects."
+  opts.separator ""
+  opts.separator "If you supply a project directory we assume you have run this before and will just generate the files for that project.  If you specify your projects directory we will generate the files for all projects found.  Not supplying a directory is the same as supplying your current directory."
+  opts.separator ""
+  opts.separator "No flags = try to generate files for all envs"
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  # Mandatory argument.
+  opts.on("-e", "--environment ENV",
+          "specify a specific environment to generate (defaults to all in database.yml)") do |env|
+    $ENVS << env
+  end
+
+  opts.on("-n", "--list-hosts",
+          "list generated hostnames, useful for setting up the hosts file on your own") do
+    $PRINT_HOSTS = true
+  end
+
+  opts.on("-c", "--create-web-server-files-dir",
+          "create web_server_files directory (useful the first time you run this script) in this case the supplied (or assumed) directory will be set as the 'projects' directory") do
+    $CREATE_WEB_SERVER_FILES_DIR = true
+  end
+
+  opts.on("-p", "--projects-dir DIR",
+          "specify the directory containing all your projects") do |dir|
+    $PROJECTS_DIRECTORY = dir
+  end
+
+  opts.on("-l", "--web-server-files-dir-location DIR",
+          "put all the web server configuration files in DIR instead of the default location") do |path|
+    $WEB_SERVER_FILES_DIR = File.expand_path(path)
+  end
+
+  opts.on("-a", "--[no-]add-hosts",
+          "add ghost entries for generated hostnames, requires ghost gem") do |b|
+    $ADD_HOSTS = b
+  end
+
+  opts.on("-r", "--[no-]restart-nginx",
+          "restart nginx at the end") do |b|
+    $RESTART_NGINX = b
+  end
+
+  opts.on("-v", "--verbose",
+          "verbose") do
+    $VERBOSE = true
+  end
+
+  opts.on("-t", "--test-mode",
+          "test mode; do not modify the FS, just print messsages") do
+    $TEST_MODE = true
+  end
+
+#   # Optional argument; multi-line description.
+#   opts.on("-i", "--inplace [EXTENSION]",
+#           "Edit ARGV files in place",
+#           "  (make backup if EXTENSION supplied)") do |ext|
+#     options.inplace = true
+#     options.extension = ext || ''
+#     options.extension.sub!(/\A\.?(?=.)/, ".")  # Ensure extension begins with dot.
+#   end
+
+#   # Boolean switch.
+#   opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+#     options.verbose = v
+#   end
+
+  opts.separator ""
+  opts.separator "Common options:"
+
+  # No argument, shows at tail.  This will print an options summary.
+  # Try it and see!
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+opts.parse!(ARGV)
+
+def agree( yes_or_no_question, character = nil )
+  ask(yes_or_no_question, lambda { |yn| yn.downcase[0] == ?y}) do |q|
+    q.validate                 = /\Ay(?:es)?|no?\Z/i
+    q.responses[:not_valid]    = 'Please enter "yes" or "no".'
+    q.responses[:ask_on_error] = :question
+    q.character                = character
+    yield q if block_given?
+  end
+end
+
+module WebServerSetup
+  WEB_SERVER_FILES_DIR_NAME = ".webconfig"
+
+  class Directory < Pathname
+    def +(other)
+      other = self.class.new(other) unless self.class === other
+      self.class.new(plus(@path, other.to_s))
+    end
+
+    def mkpath
+      if $TEST_MODE
+        puts "test mode: mkpath #{self}"
+      else
+        super
+      end
+    end
+
+    def write(arg)
+      if $TEST_MODE
+        puts "test mode: write #{self}, #{arg.to_s[0, 100]}..."
+      else
+        FileUtils.mkdir_p File.dirname(self)
+        self.open("w") { |f| f.write arg }
+      end
+    end
+
+    def read
+      if self.exist?
+        self.open("r") { |f| f.read }
+      else
+        ""
+      end
+    end
+  end
+
+  class Generator
+    def initialize(options)
+      options.each do |opt, val|
+        instance_variable_set("@#{opt}", val)
+      end
+
+      @starting_port = options[:starting_port] || 40000
+      @port_pool_size = options[:port_pool_size] || 10000
+
+      @environment_map = Hash.new(options[:environments]) if options[:environments]
+
+      setup_config_dir
+
+      @project_or_projects_dir ||= projects_dir
+    end
+
+    def write_conf_files
+      FileUtils.cd projects_dir do
+        # generate files for each proj/env
+        list_of_conf_files = []
+        app_projects.each do |p|
+          environment_map[p].each do |env|
+            list_of_conf_files << write_conf_file(p, env)
+          end
+        end
+
+        sub_uri_projects.each do |p|
+          create_sub_uri_links_dir p
+          list_of_conf_files << write_conf_file(p, p.env)
+        end
+
+        current_lines = []
+        web_server_vhost_nginx_conf.read.each_line { |l| current_lines << l }
+        new_lines = current_lines + list_of_conf_files.map { |p| "include #{p};\n" }
+        new_lines.uniq!
+        new_lines.sort!
+        web_server_vhost_nginx_conf.write(new_lines.join)
+      end
+    end
+
+    def create_sub_uri_links_dir(sub_uri_project)
+      env = sub_uri_project.env
+
+      web_server_sub_uri_apps_dir.mkdir unless web_server_sub_uri_apps_dir.exist?
+      links_dir = web_server_sub_uri_apps_dir + sub_uri_project.server_name
+      links_dir.mkdir unless links_dir.exist?
+      sub_uri_project.projects.each do |p|
+        symlink p.expand_path + "public", File.join(links_dir, p.relative_root_url_for_env(env))
+        if p.relative_root_url_root_for_env(env)
+          symlink p.expand_path + "public", File.join(links_dir, "root")
+        end
+      end
+    end
+
+    def server_names
+      projects.map { |p| p.server_names }.flatten
+    end
+
+    def add_ghost_entries
+      current_hosts = Host.list
+      already_correct = []
+      added = []
+      present_but_incorrect = []
+      server_names.each do |server_name|
+        if host = current_hosts.detect { |h| h.name == server_name }
+          if host.ip == "127.0.0.1"
+            already_correct << host
+          else
+            present_but_incorrect << host
+          end
+        else
+          if $TEST_MODE
+            puts "would have added #{server_name} -> 127.0.0.1"
+          else
+            added << Host.add(server_name)
+          end
+        end
+      end
+
+      if already_correct.size > 0
+        puts "\n#{already_correct.size} hosts were already setup correctly"
+        puts
+      end
+
+      if added.size > 0
+        puts "The following hostnames were added for 127.0.0.1:"
+        puts added.map { |h| "  #{h.name}\n" }
+        puts
+      end
+
+      if present_but_incorrect.size > 0
+        puts "The following hostnames were present, but didn't map to 127.0.0.1:"
+        pad = present_but_incorrect.max{|a,b| a.to_s.length <=> b.to_s.length }.to_s.length
+        puts present_but_incorrect.map { |h| "#{h.name.rjust(pad+2)} -> #{h.ip}\n" }
+        puts
+      end
+    end
+
+    def setup_config_dir
+      unless File.exist?(config_dir)
+        unless dir = $PROJECTS_DIRECTORY
+          puts "It looks like this is the first time you've run me."
+          puts 
+          if agree("setup #{@project_or_projects_dir} as your projects dir? [Y/n]") { |q| q.default = "Y"}
+            dir = @project_or_projects_dir
+          else
+            puts "for your first run you'll need to supply your projects directory"
+            exit
+          end
+          puts "setting up config dir"
+        end
+
+        FileUtils.mkdir_p config_dir
+        initial_config = { :projects_dirs => [File.expand_path(dir)]}
+        save_global_config(initial_config)
+      end
+    end
+
+    def symlink(link_target, link_name)
+      if File.exist?(link_name)
+        if FileTest.symlink?(link_name)
+          unless File.readlink(link_name) == link_target
+            puts "symlink '#{link_name}' exists, but doesn't appear to link to the correct place"
+          end
+        else
+          puts "couldn't make symlink '#{link_name}', something's already there"
+        end
+      else
+        File.symlink link_target, link_name
+      end
+    end
+
+    def setup_webserver_links_dir
+      FileUtils.cd projects_dir do
+        link_target = File.join "..", ".."
+        web_server_links_dir.mkpath
+        environments.each do |e|
+          link_name = web_server_links_dir + e
+          symlink(link_target, link_name)
+        end
+      end
+    end
+
+    def app_projects
+      @app_projects ||=
+        begin
+          find_project_and_symlink_dirs
+          @app_projects
+        end
+    end
+
+    def sub_uri_projects
+      return @sub_uri_projects if @sub_uri_projects
+      server_name_env_project_map = {}
+      app_projects.each do |p|
+        p.server_name_env_pairs.each do |server_name, env|
+          server_name_env_project_map[server_name] ||= {}
+          server_name_env_project_map[server_name][:env] ||= env
+          raise "can't have one hostname map to multiple envs" if server_name_env_project_map[server_name][:env] != env
+          server_name_env_project_map[server_name][:projects] ||= []
+          server_name_env_project_map[server_name][:projects] << p
+        end
+      end
+      server_name_env_project_map = server_name_env_project_map.select { |server_name, env_and_projects| env_and_projects[:projects].size > 1 }
+      @sub_uri_projects = server_name_env_project_map.map do |server_name, env_and_projects|
+        WebServerConfigGenerator::SubUriProject.new(server_name, env_and_projects, self)
+      end
+    end
+
+    def projects
+      app_projects + sub_uri_projects
+    end
+
+    def environments
+      @environments ||= environment_map.values.flatten.uniq
+    end
+
+    def web_server_vhost_nginx_conf
+      web_server_vhost_nginx_dir + "projects.conf"
+    end
+
+    def check_nginx_conf
+      unless nginx_conf =~ /include.*#{web_server_vhost_nginx_conf}/
+        puts "\nWarning: You'll need to make sure this line is in your nginx config, in the http block:"
+        puts "  include #{web_server_vhost_nginx_conf};"
+      end
+
+      unless nginx_conf =~ /server_names_hash_bucket_size.*128/
+        puts "\nWarning: Couldn't find the following line in your nginx conf.  It should be in the http block."
+        puts "  server_names_hash_bucket_size 128;"
+      end
+    end
+
+    def prompt_to_restart_nginx
+      puts
+      if $RESTART_NGINX || ($RESTART_NGINX.nil? && agree("Restart nginx? [Y/n]") { |q| q.default = "Y"})
+        puts "Restarting nginx..."
+        cmd = "sudo killall nginx; sleep 1 && sudo #{nginx}"
+        puts "running: #{cmd}"
+        system cmd
+      end
+    end
+
+    def web_server_links_dir
+      web_server_files_dir + "links"
+    end
+
+    def projects_dir
+      WebServerSetup::Directory.new(global_config[:projects_dirs].first).expand_path
+    end
+
+    def web_server_sub_uri_apps_dir
+      web_server_files_dir + "sub_uri_apps"
+    end
+
+    private
+
+    def config_dir
+      $WEB_SERVER_FILES_DIR || begin
+                                 raise "Couldn't fine $HOME" unless home_dir = ENV["HOME"]
+                                 File.join(home_dir, ".webconfig")
+                               end
+    end
+
+    def global_config(reload = false)
+      @global_config = nil if reload
+      @global_config ||= YAML.load_file(global_config_path)
+    end
+
+    def save_global_config(config)
+      @global_config = config
+      File.open(global_config_path, "w") { |f| f.write config.to_yaml }
+    end
+
+    def global_config_path
+      File.join(config_dir, "global_config.yml")
+    end
+
+    def web_server_files_dir
+      $WEB_SERVER_FILES_DIR ? Directory.new($WEB_SERVER_FILES_DIR) : config_dir
+    end
+
+    def web_server_vhost_dir
+      web_server_files_dir + "vhost"
+    end
+
+    def web_server_vhost_nginx_dir
+      web_server_vhost_dir + "nginx"
+    end
+
+    def find_project_and_symlink_dirs
+      @app_projects ||= []
+
+      if @project_or_projects_dir.expand_path != projects_dir.expand_path
+        @app_projects = [WebServerConfigGenerator::ProjectDirectory.new(@project_or_projects_dir, self)]
+        return
+      end
+
+      Dir[File.join(projects_dir, "**", ".webconfig.yml")].each do |webconfig_path|
+        @app_projects << WebServerConfigGenerator::ProjectDirectory.new(File.dirname(webconfig_path), self)
+      end
+    end
+
+    def projects_environment_map
+      app_projects.inject({}) { |map, p| map[p] = p.environments; map }
+    end
+
+    def symlinks_environment_map
+      sub_uri_projects.inject({}) { |map, p| map[p] = p.env.to_s; map }
+    end
+
+    def environment_map
+      @environment_map ||= projects_environment_map.merge(symlinks_environment_map)
+    end
+
+    def projects_relative_project_path(dir)
+      File.expand_path(dir).sub(File.expand_path(projects_dir), '').sub(/^\//, '')
+    end
+
+    def write_conf_file(p, env)
+      project_vhost_dir = web_server_vhost_nginx_dir + projects_relative_project_path(p)
+      project_vhost_dir.mkpath
+      project_env_vhost_filename = project_vhost_dir + "#{env}.conf"
+      new_contents = p.generate_conf_file_contents(:env => env)
+      if project_env_vhost_filename.exist?
+        old_contents = project_env_vhost_filename.read
+        if old_contents != new_contents
+          puts "#{project_env_vhost_filename} exists, but doesn't match"
+        end
+      else
+        project_env_vhost_filename.write new_contents
+      end
+      project_env_vhost_filename.expand_path
+    end
+
+    def nginx_conf_path
+      m = `#{nginx} -t 2>&1`.match /the configuration file (.*) syntax is ok/
+      m[1]
+    end
+
+    def nginx_conf
+      @nginx_conf ||= begin
+                        File.read(nginx_conf_path)
+                      rescue Exception => e
+                        puts "Warning: Couldn't find/read nginx conf"
+                        ""
+                      end
+    end
+
+    def nginx
+      nginx_path_options = [
+                            "nginx",
+                            "/opt/nginx/sbin/nginx"
+                           ]
+      nginx_path_options.detect { |p| system "which #{p} &> /dev/null" }
+    end
+
+  end
+
+end
+
+
+project_or_projects_dir = ARGV.first && WebServerSetup::Directory.new(File.expand_path(ARGV.first))
+
+options = {}
+options[:environments] = $ENVS if $ENVS.any?
+options[:project_or_projects_dir] = project_or_projects_dir
+web_server_setup = WebServerSetup::Generator.new(options)
+
+web_server_setup.setup_webserver_links_dir
+
+if $PRINT_HOSTS
+  puts web_server_setup.server_names.join("\n")
+  exit 0
+end
+
+
+web_server_setup.write_conf_files
+
+begin
+  require 'ghost'
+  puts
+  if $ADD_HOSTS || ($ADD_HOSTS.nil? && agree("Setup ghost entries for projects? [Y/n]") { |q| q.default = "Y"})
+    puts "Setting up ghost entries..."
+    web_server_setup.add_ghost_entries
+  end
+rescue LoadError
+  puts "Couldn't load ghost so I won't add hostname entries for you.  Install the 'ghost' gem, or run me with a -n to get a list of hostnames to setup youself."
+end
+
+pp web_server_setup.app_projects if $VERBOSE
+# pp web_server_setup.symlink_dirs if $VERBOSE
+pp web_server_setup.environments if $VERBOSE
+
+web_server_setup.check_nginx_conf
+
+web_server_setup.prompt_to_restart_nginx
+

data/lib/web_server_config_generator.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module WebServerConfigGenerator
+  VERSION = '0.0.1'
+  STARTING_PORT = 40_000
+  PORT_POOL_SIZE = 10_000
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: web_server_config_generator
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Expected Behavior
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-17 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: automatically generate web server config files for you projects directory
+email: 
+executables: 
+- web_server_setup
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/web_server_config_generator.rb
+- lib/web_server_config_generator/project_directory.rb
+- lib/web_server_config_generator/sub_uri_project.rb
+has_rdoc: true
+homepage: http://github.com/expectedbehavior/web_server_config_generator
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: automatically generate web server config files for you projects directory
+test_files: []
+