Class: Dependabot::Clients::Azure

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

Defined Under Namespace

Classes: NotFound

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, credentials) ⇒ Azure

Client #



28
29
30
31
32
 
# File 'lib/dependabot/clients/azure.rb', line 28

def initialize(source, credentials)
  @source = source
  @credentials = credentials
  @auth_header = auth_header_for(credentials&.fetch("token", nil))
end

Class Method Details

.for_source(source:, credentials:) ⇒ Object

Constructor methods #



15
16
17
18
19
20
21
22
 
# File 'lib/dependabot/clients/azure.rb', line 15

def self.for_source(source:, credentials:)
  credential =
    credentials.
    select { |cred| cred["type"] == "git_source" }.
    find { |cred| cred["host"] == source.hostname }

  new(source, credential)
end

Instance Method Details

#branch(branch_name) ⇒ Object 



105
106
107
108
109
110
111
112
 
# File 'lib/dependabot/clients/azure.rb', line 105

def branch(branch_name)
  response = get(source.api_endpoint +
    source.organization + "/" + source.project +
    "/_apis/git/repositories/" + source.unscoped_repo +
    "/refs?filter=heads/" + branch_name)

  JSON.parse(response.body).fetch("value").first
end

#commits(branch_name = nil) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/dependabot/clients/azure.rb', line 92

def commits(branch_name = nil)
  commits_url = source.api_endpoint +
                source.organization + "/" + source.project +
                "/_apis/git/repositories/" + source.unscoped_repo +
                "/commits"

  commits_url += "?searchCriteria.itemVersion.version=" + branch_name unless branch_name.to_s.empty?

  response = get(commits_url)

  JSON.parse(response.body).fetch("value")
end

#create_commit(branch_name, base_commit, commit_message, files, author_details) ⇒ Object 



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
151
152
 
# File 'lib/dependabot/clients/azure.rb', line 125

def create_commit(branch_name, base_commit, commit_message, files,
                  author_details)
  content = {
    refUpdates: [
      { name: "refs/heads/" + branch_name, oldObjectId: base_commit }
    ],
    commits: [
      {
        comment: commit_message,
        author: author_details,
        changes: files.map do |file|
          {
            changeType: "edit",
            item: { path: file.path },
            newContent: {
              content: Base64.encode64(file.content),
              contentType: "base64encoded"
            }
          }
        end
      }.compact
    ]
  }

  post(source.api_endpoint + source.organization + "/" + source.project +
    "/_apis/git/repositories/" + source.unscoped_repo +
    "/pushes?api-version=5.0", content.to_json)
end

#create_pull_request(pr_name, source_branch, target_branch, pr_description, labels, work_item = nil) ⇒ Object

rubocop:disable Metrics/ParameterLists



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/dependabot/clients/azure.rb', line 155

def create_pull_request(pr_name, source_branch, target_branch,
                        pr_description, labels, work_item = nil)
  # Azure DevOps only support descriptions up to 4000 characters
  # https://developercommunity.visualstudio.com/content/problem/608770/remove-4000-character-limit-on-pull-request-descri.html
  azure_max_length = 3999
  if pr_description.length > azure_max_length
    truncated_msg = "...\n\n_Description has been truncated_"
    truncate_length = azure_max_length - truncated_msg.length
    pr_description = pr_description[0..truncate_length] + truncated_msg
  end
  # rubocop:enable Metrics/ParameterLists

  content = {
    sourceRefName: "refs/heads/" + source_branch,
    targetRefName: "refs/heads/" + target_branch,
    title: pr_name,
    description: pr_description,
    labels: labels.map { |label| { name: label } },
    workItemRefs: [{ id: work_item }]
  }

  post(source.api_endpoint +
    source.organization + "/" + source.project +
    "/_apis/git/repositories/" + source.unscoped_repo +
    "/pullrequests?api-version=5.0", content.to_json)
end

#fetch_commit(_repo, branch) ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'lib/dependabot/clients/azure.rb', line 34

def fetch_commit(_repo, branch)
  response = get(source.api_endpoint +
    source.organization + "/" + source.project +
    "/_apis/git/repositories/" + source.unscoped_repo +
    "/stats/branches?name=" + branch)

  JSON.parse(response.body).fetch("commit").fetch("commitId")
end

#fetch_default_branch(_repo) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/dependabot/clients/azure.rb', line 43

def fetch_default_branch(_repo)
  response = get(source.api_endpoint +
    source.organization + "/" + source.project +
    "/_apis/git/repositories/" + source.unscoped_repo)

  JSON.parse(response.body).fetch("defaultBranch").gsub("refs/heads/", "")
end

#fetch_file_contents(commit, path) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/dependabot/clients/azure.rb', line 81

def fetch_file_contents(commit, path)
  response = get(source.api_endpoint +
    source.organization + "/" + source.project +
    "/_apis/git/repositories/" + source.unscoped_repo +
    "/items?path=" + path +
    "&versionDescriptor.versionType=commit" \
    "&versionDescriptor.version=" + commit)

  response.body
end

#fetch_repo_contents(commit = nil, path = nil) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/dependabot/clients/azure.rb', line 51

def fetch_repo_contents(commit = nil, path = nil)
  tree = fetch_repo_contents_treeroot(commit, path)

  response = get(source.api_endpoint +
    source.organization + "/" + source.project +
    "/_apis/git/repositories/" + source.unscoped_repo +
    "/trees/" + tree + "?recursive=false")

  JSON.parse(response.body).fetch("treeEntries")
end

#fetch_repo_contents_treeroot(commit = nil, path = nil) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/dependabot/clients/azure.rb', line 62

def fetch_repo_contents_treeroot(commit = nil, path = nil)
  actual_path = path
  actual_path = "/" if path.to_s.empty?

  tree_url = source.api_endpoint +
             source.organization + "/" + source.project +
             "/_apis/git/repositories/" + source.unscoped_repo +
             "/items?path=" + actual_path

  unless commit.to_s.empty?
    tree_url += "&versionDescriptor.versionType=commit" \
                "&versionDescriptor.version=" + commit
  end

  tree_response = get(tree_url)

  JSON.parse(tree_response.body).fetch("objectId")
end

#get(url) ⇒ Object

Raises:



182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/dependabot/clients/azure.rb', line 182

def get(url)
  response = Excon.get(
    url,
    user: credentials&.fetch("username", nil),
    password: credentials&.fetch("password", nil),
    idempotent: true,
    **SharedHelpers.excon_defaults(
      headers: auth_header
    )
  )
  raise NotFound if response.status == 404

  response
end

#post(url, json) ⇒ Object

Raises:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/dependabot/clients/azure.rb', line 197

def post(url, json)
  response = Excon.post(
    url,
    body: json,
    user: credentials&.fetch("username", nil),
    password: credentials&.fetch("password", nil),
    idempotent: true,
    **SharedHelpers.excon_defaults(
      headers: auth_header.merge(
        {
          "Content-Type" => "application/json"
        }
      )
    )
  )
  raise NotFound if response.status == 404

  response
end

#pull_requests(source_branch, target_branch) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/dependabot/clients/azure.rb', line 114

def pull_requests(source_branch, target_branch)
  response = get(source.api_endpoint +
    source.organization + "/" + source.project +
    "/_apis/git/repositories/" + source.unscoped_repo +
    "/pullrequests?searchCriteria.status=all" \
    "&searchCriteria.sourceRefName=refs/heads/" + source_branch +
    "&searchCriteria.targetRefName=refs/heads/" + target_branch)

  JSON.parse(response.body).fetch("value")
end