vagrant-hypconfigmgmt 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1ca6d12b79bff6c9cc89da885833eb16a0a2d3b
-  data.tar.gz: 4663a9bd184d529a84ec76a4d0afcf42f975c900
+  metadata.gz: e9cee22257d778227a2d1b2b2286e7ee518ee55c
+  data.tar.gz: 96bef3d160c2e5a77b5fa7e884c916906bd62abd
 SHA512:
-  metadata.gz: 3832d2fa53fac113c4ae7a41f5eae81d127ddd4b6bde96bc16a6723c03cf3c7dd7dda702fb130ab0ec531b034e8571355decd7c712c16f923051928a25ea5630
-  data.tar.gz: e653bc874f0a4ced2a4b5fa4718a3ce3552b2241a2baa78ca2616db35d6d9ad5422d149dbdf4724b6c81b0ab4497db5b2a84aca62362501899671db092696566
+  metadata.gz: f51b5e656562c661f5d1b8bc35e2a947f04675810f165bf1506e5675ef7cae288619825791179ea89b4d4e1cfe97fa2859f2298ced0e77f2d1e1575e2dd3d60a
+  data.tar.gz: 2d9b031d84ea2c15e4d4c372517aa59f6c578c35717d82b7075ad1d108bdbfdcb975333ef546f7be06a0f4ca9e3626131386cba4dd773ec58f712159659cdad0

data/.gitignore

@@ -0,0 +1,3 @@
+.coverage/
+Gemfile.lock
+coverage/

data/.rspec

@@ -0,0 +1 @@
+--color

data/Makefile

@@ -7,8 +7,10 @@ DESCRIPTION := Prompt to configure a hypernode-vagrant
 
 all:
 	rake build
+test:
+	bundle exec rspec spec/
 install:
-	find pkg/ | tail -n 1 | xargs vagrant plugin install
+	find pkg/ -name '*.gem' | head -n 1 | xargs vagrant plugin install
 clean:
 	git clean -xfd
 

data/README.md

@@ -2,8 +2,7 @@ Install the build deps
 ======================
 
 ```
-sudo apt-get install bundler
-sudo apt-get install rake
+sudo gem install bundler rake rspec simplecov coveralls
 ```
 
 Create the gemfile (package)
@@ -12,5 +11,5 @@ Create the gemfile (package)
 ```
 $ make
 rake build
-vagrant-hypconfigmgmt 0.0.1 built to pkg/vagrant-hypconfigmgmt-0.0.1.gem.
+vagrant-hypconfigmgmt 0.0.2 built to pkg/vagrant-hypconfigmgmt-0.0.2.gem.
 ```

data/lib/vagrant-hypconfigmgmt/command.rb

@@ -12,224 +12,265 @@ AVAILABLE_VARNISH_STATES = [true, false]
 
 # paths to local settings file
 H_V_SETTINGS_FILE = "local.yml"
+H_V_BASE_SETTINGS_FILE = ".local.base.yml"
 
 RECOMMENDED_PLUGINS = ["vagrant-hostmanager", "vagrant-vbguest"]
 
 
-def retrieve_settings()
-  return YAML.load_file(H_V_SETTINGS_FILE)
-end
-
-
-def update_settings(settings)
-  File.open(H_V_SETTINGS_FILE, 'w') {|f| f.write settings.to_yaml }
-end
-
-
-def use_default_if_input_empty(input, default)
-  if input == ''
-    return default.to_s
-  else
-    return input
-  end
-end
+module VagrantHypconfigmgmt
+  class Command
 
+    def initialize(app, env)
+      @app = app
+      @env = env
+    end
 
-def get_varnish_state(env)
-  input = env[:ui].ask("Do you want to enable Varnish? Enter true or false [default false]: ")
-  varnish_state = use_default_if_input_empty(input, DEFAULT_VARNISH_STATE)
 
