nugrant 1.2.0 → 1.3.0

data/lib/nugrant/vagrant/v1/command/env.rb

@@ -0,0 +1,73 @@
+require 'nugrant'
+require 'nugrant/helper/env'
+
+module Nugrant
+  module Vagrant
+    module V1
+      module Command
+        class Env < ::Vagrant::Command::Base
+          def initialize(arguments, environment)
+            super(arguments, environment)
+
+            @unset = false
+            @script = false
+            @show_help = false
+          end
+
+          def create_parser()
+            return OptionParser.new do |parser|
+              parser.banner = "Usage: vagrant user env [<options>]"
+              parser.separator ""
+
+              parser.separator "Outputs the commands that should be executed to export\n" +
+                               "the various parameter as environment variables. By default,\n" +
+                               "existing ones are overridden."
+              parser.separator ""
+
+              parser.separator "Available options:"
+              parser.separator ""
+
+              parser.on("-u", "--[no-]unset", "Generates commands needed to unset environment variables, default false") do |unset|
+                @unset = unset
+              end
+
+              parser.on("-s", "--[no-]script", "Generates a bash script instead of simply showing command, default false") do |script|
+                 @script = script
+              end
+
+              parser.on("-h", "--help", "Print this help") do
+                @show_help = true
+              end
+            end
+          end
+
+          def help(parser)
+            @env.ui.info(parser.help, :prefix => false)
+          end
+
+          def execute
+            parser = create_parser()
+            arguments = parse_options(parser)
+
+            return help(parser) if @show_help
+
+            @logger.debug("Nugrant 'Env'")
+            with_target_vms(arguments) do |vm|
+              config = vm.config.user
+              parameters = config ? config.parameters : Nugrant::Parameters.new()
+              bag = parameters.__all
+
+              options = {:type => @unset ? :unset : :export}
+
+              Helper::Env.write_commands(bag, options) if not @script
+              Helper::Env.write_script(bag, options) if @script
+
+              # No need to execute for the other VMs
+              return 0
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -37,18 +37,18 @@ module Nugrant
               end
 
               parser.on("-u", "--user", "Show only user parameters") do
-                 @show_user = true
-               end
-
-               parser.on("-p", "--project", "Show only project parameters") do
-                 @show_project = true
-               end
-
-               parser.separator ""
-               parser.separator "When no options is provided, the command prints the names and values \n" +
-                                "of all parameters that would be available for usage in the Vagrantfile.\n" +
-                                "The hierarchy of the parameters is respected, so the final values are\n" +
-                                "displayed."
+                @show_user = true
+              end
+
+              parser.on("-p", "--project", "Show only project parameters") do
+                @show_project = true
+              end
+
+              parser.separator ""
+              parser.separator "When no options is provided, the command prints the names and values \n" +
+                               "of all parameters that would be available for usage in the Vagrantfile.\n" +
+                               "The hierarchy of the parameters is respected, so the final values are\n" +
+                               "displayed."
             end
           end
 
@@ -110,7 +110,7 @@ module Nugrant
 
             print_parameters(kind, {
               'config' => {
-                'user' => bag.__to_hash()
+                'user' => bag.__to_hash(:string_key => true)
               }
             })
           end

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

@@ -1,4 +1,6 @@
 require 'nugrant'
+require 'nugrant/vagrant/v1/command/env'
+require 'nugrant/vagrant/v1/command/parameters'
 require 'nugrant/version'
 
 module Nugrant
@@ -15,9 +17,12 @@ 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
 
             @show_help = false

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

