Class: Gem::InstallerTestCase (Ruby 2.7.5)
Description: Class : Gem::InstallerTestCase - Ruby 2.7.5

### Home Classes Methods

### In Files

- rubygems/installer_test_case.rb

### Parent

Gem::TestCase

### Methods

- #setup
- #setup_base_gem
- #setup_base_installer
- #setup_base_spec
- #setup_base_user_installer
- #util_inst_bindir
- #util_installer
- #util_make_exec
- #util_setup_gem
- #util_setup_installer

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::BundlerVersionFinder
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InfoCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SetupCommand::MakeDirs
- Gem::Commands::SigninCommand
- Gem::Commands::SignoutCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::Installer::FakePackage
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::Licenses
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MissingSpecError
- Gem::MissingSpecVersionError
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::RequestSet::Lockfile::Parser
- Gem::RequestSet::Lockfile::Tokenizer
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::Molinillo
- Gem::Resolver::Molinillo::CircularDependencyError
- Gem::Resolver::Molinillo::Delegates
- Gem::Resolver::Molinillo::Delegates::ResolutionState
- Gem::Resolver::Molinillo::Delegates::SpecificationProvider
- Gem::Resolver::Molinillo::DependencyGraph
- Gem::Resolver::Molinillo::DependencyGraph::Action
- Gem::Resolver::Molinillo::DependencyGraph::AddEdgeNoCircular
- Gem::Resolver::Molinillo::DependencyGraph::DeleteEdge
- Gem::Resolver::Molinillo::DependencyGraph::DetachVertexNamed
- Gem::Resolver::Molinillo::DependencyGraph::Log
- Gem::Resolver::Molinillo::DependencyGraph::Tag
- Gem::Resolver::Molinillo::DependencyGraph::Vertex
- Gem::Resolver::Molinillo::DependencyState
- Gem::Resolver::Molinillo::NoSuchDependencyError
- Gem::Resolver::Molinillo::PossibilityState
- Gem::Resolver::Molinillo::ResolutionState
- Gem::Resolver::Molinillo::Resolver
- Gem::Resolver::Molinillo::Resolver::Resolution
- Gem::Resolver::Molinillo::ResolverError
- Gem::Resolver::Molinillo::SpecificationProvider
- Gem::Resolver::Molinillo::UI
- Gem::Resolver::Molinillo::VersionConflict
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SourceSet
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::RuntimeRequirementNotMetError
- Gem::S3URISigner
- Gem::S3URISigner::ConfigurationError
- Gem::S3URISigner::InstanceProfileError
- Gem::SafeYAML
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::SecurityOption
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::SpecificationPolicy
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::ThreadedDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::UninstallError
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UriParser
- Gem::UriParsing
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::InstallerTestCase

A test case for `Gem::Installer`.

### Public Instance Methods

setup() click to toggle source

                   # File rubygems/installer_test_case.rb, line 69
    def setup
      super

      Gem::Installer.path_warning = false
    end

setup_base_gem() click to toggle source

Creates the following instance variables:

@spec

  a spec named 'a', intended for regular installs

And returns a gem built for the @spec

                   # File rubygems/installer_test_case.rb, line 127
    def setup_base_gem
      @spec = setup_base_spec
      util_build_gem @spec
      @spec.cache_file
    end

setup_base_installer() click to toggle source

Creates the following instance variables:

@spec

  a spec named 'a', intended for regular installs

@gem

  the path to a built gem from @spec

And returns a `Gem::Installer` for the @spec that installs into @gemhome

                   # File rubygems/installer_test_case.rb, line 114
    def setup_base_installer
      @gem = setup_base_gem
      util_installer @spec, @gemhome
    end

setup_base_spec() click to toggle source

Sets up a generic specification for testing the rubygems installer

And returns it

                   # File rubygems/installer_test_case.rb, line 138
    def setup_base_spec
      quick_gem 'a' do |spec|
        util_make_exec spec
      end
    end

setup_base_user_installer() click to toggle source

Creates the following instance variables:

@spec

  a spec named 'a', intended for regular installs

@user_spec

  a spec named 'b', intended for user installs

@gem

  the path to a built gem from @spec

@user_gem

  the path to a built gem from @user_spec

And returns a `Gem::Installer` for the @user_spec that installs into `Gem.user_dir`

                   # File rubygems/installer_test_case.rb, line 159
    def setup_base_user_installer
      @user_spec = quick_gem 'b' do |spec|
        util_make_exec spec
      end

      util_build_gem @user_spec

      @user_gem = @user_spec.cache_file

      util_installer @user_spec, Gem.user_dir, :user
    end

util_inst_bindir() click to toggle source

The path where installed executables live

                   # File rubygems/installer_test_case.rb, line 78
    def util_inst_bindir
      File.join @gemhome, "bin"
    end

util_installer(spec, gem_home, user=false) click to toggle source

Creates an installer for `spec` that will install into `gem_home`. If `user` is true a user-install will be performed.

                   # File rubygems/installer_test_case.rb, line 227
    def util_installer(spec, gem_home, user=false)
      Gem::Installer.at(spec.cache_file,
                         :install_dir => gem_home,
                         :user_install => user)
    end

util_make_exec(spec = @spec, shebang = "#!/usr/bin/ruby", bindir = "bin") click to toggle source

Adds an executable named “executable” to `spec` with the given `shebang`.

The executable is also written to the bin dir in @tmpdir and the installed gem directory for `spec`.

                   # File rubygems/installer_test_case.rb, line 88
    def util_make_exec(spec = @spec, shebang = "#!/usr/bin/ruby", bindir = "bin")
      spec.executables = %w[executable]
      spec.bindir = bindir

      exec_path = spec.bin_file "executable"
      write_file exec_path do |io|
        io.puts shebang
      end

      bin_path = File.join @tempdir, "bin", "executable"
      write_file bin_path do |io|
        io.puts shebang
      end
    end

util_setup_gem(ui = @ui) click to toggle source

Builds the @spec gem and returns an installer for it. The built gem includes:

    bin/executable
    lib/code.rb
    ext/a/mkrf_conf.rb

                   # File rubygems/installer_test_case.rb, line 188
      def util_setup_gem(ui = @ui)
        @spec.files << File.join('lib', 'code.rb')
        @spec.extensions << File.join('ext', 'a', 'mkrf_conf.rb')

        Dir.chdir @tempdir do
          FileUtils.mkdir_p 'bin'
          FileUtils.mkdir_p 'lib'
          FileUtils.mkdir_p File.join('ext', 'a')

          File.open File.join('bin', 'executable'), 'w' do |f|
            f.puts "raise 'ran executable'"
          end

          File.open File.join('lib', 'code.rb'), 'w' do |f|
            f.puts '1'
          end

          File.open File.join('ext', 'a', 'mkrf_conf.rb'), 'w' do |f|
            f << <<-EOF
              File.open 'Rakefile', 'w' do |rf| rf.puts "task :default" end
            EOF
          end

          yield @spec if block_given?

          use_ui ui do
            FileUtils.rm_f @gem

            @gem = Gem::Package.build @spec
          end
        end

        Gem::Installer.at @gem
      end

util_setup_installer() click to toggle source

Sets up the base @gem, builds it and returns an installer for it.

                   # File rubygems/installer_test_case.rb, line 174
    def util_setup_installer
      @gem = setup_base_gem

      util_setup_gem
    end