-  case varnish_state
-    when "true"
-      env[:ui].info("Varnish will be enabled.")
-    when "false"
-      env[:ui].info("Varnish will be disabled by loading a nocache vcl.")
-    else
-      env[:ui].error("The value #{varnish_state} is not a valid value. Please enter true or false")
-      return get_varnish_state(env)
-  end
-  return varnish_state == "true" ? true : false
-end
+    # prompt for missing settings in local.yml. complain if there are invalid settings.
+    def call(env)
+      if env[:machine].config.hypconfigmgmt.enabled
+        changed = ensure_settings_configured(env)
+        ensure_required_plugins_are_installed(env)
+        if changed
+          env[:ui].info("Your hypernode-vagrant is now configured. Please run \"vagrant up\" again.")
+          return
+        end
+      end
+      @app.call(env)
+    end
 
 
-def get_magento_version(env)
-  available_versions = AVAILABLE_MAGENTO_VERSIONS.join(' or ')
-  input = env[:ui].ask("Is this a Magento #{available_versions} Hypernode? [default #{DEFAULT_MAGENTO_VERSION}]: ")
-  magento_version = use_default_if_input_empty(input, DEFAULT_MAGENTO_VERSION)
+    def retrieve_settings()
+      begin
+        return YAML.load_file(H_V_SETTINGS_FILE)
+      rescue Errno::ENOENT
+        return YAML.load_file(H_V_BASE_SETTINGS_FILE)
+      end
+    end
+    
 
-  case magento_version
-    when "1"
-      env[:ui].info("Nginx will be configured for Magento 1. The webdir will be /data/web/public")
-    when "2"
-      env[:ui].info("Nginx will be configured for Magento 2. /data/web/magento2/pub will be symlinked to /data/web/public")
-    else
-      env[:ui].error("The value #{magento_version} is not a valid Magento version. Please enter #{available_versions}")
-      return get_magento_version(env)
-  end
-  return magento_version.to_i
-end
+    def update_settings(settings)
+      File.open(H_V_SETTINGS_FILE, 'w') {|f| f.write settings.to_yaml }
+    end
+    
+    
+    def use_default_if_input_empty(input, default)
+      return input == '' ? default.to_s : input
+    end
+    
+    
+    def get_setting(env, available, default, ask_message)
+      input = env[:ui].ask(ask_message)
+      value = use_default_if_input_empty(input, default)
+      unless available.map { | v | v.to_s }.include?(value.to_s)
+        available_versions = get_options_string(available)
+        env[:ui].error("The value #{value} is not a valid value. Please enter #{available_versions}")
+        return get_setting(env, available, default, ask_message)
+      end
+      return value
+    end 
 
 
-# todo: refactor this and the above function into one
-def get_php_version(env)
-  available_versions = AVAILABLE_PHP_VERSIONS.join(' or ')
-  input = env[:ui].ask("Is this a PHP #{available_versions} Hypernode? [default #{DEFAULT_PHP_VERSION}]: ")
-  php_version = use_default_if_input_empty(input, DEFAULT_PHP_VERSION)
-
-  case php_version
-    when "5.5"
-      env[:ui].info("Will boot a box with PHP 5.5 installed")
-    when "7.0"
-      env[:ui].info("Will boot a box with PHP 7.0 installed")
-    else
-      env[:ui].error("The value #{php_version} is not a valid PHP version. Please enter #{available_versions}")
-      return get_php_version(env)
-  end
-  return php_version.to_f
-end
+    def get_options_string(available)
+      return available.map { | v | v.to_s }.join(' or ')
+    end
 
 
-def ensure_varnish_state_configured(env)
-  settings = retrieve_settings()
-  if settings['varnish']['enabled'].nil?
-    settings['varnish']['enabled'] = get_varnish_state(env)
-  elsif ![true, false].include?(settings['varnish']['enabled'])
-    env[:ui].error("The Varnish state configured in local.yml is invalid.")
-    settings['varnish']['enabled'] = get_varnish_state(env)
-  end
-  update_settings(settings)
-end
+    def get_php_version(env)
+      available_versions = get_options_string(AVAILABLE_PHP_VERSIONS)
+      ask_message = "Is this a PHP #{available_versions} Hypernode? [default #{DEFAULT_PHP_VERSION}]: "
+      php_version = get_setting(env, AVAILABLE_PHP_VERSIONS, DEFAULT_PHP_VERSION, ask_message).to_f
+      env[:ui].info("Will boot a box with PHP #{php_version} installed")
+      return php_version
+    end
 
 
-def ensure_magento_version_configured(env)
-  settings = retrieve_settings()
-  if settings['magento']['version'].nil?
-    settings['magento']['version'] = get_magento_version(env)
-  elsif !AVAILABLE_MAGENTO_VERSIONS.include?(settings['magento']['version'].to_i)
-    env[:ui].error("The Magento version configured in local.yml is invalid.")
-    settings['magento']['version'] = get_magento_version(env)
-  end
-  update_settings(settings)
-end
+    def get_magento_version(env)
+      available_versions = get_options_string(AVAILABLE_MAGENTO_VERSIONS)
+      ask_message = "Is this a Magento #{available_versions} Hypernode? [default #{DEFAULT_MAGENTO_VERSION}]: "
+      magento_version = get_setting(env, AVAILABLE_MAGENTO_VERSIONS, DEFAULT_MAGENTO_VERSION, ask_message).to_i
+      message = "Nginx will be configured for Magento #{magento_version}."
+      case magento_version
+        when 1
+          message += " The webdir will be /data/web/public"
+        when 2
+          message += " /data/web/magento2/pub will be symlinked to /data/web/public"
+      end
+      env[:ui].info(message)
+      return magento_version
+    end
 
 
-# Make sure we don't link /data/web/public on Magento 2 Vagrants
-# because that dir will be a symlink to /data/web/magento2/pub and 
-# we mount that. On Magento 1 Vagrants we need to make sure we don't
-# mount /data/web/magento2/pub.
-def ensure_magento_mounts_configured(env)
-  settings = retrieve_settings()
-  if !settings['fs'].nil? and !settings['fs']['folders'].nil?
-    if settings['fs']['disabled_folders'].nil?
-	    settings['fs']['disabled_folders'] = Hash.new
-    end
-    if settings['magento']['version'] == 1
-      if !settings['fs']['disabled_folders']['magento1'].nil?
-        settings['fs']['folders']['magento1'] = settings['fs']['disabled_folders']['magento1'].clone
-        settings['fs']['disabled_folders'].delete('magento1')
-        env[:ui].info("Re-enabling fs->disabled_folders->magento1 in the local.yml.")
-      end
-      if !settings['fs']['folders']['magento2'].nil?
-        settings['fs']['disabled_folders']['magento2'] = settings['fs']['folders']['magento2'].clone
-        settings['fs']['folders'].delete('magento2')
-        env[:ui].info("Disabling fs->folders->magento2 in the local.yml because Magento 1 was configured.")
-      end
-    elsif settings['magento']['version'] == 2
-      if !settings['fs']['disabled_folders']['magento2'].nil?
-        settings['fs']['folders']['magento2'] = settings['fs']['disabled_folders']['magento2'].clone
-        settings['fs']['disabled_folders'].delete('magento2')
-        env[:ui].info("Re-enabling fs->disabled_folders->magento2 in the local.yml.")
+    def get_varnish_state(env)
+      ask_message = "Do you want to enable Varnish? Enter true or false [default false]: "
+      varnish_enabled = get_setting(env, AVAILABLE_VARNISH_STATES, DEFAULT_VARNISH_STATE, ask_message)
+      varnish_state = varnish_enabled == 'true' ? true : false
+      message = "Varnish will be #{varnish_state ? 'enabled' : 'disabled'}"
+      if ! varnish_state
+        message += " by loading a nocache vcl."
       end
