How to use copy_in_config_dir method of InstallerTestHelpers Package

Best Inspec_ruby code snippet using InstallerTestHelpers.copy_in_config_dir

installer_test.rb

Source:installer_test.rb

...13    ENV['HOME'] = @orig_home14    ENV['INSPEC_CONFIG_DIR'] = nil15    @installer.__reset16  end17  def copy_in_config_dir(fixture_name)18    src = Dir.glob(File.join(@config_dir_path, fixture_name, '*'))19    dest = File.join(@config_dir_path, 'empty')20    src.each { |path| FileUtils.cp_r(path, dest) }21  end22  def setup23    @orig_home = Dir.home24    repo_path = File.expand_path(File.join( __FILE__, '..', '..', '..', '..', '..'))25    mock_path = File.join(repo_path, 'test', 'unit', 'mock')26    @config_dir_path = File.join(mock_path, 'config_dirs')27    @plugin_fixture_src_path = File.join(mock_path, 'plugins', 'inspec-test-fixture')28    @plugin_fixture_pkg_path = File.join(@plugin_fixture_src_path, 'pkg')29    # This is unstable under CI; see https://github.com/inspec/inspec/issues/335530    # @ruby_abi_version = (RUBY_VERSION.split('.')[0,2] << '0').join('.')31    @ruby_abi_version = (Gem.ruby_version.segments[0, 2] << 0).join('.')32    @installer = Inspec::Plugin::V2::Installer.instance33    reset_globals34    WebMock.disable_net_connect!(allow: %r{(api\.)?rubygems\.org/.*})35  end36  def teardown37    reset_globals38    # We use the 'empty' config dir for exercising a lot of installs.39    # Purge it after every test.40    unless ENV['INSPEC_TEST_PRESERVE_PLUGIN']41      Dir.glob(File.join(@config_dir_path, 'empty', '*')).each do |path|42        next if path.end_with? '.gitkeep'43        FileUtils.rm_rf(path)44      end45    end46    # Clean up any activated gems47    Gem.loaded_specs.delete('inspec-test-fixture')48  end49end50#-----------------------------------------------------------------------#51# basics52#-----------------------------------------------------------------------#53class PluginInstallerBasicTests < MiniTest::Test54  include InstallerTestHelpers55  # it's a singleton56  def test_it_should_be_a_singleton57    klass = Inspec::Plugin::V2::Installer58    assert_equal klass.instance, klass.instance, "Calling instance on the Installer should always return the same object"59    assert_kind_of Inspec::Plugin::V2::Installer, klass.instance, 'Calling instance on the INstaller should return the right class'60    assert_raises(NoMethodError, 'Installer should have a private constructor') { klass.new }61  end62  # it should know its gem path63  def test_it_should_know_its_gem_path_with_a_default_location64    ENV['HOME'] = File.join(@config_dir_path, 'fakehome')65    expected = File.join(ENV['HOME'], '.inspec', 'gems', @ruby_abi_version)66    assert_equal expected, @installer.gem_path67  end68  def test_it_should_know_its_gem_path_with_a_custom_config_dir_from_env69    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')70    expected = File.join(ENV['INSPEC_CONFIG_DIR'], 'gems', @ruby_abi_version)71    assert_equal expected, @installer.gem_path72  end73end74#-----------------------------------------------------------------------#75# Installing76#-----------------------------------------------------------------------#77class PluginInstallerInstallationTests < MiniTest::Test78  include InstallerTestHelpers79  # While this is a negative test case on the prefix checking, there are80  # several positive test cases following.81  def test_refuse_to_install_gems_with_wrong_name_prefix82    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')83    # Here, ordinal_array is the name of a simple, small gem available on rubygems.org84    # There is no significance in choosing that gem over any other.85    # Main point here is that its name does not begin with 'inspec-'.86    assert_raises(Inspec::Plugin::V2::InstallError) { @installer.install('ordinal_array')}87  end88  def test_install_a_gem_from_local_file89    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')90    gem_file = File.join(@plugin_fixture_pkg_path, 'inspec-test-fixture-0.1.0.gem')91    @installer.install('inspec-test-fixture', gem_file: gem_file)92    # Because no exception was thrown, this is a positive test case for prefix-checking.93    # Installing a gem places it under the config dir gem area94    # Two things should happen: a copy of the gemspec should be left there...95    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.1.0.gemspec')96    assert File.exist?(spec_path), 'After installation from a gem file, the gemspec should be installed to the gem path'97    # ... and the actual library code should be decompressed into a directory tree.98    installed_gem_base = File.join(@installer.gem_path, 'gems', 'inspec-test-fixture-0.1.0')99    assert Dir.exist?(installed_gem_base), 'After installation from a gem file, the gem tree should be installed to the gem path'100    # Installation = gem activation101    spec = Gem.loaded_specs['inspec-test-fixture']102    assert spec.activated?, 'Installing a gem should cause the gem to activate'103  end104  def test_install_a_gem_from_missing_local_file105    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')106    gem_file = File.join(@plugin_fixture_pkg_path, 'inspec-test-fixture-nonesuch-0.0.0.gem')107    refute File.exist?(gem_file), "The nonexistant gem should not exist prior to install attempt"108    ex = assert_raises(Inspec::Plugin::V2::InstallError) { @installer.install('inspec-test-fixture-nonesuch', gem_file: gem_file)}109    assert_includes ex.message, 'Could not find local gem file'110  end111  def test_install_a_gem_from_local_file_creates_plugin_json112    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')113    gem_file = File.join(@plugin_fixture_pkg_path, 'inspec-test-fixture-0.1.0.gem')114    @installer.install('inspec-test-fixture', gem_file: gem_file)115    # Should now be present in plugin.json116    plugin_json_path = File.join(ENV['INSPEC_CONFIG_DIR'], 'plugins.json')117    assert File.exist?(plugin_json_path), 'plugins.json should now exist'118    config_file = Inspec::Plugin::V2::ConfigFile.new(plugin_json_path)119    assert_equal 1, config_file.count, 'plugins.json should have one entry'120    assert config_file.existing_entry?(:'inspec-test-fixture')121  end122  def test_install_a_gem_from_rubygems_org123    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')124    @installer.install('inspec-test-fixture')125    # Because no exception was thrown, this is a positive test case for prefix-checking.126    # Installing a gem places it under the config dir gem area127    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.2.0.gemspec')128    assert File.exist?(spec_path), 'After installation from rubygems.org, the gemspec should be installed to the gem path'129    installed_gem_base = File.join(@installer.gem_path, 'gems', 'inspec-test-fixture-0.2.0')130    assert Dir.exist?(installed_gem_base), 'After installation from rubygems.org, the gem tree should be installed to the gem path'131    # installing a gem with dependencies should result in the deps being installed under the config dir132    spec_path = File.join(@installer.gem_path, 'specifications', 'ordinal_array-0.2.0.gemspec')133    assert File.exist?(spec_path), 'After installation from a gem file, the gemspec should be installed to the gem path'134    installed_gem_base = File.join(@installer.gem_path, 'gems', 'inspec-test-fixture-0.2.0')135    assert Dir.exist?(installed_gem_base), 'After installation from a gem file, the gem tree should be installed to the gem path'136    # Installation != gem activation137    spec = Gem.loaded_specs['inspec-test-fixture']138    assert spec.activated?, 'Installing a gem should cause the gem to activate'139  end140  def test_handle_no_such_gem141    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')142    assert_raises(Inspec::Plugin::V2::InstallError) { @installer.install('inspec-test-fixture-nonesuch') }143  end144  # Should be able to install a plugin while pinning the version145  def test_install_a_pinned_gem_from_rubygems_org146    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')147    @installer.install('inspec-test-fixture', version: '= 0.1.0')148    # Installing a gem places it under the config dir gem area149    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.1.0.gemspec')150    assert File.exist?(spec_path), 'After pinned installation from rubygems.org, the gemspec should be installed to the gem path'151    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.2.0.gemspec')152    refute File.exist?(spec_path), 'After pinned installation from rubygems.org, the wrong gemspec version should be absent'153    config_file = Inspec::Plugin::V2::ConfigFile.new154    entry = config_file.plugin_by_name(:'inspec-test-fixture')155    assert_includes entry.keys, :version, 'plugins.json should include version pinning key'156    assert_equal '= 0.1.0', entry[:version], 'plugins.json should include version pinning value'157  end158  def test_install_a_gem_with_conflicting_depends_from_rubygems_org159    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')160    ex = assert_raises(Inspec::Plugin::V2::InstallError) do161      @installer.install('inspec-test-fixture', version: '= 0.1.1')162    end163    assert_includes ex.message, "can't activate rake-0.4.8, already activated rake-"164  end165  def test_install_a_gem_with_invalid_depends_from_rubygems_org166    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')167    ex = assert_raises(Inspec::Plugin::V2::InstallError) do168      @installer.install('inspec-test-fixture', version: '= 0.1.2')169    end170    assert_includes ex.message, "Could not find 'fake_plugin_dependency' (>= 0)"171  end172  def test_install_a_plugin_from_a_path173    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')174    @installer.install('inspec-test-fixture', path: @plugin_fixture_src_path)175    # No gemspec should exist in the plugins area176    specs = Dir.glob(File.join(@installer.gem_path, 'specifications', '*.gemspec'))177    assert_empty specs, 'After install-from-path, no gemspecs should be installed'178    config_file = Inspec::Plugin::V2::ConfigFile.new179    entry = config_file.plugin_by_name(:'inspec-test-fixture')180    assert_includes entry.keys, :installation_type, 'plugins.json should include installation_type key'181    assert_equal :path, entry[:installation_type], 'plugins.json should include path installation_type'182    assert_includes entry.keys, :installation_path, 'plugins.json should include installation_path key'183    assert_equal @plugin_fixture_src_path, entry[:installation_path], 'plugins.json should include correct value for installation path'184  end185  def test_refuse_to_install_gem_whose_name_is_on_the_reject_list186    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')187    # Here, 'inspec-core', 'inspec-multi-server', and 'train-tax-collector'188    # are the names of real rubygems.  They are not InSpec/Train plugins, though,189    # and installing them would be a jam-up.190    # This is configured in 'etc/plugin-filter.json'.191    [192      'inspec-core',193      'inspec-multi-server',194      'train-tax-calculator',195    ].each do |plugin_name|196      ex = assert_raises(Inspec::Plugin::V2::InstallError) { @installer.install(plugin_name)}197      assert_includes(ex.message, 'on the Plugin Exclusion List')198      assert_includes(ex.message, 'Rationale:')199    end200  end201end202#-----------------------------------------------------------------------#203# Updating204#-----------------------------------------------------------------------#205class PluginInstallerUpdaterTests < MiniTest::Test206  include InstallerTestHelpers207  def test_update_using_path_not_allowed208    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')209    assert_raises(Inspec::Plugin::V2::UpdateError) do210      @installer.update('inspec-test-fixture', path: @plugin_fixture_src_path)211    end212  end213  def test_update_existing_plugin_at_same_version_not_allowed214    copy_in_config_dir('test-fixture-1-float')215    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')216    assert_raises(Inspec::Plugin::V2::UpdateError) do217      @installer.update('inspec-test-fixture', version: '0.1.0')218    end219  end220  def test_install_plugin_at_existing_version_not_allowed221    copy_in_config_dir('test-fixture-1-float')222    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')223    assert_raises(Inspec::Plugin::V2::InstallError) do224      @installer.install('inspec-test-fixture', version: '0.1.0')225    end226  end227  def test_install_existing_plugin_not_allowed228    copy_in_config_dir('test-fixture-1-float')229    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')230    ex = assert_raises(Inspec::Plugin::V2::InstallError) do231      @installer.install('inspec-test-fixture')232    end233    assert_includes ex.message, "Use 'inspec plugin update'"234  end235  def test_update_to_latest_version236    copy_in_config_dir('test-fixture-1-float')237    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')238    @installer.__reset_loader239    @installer.update('inspec-test-fixture')240    # Verify presence of gemspecs241    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.2.0.gemspec')242    assert File.exist?(spec_path), 'After update, the 0.2.0 gemspec should be installed to the gem path'243    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.1.0.gemspec')244    assert File.exist?(spec_path), 'After update, the 0.1.0 gemspec should remain'245    # Plugins file entry should not be version pinned246    plugin_json_path = File.join(ENV['INSPEC_CONFIG_DIR'], 'plugins.json')247    plugin_json_data = JSON.parse(File.read(plugin_json_path))248    entry = plugin_json_data['plugins'].detect { |e| e["name"] == 'inspec-test-fixture'}249    refute_includes entry.keys, 'version', 'plugins.json should NOT include version pinning key'250  end251  def test_update_to_specified_later_version252    copy_in_config_dir('test-fixture-1-float')253    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')254    @installer.__reset_loader255    # Update to specific (but later) version256    @installer.update('inspec-test-fixture', version: '0.2.0')257    # Verify presence of gemspecs258    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.2.0.gemspec')259    assert File.exist?(spec_path), 'After update, the 0.2.0 gemspec should be installed to the gem path'260    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.1.0.gemspec')261    assert File.exist?(spec_path), 'After update, the 0.1.0 gemspec should remain'262    # Plugins file entry should be version pinned263    config_file = Inspec::Plugin::V2::ConfigFile.new264    entry = config_file.plugin_by_name(:'inspec-test-fixture')265    assert_includes entry.keys, :version, 'plugins.json should include version pinning key'266    assert_equal '= 0.2.0', entry[:version], 'plugins.json should include version pinning value'267  end268  # TODO: Prevent updating a gem if it will lead to unsolveable dependencies269  # TODO: allow updating a gem that will lead to unsolveable dependencies if :force is provided270  # TODO: Prevent downgrading a gem if it will lead to unsolveable dependencies271  # TODO: allow downgrading a gem that will lead to unsolveable dependencies if :force is provided272  # TODO: update all273  # TODO: downgrade a plugin274  # TODO: Trying to do a gemfile install with an update is an error if the file version matches the installed version275end276#-----------------------------------------------------------------------#277# Uninstalling278#-----------------------------------------------------------------------#279class PluginInstallerUninstallTests < MiniTest::Test280  include InstallerTestHelpers281  def test_uninstalling_a_nonexistant_plugin_is_an_error282    # Try a mythical one283    ex = assert_raises(Inspec::Plugin::V2::UnInstallError) do284      @installer.uninstall('inspec-test-fixture-nonesuch')285    end286    assert_includes ex.message, "'inspec-test-fixture-nonesuch' is not installed, refusing to uninstall."287    # Try a real plugin that is not installed288    ex = assert_raises(Inspec::Plugin::V2::UnInstallError) do289      @installer.uninstall('inspec-test-fixture')290    end291    assert_includes ex.message, "'inspec-test-fixture' is not installed, refusing to uninstall."292  end293  def test_uninstalling_a_path_based_plugin_works294    copy_in_config_dir('meaning_by_path')295    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')296    @installer.__reset_loader297    @installer.uninstall('inspec-meaning-of-life')298    # Plugins file entry should be removed299    plugin_json_path = File.join(ENV['INSPEC_CONFIG_DIR'], 'plugins.json')300    plugin_json_data = JSON.parse(File.read(plugin_json_path))301    entries = plugin_json_data['plugins'].select { |e| e["name"] == 'inspec-meaning-of-life'}302    assert_empty entries, "After path-based uninstall, plugin name should be removed from plugins.json"303  end304  def test_uninstall_a_gem_plugin305    copy_in_config_dir('test-fixture-1-float')306    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')307    @installer.__reset_loader308    @installer.uninstall('inspec-test-fixture')309    # UnInstalling a gem physically removes the gemspec and the gem library code310    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.1.0.gemspec')311    refute File.exist?(spec_path), 'After uninstallation of a gem plugin, the gemspec should be removed.'312    installed_gem_base = File.join(@installer.gem_path, 'gems', 'inspec-test-fixture-0.1.0')313    refute Dir.exist?(installed_gem_base), 'After uninstallation of a gem plugin, the gem tree should be removed.'314    # Rubygems' idea of what we have installed should be changed.315    # It should no longer be able to satisfy a request for the formerly installed gem.316    universe_set = @installer.send(:build_gem_request_universe) # private method317    request_set = Gem::RequestSet.new(Gem::Dependency.new('inspec-test-fixture'))318    assert_raises(Gem::UnsatisfiableDependencyError) { request_set.resolve(universe_set) }319    # Plugins file entry should be removed320    config_file = Inspec::Plugin::V2::ConfigFile.new321    refute config_file.existing_entry?(:'inspec-test-fixture'), "After gem-based uninstall, plugin name should be removed from plugins.json"322  end323  def test_uninstall_a_gem_plugin_removes_deps324    copy_in_config_dir('test-fixture-2-float')325    ENV['INSPEC_CONFIG_DIR'] = File.join(@config_dir_path, 'empty')326    @installer.__reset_loader327    @installer.uninstall('inspec-test-fixture')328    # UnInstalling a gem removes the gemspec and the gem library code329    spec_path = File.join(@installer.gem_path, 'specifications', 'inspec-test-fixture-0.2.0.gemspec')330    refute File.exist?(spec_path), 'After uninstallation of a gem plugin with deps, the gemspec should be removed.'331    installed_gem_base = File.join(@installer.gem_path, 'gems', 'inspec-test-fixture-0.2.0')332    refute Dir.exist?(installed_gem_base), 'After uninstallation of a gem plugin with deps, the gem tree should be removed.'333    # UnInstalling a gem with dependencies should result in the deps being removed334    spec_path = File.join(@installer.gem_path, 'specifications', 'ordinal_array-0.2.0.gemspec')335    refute File.exist?(spec_path), 'After uninstallation of a gem plugin with deps, the dep gemspec should be removed.'336    installed_gem_base = File.join(@installer.gem_path, 'gems', 'ordinal_array-0.2.0')337    refute Dir.exist?(installed_gem_base), 'After installation a gem plugin with deps, the gem tree should be removed.'338    # Rubygems' idea of what we have installed should be changed....

