fig 2.0.0.pre.alpha.4 → 2.0.0.pre.alpha.5

data/spec/command/grammar_environment_variable_spec.rb

@@ -0,0 +1,384 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/grammar_spec_helper')
+
+describe 'Fig' do
+  ILLEGAL_CHARACTERS_IN_V0_PATH_STATEMENTS = %w< ; : < > | >
+
+  describe %q<uses the correct grammar version in the package definition created for publishing> do
+    before(:each) do
+      clean_up_test_environment
+      set_up_test_environment
+    end
+
+    ENVIRONMENT_VARIABLE_PUBLISHED_QUOTING_EXAMPLES = {
+      [%q<VARIABLE='foo\'bar'>, 1] => [
+        %q<VARIABLE=foo\'bar>,
+        %q<VARIABLE="foo'bar">,
+        %q<VARIABLE='foo\'bar'>
+      ],
+      [%q<VARIABLE='foobar\''>, 1] => [
+        %q<VARIABLE=foobar\'>,
+        %q<VARIABLE="foobar'">,
+        %q<VARIABLE='foobar\''>
+      ],
+      [%q<VARIABLE='foobar"'>, 1] => [
+        %q<VARIABLE=foobar\">,
+        %q<VARIABLE="foobar\"">,
+        %q<VARIABLE='foobar"'>
+      ],
+      [%q<VARIABLE='foo"bar'>,  1] => [
+        %q<VARIABLE=foo\"bar>,
+        %q<VARIABLE="foo\"bar">,
+        %q<VARIABLE='foo"bar'>
+      ],
+      [%q<VARIABLE='foo#bar'>,  1] => [
+        %q<VARIABLE="foo#bar">,
+        %q<VARIABLE='foo#bar'>
+      ],
+      [%q<VARIABLE=foo@bar>,    0] => [
+        %q<VARIABLE=foo@bar>,
+        %q<VARIABLE="foo@bar">,
+      ],
+      [%q<VARIABLE=foo\@bar>,   0] => [
+        %q<VARIABLE=foo\@bar>,
+        %q<VARIABLE="foo\@bar">,
+        %q<VARIABLE='foo@bar'>
+      ],
+      [%q<VARIABLE=foo\\\\bar>,   0] => [
+        %q<VARIABLE=foo\\\\bar>,
+        %q<VARIABLE="foo\\\\bar">,
+        %q<VARIABLE='foo\\\\bar'>
+      ]
+    }
+
+    shared_examples_for 'environment variable option' do
+      |assignment_type|
+
+      it 'with simple value' do
+        fig(
+          [%w<--publish foo/1.2.3>, "--#{assignment_type}", 'VARIABLE=VALUE'],
+          :fork => false
+        )
+
+        out, * = check_published_grammar_version(0)
+
+        out.should =~ / \b #{assignment_type} \s+ VARIABLE=VALUE \b /x
+      end
+
+      {
+        'unquoted'        => %q<>,
+        'double quoted'   => %q<">,
+        'single quoted'   => %q<'>
+      }.each do
+        |name, quote|
+
+        it "with #{name} whitespace" do
+          fig(
+            [
+              %w<--publish foo/1.2.3>,
+              "--#{assignment_type}",
+              "VARIABLE=#{quote}foo bar#{quote}"
+            ],
+            :fork => false
+          )
+
+          out, * = check_published_grammar_version(1)
+
+          out.should =~ / \b #{assignment_type} \s+ VARIABLE='foo[ ]bar' /x
+        end
+      end
+
+      ENVIRONMENT_VARIABLE_PUBLISHED_QUOTING_EXAMPLES.each do
+        |expected, inputs|
+
+        result, version = *expected
+
+        inputs.each do
+          |value|
+
+          it "with «#{value}»" do
+            fig(
+              [ %w<--publish foo/1.2.3>, "--#{assignment_type}", value ],
+              :fork => false
+            )
+
+            out, * = check_published_grammar_version(version)
+
+            out.should =~ / \b #{assignment_type} \s+ #{Regexp.quote result} /x
+          end
+        end
+      end
+
+      it "with «VARIABLE=foo#bar»" do
+        fig(
+          [
+            %w<--publish foo/1.2.3>,
+            "--#{assignment_type}",
+            %q<VARIABLE=foo#bar>
+          ],
+          :fork => false
+        )
+
+        out, * = check_published_grammar_version(1)
+
+        out.should =~ / \b #{assignment_type} \s+ VARIABLE='foo[#]bar' /x
+      end
+
+      {
+        'unquoted'        => %q<>,
+        'double quoted'   => %q<">
+      }.each do
+        |name, quote|
+
+        it "with #{name}, unescaped at sign, but forced to v1 grammar" do
+          fig(
+            [
+              %w<--publish foo/1.2.3>,
+              "--#{assignment_type}",
+              'VARIABLE_WITH_WHITESPACE_TO_FORCE=v1 grammar',
+              "--#{assignment_type}",
+              "VARIABLE=#{quote}foo@bar#{quote}"
+            ],
+            :fork => false
+          )
+
+          out, * = check_published_grammar_version(1)
+
+          out.should =~ / \b #{assignment_type} \s+ VARIABLE="foo@bar" /x
+        end
+      end
+    end
+
+    describe 'for --set' do
+      it_behaves_like 'environment variable option', 'set'
+
+      ILLEGAL_CHARACTERS_IN_V0_PATH_STATEMENTS.each do
+        |character|
+
+        it "for «#{character}»" do
+          fig(
+            [
+              %w<--publish foo/1.2.3 --set>,
+              "VARIABLE=#{character}"
+            ],
+            :fork => false
+          )
+
+          out, * = check_published_grammar_version(0)
+
+          out.should =~ / \b set \s+ VARIABLE=#{Regexp.quote character} [^'] /x
+        end
+      end
+    end
+
+    describe 'for --add' do
+      it_behaves_like 'environment variable option', 'add'
+
+      ILLEGAL_CHARACTERS_IN_V0_PATH_STATEMENTS.each do
+        |character|
+
+        it "for «VARIABLE=#{character}»" do
+          fig(
+            [
+              %w<--publish foo/1.2.3 --append>,
+              "VARIABLE=#{character}"
+            ],
+            :fork => false
+          )
+
+          out, * = check_published_grammar_version(1)
+
+          out.should =~ / \b add \s+ VARIABLE='#{Regexp.quote character}' /x
+        end
+      end
+    end
+
+    shared_examples_for 'environment variable statement' do
+      |assignment_type|
+
+      it 'with simple value' do
+        out, * = check_published_grammar_version(0, <<-"END_INPUT")
+          grammar v1
+          config default
+            #{assignment_type} VARIABLE=VALUE
+          end
+        END_INPUT
+
+        out.should =~ / \b #{assignment_type} \s+ VARIABLE=VALUE \b /x
+      end
+
+      {
+        'double quoted'   => %q<">,
+        'single quoted'   => %q<'>
+      }.each do
+        |name, quote|
+
+        it "with #{name} whitespace" do
+          out, * = check_published_grammar_version(1, <<-"END_INPUT")
+            grammar v1
+            config default
+              #{assignment_type} VARIABLE=#{quote}foo bar#{quote}
+            end
+          END_INPUT
+
+          out.should =~ / \b #{assignment_type} \s+ VARIABLE='foo[ ]bar' /x
+        end
+      end
+
+      ENVIRONMENT_VARIABLE_PUBLISHED_QUOTING_EXAMPLES.each do
+        |expected, inputs|
+
+        result, version = *expected
+
+        inputs.each do
+          |value|
+
+          it "with «#{value}»" do
+            out, * = check_published_grammar_version(version, <<-"END_INPUT")
+              grammar v1
+              config default
+                #{assignment_type} #{value}
+              end
+            END_INPUT
+
+            out.should =~ / \b #{assignment_type} \s+ #{Regexp.quote result} /x
+          end
+        end
+      end
+    end
+
+    describe 'for set statement in v1 grammar' do
+      it_behaves_like 'environment variable statement', 'set'
+
+      ILLEGAL_CHARACTERS_IN_V0_PATH_STATEMENTS.each do
+        |character|
+
+        it "for «#{character}»" do
+          out, * = check_published_grammar_version(0, <<-"END_INPUT")
+            grammar v1
+            config default
+              set VARIABLE=#{character}
+            end
+          END_INPUT
+
+          out.should =~ / \b set \s+ VARIABLE=#{Regexp.quote character} [^'] /x
+        end
+      end
+    end
+
+    describe 'for add statement in v1 grammar' do
+      it_behaves_like 'environment variable statement', 'add'
+
+      ILLEGAL_CHARACTERS_IN_V0_PATH_STATEMENTS.each do
+        |character|
+
+        it "for «#{character}»" do
+          out, * = check_published_grammar_version(1, <<-"END_INPUT")
+            grammar v1
+            config default
+              add VARIABLE=#{character}
+            end
+          END_INPUT
+
+          out.should =~ / \b add \s+ VARIABLE='#{Regexp.quote character}' /x
+        end
+      end
+    end
+  end
+
+  describe %q<rejects path statements from v0 package definition files containing> do
+    before(:each) do
+      clean_up_test_environment
+      set_up_test_environment
+    end
+
+    ILLEGAL_CHARACTERS_IN_V0_PATH_STATEMENTS.each do
+      |character|
+
+      it %Q<«#{character}»> do
+        input = <<-END
+          grammar v0
+          config default
+            add VARIABLE=x#{character}x
+          end
+        END
+
+        out, err, exit_code =
+          fig [], input, :no_raise_on_error => true, :fork => false
+        err.should =~
+          /value of path variable VARIABLE.*contains.*"#{Regexp.quote character}"/
+        out.should == ''
+        exit_code.should_not == 0
+      end
+    end
+
+    it %Q<«'»> do
+      input = <<-END
+        grammar v0
+        config default
+          add VARIABLE=x'x
+        end
+      END
+
+      out, err, exit_code =
+        fig [], input, :no_raise_on_error => true, :fork => false
+      err.should =~ /value of VARIABLE.*contains.*single quote/
+      out.should == ''
+      exit_code.should_not == 0
+    end
+
+    it %Q<«"»> do
+      input = <<-END
+        grammar v0
+        config default
+          add VARIABLE=x"x
+        end
+      END
+
+      out, err, exit_code =
+        fig [], input, :no_raise_on_error => true, :fork => false
+      err.should =~ /value of VARIABLE.*contains.*double quote/
+      out.should == ''
+      exit_code.should_not == 0
+    end
+  end
+
+  describe %q<rejects set statements from v0 package definition files containing> do
+    before(:each) do
+      clean_up_test_environment
+      set_up_test_environment
+    end
+
+    it %Q<«'»> do
+      input = <<-END
+        grammar v0
+        config default
+          set VARIABLE=x'x
+        end
+      END
+
+      out, err, exit_code =
+        fig [], input, :no_raise_on_error => true, :fork => false
+      err.should =~ /value of VARIABLE.*contains.*single quote/
+      out.should == ''
+      exit_code.should_not == 0
+    end
+
+    it %Q<«"»> do
+      input = <<-END
+        grammar v0
+        config default
+          set VARIABLE=x"x
+        end
+      END
+
+      out, err, exit_code =
+        fig [], input, :no_raise_on_error => true, :fork => false
+      err.should =~ /value of VARIABLE.*contains.*double quote/
+      out.should == ''
+      exit_code.should_not == 0
+    end
+  end
+end
+
+# vim: set fileencoding=utf8 :