-      if !settings['fs']['folders']['magento1'].nil?
-        settings['fs']['disabled_folders']['magento1'] = settings['fs']['folders']['magento1'].clone
-        settings['fs']['folders'].delete('magento1')
-        env[:ui].info("Disabling fs->folders->magento1 in the local.yml because Magento 2 was configured..")
+      env[:ui].info(message)
+      return varnish_state
+    end
+    
+
+    # Make sure we don't link /data/web/public on Magento 2 Vagrants
+    # because that dir will be a symlink to /data/web/magento2/pub and 
+    # we mount that. On Magento 1 Vagrants we need to make sure we don't
+    # mount /data/web/magento2/pub.
+    def ensure_magento_mounts_configured(env)
+      settings = retrieve_settings()
+      if !settings['fs'].nil? and !settings['fs']['folders'].nil?
+        settings['fs']['disabled_folders'] ||= Hash.new
+        if settings['magento']['version'].to_s == "1"
+          if !settings['fs']['disabled_folders']['magento1'].nil?
+            settings['fs']['folders']['magento1'] = settings['fs']['disabled_folders']['magento1'].clone
+            settings['fs']['disabled_folders'].delete('magento1')
+            env[:ui].info("Re-enabling fs->disabled_folders->magento1 in the local.yml.")
+          end
+          if !settings['fs']['folders']['magento2'].nil?
+            settings['fs']['disabled_folders']['magento2'] = settings['fs']['folders']['magento2'].clone
+            settings['fs']['folders'].delete('magento2')
+            env[:ui].info("Disabling fs->folders->magento2 in the local.yml because Magento 1 was configured.")
+          end
+        elsif settings['magento']['version'].to_s == "2"
+          if !settings['fs']['disabled_folders']['magento2'].nil?
+            settings['fs']['folders']['magento2'] = settings['fs']['disabled_folders']['magento2'].clone
+            settings['fs']['disabled_folders'].delete('magento2')
+            env[:ui].info("Re-enabling fs->disabled_folders->magento2 in the local.yml.")
+          end
+          if !settings['fs']['folders']['magento1'].nil?
+            settings['fs']['disabled_folders']['magento1'] = settings['fs']['folders']['magento1'].clone
+            settings['fs']['folders'].delete('magento1')
+            env[:ui].info("Disabling fs->folders->magento1 in the local.yml because Magento 2 was configured..")
+          end
+        end 
+        if settings['fs']['disabled_folders'] == Hash.new
+          settings['fs'].delete('disabled_folders')
+        end
       end
