Class: Danger::DangerGitlabGraph

Inherits:
Plugin
  • Object
show all
Defined in:
lib/gitlab_graph/plugin.rb

Overview

This plugin retrieves a certain metric from previous job runs and displays them as a graph

Examples:

Extract values from job “test” with the given regex


gitlab_graph.report_metric(/performance: ([0-9]+)s/, "test")

See Also:

  • kingjan1999/danger-gitlab_graph

Instance Method Summary collapse

Instance Method Details

#report_metric(extraction_regex, job_name, prev_pipeline_count = 10, graph_options = {}) ⇒ Array<String>

Creates and comments a graph based on a certain metric, extracted via regex

Returns:

  • (Array<String>) 


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/gitlab_graph/plugin.rb', line 18

def report_metric(extraction_regex, job_name, prev_pipeline_count = 10, graph_options = {})
  pipeline_id = ENV["CI_PIPELINE_ID"]
  project_id = ENV["CI_PROJECT_ID"]

  target_branch = gitlab.branch_for_merge

  _, new_metric = extract_metric_from_pipeline(project_id, pipeline_id, extraction_regex, job_name)
  unless new_metric
    warn("No updated metric found for job #{job_name}")
    return
  end

  previous_target_branch_pipelines = gitlab.api.pipelines(project_id, {
    status: 'success',
    ref: target_branch,
    per_page: prev_pipeline_count
  })

  previous_metrics = previous_target_branch_pipelines.collect { |pipeline| extract_metric_from_pipeline(project_id, pipeline.id, extraction_regex, job_name) }
  previous_metrics = previous_metrics.select { |val| val[1] }
  # create graph

  data = previous_metrics.collect { |val| val[1] }
  data = data + [new_metric]

  fields = previous_metrics.collect { |pipeline| "Run #{pipeline[0]}" }
  fields += [pipeline_id]

  default_graph_options = {
    :width => 640,
    :height => 480,
    :graph_title => "Performance Metric",
    :show_graph_title => true,
    :x_title => "Pipeline Runs",
    :y_title => "Metric Value",
    :show_y_title => true,
    :show_x_title => true,
    :number_format => "%.2fs",
    :fields => fields
  }

  g = SVG::Graph::Line.new(default_graph_options.merge(graph_options))

  g.add_data(:data => data)

  temp_file = Tempfile.new(%w[graph .svg])
  begin
    temp_file.write(g.burn_svg_only)
    uploaded_file = gitlab.api.upload_file(project_id, temp_file.path)
    markdown(uploaded_file.markdown)
  ensure
    temp_file.close
    temp_file.unlink
  end
end