@@ -0,0 +1,73 @@
+require 'nugrant'
+require 'nugrant/helper/env'
+
+module Nugrant
+  module Vagrant
+    module V2
+      module Command
+        class Env < ::Vagrant.plugin("2", :command)
+          def initialize(arguments, environment)
+            super(arguments, environment)
+
+            @unset = false
+            @script = false
+            @show_help = false
+          end
+
+          def create_parser()
+            return OptionParser.new do |parser|
+              parser.banner = "Usage: vagrant user env [<options>]"
+              parser.separator ""
+
+              parser.separator "Outputs the commands that should be executed to export\n" +
+                               "the various parameter as environment variables. By default,\n" +
+                               "existing ones are overridden."
+              parser.separator ""
+
+              parser.separator "Available options:"
+              parser.separator ""
+
+              parser.on("-u", "--[no-]unset", "Generates commands needed to unset environment variables, default false") do |unset|
+                @unset = unset
+              end
+
+              parser.on("-s", "--[no-]script", "Generates a bash script instead of simply showing command, default false") do |script|
+                 @script = script
+              end
+
+              parser.on("-h", "--help", "Print this help") do
+                @show_help = true
+              end
+            end
+          end
+
+          def help(parser)
+            @env.ui.info(parser.help, :prefix => false)
+          end
+
+          def execute
+            parser = create_parser()
+            arguments = parse_options(parser)
+
+            return help(parser) if @show_help
+
+            @logger.debug("Nugrant 'Env'")
+            with_target_vms(arguments) do |vm|
+              config = vm.config.user
+              parameters = config ? config.parameters : Nugrant::Parameters.new()
+              bag = parameters.__all
+
+              options = {:type => @unset ? :unset : :export}
+
+              Helper::Env.write_commands(bag, options) if not @script
+              Helper::Env.write_script(bag, options) if @script
+
+              # No need to execute for the other VMs
+              return 0
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -110,7 +110,7 @@ module Nugrant
 
             print_parameters(kind, {
               'config' => {
-                'user' => bag.__to_hash()
+                'user' => bag.__to_hash(:string_key => true)
               }
             })
           end

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

@@ -1,4 +1,6 @@
 require 'nugrant'
+require 'nugrant/vagrant/v2/command/env'
+require 'nugrant/vagrant/v2/command/parameters'
 require 'nugrant/version'
 
 module Nugrant
@@ -15,9 +17,12 @@ 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
 
             @show_help = false

data/lib/nugrant/version.rb

@@ -1,3 +1,3 @@
 module Nugrant
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/nugrant.gemspec

@@ -25,10 +25,11 @@ 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.add_dependency 'multi_json', '~> 1.8'
+  gem.add_dependency "multi_json", "~> 1.8"
 
   gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest", "~> 5.0.8"
 end

data/test/lib/nugrant/helper/test_env.rb