-    end 
-    if settings['fs']['disabled_folders'] == Hash.new
-      settings['fs'].delete('disabled_folders')
+      update_settings(settings)
     end
-  end
-  update_settings(settings)
-end
 
 
-# todo: refactor this and the above function into one
-def ensure_php_version_configured(env)
-  settings = retrieve_settings()
-  if settings['php']['version'].nil?
-    settings['php']['version'] = get_php_version(env)
-  elsif !AVAILABLE_PHP_VERSIONS.include?(settings['php']['version'].to_f)
-    env[:ui].error("The PHP version configured in local.yml is invalid.")
-    settings['php']['version'] = get_php_version(env)
-  end
-  update_settings(settings)
-end
+    def ensure_attribute_configured(env, name, attribute, available)
+      settings = retrieve_settings()
+      if settings[name][attribute].nil?
+        settings[name][attribute] = yield
+      elsif !available.map { | v | v.to_s }.include?(settings[name][attribute].to_s)
+        env[:ui].error("The #{name} #{attribute} configured in local.yml is invalid.")
+        settings[name][attribute] = yield
+      end
+      update_settings(settings)
+    end
 
 
-def ensure_setting_exists(name)
-  settings = retrieve_settings()
-  if settings[name].nil?
-    settings[name] = Hash.new
-  end
-  update_settings(settings)
-end
+    def ensure_setting_exists(name)
+      settings = retrieve_settings()
+      settings[name] ||= Hash.new
+      update_settings(settings) 
+    end
+    
+    
+    def validate_magento2_root(env)
+      settings = retrieve_settings()
+      if !settings['fs'].nil? and !settings['fs']['folders'].nil?
+        if settings['fs']['folders'].select{ |_, f| f['guest'].start_with?('/data/web/public') }.any? && settings['magento']['version'] == 2
+          env[:ui].info("Can not configure a synced /data/web/public directory with Magento 2, this will be symlinked to /data/web/magento2!")
+          env[:ui].error("Please remove all fs->folders->*->guest paths that start with /data/web/public from your local.yml. Use /data/web/magento2 instead.")
+        end
+      end
+    end
 
 
-def validate_magento2_root(env)
-  settings = retrieve_settings()
-  if !settings['fs'].nil? and !settings['fs']['folders'].nil?
-    if settings['fs']['folders'].select{ |_, f| f['guest'].start_with?('/data/web/public') }.any? && settings['magento']['version'] == 2
-      env[:ui].info("Can not configure a synced /data/web/public directory with Magento 2, this will be symlinked to /data/web/magento2!")
-      env[:ui].error("Please remove all fs->folders->*->guest paths that start with /data/web/public from your local.yml. Use /data/web/magento2 instead.")
+    def inform_if_gatling_not_installed(env)
+      settings = retrieve_settings()
+      if settings['fs']['type'] == 'rsync' and !Vagrant.has_plugin?('vagrant-gatling-rsync')
+        env[:ui].info(<<-HEREDOC
+'Tip: run "vagrant plugin install vagrant-gatling-rsync" to speed up 
+shared folder operations.\nYou can then sync with "vagrant gatling-rsync-auto"
+instead of "vagrant rsync-auto" to increase performance
+HEREDOC
+)
+      end
     end