data/spec/command/grammar_retrieve_spec.rb

@@ -0,0 +1,74 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/grammar_spec_helper')
+
+describe 'Fig' do
+  before(:each) do
+    clean_up_test_environment
+    set_up_test_environment
+  end
+
+  describe %q<uses the correct grammar version in the package definition created for publishing> do
+    it 'from v1 file input with a simple, unquoted retrieve statement' do
+      check_published_grammar_version 0, <<-'END'
+        grammar v1
+        retrieve variable->value
+      END
+    end
+
+    it 'from v1 file input with a simple, single-quoted retrieve statement (v1 currently, should change to v0 eventually)' do
+      check_published_grammar_version 0, <<-'END'
+        grammar v1
+        retrieve variable->'value'
+      END
+    end
+
+    it 'from v1 file input with a package-expanded, single-quoted retrieve statement' do
+      check_published_grammar_version 0, <<-'END'
+        grammar v1
+        retrieve variable->"value[package]value"
+      END
+    end
+
+    it 'from v1 file input with package-escaped, single-quoted retrieve statement' do
+      # Backslashes are not allowed in v0 grammar, at all.  Not even to escape
+      # "[package]".
+      check_published_grammar_version 1, <<-'END'
+        grammar v1
+        retrieve variable->"value\[package]value"
+      END
+    end
+
+    it 'from v1 file input with a retrieve statement containing whitespace' do
+      check_published_grammar_version 1, <<-'END'
+        grammar v1
+        retrieve variable->"some value"
+      END
+    end
+
+    it 'from v1 file input with a retrieve statement containing an octothorpe' do
+      check_published_grammar_version 1, <<-'END'
+        grammar v1
+        retrieve variable->"some#value"
+      END
+    end
+  end
+
+  it %q<considers a retrieve path containing an unescaped square bracket that is not followed by "package]" to be a syntax error> do
+    input = <<-'END'
+      grammar v1
+      retrieve variable->value[something]value
+    END
+
+    out, err, exit_code = fig(
+      %w< --publish foo/1.2.3 >,
+      input,
+      :no_raise_on_error => true,
+      :fork => false
+    )
+    err.should =~ /\[something\]/
+    out.should == ''
+    exit_code.should_not == 0
+  end
+end
+
+# vim: set fileencoding=utf8 :