copy_in_config_dir

Using AI Code Generation

1    copy_in_config_dir('test')2    assert File.exist?(File.join(@config_dir, 'test'))3  def copy_in_config_dir(filename)4    FileUtils.cp_r(File.join(File.dirname(__FILE__), filename),5    copy_in_config_dir('test')6    assert File.exist?(File.join(@config_dir, 'test'))7  def copy_in_config_dir(filename)8    FileUtils.cp_r(File.join(File.dirname(__FILE__), filename),9    copy_in_config_dir('test')10    assert File.exist?(File.join(@config_dir, 'test'))11  def copy_in_config_dir(filename)12    FileUtils.cp_r(File.join(File.dirname(__FILE__), filename),13    copy_in_config_dir('test')14    assert File.exist?(File.join(@config_dir, 'test'))

copy_in_config_dir

Using AI Code Generation

1    assert File.exist?('/tmp/config_dir/file1.txt')2    assert File.exist?('/tmp/config_dir/file2.txt')3    assert File.exist?('/tmp/config_dir/file1.txt')4    assert File.exist?('/tmp/config_dir/file2.txt')5  FileUtils.rm_rf('/tmp/config_dir')6  FileUtils.rm_rf('/tmp/config_dir')7  FileUtils.rm_rf('/tmp/config_dir')8  FileUtils.rm_rf('/tmp/config_dir')

copy_in_config_dir

Using AI Code Generation

1require File.expand_path('../../config/environment', __FILE__)2    FileUtils.cp_r Rails.root.join('test/fixtures/config_dir'), Rails.root.join('test/config_dir')3    FileUtils.rm_rf Rails.root.join('test/config_dir')

copy_in_config_dir

Using AI Code Generation

1copy_in_config_dir('config')2config_dir = copy_in_config_dir('config')3copy_in_config_dir('config')4config_dir = copy_in_config_dir('config')5copy_in_config_dir('config')6config_dir = copy_in_config_dir('config')7copy_in_config_dir('config')8config_dir = copy_in_config_dir('config')

copy_in_config_dir

Using AI Code Generation

1    copy_in_config_dir('config1')2    run_installer('--config-file', 'config1')3    run_installer('--config-file', 'config1')4    copy_in_config_dir('config2')5    run_installer('--config-file', 'config2')6    run_installer('--config-file', 'config2')7    copy_in_config_dir('config3')8    run_installer('--config-file', 'config3')9    run_installer('--config-file', 'config3')

copy_in_config_dir

Using AI Code Generation

1copy_in_config_dir('config')2config_dir = copy_in_config_dir('config')3copy_in_config_dir('config')4config_dir = copy_in_config_dir('config')5copy_in_config_dir('config')6config_dir = copy_in_config_dir('config')7copy_in_config_dir('config')8config_dir = copy_in_config_dir('config')

copy_in_config_dir

Using AI Code Generation

1    copy_in_config_dir('config1')2    run_installer('--config-file', 'config1')3    run_installer('--config-file', 'config1')4    copy_in_config_dir('config2')5    run_installer('--config-file', 'config2')6    run_installer('--config-file', 'config2')7    copy_in_config_dir('config3')8    run_installer('--config-file', 'config3')9    run_installer('--config-file', 'config3')

copy_in_config_dir

Using AI Code Generation

1    copy_in_config_dir('config1')2    run_installer('--config-file', 'config1')3    run_installer('--config-file', 'config1')4    copy_in_config_dir('config2')5    run_installer('--config-file', 'config2')6    run_installer('--config-file', 'config2')7    copy_in_config_dir('config3')8    run_installer('--config-file', 'config3')9    run_installer('--config-file', 'config3')

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.