nugrant 2.0.0.dev2 → 2.0.0.pre1

data/lib/nugrant/vagrant/v2/command/helper.rb

@@ -0,0 +1,30 @@
+require 'nugrant'
+require 'nugrant/bag'
+require 'nugrant/vagrant/v2/config/user'
+
+module Nugrant
+  module Vagrant
+    module V2
+      module Command
+        class Helper
+          def self.get_restricted_keys()
+            bag_methods = Nugrant::Bag.instance_methods
+            parameters_methods = V2::Config::User.instance_methods
+
+            (bag_methods | parameters_methods).map(&:to_s)
+          end
+
+          def self.get_used_restricted_keys(hash, restricted_keys)
+            keys = []
+            hash.each do |key, value|
+              keys << key if restricted_keys.include?(key)
+              keys += get_used_restricted_keys(value, restricted_keys) if value.kind_of?(Hash)
+            end
+
+            keys.uniq
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nugrant/vagrant/v2/command/parameters.rb

@@ -1,5 +1,6 @@
 require 'nugrant'
 require 'nugrant/helper/yaml'
+require 'nugrant/vagrant/v2/command/helper'
 
 module Nugrant
   module Vagrant
@@ -61,7 +62,7 @@ module Nugrant
             @logger.debug("'Parameters' each target VM...")
             with_target_vms(arguments) do |vm|
               config = vm.config.user
-              parameters = config ? config.parameters : Nugrant::Parameters.new()
+              parameters = config || Nugrant::Parameters.new()
 
               @env.ui.info("# Vm '#{vm.name}'", :prefix => false)
 
@@ -110,13 +111,16 @@ module Nugrant
 
             print_parameters(kind, {
               'config' => {
-                'user' => bag.__to_hash()
+                'user' => bag.to_hash(:use_string_key => true)
               }
             })
           end
 
-          def print_parameters(kind, data)
-            string = Nugrant::Helper::Yaml.format(data.to_yaml, :indent => 1)
+          def print_parameters(kind, hash)
+            string = Nugrant::Helper::Yaml.format(hash.to_yaml, :indent => 1)
+            used_restricted_keys = Helper::get_used_restricted_keys(hash, Helper::get_restricted_keys())
+
+            print_warning(used_restricted_keys) if !used_restricted_keys.empty?()
 
             print_header(kind)
             @env.ui.info(string, :prefix => false)
@@ -127,6 +131,14 @@ module Nugrant
             @env.ui.info(" #{kind.capitalize} Parameters", :prefix => false)
             @env.ui.info(" " + "-" * length, :prefix => false)
           end
+
+          def print_warning(used_restricted_keys)
+            @env.ui.info("", :prefix => false)
+            @env.ui.info(" You are using some restricted keys. Method access will not work with", :prefix => false)
+            @env.ui.info(" the following keys, only array access will:", :prefix => false)
+            @env.ui.info("   #{used_restricted_keys.join(", ")}", :prefix => false)
+            @env.ui.info("", :prefix => false)
+          end
         end
       end
     end

data/lib/nugrant/vagrant/v2/command/restricted_keys.rb