data/spec/command/grammar_spec.rb

@@ -0,0 +1,87 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/grammar_spec_helper')
+
+describe 'Fig' do
+  describe 'grammar statement' do
+    before(:each) do
+      clean_up_test_environment
+      set_up_test_environment
+    end
+
+    %w< 0 1 2 >.each do
+      |version|
+
+      it %Q<for v#{version} is accepted> do
+        input = <<-"END"
+          # A comment
+          grammar v#{version}
+          config default
+            set variable=foo
+          end
+        END
+
+        out, err = fig(%w<--get variable>, input, :fork => false)
+        err.should == ''
+        out.should == 'foo'
+      end
+    end
+
+    it %q<is not accepted if it isn't the first statement> do
+      skip 'user-friendly warning message not implemented yet' do
+        input = <<-END
+          config default
+          end
+          grammar v1
+        END
+
+        out, err, exit_code =
+          fig([], input, :no_raise_on_error => true, :fork => false)
+        err.should =~ /grammar statement wasn't first statement/i
+        out.should == ''
+        exit_code.should_not == 0
+      end
+    end
+
+    it %q<is not accepted for future version> do
+      input = <<-END
+        grammar v31415269
+        config default
+        end
+      END
+
+      out, err, exit_code =
+        fig([], input, :no_raise_on_error => true, :fork => false)
+      err.should =~ /don't know how to parse grammar version/i
+      out.should == ''
+      exit_code.should_not == 0
+    end
+  end
+
+  describe %q<uses the correct grammar version in the package definition created for publishing> do
+    before(:each) do
+      clean_up_test_environment
+      set_up_test_environment
+    end
+
+    it 'from unversioned file input with a "default" config' do
+      check_published_grammar_version(0, <<-'END')
+        config default
+        end
+      END
+    end
+
+    %w< 1 2 >.each do
+      |version|
+
+      it %Q<from v#{version} grammar file input with a "default" config> do
+        check_published_grammar_version(0, <<-"END")
+          grammar v#{version}
+          config default
+          end
+        END
+      end
+    end
+  end
+end
+
+# vim: set fileencoding=utf8 :

