Class: Dependabot::Source

Inherits:
Object
  • Object
show all
Defined in:
lib/dependabot/source.rb

Constant Summary collapse

GITHUB_SOURCE = 
%r{
  (?<provider>github)
  (?:\.com)[/:]
  (?<repo>[\w.-]+/(?:[\w.-])+)
  (?:(?:/tree|/blob)/(?<branch>[^/]+)/(?<directory>.*)[\#|/])?
}x
GITHUB_ENTERPRISE_SOURCE = 
%r{
  (?<protocol>(http://|https://|git://|ssh://))*
  (?<username>[^@]+@)*
  (?<host>[^/]+)
  [/:]
  (?<repo>[\w.-]+/(?:[\w.-])+)
  (?:(?:/tree|/blob)/(?<branch>[^/]+)/(?<directory>.*)[\#|/])?
}x
GITLAB_SOURCE = 
%r{
  (?<provider>gitlab)
  (?:\.com)[/:]
  (?<repo>[^/]+/(?:[^/])+((?!/tree|/blob/|/-)/[^/]+)?)
  (?:(?:/tree|/blob)/(?<branch>[^/]+)/(?<directory>.*)[\#|/].*)?
}x
BITBUCKET_SOURCE = 
%r{
  (?<provider>bitbucket)
  (?:\.org)[/:]
  (?<repo>[\w.-]+/(?:[\w.-])+)
  (?:(?:/src)/(?<branch>[^/]+)/(?<directory>.*)[\#|/])?
}x
AZURE_SOURCE = 
%r{
  (?<provider>azure)
  (?:\.com)[/:]
  (?<repo>[\w.-]+/([\w.-]+/)?(?:_git/)(?:[\w.-])+)
}x
CODECOMMIT_SOURCE = 
%r{
  (?<protocol>(http://|https://|git://|ssh://))
  git[-]
  (?<provider>codecommit)
  (?:.*)
  (?:\.com/v1/repos/)
  (?<repo>([^/]*))
  (?:/)?(?<directory>[^?]*)?
  [?]?
  (?<ref>.*)?
}x
SOURCE_REGEX = 
/
  (?:#{GITHUB_SOURCE})|
  (?:#{GITLAB_SOURCE})|
  (?:#{BITBUCKET_SOURCE})|
  (?:#{AZURE_SOURCE})|
  (?:#{CODECOMMIT_SOURCE})
/x
IGNORED_PROVIDER_HOSTS = 
%w(gitbox.apache.org svn.apache.org fuchsia.googlesource.com).freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider:, repo:, directory: nil, branch: nil, commit: nil, hostname: nil, api_endpoint: nil) ⇒ Source

Returns a new instance of Source.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/dependabot/source.rb', line 110

def initialize(provider:, repo:, directory: nil, branch: nil, commit: nil,
               hostname: nil, api_endpoint: nil)
  if (hostname.nil? ^ api_endpoint.nil?) && (provider != "codecommit")
    msg = "Both hostname and api_endpoint must be specified if either " \
          "are. Alternatively, both may be left blank to use the " \
          "provider's defaults."
    raise msg
  end

  @provider = provider
  @repo = repo
  @directory = directory
  @branch = branch
  @commit = commit
  @hostname = hostname || default_hostname(provider)
  @api_endpoint = api_endpoint || default_api_endpoint(provider)
end

Instance Attribute Details

#api_endpoint ⇒ Object

Returns the value of attribute api_endpoint.



64
65
66
 
# File 'lib/dependabot/source.rb', line 64

def api_endpoint
  @api_endpoint
end

#branch ⇒ Object

Returns the value of attribute branch.



64
65
66
 
# File 'lib/dependabot/source.rb', line 64

def branch
  @branch
end

#commit ⇒ Object

Returns the value of attribute commit.



64
65
66
 
# File 'lib/dependabot/source.rb', line 64

def commit
  @commit
end

#directory ⇒ Object

Returns the value of attribute directory.



64
65
66
 
# File 'lib/dependabot/source.rb', line 64

def directory
  @directory
end

#hostname ⇒ Object

Returns the value of attribute hostname.



64
65
66
 
# File 'lib/dependabot/source.rb', line 64

def hostname
  @hostname
end

#provider ⇒ Object

Returns the value of attribute provider.



64
65
66
 
# File 'lib/dependabot/source.rb', line 64

def provider
  @provider
end

#repo ⇒ Object

Returns the value of attribute repo.



64
65
66
 
# File 'lib/dependabot/source.rb', line 64

def repo
  @repo
end

Class Method Details

.from_url(url_string) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/dependabot/source.rb', line 67

def self.from_url(url_string)
  return github_enterprise_from_url(url_string) unless url_string&.match?(SOURCE_REGEX)

  captures = url_string.match(SOURCE_REGEX).named_captures

  new(
    provider: captures.fetch("provider"),
    repo: captures.fetch("repo").delete_suffix(".git").delete_suffix("."),
    directory: captures.fetch("directory"),
    branch: captures.fetch("branch")
  )
end

.github_enterprise?(base_url) ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
102
103
104
105
106
107
108
 
# File 'lib/dependabot/source.rb', line 99

def self.github_enterprise?(base_url)
  resp = Excon.get(File.join(base_url, "status"))
  resp.status == 200 &&
    # Alternatively: resp.headers["Server"] == "GitHub.com", but this
    # currently doesn't work with development environments
    resp.headers["X-GitHub-Request-Id"] &&
    !resp.headers["X-GitHub-Request-Id"].empty?
rescue StandardError
  false
end

.github_enterprise_from_url(url_string) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/dependabot/source.rb', line 80

def self.github_enterprise_from_url(url_string)
  captures = url_string&.match(GITHUB_ENTERPRISE_SOURCE)&.named_captures
  return unless captures
  return if IGNORED_PROVIDER_HOSTS.include?(captures.fetch("host"))

  base_url = "https://#{captures.fetch('host')}"

  return unless github_enterprise?(base_url)

  new(
    provider: "github",
    repo: captures.fetch("repo").delete_suffix(".git").delete_suffix("."),
    directory: captures.fetch("directory"),
    branch: captures.fetch("branch"),
    hostname: captures.fetch("host"),
    api_endpoint: File.join(base_url, "api", "v3")
  )
end

Instance Method Details

#organization ⇒ Object 



152
153
154
 
# File 'lib/dependabot/source.rb', line 152

def organization
  repo.split("/").first
end

#project ⇒ Object 



156
157
158
159
160
161
162
163
 
# File 'lib/dependabot/source.rb', line 156

def project
  raise "Project is an Azure DevOps concept only" unless provider == "azure"

  parts = repo.split("/_git/")
  return parts.first.split("/").last if parts.first.split("/").count == 2

  parts.last
end

#unscoped_repo ⇒ Object 



165
166
167
 
# File 'lib/dependabot/source.rb', line 165

def unscoped_repo
  repo.split("/").last
end

#url ⇒ Object 



128
129
130
 
# File 'lib/dependabot/source.rb', line 128

def url
  "https://" + hostname + "/" + repo
end

#url_with_directory ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/dependabot/source.rb', line 132

def url_with_directory
  return url if [nil, ".", "/"].include?(directory)

  case provider
  when "github", "gitlab"
    path = Pathname.new(File.join("tree/#{branch || 'HEAD'}", directory))
                   .cleanpath.to_path
    url + "/" + path
  when "bitbucket"
    path = Pathname.new(File.join("src/#{branch || 'default'}", directory))
                   .cleanpath.to_path
    url + "/" + path
  when "azure"
    url + "?path=#{directory}"
  when "codecommit"
    raise "The codecommit provider does not utilize URLs"
  else raise "Unexpected repo provider '#{provider}'"
  end
end