Class: Gem::Validator

Inherits:
Object
  • Object
show all
Includes:
UserInteraction
Defined in:
lib/rubygems/validator.rb

Overview

Validator performs various gem file and gem database validation

Defined Under Namespace

Classes: ErrorData

Instance Method Summary collapse

Methods included from DefaultUserInteraction

#ui, ui, #ui=, ui=, #use_ui, use_ui

Instance Method Details

#alien ⇒ Object

Checks the gem directory for the following potential inconsistencies/problems:

  • Checksum gem itself

  • For each file in each gem, check consistency of installed versions

  • Check for files that aren’t part of the gem but are in the gems directory

  • 1 cache - 1 spec - 1 directory.

returns a hash of ErrorData objects, keyed on the problem gem’s name.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/rubygems/validator.rb', line 75

def alien
  require 'rubygems/installer'
  require 'find'
  require 'md5'
  errors = {}
  Gem::SourceIndex.from_installed_gems.each do |gem_name, gem_spec|
    errors[gem_name] ||= []
    gem_path = File.join(Gem.dir, "cache", gem_spec.full_name) + ".gem"
    spec_path = File.join(Gem.dir, "specifications", gem_spec.full_name) + ".gemspec"
    gem_directory = File.join(Gem.dir, "gems", gem_spec.full_name)
    installed_files = find_files_for_gem(gem_directory)

    if(!File.exist?(spec_path)) then
      errors[gem_name] << ErrorData.new(spec_path, "Spec file doesn't exist for installed gem")
    end

    begin
      require 'rubygems/format.rb'
      verify_gem_file(gem_path)
      File.open(gem_path) do |file|
        format = Gem::Format.from_file_by_path(gem_path)
        format.file_entries.each do |entry, data|
          # Found this file.  Delete it from list
          installed_files.delete remove_leading_dot_dir(entry['path'])
          File.open(File.join(gem_directory, entry['path']), 'rb') do |f|
            unless MD5.md5(f.read).to_s == MD5.md5(data).to_s
              errors[gem_name] << ErrorData.new(entry['path'], "installed file doesn't match original from gem")
            end
          end
        end
      end
    rescue VerificationError => e
      errors[gem_name] << ErrorData.new(gem_path, e.message)
    end
    # Clean out directories that weren't explicitly included in the gemspec
    # FIXME: This still allows arbitrary incorrect directories.
    installed_files.delete_if {|potential_directory|        
      File.directory?(File.join(gem_directory, potential_directory))
    }
    if(installed_files.size > 0) then
      errors[gem_name] << ErrorData.new(gem_path, "Unmanaged files in gem: #{installed_files.inspect}")
    end
  end
  errors
end

#remove_leading_dot_dir(path) ⇒ Object 



152
153
154
 
# File 'lib/rubygems/validator.rb', line 152

def remove_leading_dot_dir(path)
  path.sub(/^\.\//, "")
end

#unit_test(gem_spec) ⇒ Object

Runs unit tests for a given gem specification



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/rubygems/validator.rb', line 123

def unit_test(gem_spec)
 start_dir = Dir.pwd
 Dir.chdir(gem_spec.full_gem_path)
  $: << File.join(Gem.dir, "gems", gem_spec.full_name)
    # XXX: why do we need this gem_spec when we've already got 'spec'?
  test_files = gem_spec.test_files
  if test_files.empty?
    say "There are no unit tests to run for #{gem_spec.name}-#{gem_spec.version}"
    return
  end
  gem gem_spec.name, "= #{gem_spec.version.version}"
  test_files.each do |f| require f end
  require 'test/unit/ui/console/testrunner'
  suite = Test::Unit::TestSuite.new("#{gem_spec.name}-#{gem_spec.version}")
  ObjectSpace.each_object(Class) do |klass|
    suite << klass.suite if (klass < Test::Unit::TestCase)
  end
  result = Test::Unit::UI::Console::TestRunner.run(suite, Test::Unit::UI::SILENT)
  unless result.passed?
    alert_error(result.to_s)
    #unless ask_yes_no(result.to_s + "...keep Gem?", true) then
      #Gem::Uninstaller.new(gem_spec.name, gem_spec.version.version).uninstall
    #end
  end
  result
ensure
  Dir.chdir(start_dir)
end

#verify_gem(gem_data) ⇒ Object

Given a gem file’s contents, validates against its own MD5 checksum

gem_data
String

Contents of the gem file



19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/rubygems/validator.rb', line 19

def verify_gem(gem_data)
  if(gem_data.size == 0) then
    raise VerificationError.new("Empty Gem file")
  end
  require 'md5'
 unless(gem_data =~ /MD5SUM/m)
   return # Don't worry about it...this sucks.  Need to fix MD5 stuff for
            # new format
            # FIXME
  end
  unless (MD5.md5(gem_data.gsub(/MD5SUM = "([a-z0-9]+)"/, "MD5SUM = \"" + ("F" * 32) + "\"")) == $1.to_s) 
    raise VerificationError.new("Invalid checksum for Gem file")
  end
end

#verify_gem_file(gem_path) ⇒ Object

Given the path to a gem file, validates against its own MD5 checksum

gem_path
String

Path to gem file



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/rubygems/validator.rb', line 38

def verify_gem_file(gem_path)
  begin
    File.open(gem_path, 'rb') do |file|
      gem_data = file.read
      verify_gem(gem_data)
    end
  rescue Errno::ENOENT
    raise Gem::VerificationError.new("Missing gem file #{gem_path}")
  end
end