-  end
-end
-  
-
-def ensure_settings_configured(env)
-  old_settings = retrieve_settings()
-  ensure_setting_exists('magento')
-  ensure_magento_version_configured(env)
-  ensure_setting_exists('php')
-  ensure_php_version_configured(env)
-  ensure_setting_exists('varnish')
-  ensure_varnish_state_configured(env)
-  ensure_magento_mounts_configured(env)
-  validate_magento2_root(env)
-  new_settings = retrieve_settings()
-  return new_settings.to_yaml != old_settings.to_yaml
-end
 
 
-def ensure_required_plugins_are_installed(env)
-  RECOMMENDED_PLUGINS.each do |plugin|
-    unless Vagrant.has_plugin?(plugin)
-      env[:ui].info("Installing the #{plugin} plugin.")
-      system("vagrant plugin install #{plugin}")
+    def ensure_vagrant_box_type_configured(env)
+      settings = retrieve_settings()
+      case settings['php']['version']
+        when 5.5
+          env[:ui].info("Will use PHP 5.5. If you want PHP 7 instead change the php version in local.yml.")
+          settings['vagrant']['box'] = 'hypernode_php5'
+          settings['vagrant']['box_url'] = 'http://vagrant.hypernode.com/customer/php5/catalog.json'
+        when 7.0
+          env[:ui].info("Will use PHP 7. If you want PHP 5.5 instead change the php version in local.yml.")
+          settings['vagrant']['box'] = 'hypernode_php7'
+          settings['vagrant']['box_url'] = 'http://vagrant.hypernode.com/customer/php7/catalog.json'
+      end
+      update_settings(settings)
+    end
+      
+    
+    def configure_magento(env)
+      ensure_setting_exists('magento')
+      ensure_attribute_configured(
+        env, 'magento', 'version', 
+        AVAILABLE_MAGENTO_VERSIONS
+      ) { get_magento_version(env) }
+    end
+    
+    
+    def configure_php(env)
+      ensure_setting_exists('php')
+      ensure_attribute_configured(
+        env, 'php', 'version',
+        AVAILABLE_PHP_VERSIONS
+      ) { get_php_version(env) }
+    end
+    
+    
+    def configure_varnish(env)
+      ensure_setting_exists('varnish')
+      ensure_attribute_configured(
+        env, 'varnish', 'state',
+        AVAILABLE_VARNISH_STATES
+      ) { get_varnish_state(env) }
+    end
+    
+    
+    def configure_synced_folders(env)
+      ensure_magento_mounts_configured(env)
+      validate_magento2_root(env)
+      inform_if_gatling_not_installed(env)
     end
-  end
-end
-
 
-module VagrantHypconfigmgmt
-  class Command
 
-    def initialize(app, env)
-      @app = app
-      @env = env
+    def configure_vagrant(env)
+      ensure_setting_exists('vagrant')
+      ensure_vagrant_box_type_configured(env)
     end
-
-    def call(env)
-      if env[:machine].config.hypconfigmgmt.enabled
-        changed = ensure_settings_configured(env)
-        ensure_required_plugins_are_installed(env)
-	if changed
-          env[:ui].info("Your hypernode-vagrant is now configured. Please run \"vagrant up\" again.")
-	  return
-	end
+    
+    
+    def ensure_settings_configured(env)
+      old_settings = retrieve_settings()
+      configure_magento(env)
+      configure_php(env)
+      configure_varnish(env)
+      configure_synced_folders(env)
+      configure_vagrant(env)
+      new_settings = retrieve_settings()
+      return new_settings.to_yaml != old_settings.to_yaml
+    end
+    
+    
+    def ensure_required_plugins_are_installed(env)
+      RECOMMENDED_PLUGINS.each do |plugin|
+        unless Vagrant.has_plugin?(plugin)
+          env[:ui].info("Installing the #{plugin} plugin.")
+          system("vagrant plugin install #{plugin}")
+        end
       end
-      @app.call(env)
     end
   end
 end