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

data/spec/deparser/v1_spec.rb

@@ -0,0 +1,64 @@
+# coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'fig/deparser/v1'
+require 'fig/statement/archive'
+require 'fig/statement/resource'
+
+describe Fig::Deparser::V1 do
+  let(:deparser) {
+    Fig::Deparser::V1.new :emit_as_input, '<indent>', 1
+  }
+
+  describe 'deparses' do
+    {
+      Fig::Statement::Archive  => 'archive',
+      Fig::Statement::Resource => 'resource',
+    }.each_pair do
+      |statement_class, keyword|
+
+      describe keyword do
+        it %q<«chocolate*pizza» with globbing> do
+          statement =
+            statement_class.new(nil, nil, 'chocolate*pizza', :glob_if_not_url)
+
+          deparser.deparse([statement]).should ==
+            %Q[<indent>#{keyword} "chocolate*pizza"\n]
+        end
+
+        it %q<«chocolate*pizza» without globbing> do
+          statement =
+            statement_class.new(nil, nil, 'chocolate*pizza', false)
+
+          deparser.deparse([statement]).should ==
+            %Q[<indent>#{keyword} 'chocolate*pizza'\n]
+        end
+
+        it %q<«chocolate\\pizza» with globbing> do
+          statement =
+            statement_class.new(nil, nil, 'chocolate\\pizza', :glob_if_not_url)
+
+          deparser.deparse([statement]).should ==
+            %Q[<indent>#{keyword} "chocolate\\\\pizza"\n]
+        end
+
+        it %q<«chocolate\\pizza» without globbing> do
+          statement = statement_class.new(nil, nil, 'chocolate\\pizza', false)
+
+          deparser.deparse([statement]).should ==
+            %Q[<indent>#{keyword} 'chocolate\\\\pizza'\n]
+        end
+
+        it %q<«chocolate'"pizza»> do
+          statement = statement_class.new(nil, nil, %q<chocolate'"pizza>, false)
+
+          deparser.deparse([statement]).should ==
+            %Q[<indent>#{keyword} 'chocolate\\'"pizza'\n]
+        end
+      end
+    end
+  end
+end
+
+# vim: set fileencoding=utf8 :

data/spec/environment_variables_spec.rb

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'fig/environment_variables/case_insensitive'
+require 'fig/environment_variables/case_sensitive'
+
+def find_diffs(primary_hash, secondary_hash, diff_hash)
+  primary_hash.each do |key, value|
+    if ! secondary_hash.has_key?(key)
+      diff_hash[key] = value
+    elsif primary_hash[key] != secondary_hash[key]
+      diff_hash[key] = value
+    end
+  end
+
+  return
+end
+
+def hash_differences(hash_one, hash_two)
+  hash_differences = {}
+  find_diffs(hash_one, hash_two, hash_differences)
+  find_diffs(hash_two, hash_one, hash_differences)
+
+  return hash_differences
+end
+
+describe 'EnvironmentVariables' do
+  it 'correctly sets and unsets the system environment variables' do
+    env_vars = Fig::EnvironmentVariables::CaseSensitive.new({ 'Foo' => 'BAR' })
+
+    sys_vars_prior = {}
+    sys_vars_prior.merge!(ENV.to_hash)
+    sys_vars_set = {}
+    sys_vars_after = {}
+
+    env_vars['BAR'] = 'BAZ'
+    env_vars.with_environment { sys_vars_set.merge!(ENV.to_hash) }
+    sys_vars_after.merge!(ENV.to_hash)
+
+    hash_differences(sys_vars_prior, sys_vars_after).should be_empty
+    before_and_during_diff = hash_differences(sys_vars_prior, sys_vars_set)
+    hash_differences(before_and_during_diff, {'BAR' => 'BAZ', 'Foo' => 'BAR'}).should be_empty
+  end
+
+  describe 'case sensitive' do
+    it 'sets and retrieves variables' do
+      env_vars = Fig::EnvironmentVariables::CaseSensitive.new({ 'Foo' => 'BAR' })
+
+      env_vars['FOO'].should == nil
+      env_vars['Foo'].should == 'BAR'
+
+      env_vars['BAR'] = 'BAZ'
+      env_vars['BAR'].should == 'BAZ'
+      env_vars['bar'].should == nil
+    end
+
+    it 'prepends values onto variables' do
+      env_vars = Fig::EnvironmentVariables::CaseSensitive.new({ 'Foo' => 'BAR' })
+
+      env_vars.prepend_variable('Foo', 'BAZ')
+      env_vars['Foo'].should == 'BAZ' + File::PATH_SEPARATOR + 'BAR'
+
+      env_vars.prepend_variable('FOO', 'XYZZY')
+      env_vars['FOO'].should == 'XYZZY'
+    end
+  end
+
+  describe 'case sensitive' do
+    it 'sets and retrieves variables' do
+      env_vars = Fig::EnvironmentVariables::CaseInsensitive.new({ 'Foo' => 'BAR' })
+
+      env_vars['FOO'].should == 'BAR'
+      env_vars['foo'].should == 'BAR'
+
+      env_vars['BAR'] = 'BAZ'
+      env_vars['BAR'].should == 'BAZ'
+      env_vars['bar'].should == 'BAZ'
+    end
+
+    it 'prepends values onto variables' do
+      env_vars = Fig::EnvironmentVariables::CaseInsensitive.new({ 'Foo' => 'BAR' })
+
+      env_vars.prepend_variable('Foo', 'BAZ')
+      env_vars['Foo'].should == 'BAZ' + File::PATH_SEPARATOR + 'BAR'
+
+      env_vars.prepend_variable('FOO', 'XYZZY')
+      env_vars['Foo'].should == 'XYZZY' + File::PATH_SEPARATOR + 'BAZ' + File::PATH_SEPARATOR + 'BAR'
+    end
+  end
+end

data/spec/figrc_spec.rb

@@ -0,0 +1,144 @@
+# coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'stringio'
+require 'tempfile'
+
+require 'fig/figrc'
+require 'fig/operating_system'
+require 'fig/repository'
+require 'fig/working_directory_maintainer'
+
+describe 'FigRC' do
+  def create_override_file(foo, bar = nil)
+    tempfile = Tempfile.new('some_json_tempfile')
+    tempfile << %Q< { "foo" : "#{foo}" >
+    if not bar.nil?
+      tempfile << %Q< , "bar" : "#{bar}" >
+    end
+    tempfile << %Q< } >
+    tempfile.close
+    return tempfile
+  end
+
+  def create_override_file_with_repository_url()
+    tempfile = Tempfile.new('some_json_tempfile')
+    tempfile << %Q< { "default FIG_DOWNLOAD_URL" : "#{FIG_DOWNLOAD_URL}", "default FIG_UPLOAD_URL" : "#{FIG_UPLOAD_URL}" } >
+    tempfile.close
+    return tempfile
+  end
+
+  def create_remote_config(foo, bar = nil)
+    FileUtils.mkdir_p(
+      File.join(FIG_DOWNLOAD_DIR, Fig::Repository::METADATA_SUBDIRECTORY)
+    )
+    figrc_path = File.join(FIG_DOWNLOAD_DIR, Fig::FigRC::REPOSITORY_CONFIGURATION)
+    file_handle = File.new(figrc_path,'w')
+    file_handle.write( %Q< { "foo" : "#{foo}" > )
+    if not bar.nil?
+      file_handle.write( %Q< , "bar" : "#{bar}" > )
+    end
+    file_handle.write( %Q< } > )
+    file_handle.close
+    return
+  end
+
+  def invoke_find(override_path, download_repository_url, upload_repository_url = nil)
+    return Fig::FigRC.find(
+      override_path,
+      download_repository_url,
+      upload_repository_url,
+      Fig::OperatingSystem.new(false),
+      FIG_HOME,
+      true
+    )
+  end
+
+  before(:all) do
+    clean_up_test_environment
+    set_up_test_environment
+  end
+
+  after(:each) do
+    clean_up_test_environment
+  end
+
+  it 'handles override path with a remote repository' do
+    tempfile = create_override_file('loaded as override')
+
+    create_remote_config("loaded from repository (shouldn't be)")
+    configuration = invoke_find tempfile.path, FIG_DOWNLOAD_URL, FIG_UPLOAD_URL
+    tempfile.unlink
+
+    configuration['foo'].should == 'loaded as override'
+  end
+
+  it 'handles no override, no repository (full stop)' do
+    configuration = invoke_find nil, nil
+    configuration['foo'].should == nil
+  end
+
+  it 'handles no override, repository specified as the empty string' do
+    configuration = invoke_find nil, ''
+    configuration['foo'].should == nil
+  end
+
+  it 'handles no override, repository specified as whitespace' do
+    configuration = invoke_find nil, " \n\t"
+    configuration['foo'].should == nil
+  end
+
+  it 'handles no repository config and no override specified, and config does NOT exist on server' do
+    configuration = invoke_find nil, 'file:///does_not_exist/'
+    configuration['foo'].should == nil
+  end
+
+  it 'retrieves configuration from repository with no override' do
+    create_remote_config('loaded from repository')
+
+    configuration = invoke_find nil, FIG_DOWNLOAD_URL
+    configuration['foo'].should == 'loaded from repository'
+  end
+
+  it 'has a remote config but gets its config from the override file provided' do
+    create_remote_config('loaded from remote repository')
+    tempfile = create_override_file('loaded as override to override remote config')
+    configuration = invoke_find tempfile.path, FIG_DOWNLOAD_URL
+    configuration['foo'].should == 'loaded as override to override remote config'
+  end
+
+  it 'merges override file config over remote config' do
+    create_remote_config('loaded from remote repository', 'should not be overwritten')
+    tempfile = create_override_file('loaded as override to override remote config')
+    configuration = invoke_find tempfile.path, FIG_DOWNLOAD_URL, FIG_UPLOAD_URL
+    configuration['foo'].should == 'loaded as override to override remote config'
+    configuration['bar'].should == 'should not be overwritten'
+  end
+
+  it 'retrieves configuration from repository specified by override file' do
+    tempfile = create_override_file_with_repository_url
+    create_remote_config('loaded from repository')
+
+    configuration = invoke_find tempfile.path, nil, nil
+    configuration['foo'].should == 'loaded from repository'
+  end
+
+  it 'ignores unknown settings without errors' do
+    tempfile = Tempfile.new('unknown_settings_test')
+    tempfile << %Q< { "foo": "bar", "fig_2x_setting": "future setting value" } >
+    tempfile.close
+
+    # This should not raise any errors despite unknown setting
+    configuration = invoke_find(tempfile.path, nil)
+    
+    # Known setting works
+    configuration['foo'].should == 'bar'
+    
+    # Unknown setting is accessible but would be ignored by code not looking for it
+    configuration['fig_2x_setting'].should == 'future setting value'
+    
+    # Completely nonexistent setting returns nil
+    configuration['nonexistent'].should be_nil
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,398 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'fig/application_configuration'
+require 'fig/not_yet_parsed_package'
+require 'fig/package_descriptor'
+require 'fig/package_parse_error'
+require 'fig/parser'
+
+describe 'Parser' do
+  def new_configuration
+    application_configuration = Fig::ApplicationConfiguration.new
+
+    application_configuration.base_whitelisted_url = 'http://example/'
+    application_configuration.remote_download_url = 'http://example/'
+    application_configuration.remote_upload_url = 'http://example/upload/'
+
+    return application_configuration
+  end
+
+  def test_no_parse_exception(fig_input)
+    application_configuration = new_configuration
+
+    unparsed_package = Fig::NotYetParsedPackage.new
+    unparsed_package.descriptor         =
+      Fig::PackageDescriptor.new('package_name', '0.1.1', nil)
+    unparsed_package.working_directory  =
+      unparsed_package.include_file_base_directory =
+      'foo_directory'
+    unparsed_package.source_description = 'source description'
+    unparsed_package.unparsed_text      = fig_input
+
+    package = Fig::Parser.new(application_configuration, false).parse_package(
+      unparsed_package
+    )
+    # Got no exception.
+
+    return package
+  end
+
+  def test_error(fig_input, error_class, message_pattern)
+    application_configuration = new_configuration
+
+    unparsed_package = Fig::NotYetParsedPackage.new
+    unparsed_package.descriptor         =
+      Fig::PackageDescriptor.new('package_name', '0.1.1', nil)
+    unparsed_package.working_directory  =
+      unparsed_package.include_file_base_directory =
+      'foo_directory'
+    unparsed_package.source_description = 'source description'
+    unparsed_package.unparsed_text      = fig_input
+
+    expect {
+      Fig::Parser.new(application_configuration, false).parse_package(
+        unparsed_package
+      )
+    }.to raise_error(error_class, message_pattern)
+
+    return
+  end
+
+  def test_user_input_error(fig_input, message_pattern)
+    test_error(fig_input, Fig::UserInputError, message_pattern)
+
+    return
+  end
+
+  def test_package_parse_error(
+    fig_input, message_pattern = /source description/
+  )
+    test_error(fig_input, Fig::PackageParseError, message_pattern)
+
+    return
+  end
+
+  describe 'base syntax' do
+    it 'throws the correct exception on syntax error' do
+      application_configuration = new_configuration
+
+      unparsed_package = Fig::NotYetParsedPackage.new
+      unparsed_package.descriptor         =
+        Fig::PackageDescriptor.new('package_name', '0.1.1', nil)
+      unparsed_package.working_directory  =
+        unparsed_package.include_file_base_directory =
+        'foo_directory'
+      unparsed_package.source_description = 'source description'
+      unparsed_package.unparsed_text      = <<-END
+        this is invalid syntax
+      END
+
+      expect {
+        Fig::Parser.new(application_configuration, false).parse_package(
+          unparsed_package
+        )
+      }.to raise_error(
+        Fig::PackageParseError
+      )
+    end
+
+    it 'assigns the correct line and column number to Statement objects.' do
+      fig_package=<<-FIG_PACKAGE
+
+        # Blank line above to ensure that we can handle starting whitespace.
+        resource http://example/is/awesome.tgz
+
+            # Indentation in here is weird to test we get things right.
+
+            # Also, we need a comment in here to make sure that cleaning them out
+            # does not affect values for statements.
+
+         archive http://svpsvn/my/repo/is/cool.jar
+
+        config default
+                include package/some-version
+
+           set VARIABLE=VALUE
+                  end
+      FIG_PACKAGE
+
+      unparsed_package = Fig::NotYetParsedPackage.new
+      unparsed_package.descriptor         =
+        Fig::PackageDescriptor.new('package_name', '0.1.1', nil)
+      unparsed_package.working_directory  =
+        unparsed_package.include_file_base_directory =
+        'foo_directory'
+      unparsed_package.source_description = 'source description'
+      unparsed_package.unparsed_text      = fig_package
+
+      application_configuration = new_configuration
+      package = Fig::Parser.new(application_configuration, false).parse_package(
+        unparsed_package
+      )
+
+      package.walk_statements do
+        |statement|
+
+        case statement
+          when Fig::Statement::Resource
+            statement.line.should == 3
+            statement.column.should == 9
+          when Fig::Statement::Archive
+            statement.line.should == 10
+            statement.column.should == 10
+          when Fig::Statement::Configuration
+            statement.line.should == 12
+            statement.column.should == 9
+          when Fig::Statement::Include
+            statement.line.should == 13
+            statement.column.should == 17
+          when Fig::Statement::Set
+            statement.line.should == 15
+            statement.column.should == 12
+        end
+      end
+    end
+  end
+
+  describe 'validating URLs' do
+    it 'passes valid, whitelisted ones' do
+      fig_package=<<-FIG_PACKAGE
+        resource http://example/is/awesome.tgz
+
+        archive http://svpsvn/my/repo/is/cool.jar
+      FIG_PACKAGE
+      application_configuration = new_configuration
+      application_configuration.push_dataset( { 'url whitelist' => 'http://svpsvn/' } )
+
+      unparsed_package = Fig::NotYetParsedPackage.new
+      unparsed_package.descriptor         =
+        Fig::PackageDescriptor.new('package_name', '0.1.1', nil)
+      unparsed_package.working_directory  =
+        unparsed_package.include_file_base_directory =
+        'foo_directory'
+      unparsed_package.source_description = 'source description'
+      unparsed_package.unparsed_text      = fig_package
+
+      package = Fig::Parser.new(application_configuration, false).parse_package(
+        unparsed_package
+      )
+      package.should_not == nil
+    end
+
+    it 'rejects non-whitelisted ones' do
+      fig_package=<<-FIG_PACKAGE
+        resource http://evil_url/is/bad.tgz
+
+        archive http://evil_repo/my/repo/is/bad.jar
+      FIG_PACKAGE
+      application_configuration = new_configuration
+      application_configuration.push_dataset( { 'url whitelist' => 'http://svpsvn/' } )
+
+      unparsed_package = Fig::NotYetParsedPackage.new
+      unparsed_package.descriptor         =
+        Fig::PackageDescriptor.new('package_name', '0.1.1', nil)
+      unparsed_package.working_directory  =
+        unparsed_package.include_file_base_directory =
+        'foo_directory'
+      unparsed_package.source_description = 'source description'
+      unparsed_package.unparsed_text      = fig_package
+
+      exception = nil
+      begin
+        package =
+          Fig::Parser.new(application_configuration, false).parse_package(
+            unparsed_package
+          )
+      rescue Fig::URLAccessDisallowedError => exception
+      end
+      exception.should_not == nil
+      exception.urls.should =~ %w<http://evil_url/is/bad.tgz http://evil_repo/my/repo/is/bad.jar>
+      exception.descriptor.name.should == 'package_name'
+      exception.descriptor.version.should == '0.1.1'
+    end
+  end
+
+  describe 'command statements' do
+    %w< 0 1 >.each do
+      |version|
+
+      command_terminator = version.to_i == 0 ? '' : ' end'
+      describe %Q<in the v#{version} grammar> do
+        it 'reject multiple commands in config file' do
+          input = <<-"END_PACKAGE"
+            grammar v#{version}
+            config default
+              command "echo foo"#{command_terminator}
+              command "echo bar"#{command_terminator}
+            end
+          END_PACKAGE
+
+          test_user_input_error(
+            input,
+            /found a second "command" statement within a "config" block/i
+          )
+        end
+
+        it 'accept multiple configs, each with a single command' do
+          test_no_parse_exception(<<-"END_PACKAGE")
+            grammar v#{version}
+            config default
+              command "echo foo"#{command_terminator}
+            end
+            config another
+              command "echo bar"#{command_terminator}
+            end
+          END_PACKAGE
+        end
+
+        it 'reject multiple configs where one has multiple commands' do
+          input = <<-"END_PACKAGE"
+            grammar v#{version}
+            config default
+              command "echo foo"#{command_terminator}
+            end
+            config another
+              command "echo bar"#{command_terminator}
+              command "echo baz"#{command_terminator}
+            end
+          END_PACKAGE
+
+          test_user_input_error(
+            input,
+            /found a second "command" statement within a "config" block/i
+          )
+        end
+      end
+    end
+  end
+
+  describe 'path statements' do
+    {
+      ';'  => ';',
+      ':'  => ':',
+      '"'  => '"',
+      '<'  => '<',
+      '>'  => '>',
+      '|'  => '|',
+      ' '  => ' ',
+      '\t' => "\t",
+      '\r' => "\r",
+      '\n' => "\n"
+    }.each do
+      |display, character|
+
+      it %Q<reject "#{display}" in a PATH component in the v0 grammar> do
+        input = <<-"END_PACKAGE"
+          grammar v0
+          config default
+            append PATH_VARIABLE=#{character}
+          end
+        END_PACKAGE
+
+        test_user_input_error(
+          input, /(?i:invalid append statement).*\bPATH_VARIABLE\b/
+        )
+      end
+
+      it %Q<accept "#{display}" in a PATH component in the v1 grammar> do
+        right_hand_side = nil
+        if character == '"' or character =~ /\s/
+          right_hand_side = %Q<'#{character}'>
+        else
+          right_hand_side = character
+        end
+
+        test_no_parse_exception(<<-"END_PACKAGE")
+          grammar v1
+          config default
+            append PATH_VARIABLE=#{right_hand_side}
+          end
+        END_PACKAGE
+      end
+    end
+  end
+
+  %w< archive resource >.each do
+    |asset_type|
+
+    describe "#{asset_type} statements" do
+      %w< ' " >.each do
+        |character|
+
+        %w< 0 1 >.each do
+          |version|
+
+          it %Q<produce a parse error with unescaped «#{character}» in a URL in the v#{version} grammar> do
+            input = <<-"END_PACKAGE"
+              grammar v#{version}
+              #{asset_type} #{character}
+            END_PACKAGE
+
+            test_package_parse_error(input)
+          end
+        end
+      end
+
+      %w[ @ < > | ].each do
+        |character|
+
+
+        it %Q<produce a parse error with «#{character}» in a URL in the v0 grammar> do
+          input = <<-"END_PACKAGE"
+            #{asset_type} #{character}
+          END_PACKAGE
+
+          test_package_parse_error(input)
+        end
+
+        %w< 1 >.each do
+          |version|
+
+          it %Q<handles «#{character}» in a URL in the v#{version} grammar> do
+            package = test_no_parse_exception(<<-"END_PACKAGE")
+              grammar v#{version}
+              #{asset_type} foo#{character}bar
+              config default
+              end
+            END_PACKAGE
+
+            url =
+              [package.archive_locations, package.resource_locations].flatten[0]
+            url.should == "foo#{character}bar"
+          end
+        end
+      end
+
+      it %q<handles octothorpes in a URL in the v1 grammar> do
+        package = test_no_parse_exception(<<-"END_PACKAGE")
+          grammar v1
+          #{asset_type} 'foo#bar'
+          config default
+          end
+        END_PACKAGE
+
+        url = [package.archive_locations, package.resource_locations].flatten[0]
+        url.should == 'foo#bar'
+      end
+
+      describe %Q<handles plus signs in the path (e.g. for C++ libraries)> do
+        %w< 0 1 >.each do
+          |version|
+
+          it %Q<in the v#{version} grammar> do
+            test_no_parse_exception(<<-"END_PACKAGE")
+              grammar v#{version}
+              #{asset_type} testlib++.whatever
+              config default
+                append LIBPATH=@/testlib++
+              end
+            END_PACKAGE
+          end
+        end
+      end
+    end
+  end
+end
+
+# vim: set fileencoding=utf8 :