Class: LogStash::Inputs::Bitbucket

Inherits:
Base
  • Object
show all
Includes:
PluginMixins::HttpClient
Defined in:
lib/logstash/inputs/bitbucket.rb

Overview

DISCLAIMER: Functions for this plugin are made public for the sake of creating concise unit tests

Constant Summary collapse

Schedule_types = 
%w(cron every at in)

Instance Method Summary collapse

Instance Method Details

#handle_branch_response(queue, uri, parameters, response, execution_time) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/logstash/inputs/bitbucket.rb', line 259

def handle_branch_response(queue, uri, parameters, response, execution_time)
  body = JSON.parse(response.body)

  #@logger.info("Handle Branch Response", :uri => uri, :project => parameters[:project], :repo => parameters[:repo], :start => body['start'], :size => body['size'])


  unless body['isLastPage']
    request_async(
        queue,
        "rest/api/1.0/projects/%{project}/repos/%{repo}/branches",
        {:project => parameters[:project], :repo => parameters[:repo]},
        {:query => {'details' => 'true', 'state' => 'ALL', 'start' => body['nextPageStart']}},
        'handle_branch_response')

    # Send HTTP requests
    client.execute!
  end

  # Iterate over each Branch
  body['values'].each { |branch|
    #@logger.info("Add Branch Request", :project => parameters[:project], :repo => parameters[:repo], :branch => branch['id'])

    # Push Branch event into queue
    event = LogStash::Event.new(branch)
    event.set("[@metadata][index]", "branch")
    event.set("[@metadata][id]", "#{parameters[:project]}-#{parameters[:repo]}-#{branch['id']}")
    queue << event
  }

end

#handle_commits_response(queue, uri, parameters, response, execution_time) ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/logstash/inputs/bitbucket.rb', line 290

def handle_commits_response(queue, uri, parameters, response, execution_time)

  body = JSON.parse(response.body)
  @logger.info("Handle Commits Response", :uri => uri, :project => parameters[:project], :repo => parameters[:repo], :start => body['start'], :size => body['size'])

  unless body['isLastPage']
    request_async(
        queue,
        "rest/api/1.0/projects/%{project}/repos/%{repo}/commits",
        {:project => parameters[:project], :repo => parameters[:repo]},
        {:query => {'details' => 'true', 'state' => 'ALL', 'start' => body['nextPageStart']}},
        'handle_commits_response')

    # Send HTTP requests
    client.execute!
  end

  # Iterate over each Commit
  body['values'].each { |commit|
    @logger.info("Add Commit Request", :project => parameters[:project], :repo => parameters[:repo], :commit => commit['id'])

    # Push Commit event into queue
    event = LogStash::Event.new(commit)
    event.set("[@metadata][index]", "commit")
    event.set("[@metadata][id]", "#{parameters[:project]}-#{parameters[:repo]}-#{commit['id']}")
    queue << event
  }
end

#handle_failure(queue, path, parameters, exception, execution_time) ⇒ Object 



319
320
321
 
# File 'lib/logstash/inputs/bitbucket.rb', line 319

def handle_failure(queue, path, parameters, exception, execution_time)
  @logger.error('HTTP Request failed', :path => path, :parameters => parameters, :exception => exception, :backtrace => exception.backtrace);
end

#handle_projects_response(queue, uri, parameters, response, execution_time) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
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
151
152
153
154
155
156
157
158
159
 
# File 'lib/logstash/inputs/bitbucket.rb', line 107

def handle_projects_response(queue, uri, parameters, response, execution_time)
  # Decode JSON
  body = JSON.parse(response.body)

  #@logger.info("Handle Projects Response", :uri => uri, :start => body['start'], :size => body['size'])
  #@logger.info("Response Body", :body => response)

  request_count = 0

  # Fetch addition project pages
  unless body['isLastPage']
    request_async(
        queue,
        "rest/api/1.0/projects",
        {},
        {:query => {'start' => body['nextPageStart']}},
        'handle_projects_response'
    )

    client.execute!
  end

  # Iterate over each project
  body['values'].each do |project|
    #@logger.info("Add project", :project => project['key'])

    # Send get repos request
    request_async(
        queue,
        "rest/api/1.0/projects/%{project}/repos",
        {:project => project['key']},
        {},
        'handle_repos_response')

    request_count += 1

    if request_count > 1
      request_count = 0
      client.execute!
    end

    # Push project event into queue
    event = LogStash::Event.new(project)
    event.set('[@metadata][index]', 'project')
    event.set('[@metadata][id]', project['id'])
    queue << event
  end

  if request_count > 0
    # Send HTTP requests
    client.execute!
  end
end

#handle_pull_requests_response(queue, uri, parameters, response, execution_time) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/logstash/inputs/bitbucket.rb', line 228

def handle_pull_requests_response(queue, uri, parameters, response, execution_time)
  # Decode JSON
  body = JSON.parse(response.body)

  #@logger.info("Handle Pull Requests Response", :uri => uri, :project => parameters[:project], :repo => parameters[:repo], :start => body['start'], :size => body['size'])

  # Fetch addition pull request pages
  unless body['isLastPage']
    request_async(
        queue,
        "rest/api/1.0/projects/%{project}/repos/%{repo}/pull-requests",
        {:project => parameters[:project], :repo => parameters[:repo]},
        {:query => {'state' => 'ALL', 'start' => body['nextPageStart']}},
        'handle_pull_requests_response')

    # Send HTTP requests
    client.execute!
  end

  # Iterate over each pull request
  body['values'].each { |pull_request|
    #@logger.info("Add Pull Request", :project => parameters[:project], :repo => parameters[:repo], :pull_request => pull_request['title'])

    # Push repo event into queue
    event = LogStash::Event.new(pull_request)
    event.set("[@metadata][index]", "pull_request")
    event.set("[@metadata][id]", "#{parameters[:project]}-#{parameters[:repo]}-#{pull_request['id']}")
    queue << event
  }
