Class: Gem::Package::TarTestCase (Ruby 2.7.5)
Description: Class : Gem::Package::TarTestCase - Ruby 2.7.5

### Home Classes Methods

### In Files

- rubygems/package/tar_test_case.rb

### Parent

Gem::TestCase

### Methods

- #ASCIIZ
- #SP
- #SP_Z
- #Z
- #assert_headers_equal
- #calc_checksum
- #header
- #tar_dir_header
- #tar_file_header
- #tar_symlink_header
- #to_oct
- #util_dir_entry
- #util_entry
- #util_symlink_entry

### 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::Package::TarTestCase

A test case for Gem::Package::Tar* classes

### Public Instance Methods

ASCIIZ(str, length) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 10
    def ASCIIZ(str, length)
      str + "\0" * (length - str.length)
    end

SP(s) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 14
    def SP(s)
      s + " "
    end

SP_Z(s) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 18
    def SP_Z(s)
      s + " \0"
    end

Z(s) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 22
    def Z(s)
      s + "\0"
    end

assert_headers_equal(expected, actual) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 26
    def assert_headers_equal(expected, actual)
      expected = expected.to_s unless String === expected
      actual = actual.to_s unless String === actual

      fields = %w[
        name 100
        mode 8
        uid 8
        gid 8
        size 12
        mtime 12
        checksum 8
        typeflag 1
        linkname 100
        magic 6
        version 2
        uname 32
        gname 32
        devmajor 8
        devminor 8
        prefix 155
      ]

      offset = 0

      until fields.empty? do
        name = fields.shift
        length = fields.shift.to_i

        if name == "checksum"
          chksum_off = offset
          offset += length
          next
        end

        assert_equal expected[offset, length], actual[offset, length],
                     "Field #{name} of the tar header differs."

        offset += length
      end

      assert_equal expected[chksum_off, 8], actual[chksum_off, 8]
    end

calc_checksum(header) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 70
    def calc_checksum(header)
      sum = header.unpack("C*").inject{|s,a| s + a}
      SP(Z(to_oct(sum, 6)))
    end

header(type, fname, dname, length, mode, mtime, checksum = nil, linkname = "") click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 75
    def header(type, fname, dname, length, mode, mtime, checksum = nil, linkname = "")
      checksum ||= " " * 8

      arr = [                  # struct tarfile_entry_posix
        ASCIIZ(fname, 100),    # char name[100];     ASCII + (Z unless filled)
        Z(to_oct(mode, 7)),    # char mode[8];       0 padded, octal null
        Z(to_oct(0, 7)),       # char uid[8];        ditto
        Z(to_oct(0, 7)),       # char gid[8];        ditto
        Z(to_oct(length, 11)), # char size[12];      0 padded, octal, null
        Z(to_oct(mtime, 11)),  # char mtime[12];     0 padded, octal, null
        checksum,              # char checksum[8];   0 padded, octal, null, space
        type,                  # char typeflag[1];   file: "0"  dir: "5"
        ASCIIZ(linkname, 100), # char linkname[100]; ASCII + (Z unless filled)
        "ustar\0",             # char magic[6];      "ustar\0"
        "00",                  # char version[2];    "00"
        ASCIIZ("wheel", 32),   # char uname[32];     ASCIIZ
        ASCIIZ("wheel", 32),   # char gname[32];     ASCIIZ
        Z(to_oct(0, 7)),       # char devmajor[8];   0 padded, octal, null
        Z(to_oct(0, 7)),       # char devminor[8];   0 padded, octal, null
        ASCIIZ(dname, 155)     # char prefix[155];   ASCII + (Z unless filled)
      ]

      h = arr.join
      ret = h + "\0" * (512 - h.size)
      assert_equal(512, ret.size)
      ret
    end

tar_dir_header(name, prefix, mode, mtime) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 103
    def tar_dir_header(name, prefix, mode, mtime)
      h = header("5", name, prefix, 0, mode, mtime)
      checksum = calc_checksum(h)
      header("5", name, prefix, 0, mode, mtime, checksum)
    end

tar_file_header(fname, dname, mode, length, mtime) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 109
    def tar_file_header(fname, dname, mode, length, mtime)
      h = header("0", fname, dname, length, mode, mtime)
      checksum = calc_checksum(h)
      header("0", fname, dname, length, mode, mtime, checksum)
    end

tar_symlink_header(fname, prefix, mode, mtime, linkname) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 115
    def tar_symlink_header(fname, prefix, mode, mtime, linkname)
      h = header("2", fname, prefix, 0, mode, mtime, nil, linkname)
      checksum = calc_checksum(h)
      header("2", fname, prefix, 0, mode, mtime, checksum, linkname)
    end

to_oct(n, pad_size) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 121
    def to_oct(n, pad_size)
      "%0#{pad_size}o" % n
    end

util_dir_entry() click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 133
    def util_dir_entry
      util_entry tar_dir_header("foo", "bar", 0, Time.now)
    end

util_entry(tar) click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 125
    def util_entry(tar)
      io = TempIO.new tar

      header = Gem::Package::TarHeader.from io

      Gem::Package::TarReader::Entry.new header, io
    end

util_symlink_entry() click to toggle source

                   # File rubygems/package/tar_test_case.rb, line 137
    def util_symlink_entry
      util_entry tar_symlink_header("foo", "bar", 0, Time.now, "link")
    end