@@ -0,0 +1,60 @@
+require 'nugrant'
+require 'nugrant/vagrant/v2/command/helper'
+
+module Nugrant
+  module Vagrant
+    module V2
+      module Command
+        class RestrictedKeys < ::Vagrant.plugin("2", :command)
+          def initialize(arguments, environment)
+            super(arguments, environment)
+
+            @show_help = false
+          end
+
+          def create_parser()
+            return OptionParser.new do |parser|
+              parser.banner = "Usage: vagrant user restricted-keys"
+              parser.separator ""
+
+              parser.separator "Available options:"
+              parser.separator ""
+
+              parser.on("-h", "--help", "Print this help") do
+                @show_help = true
+              end
+
+               parser.separator ""
+               parser.separator "Prints keys that cannot be accessed using the method access syntax\n" +
+                                "(`config.user.local`). Use array access syntax (`config.user['local']`)\n" +
+                                "if you really want to use of the restricted keys\n"
+            end
+          end
+
+          def execute
+            parser = create_parser()
+            arguments = parse_options(parser)
+
+            return help(parser) if @show_help
+
+            @env.ui.info("The following keys are restricted, i.e. that method access (`config.user.first`)", :prefix => false)
+            @env.ui.info("will not work. If you really want to use a restricted key, use array access ", :prefix => false)
+            @env.ui.info("instead (`config.user['local']`).", :prefix => false)
+            @env.ui.info("", :prefix => false)
+
+            @env.ui.info("You can run `vagrant user parameters` to check if your config currently defines", :prefix => false)
+            @env.ui.info("one or more restricted keys shown below.", :prefix => false)
+            @env.ui.info("", :prefix => false)
+
+            restricted_keys = Helper::get_restricted_keys()
+            @env.ui.info(restricted_keys.sort().join(", "), :prefix => false)
+          end
+
+          def help(parser)
+            @env.ui.info(parser.help, :prefix => false)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nugrant/vagrant/v2/command/root.rb

@@ -1,4 +1,7 @@
 require 'nugrant'
+require 'nugrant/vagrant/v2/command/env'
+require 'nugrant/vagrant/v2/command/parameters'
+require 'nugrant/vagrant/v2/command/restricted_keys'
 require 'nugrant/version'
 
 module Nugrant
@@ -15,9 +18,16 @@ module Nugrant
             @argv = @arguments
 
             @subcommands = ::Vagrant::Registry.new()
+            @subcommands.register(:env) do
+              Command::Env
+            end
+
             @subcommands.register(:parameters) do
-              require File.expand_path("../parameters", __FILE__)
-              Parameters
+              Command::Parameters
+            end
+
+            @subcommands.register(:'restricted-keys') do
+              Command::RestrictedKeys
             end
 
             @show_help = false

data/lib/nugrant/vagrant/v2/config/user.rb

@@ -1,35 +1,23 @@
 require 'nugrant'
+require 'nugrant/mixin/parameters'
+require 'nugrant/vagrant/errors'
 
 module Nugrant
   module Vagrant
     module V2
       module Config
         class User < ::Vagrant.plugin("2", :config)
-          attr_reader :parameters
+          attr_reader :__current, :__user, :__system, :__defaults, :__all
 
           def initialize()
-            @parameters = Nugrant::Parameters.new({:config => {:params_filename => ".vagrantuser"}})
+            compute_bags!({:params_filename => ".vagrantuser"}, options = {
+              :key_error => Proc.new do |key|
+                raise Errors::ParameterNotFoundError, :key => key.to_s
+              end
+            })
           end
 
-          def [](param_name)
-            return @parameters[param_name]
-          end
-
-          def method_missing(method, *args, &block)
-            return @parameters.method_missing(method, *args, &block)
-          end
-
-          def each(&block)
-            @parameters.each(&block)
-          end
-
-          def defaults(parameters)
-            @parameters.defaults(parameters)
-          end
-
-          def defaults=(parameters)
-            @parameters.defaults=(parameters)
-          end
+          include Mixin::Parameters
         end
       end
     end

data/lib/nugrant/vagrant/v2/plugin.rb

@@ -7,7 +7,6 @@ module Nugrant
 
         command "user" do
           require_relative "command/root"
-
           Command::Root
         end
 

data/lib/nugrant/version.rb

@@ -1,3 +1,3 @@
 module Nugrant
-  VERSION = "2.0.0.dev2"
+  VERSION = "2.0.0.pre1"
 end

data/locales/en.yml

@@ -0,0 +1,13 @@
+en:
+  nugrant:
+    vagrant:
+      errors:
+        parameter_not_found: |-
+          Nugrant: Parameter '%{key}' was not found, is it defined in
+          your .vagrantuser file? Here where we think the error
+          could be in your Vagrantfile:
+
+          %{context}
+
+          If you think it should be found, don't hesitate to fill an
+          issue @ https://github.com/maoueh/nugrant/issues.

data/nugrant.gemspec

