Class: Bundler::Audit::CLI

Inherits:
Thor
  • Object
show all
Defined in:
lib/bundler/audit/cli.rb,
lib/bundler/audit/cli/formats.rb,
lib/bundler/audit/cli/formats/json.rb,
lib/bundler/audit/cli/formats/text.rb,
lib/bundler/audit/cli/formats/junit.rb

Overview

The bundle-audit command.

Defined Under Namespace

Modules: Formats

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.exit_on_failure? ⇒ Boolean (protected)

Note:

Silence deprecation warnings from Thor.

Returns:

  • (Boolean) 


166
167
168
 
# File 'lib/bundler/audit/cli.rb', line 166

def self.exit_on_failure?
  true
end

Instance Method Details

#check(dir = Dir.pwd) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/bundler/audit/cli.rb', line 49

def check(dir=Dir.pwd)
  unless File.directory?(dir)
    say_error "No such file or directory: #{dir}", :red
    exit 1
  end

  begin
    extend Formats.load(options[:format])
  rescue Formats::FormatNotFound
    say_error "Unknown format: #{options[:format]}", :red
    exit 1
  end

  if !Database.exists?(options[:database])
    download(options[:database])
  elsif options[:update]
    update(options[:database])
  end

  database = Database.new(options[:database])
  scanner  = begin
               Scanner.new(dir,options[:gemfile_lock],database, options[:config])
             rescue Bundler::GemfileLockNotFound => exception
               say exception.message, :red
               exit 1
             end

  report = scanner.report(ignore: options.ignore)

  output = if options[:output] then File.new(options[:output],'w')
           else                     $stdout
           end

  print_report(report,output)

  output.close if options[:output]

  exit(1) if report.vulnerable?
end

#download(path = Database.path) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/bundler/audit/cli.rb', line 107

def download(path=Database.path)
  if Database.exists?(path)
    say "Database already exists", :yellow
    return
  end

  say("Download ruby-advisory-db ...") unless options.quiet?

  begin
    Database.download(path: path, quiet: options.quiet?)
  rescue Database::DownloadFailed => error
    say error.message, :red
    exit 1
  end

  stats(path) unless options.quiet?
end

#print_report(report) ⇒ Object (protected)

This method is abstract.

Raises:

  • (NotImplementedError) 


173
174
175
 
# File 'lib/bundler/audit/cli.rb', line 173

def print_report(report)
  raise(NotImplementedError,"#{self.class}##{__method__} not defined")
end

#stats(path = Database.path) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/bundler/audit/cli.rb', line 92

def stats(path=Database.path)
  database = Database.new(path)

  puts "ruby-advisory-db:"
  puts "  advisories:\t#{database.size} advisories"
  puts "  last updated:\t#{database.last_updated_at}"

  if (commit_id = database.commit_id)
    puts "  commit:\t#{commit_id}"
  end
end

#update(path = Database.path) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/bundler/audit/cli.rb', line 128

def update(path=Database.path)
  unless Database.exists?(path)
    download(path)
    return
  end

  say("Updating ruby-advisory-db ...") unless options.quiet?

  database = Database.new(path)

  case database.update!(quiet: options.quiet?)
  when true
    say("Updated ruby-advisory-db", :green) unless options.quiet?
  when false
    say_error "Failed updating ruby-advisory-db!", :red
    exit 1
  when nil
    unless Bundler.git_present?
      say_error "Git is not installed!", :red
      exit 1
    end

    say "Skipping update", :yellow
  end

  stats(path) unless options.quiet?
end

#version ⇒ Object 



157
158
159
 
# File 'lib/bundler/audit/cli.rb', line 157

def version
  puts "bundler-audit #{VERSION}"
end