end

#handle_repos_response(queue, uri, parameters, response, execution_time) ⇒ Object

Process response from get repos API request



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/logstash/inputs/bitbucket.rb', line 162

def handle_repos_response(queue, uri, parameters, response, execution_time)
  # Decode JSON
  body = JSON.parse(response.body)

  #@logger.info("Handle Repos Response", :uri => uri, :project => parameters[:project], :start => body['start'], :size => body['size'])

  request_count = 0

  # Fetch addition repo pages
  unless body['isLastPage']
    request_async(
        queue,
        "rest/api/1.0/projects/%{project}/repos",
      {:project => parameters[:project]},
        {:query => {'start' => body['nextPageStart']}},
        'handle_repos_response'
    )

    client.execute!
  end

  # Iterate over each repo
  body['values'].each { |repo|
   #@logger.info("Add repo", :project => parameters[:project], :repo => repo['slug'])

    # Send get pull requests request
    request_async(
        queue,
        "rest/api/1.0/projects/%{project}/repos/%{repo}/pull-requests",
        {:project => parameters[:project], :repo => repo['slug']},
        {:query => {'state' => 'ALL'}},
        'handle_pull_requests_response')
    # Semd Branch requests request
    request_async(
        queue,
        "rest/api/1.0/projects/%{project}/repos/%{repo}/branches",
        {:project => parameters[:project], :repo => repo['slug']},
        {:query => {'state' => 'ALL'}},
        'handle_branch_response')

    request_async(
        queue,
        "rest/api/1.0/projects/%{project}/repos/%{repo}/commits",
        {:project => parameters[:project], :repo => repo['slug']},
        {:query => {'state' => 'ALL'}},
        'handle_commits_response')
    request_count +=1

    if request_count > 1
      request_count = 0
      client.execute!
    end

    # Push repo event into queue
    event = LogStash::Event.new(repo)
    event.set("[@metadata][index]", "repo")
    event.set("[@metadata][id]", repo['id'])
    queue << event
  }

  if request_count > 0
    # Send HTTP requests
    client.execute!
  end
end

#register ⇒ Object 



45
46
47
48
49
 
# File 'lib/logstash/inputs/bitbucket.rb', line 45

def register
  @host = Socket.gethostname.force_encoding(Encoding::UTF_8)
  @authorization = "Bearer #{@token}"
  @logger.info('Register BitBucket Input', :schedule => @schedule, :hostname => @hostname, :port => @port)
end

#request_async(queue, path, parameters, request_options, callback) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/logstash/inputs/bitbucket.rb', line 89

def request_async(queue, path, parameters, request_options, callback)
  started = Time.now

  method = parameters[:method] ? parameters.delete(:method) : :get

  uri = "#{@scheme}://#{@hostname}/#{path}" % parameters

  request_options[:headers] = {'Authorization' => @authorization}

 # @logger.info("Fetching URL", :method => method, :request => uri)

  client.parallel.send(method, uri, request_options).
      on_success {|response| self.send(callback, queue, uri, parameters, response, Time.now - started)}.
      on_failure {|exception|
        handle_failure(queue, uri, parameters, exception, Time.now - started)
      }
end

#run(queue) ⇒ Object

Raises:

  • (Logstash::ConfigurationError) 


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/logstash/inputs/bitbucket.rb', line 51

def run(queue)
  @logger.info('RUN')
  #schedule hash must contain exactly one of the allowed keys
  msg_invalid_schedule = "Invalid config. schedule hash must contain " +
      "exactly one of the following keys - cron, at, every or in"
  raise Logstash::ConfigurationError, msg_invalid_schedule if @schedule.keys.length != 1
  schedule_type = @schedule.keys.first
  schedule_value = @schedule[schedule_type]
  raise LogStash::ConfigurationError, msg_invalid_schedule unless Schedule_types.include?(schedule_type)

  @scheduler = Rufus::Scheduler.new(:max_work_threads => 1)
  #as of v3.0.9, :first_in => :now doesn't work. Use the following workaround instead
  opts = schedule_type == "every" ? {:first_in => 0.01} : {}
  @scheduler.send(schedule_type, schedule_value, opts) {run_once(queue)}
  @scheduler.join
  @logger.info('RUN COMPLETE')
end

#run_once(queue) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/logstash/inputs/bitbucket.rb', line 69

def run_once(queue)
  @logger.info('RUN ONCE')

  request_async(
      queue,
      'rest/api/1.0/projects',
      {},
      {},
      'handle_projects_response')

  # request_async(
  #   queue,
  #   "rest/api/1.0/projects/%{project}/repos",
  #   {:project => 'SOCK', :start => 0},
  #   {:headers => {'Authorization' => @authorization}},
  #   'handle_repos_response')

  client.execute!
end

#stop ⇒ Object 



323
324
325
326
327
328
329
 
# File 'lib/logstash/inputs/bitbucket.rb', line 323

def stop
  # nothing to do in this case so it is not necessary to define stop
  # examples of common "stop" tasks:
  #  * close sockets (unblocking blocking reads/accepts)
  #  * cleanup temporary files
  #  * terminate spawned threads
end