@@ -25,13 +25,9 @@ Gem::Specification.new do |gem|
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.test_files    = gem.files.grep(%r{^(test/lib)/})
   gem.require_paths = ["lib"]
 
-  gem.requirements << "json if you plan to use json parameters format"
-
-  gem.add_dependency 'multi_json', '~> 1.7'
-
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "json"
+  gem.add_dependency "insensitive_hash", "~> 0.3"
+  gem.add_dependency "multi_json", "~> 1.8"
 end

data/test/lib/nugrant/helper/env/test_exporter.rb

@@ -0,0 +1,238 @@
+require 'minitest/autorun'
+
+require 'nugrant/bag'
+require 'nugrant/helper/env/exporter'
+
+module Nugrant
+  module Helper
+    module Env
+      class TestExporter < ::Minitest::Test
+        def create_bag(parameters)
+          return Nugrant::Bag.new(parameters)
+        end
+
+        def assert_export(expected, key, value, options = {})
+          actual = Env::Exporter.command(:export, key, value, options)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_unset(expected, key, options = {})
+          actual = Env::Exporter.command(:unset, key, options)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_autoenv_exporter(expected, bag, options = {})
+          io = StringIO.new()
+          Env::Exporter.autoenv_exporter(bag, options.merge({:io => io}))
+
+          actual = io.string().split(/\r?\n/)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_script_exporter(expected, bag, options = {})
+          io = StringIO.new()
+          Env::Exporter.script_exporter(bag, options.merge({:io => io}))
+
+          actual = io.string().split(/\r?\n/)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_terminal_exporter(expected, bag, options = {})
+          io = StringIO.new()
+          Env::Exporter.terminal_exporter(bag, options.merge({:io => io}))
+
+          actual = io.string().split(/\r?\n/)
+
+          assert_equal(expected, actual)
+        end
+
+        def assert_unset_commands(expected, bag, options = {})
+          actual = Env::Exporter.unset_commands(bag, options)
+
+          assert_equal(expected, actual)
+        end
+
+        def test_valid_exporter
+          assert_equal(true, Env::Exporter.valid?(:autoenv))
+          assert_equal(true, Env::Exporter.valid?(:script))
+          assert_equal(true, Env::Exporter.valid?(:terminal))
+          assert_equal(false, Env::Exporter.valid?(:foreman))
+        end
+
+        def test_export_command
+          assert_export("export TEST=\\\"running\\ with\\ space\\\"", "TEST", "\"running with space\"")
+          assert_export("export TEST=running with space", "TEST", "running with space", :escape_value => false)
+        end
+
+        def test_unset_command
+          assert_unset("unset TEST", "TEST")
+        end
+
+        def test_terminal_exporter_export
+          bag = create_bag({
+            :level1 => {
+              :level2 => {
+                :first => "first with space",
+                :second => "\"second\\"
+              },
+              :third => "third"
+            },
+            :existing => "downcase",
+          })
+
+          stub_env(:existing => "exist", :EXISTING => "exist") do
+            assert_terminal_exporter([
+              "export EXISTING=downcase",
+              "export LEVEL1_LEVEL2_FIRST=first\\ with\\ space",
+              "export LEVEL1_LEVEL2_SECOND=\\\"second\\\\",
+              "export LEVEL1_THIRD=third",
+            ], bag)
+
+            assert_terminal_exporter([
+              "export LEVEL1_LEVEL2_FIRST=first\\ with\\ space",
+              "export LEVEL1_LEVEL2_SECOND=\\\"second\\\\",
+              "export LEVEL1_THIRD=third",
+            ], bag, :override => false)
+
+            assert_terminal_exporter([
+              "export EXISTING=downcase",
+              "export LEVEL1_LEVEL2_FIRST=first with space",
+              "export LEVEL1_LEVEL2_SECOND=\"second\\",
+              "export LEVEL1_THIRD=third",
+            ], bag, :type => :export, :override => true, :escape_value => false)
+
+            default_namer = Env::Namer.default(".")
+            prefix_namer = Env::Namer.prefix("CONFIG", default_namer)
+
+            assert_terminal_exporter([
+              "export CONFIG.EXISTING=downcase",
+              "export CONFIG.LEVEL1.LEVEL2.FIRST=first with space",
+              "export CONFIG.LEVEL1.LEVEL2.SECOND=\"second\\",
+              "export CONFIG.LEVEL1.THIRD=third",
+            ], bag, :override => true, :escape_value => false, :namer => prefix_namer)
+          end
+        end
+
+        def test_terminal_exporter_unset
+          bag = create_bag({
+            :level1 => {
+              :level2 => {
+                :first => "first",
+                :second => "second"
+              },
+              :third => "third"
+            },
+            :existing => "downcase",
+          })
+
+          stub_env(:existing => "exist", :EXISTING => "exist") do
+            assert_terminal_exporter([
+              "unset EXISTING",
+              "unset LEVEL1_LEVEL2_FIRST",
+              "unset LEVEL1_LEVEL2_SECOND",
+              "unset LEVEL1_THIRD",
+            ], bag, :type => :unset)
+
+            assert_terminal_exporter([
+              "unset LEVEL1_LEVEL2_FIRST",
+              "unset LEVEL1_LEVEL2_SECOND",
+              "unset LEVEL1_THIRD",
+            ], bag, :override => false, :type => :unset)
+
+            default_namer = Env::Namer.default(".")
+            prefix_namer = Env::Namer.prefix("CONFIG", default_namer)
+
+            assert_terminal_exporter([
+              "unset CONFIG.EXISTING",
+              "unset CONFIG.LEVEL1.LEVEL2.FIRST",
+              "unset CONFIG.LEVEL1.LEVEL2.SECOND",
+              "unset CONFIG.LEVEL1.THIRD",
+            ], bag, :override => true, :namer => prefix_namer, :type => :unset)
+          end
+        end
+
+        def test_autoenv_exporter
+          bag = create_bag({
+            :level1 => {
+              :level2 => {
+                :first => "first",
+                :second => "second"
+              },
+              :third => "third"
+            },
+            :existing => "downcase",
+          })
+
+          assert_autoenv_exporter([
+            "export EXISTING=downcase",
+            "export LEVEL1_LEVEL2_FIRST=first",
+            "export LEVEL1_LEVEL2_SECOND=second",
+            "export LEVEL1_THIRD=third",
+          ], bag, :type => :export)
+
+          assert_autoenv_exporter([
+            "unset EXISTING",
+            "unset LEVEL1_LEVEL2_FIRST",
+            "unset LEVEL1_LEVEL2_SECOND",
+            "unset LEVEL1_THIRD",
+          ], bag, :type => :unset)
+        end
+
+        def test_script_exporter
+          bag = create_bag({
+            :level1 => {
+              :level2 => {
+                :first => "first",
+                :second => "second"
+              },
+              :third => "third"
+            },
+            :existing => "downcase",
+          })
+
+          assert_script_exporter([
+            "#!/bin/env sh",
+            "",
+            "export EXISTING=downcase",
+            "export LEVEL1_LEVEL2_FIRST=first",
+            "export LEVEL1_LEVEL2_SECOND=second",
+            "export LEVEL1_THIRD=third",
+          ], bag, :type => :export)
+
+          assert_script_exporter([
+            "#!/bin/env sh",
+            "",
+            "unset EXISTING",
+            "unset LEVEL1_LEVEL2_FIRST",
+            "unset LEVEL1_LEVEL2_SECOND",
+            "unset LEVEL1_THIRD",
+          ], bag, :type => :unset)
+        end
+
+        def replace_env(variables)
+          ENV.clear()
+
+          variables = Hash[variables.map do |name, value|
+            [name.to_s, value]
+          end]
+
+          ENV.update(variables)
+        end
+
+        def stub_env(new = {})
+          old = ENV.to_hash()
+
+          replace_env(new)
+          yield
+
+        ensure
+          replace_env(old)
+        end
+      end
+    end
+  end
+end