brew/Library/Homebrew/cmd/gist-logs.rb
Mike McQuaid 6135da800e utils, gist-logs: improve/fix credential handling.
The API used (`Net::HTTP::Post`) does not handle basic authentication
credentials in the same way as `open` so fix both cases so they work.

Also, do some general usability tweaks to point out to people what could
be wrong with their tokens or credentials to help them debug.

Closes Homebrew/homebrew#50410.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-03-28 18:22:47 +08:00

173 lines
4.7 KiB
Ruby

require "formula"
require "cmd/config"
require "net/http"
require "net/https"
require "stringio"
require "socket"
module Homebrew
def gistify_logs(f)
files = load_logs(f.logs)
build_time = f.logs.ctime
timestamp = build_time.strftime("%Y-%m-%d_%H-%M-%S")
s = StringIO.new
Homebrew.dump_verbose_config(s)
# Dummy summary file, asciibetically first, to control display title of gist
files["# #{f.name} - #{timestamp}.txt"] = { :content => brief_build_info(f) }
files["00.config.out"] = { :content => s.string }
files["00.doctor.out"] = { :content => `brew doctor 2>&1` }
unless f.core_formula?
tap = <<-EOS.undent
Formula: #{f.name}
Tap: #{f.tap}
Path: #{f.path}
EOS
files["00.tap.out"] = { :content => tap }
end
# Description formatted to work well as page title when viewing gist
if f.core_formula?
descr = "#{f.name} on #{OS_VERSION} - Homebrew build logs"
else
descr = "#{f.name} (#{f.full_name}) on #{OS_VERSION} - Homebrew build logs"
end
url = create_gist(files, descr)
if ARGV.include?("--new-issue") || ARGV.switch?("n")
auth = :AUTH_TOKEN
if GitHub.api_credentials_type == :none
puts "You can create a personal access token: https://github.com/settings/tokens"
puts "and then set HOMEBREW_GITHUB_API_TOKEN as authentication method."
puts
auth = :AUTH_USER_LOGIN
end
url = new_issue(f.tap, "#{f.name} failed to build on #{MacOS.full_version}", url, auth)
end
puts url if url
end
def brief_build_info(f)
build_time_str = f.logs.ctime.strftime("%Y-%m-%d %H:%M:%S")
s = <<-EOS.undent
Homebrew build logs for #{f.full_name} on #{OS_VERSION}
EOS
if ARGV.include?("--with-hostname")
hostname = Socket.gethostname
s << "Host: #{hostname}\n"
end
s << "Build date: #{build_time_str}\n"
s
end
# Hack for ruby < 1.9.3
def noecho_gets
system "stty -echo"
result = $stdin.gets
system "stty echo"
puts
result
end
def login(request)
print "GitHub User: "
user = $stdin.gets.chomp
print "Password: "
password = noecho_gets.chomp
puts
request.basic_auth(user, password)
end
def load_logs(dir)
logs = {}
dir.children.sort.each do |file|
contents = file.size? ? file.read : "empty log"
logs[file.basename.to_s] = { :content => contents }
end if dir.exist?
raise "No logs." if logs.empty?
logs
end
def create_gist(files, descr)
post("/gists", { "public" => true, "files" => files, "description" => descr })["html_url"]
end
def new_issue(repo, title, body, auth)
post("/repos/#{repo}/issues", { "title" => title, "body" => body }, auth)["html_url"]
end
def http
@http ||= begin
uri = URI.parse("https://api.github.com")
p = ENV["http_proxy"] ? URI.parse(ENV["http_proxy"]) : nil
if p.class == URI::HTTP || p.class == URI::HTTPS
@http = Net::HTTP.new(uri.host, uri.port, p.host, p.port, p.user, p.password)
else
@http = Net::HTTP.new(uri.host, uri.port)
end
@http.use_ssl = true
@http
end
end
def make_request(path, data, auth)
headers = GitHub.api_headers
headers["Content-Type"] = "application/json"
basic_auth_credentials = nil
if auth != :AUTH_USER_LOGIN
token, username = GitHub.api_credentials
case GitHub.api_credentials_type
when :keychain
basic_auth_credentials = [username, token]
when :environment
headers["Authorization"] = "token #{token}"
end
end
request = Net::HTTP::Post.new(path, headers)
request.basic_auth(*basic_auth_credentials) if basic_auth_credentials
login(request) if auth == :AUTH_USER_LOGIN
request.body = Utils::JSON.dump(data)
request
end
def post(path, data, auth = nil)
request = make_request(path, data, auth)
case response = http.request(request)
when Net::HTTPCreated
Utils::JSON.load get_body(response)
else
GitHub.api_credentials_error_message(response)
raise "HTTP #{response.code} #{response.message} (expected 201)"
end
end
def get_body(response)
if !response.body.respond_to?(:force_encoding)
response.body
elsif response["Content-Type"].downcase == "application/json; charset=utf-8"
response.body.dup.force_encoding(Encoding::UTF_8)
else
response.body.encode(Encoding::UTF_8, :undef => :replace)
end
end
def gist_logs
if ARGV.resolved_formulae.length != 1
puts "usage: brew gist-logs [--new-issue|-n] <formula>"
Homebrew.failed = true
return
end
gistify_logs(ARGV.resolved_formulae[0])
end
end