data/spec/command/grammar_spec_helper.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+def check_published_grammar_version(version, input = nil)
+  if input
+    fig %w< --publish foo/1.2.3 >, input, :fork => false
+  end
+
+  out, err =
+    fig(%w< foo/1.2.3 --dump-package-definition-text >, :fork => false)
+
+  if version == 0
+    out.should =~ /^# grammar v0\b/
+  else
+    out.should =~ / ^ grammar [ ] v #{version} \b/x
+  end
+
+  err.should == ''
+
+  return [out, err]
+end
+
+# vim: set fileencoding=utf8 :

data/spec/command/include_file_spec.rb

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'Fig' do
+  def set_up_include_files()
+    cleanup_home_and_remote
+    base_included = "#{CURRENT_DIRECTORY}/included"
+    sub_included = "#{base_included}/subdirectory"
+
+    FileUtils.mkdir_p sub_included
+
+    IO.write "#{sub_included}/leaf.fig", <<-END_PACKAGE
+      grammar v2
+      config default
+        set SUB_PACKAGE=@/default
+        set SHOULD_BE_OVERRIDDEN='not overridden'
+      end
+
+      config non-default
+        set SUB_PACKAGE=@/non-default
+      end
+
+      config not-used
+        set SHOULD_NOT_BE_SET='was set'
+      end
+    END_PACKAGE
+    IO.write "#{base_included}/peer.fig", <<-END_PACKAGE
+      grammar v2
+      config default
+        set PEER='was set'
+        # Note path relative to this file and not to CURRENT_DIRECTORY.
+        include-file "subdirectory/leaf.fig":non-default
+      end
+    END_PACKAGE
+    IO.write "#{base_included}/base.fig", <<-END_PACKAGE
+      grammar v2
+      config default
+        include-file subdirectory/leaf.fig
+        include-file 'peer.fig'
+
+        set SHOULD_BE_OVERRIDDEN=overridden
+      end
+    END_PACKAGE
+    IO.write "#{CURRENT_DIRECTORY}/test.fig", <<-END_PACKAGE
+      grammar v2
+      retrieve SUB_PACKAGE->somewhere
+      config default
+        include-file 'included/base.fig'
+      end
+    END_PACKAGE
+
+    return
+  end
+
+  it 'handles include-file' do
+    set_up_include_files
+
+    out, err, * = fig(
+      [
+        '--file', "#{CURRENT_DIRECTORY}/test.fig",
+        '--update',
+        '--list-variables',
+      ],
+      :fork => false,
+    )
+    out.should =~ /^PEER=was set$/
+    out.should =~ %r<^SUB_PACKAGE=.*subdirectory/non-default$>
+    out.should =~ /^SHOULD_BE_OVERRIDDEN=overridden$/
+    out.should_not =~ /^SHOULD_NOT_BE_SET=/
+    err.should =~ /[Rr]etrieve.*SUB_PACKAGE.*ignored/
+  end
+end