@@ -0,0 +1,150 @@
+require 'minitest/autorun'
+
+require 'nugrant/bag'
+require 'nugrant/helper/env'
+
+module Nugrant
+  module Helper
+    class TestEnv < ::Minitest::Test
+      def create_bag(parameters)
+        return Nugrant::Bag.new(parameters)
+      end
+
+      def assert_export(expected, key, value, options = {})
+        actual = Helper::Env.export_command(key, value, options)
+
+        assert_equal(expected, actual)
+      end
+
+      def assert_unset(expected, key, options = {})
+        actual = Helper::Env.unset_command(key, options)
+
+        assert_equal(expected, actual)
+      end
+
+      def assert_export_commands(expected, bag, options = {})
+        actual = Helper::Env.export_commands(bag, options)
+
+        assert_equal(expected.sort!(), actual.sort!())
+      end
+
+      def assert_unset_commands(expected, bag, options = {})
+        actual = Helper::Env.unset_commands(bag, options)
+
+        assert_equal(expected, actual)
+      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_export_commands
+        bag = create_bag({
+          :existing => "downcase",
+          :level1 => {
+            :level2 => {
+              :first => "first with space",
+              :second => "\"second\\"
+            },
+            :third => "third"
+          }
+        })
+
+        stub_env(:existing => "exist", :EXISTING => "exist") do
+          assert_export_commands([
+            "export EXISTING=downcase",
+            "export LEVEL1_LEVEL2_FIRST=first\\ with\\ space",
+            "export LEVEL1_LEVEL2_SECOND=\\\"second\\\\",
+            "export LEVEL1_THIRD=third",
+          ], bag)
+
+          assert_export_commands([
+            "export LEVEL1_LEVEL2_FIRST=first\\ with\\ space",
+            "export LEVEL1_LEVEL2_SECOND=\\\"second\\\\",
+            "export LEVEL1_THIRD=third",
+          ], bag, :override => false)
+
+          assert_export_commands([
+            "export EXISTING=downcase",
+            "export LEVEL1_LEVEL2_FIRST=first with space",
+            "export LEVEL1_LEVEL2_SECOND=\"second\\",
+            "export LEVEL1_THIRD=third",
+          ], bag, :override => true, :escape_value => false)
+
+          default_namer = Helper::Env.default_namer(".")
+          prefix_namer = Helper::Env.prefix_namer("CONFIG", default_namer)
+
+          assert_export_commands([
+            "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_unset_command
+        assert_unset("unset TEST", "TEST")
+      end
+
+      def test_unset_commands
+        bag = create_bag({
+          :existing => "downcase",
+          :level1 => {
+            :level2 => {
+              :first => "first",
+              :second => "second"
+            },
+            :third => "third"
+          }
+        })
+
+        stub_env(:existing => "exist", :EXISTING => "exist") do
+          assert_unset_commands([
+            "unset EXISTING",
+            "unset LEVEL1_LEVEL2_FIRST",
+            "unset LEVEL1_LEVEL2_SECOND",
+            "unset LEVEL1_THIRD",
+          ], bag)
+
+          assert_unset_commands([
+            "unset LEVEL1_LEVEL2_FIRST",
+            "unset LEVEL1_LEVEL2_SECOND",
+            "unset LEVEL1_THIRD",
+          ], bag, :override => false)
+
+          default_namer = Helper::Env.default_namer(".")
+          prefix_namer = Helper::Env.prefix_namer("CONFIG", default_namer)
+
+          assert_unset_commands([
+            "unset CONFIG.EXISTING",
+            "unset CONFIG.LEVEL1.LEVEL2.FIRST",
+            "unset CONFIG.LEVEL1.LEVEL2.SECOND",
+            "unset CONFIG.LEVEL1.THIRD",
+          ], bag, :override => true, :namer => prefix_namer)
+        end
+      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

data/test/lib/nugrant/helper/test_stack.rb

@@ -1,10 +1,10 @@
-require 'test/unit'
+require 'minitest/autorun'
 
 require 'nugrant/helper/stack'
 
 module Nugrant
   module Helper
-    class TestStack < Test::Unit::TestCase
+    class TestStack < ::Minitest::Test
       def assert_error_location(expected, entry, matcher = nil)
         assert_equal(expected, Stack::extract_error_location(entry, :matcher => matcher))
       end

data/test/lib/nugrant/test_bag.rb

@@ -1,11 +1,11 @@
-require 'test/unit'
+require 'minitest/autorun'
 
 require 'nugrant/bag'
 
 module Nugrant
-  class TestBag < Test::Unit::TestCase
-    def create_bag(parameters)
-      return Bag.new(parameters)
+  class TestBag < ::Minitest::Test
+    def create_bag(elements)
+      return Bag.new(elements)
     end
 
     def assert_all_access_equal(value, bag, key)
@@ -84,15 +84,15 @@ module Nugrant
     def test_undefined_value()
       bag = create_bag({"value" => "one"})
 
-      assert_raise(KeyError) do
+      assert_raises(KeyError) do
         bag.invalid_value
       end
 
-      assert_raise(KeyError) do
+      assert_raises(KeyError) do
         bag["invalid_value"]
       end
 
-      assert_raise(KeyError) do
+      assert_raises(KeyError) do
         bag[:invalid_value]
       end
     end