danger-gitlab_graph 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b22267bbd08ea047510e711c2e7e94df78c4a36935f58285bbbb38f36026c5db
-  data.tar.gz: faec3d4ebc51300200010473a885a8b4f80e3258946746a7363b2c78245a4d9b
+  metadata.gz: a90273371dfdea31771892146d51bb400737899f28e9f194efa2af34d9acf351
+  data.tar.gz: 3154b7f5544cdbd32658f4596b84a217d6d136b124f764045dc38be953c673a9
 SHA512:
-  metadata.gz: 91aecc44d1c12f48ba78c8b4f26fe7c1c19ed8a19f95dbcae67eba5109b75503acdda2a32d18ef6941e5245f6c9614686f1cb663464b152fccbf01949eeaebb7
-  data.tar.gz: fddd42925cb4c47fd90317fd85d0bb4591434e38cb67dee44925ee2b21b9eca4e51adb6accc15583b0f51b91a041507fbaae5207181e023120e68c573f55d6ce
+  metadata.gz: 3699777c4212c3a626b972ca3d0046214567f56c1323d8e82b0be255653813771d19ac6abca6d4c7246e590cc0348b861a419167097836cebecb89df9f8997af
+  data.tar.gz: 42c833ab21eafa3bfe452805a61ee98f604624a1b6ad9b14cdc8125d2ee50fabacbb854157df60116e24975d3794fb74e67a3267a2ee20019ce872aa3a8f0c56

data/.rubocop.yml

@@ -4,6 +4,7 @@
 
 AllCops:
   TargetRubyVersion: 2.7
+  NewCops: enable
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-gitlab_graph (0.0.3)
+    danger-gitlab_graph (0.1.0)
       danger-plugin-api (~> 1.0)
       svg-graph (~> 2.2.1)
 
@@ -20,6 +20,8 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
+    crack (0.4.5)
+      rexml
     danger (9.0.0)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
@@ -33,6 +35,9 @@ GEM
       no_proxy_fix
       octokit (~> 5.0)
       terminal-table (>= 1, < 4)
+    danger-gitlab (8.0.0)
+      danger
+      gitlab (~> 4.2, >= 4.2.0)
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.5.0)
@@ -66,6 +71,9 @@ GEM
     git (1.12.0)
       addressable (~> 2.8)
       rchardet (~> 1.8)
+    gitlab (4.19.0)
+      httparty (~> 0.20)
+      terminal-table (>= 1.5.1)
     guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -80,6 +88,10 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
     json (2.6.2)
     kramdown (2.4.0)
       rexml
@@ -90,6 +102,10 @@ GEM
       rb-inotify (>= 0.9.7)
     lumberjack (1.2.8)
     method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
     multipart-post (2.2.3)
     nap (1.1.0)
     nenv (0.3.0)
@@ -152,6 +168,10 @@ GEM
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.1)
     unicode-display_width (2.3.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
@@ -161,6 +181,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  danger-gitlab
   danger-gitlab_graph!
   guard (~> 2.14)
   guard-rspec (~> 4.7)
@@ -169,6 +190,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.4)
   rubocop
+  webmock (~> 2.1)
   yard
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,12 @@
 # danger-gitlab_graph
 
-A description of danger-gitlab_graph.
+`danger-gitlab_graph` is a [Danger](https://danger.systems) ruby plugin that allows you to extract and display metrics
+gathered from the current and previous pipeline runs. This plugin is only works with GitLab CI at the moment.
+
+It works similar to the existing test coverage extraction provided by GitLab natively: You provide a job name, an
+extraction regex (including a single capturing group) and some other, optional configuration options. The plugin then
+creates an svg graph (using the [svg-graph2](https://github.com/lumean/svg-graph2) gem) and adds them to your other
+Danger comments.
 
 ## Installation
 
@@ -11,6 +17,49 @@ A description of danger-gitlab_graph.
     Methods and attributes from this plugin are available in
     your `Dangerfile` under the `gitlab_graph` namespace.
 
+### Methods
+
+`gather_metric` - Gathers metric data from current and pevious pipelines
+
+Sample code:
+
+```ruby
+@my_plugin.gather_metric({
+                           regex: /took ([0-9]+)/,
+                           series_name: "Performance",
+                           job_name: "test1"
+                         })
+```
+
+returns an array similiar to this:
+
+```ruby
+[{ hash: "b23f54ecdc3add9abea9344f66b49f1699bff547", metric: 16.0, pipeline_id: 1119 },
+ { hash: "3333333333333333333333333333333333333333", metric: 6.0, pipeline_id: 123_456 }]
+```
+
+`report_metric` - Creates and comments a graph based on a certain metric, extracted via regex
+
+Sample code
+
+```ruby
+gitlab_graph.report_metric([{
+                              regex: /took ([0-9]+)/,
+                              series_name: "Performance",
+                              job_name: "test1"
+                            }, {
+                              regex: /slept ([0-9]+)/,
+                              series_name: "IDLE time",
+                              job_name: "test1"
+                            }]) < /pre>
+```
+
+outputs a graph similiar to this
+
+![sample graph](spec/support/fixtures/graph-simple-expected.svg)
+
+and writes it directly into the danger comment
+
 ## Development
 
 1. Clone this repo

data/danger-gitlab_graph.gemspec

@@ -5,19 +5,20 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "gitlab_graph/gem_version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "danger-gitlab_graph"
-  spec.version       = GitlabGraph::VERSION
-  spec.authors       = ["Jan Beckmann"]
-  spec.email         = ["king-jan1999@hotmail.de"]
-  spec.description   = "Danger plugin for creating graph from ci metrics."
-  spec.summary       = "Danger plugin which allows you to extract and visualize metrics over previous ci runs."
-  spec.homepage      = "https://github.com/kingjan1999/danger-gitlab_graph"
-  spec.license       = "MIT"
+  spec.name                  = "danger-gitlab_graph"
+  spec.version               = GitlabGraph::VERSION
+  spec.authors               = ["Jan Beckmann"]
+  spec.email                 = ["king-jan1999@hotmail.de"]
+  spec.description           = "Danger plugin for creating graph from ci metrics."
+  spec.summary               = "Danger plugin which allows you to extract and visualize metrics over previous ci runs."
+  spec.homepage              = "https://github.com/kingjan1999/danger-gitlab_graph"
+  spec.license               = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.add_runtime_dependency "danger-plugin-api", "~> 1.0"
   spec.add_runtime_dependency "svg-graph", "~> 2.2.1"
@@ -48,4 +49,7 @@ Gem::Specification.new do |spec|
   #
   # This will stop test execution and let you inspect the results
   spec.add_development_dependency "pry"
+
+  spec.add_development_dependency "danger-gitlab"
+  spec.add_development_dependency "webmock", "~> 2.1"
 end

data/lib/gitlab_graph/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitlabGraph
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/gitlab_graph/plugin.rb

@@ -1,66 +1,114 @@
 # frozen_string_literal: true
-require 'svggraph'
+
+require "svggraph"
 
 module Danger
   # This plugin retrieves a certain metric from previous job runs and displays them as a graph
   #
   # @example Extract values from job "test" with the given regex
   #
-  #          gitlab_graph.report_metric(/performance: ([0-9]+)s/, "test")
+  #          gitlab_graph.report_metric([{
+  #                                     regex: /took ([0-9]+)/,
+  #                                     series_name: "Performance",
+  #                                     job_name: "test1"
+  #                                   }, {
+  #                                     regex: /slept ([0-9]+)/,
+  #                                     series_name: "IDLE time",
+  #                                     job_name: "test1"
+  #                                   }])
   #
+  # outputs a graph similiar to this ![sample graph](spec/support/fixtures/graph-simple-expected.svg)
   # @see  kingjan1999/danger-gitlab_graph
   # @tags gitlab, graph, performance
   #
   class DangerGitlabGraph < Plugin
-    # Creates and comments a graph based on a certain metric, extracted via regex
-    # @return   [Array<String>]
-    #
-    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"]
+    # Gathers metric data from current and pevious pipelines
+    # @return [Arrray<{pipeline_id => int, :metric => float}>]
+    def gather_metric(extraction_config, prev_pipeline_count = 10)
+      pipeline_id = ENV["CI_PIPELINE_ID"].to_i
+      project_id = ENV.fetch("CI_PROJECT_ID", nil)
 
       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
+      begin
+        new_metric = extract_metric_from_pipeline(project_id, pipeline_id, extraction_config[:regex], extraction_config[:job_name])
+      rescue JobNotFoundException
+        warn("Job #{extraction_config[:job_name]} for metric extraction of #{extraction_config[:series_name]} not found in current pipeline")
+        return []
+      end
+
+      unless new_metric[:metric]
+        warn("No updated metric #{extraction_config[:series_name]} found for job #{extraction_config[:job_name]}")
+        return []
       end
 
       previous_target_branch_pipelines = gitlab.api.pipelines(project_id, {
-        status: 'success',
+        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
+      previous_metrics = previous_target_branch_pipelines.collect do |pipeline|
+        extract_metric_from_pipeline(project_id, pipeline.id, extraction_config[:regex], extraction_config[:job_name]).merge(hash: pipeline.sha)
+      rescue JobNotFoundException
+        return { pipeline_id: pipeline.id, metric: false, hash: pipeline.sha }
+      end
+
+      previous_metrics + [new_metric.merge(hash: ENV.fetch("CI_COMMIT_SHA", "invalid_hash"))]
+    end
+
+    # Creates and comments a graph based on a certain metric, extracted via regex
+    # @param [Array<hash>] extraction_configs Hash-Array: {:regex, :job_name, :series_name}
+    # @param [int] prev_pipeline_count
+    # @param [hash] graph_options see svg-graph doc
+    # @return [void]
+    def report_metric(extraction_configs, prev_pipeline_count = 10, graph_options = {})
+      project_id = ENV.fetch("CI_PROJECT_ID", nil)
 
-      data = previous_metrics.collect { |val| val[1] }
-      data = data + [new_metric]
+      fields = nil
+      all_data = []
+      extraction_configs.each do |extraction_config|
+        all_metrics = gather_metric(extraction_config, prev_pipeline_count)
 
-      fields = previous_metrics.collect { |pipeline| "Run #{pipeline[0]}" }
-      fields += [pipeline_id]
+        if all_metrics.length.zero?
+          next
+        end
+
+        if fields and all_metrics.length != fields.length
+          warn("Not all metrics could be found in an equal amount of jobs. Unable to plot #{extraction_config[:series_name]}")
+          next
+        end
+
+        data = all_metrics.collect { |val| val[:metric] }
+
+        fields ||= all_metrics.collect { |pipeline| pipeline[:hash][0..7] }
+
+        all_data.push({ data: data, title: extraction_config[:series_name] })
+      end
+
+      if all_data.empty?
+        return
+      end
 
       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
+        width: 640,
+        height: 480,
+        graph_title: "Performance Metric",
+        show_graph_title: true,
+        x_title: "Commit",
+        y_title: "Metric Value",
+        show_y_title: true,
+        show_x_title: true,
+        number_format: "%.2fs",
+        fields: fields
       }
 
+      # create graph
       g = SVG::Graph::Line.new(default_graph_options.merge(graph_options))
 
-      g.add_data(:data => data)
+      all_data.each { |elem| g.add_data(data: elem[:data], title: elem[:title]) }
 
-      temp_file = Tempfile.new(%w[graph .svg])
+      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)
@@ -76,16 +124,19 @@ module Danger
     def extract_metric_from_pipeline(project_id, pipeline_id, extraction_regex, job_name)
       all_jobs = gitlab.api.pipeline_jobs(project_id, pipeline_id)
       target_job = all_jobs.find { |x| x.name == job_name }
-      return false unless target_job
+      raise JobNotFoundException, "job #{job_name} not found in pipeline #{pipeline_id}" unless target_job
 
       job_trace = gitlab.api.job_trace(project_id, target_job.id)
 
       metric_matches = job_trace.match(extraction_regex)
-      unless metric_matches.captures
-        return pipeline_id, false
+      unless metric_matches&.captures
+        return { pipeline_id: pipeline_id, metric: false }
       end
 
-      [pipeline_id, metric_matches.captures[0].to_f]
+      { pipeline_id: pipeline_id, metric: metric_matches.captures[0].to_f }
+    end
+
+    class JobNotFoundException < StandardError
     end
   end
 end

data/spec/gitlab_graph_spec.rb

@@ -1,43 +1,107 @@
 # frozen_string_literal: true
 
+require "fileutils"
 require File.expand_path("spec_helper", __dir__)
 
 module Danger
-  describe Danger::DangerGitlabGraph do
+  describe Danger::DangerGitlabGraph, host: :gitlab do
     it "should be a plugin" do
       expect(Danger::DangerGitlabGraph.new(nil)).to be_a Danger::Plugin
     end
 
-    #
-    # You should test your custom attributes and methods here
-    #
     describe "with Dangerfile" do
+      graph_tmpfile = nil
+
       before do
+        stub_version("11.2.3")
+
         @dangerfile = testing_dangerfile
         @my_plugin = @dangerfile.gitlab_graph
 
-        allow(@my_plugin.gitlab).to receive(:api).and_return(json)
+        allow(@my_plugin.gitlab).to receive(:branch_for_merge).and_return("main")
+
+        stub_const("ENV", ENV.to_hash.merge(testing_env))
+
+        pipelines = File.read("#{File.dirname(__FILE__)}/support/fixtures/pipelines.json")
+
+        # stub requests
+        stub_jobs(123_456)
+        stub_jobs(1119)
+
+        stub_trace(2722)
+        stub_trace(2723)
+
+        stub_request(:get, "https://gitlab.com/api/v4/projects/123/pipelines?per_page=10&ref=main&status=success").
+          to_return(status: 200, body: pipelines, headers: {})
+
+        stub_request(:post, "https://gitlab.com/api/v4/projects/123/uploads").
+          to_return do |request|
+          svg_file = request.body[request.body.index("<svg")..request.body.index("</svg>") + 5]
+          graph_tmpfile = Tempfile.new(["tmp-graph", ".svg"])
+          begin
+            graph_tmpfile.write(svg_file)
+          ensure
+            graph_tmpfile.close
+          end
+
+          { status: 200, body: {
+            markdown: "![description](/link)"
+          }.to_json, headers: {} }
+        end
       end
 
-      # Some examples for writing tests
-      # You should replace these with your own.
+      after do
+        graph_tmpfile&.unlink
+      end
 
-      it "Warns on a monday" do
-        monday_date = Date.parse("2016-07-11")
-        allow(Date).to receive(:today).and_return monday_date
+      it "outputs a markdown image link" do
+        @my_plugin.report_metric([{
+                                    regex: /took ([0-9]+)/,
+                                    series_name: "Performance",
+                                    job_name: "test1"
+                                  }, {
+                                    regex: /slept ([0-9]+)/,
+                                    series_name: "IDLE time",
+                                    job_name: "test1"
+                                  }])
 
-        @my_plugin.warn_on_mondays
+        expect(@dangerfile.status_report[:markdowns][0].message).to eq("![description](/link)")
+        expect(graph_tmpfile).not_to be_nil
 
-        expect(@dangerfile.status_report[:warnings]).to eq(["Trying to merge code on a Monday"])
+        expected_graph_file = "#{File.dirname(__FILE__)}/support/fixtures/graph-simple-expected.svg"
+        expect(FileUtils.compare_file(graph_tmpfile.path, expected_graph_file)).to be_truthy
       end
 
-      it "Does nothing on a tuesday" do
-        monday_date = Date.parse("2016-07-12")
-        allow(Date).to receive(:today).and_return monday_date
+      it "warns an error if there is no match" do
+        @my_plugin.report_metric([{
+                                    regex: /not found ([0-9]+)/,
+                                    series_name: "Performance",
+                                    job_name: "test1"
+                                  }])
+
+        expect(@dangerfile.status_report[:warnings]).to eq(["No updated metric Performance found for job test1"])
+      end
+
+      it "warns if there is no such job" do
+        @my_plugin.report_metric([{
+                                    regex: /took ([0-9]+)/,
+                                    series_name: "Performance",
+                                    job_name: "not-found-either"
+                                  }])
+
+        expect(@dangerfile.status_report[:warnings]).to eq(["Job not-found-either for metric extraction of Performance not found in current pipeline"])
+      end
 
-        @my_plugin.warn_on_mondays
+      it "gathers all metrics" do
+        metrics = @my_plugin.gather_metric({
+                                             regex: /took ([0-9]+)/,
+                                             series_name: "Performance",
+                                             job_name: "test1"
+                                           })
 
         expect(@dangerfile.status_report[:warnings]).to eq([])
+        expect(metrics).to eq([{ hash: "b23f54ecdc3add9abea9344f66b49f1699bff547", metric: 16.0, pipeline_id: 1119 },
+                               { hash: "3333333333333333333333333333333333333333", metric: 6.0, pipeline_id: 123_456 }])
       end
     end
   end

data/spec/spec_helper.rb

@@ -4,12 +4,16 @@ require "pathname"
 ROOT = Pathname.new(File.expand_path("..", __dir__))
 $:.unshift("#{ROOT}lib".to_s)
 $:.unshift("#{ROOT}spec".to_s)
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift File.expand_path("..", __dir__)
 
 require "bundler/setup"
 require "pry"
 
 require "rspec"
 require "danger"
+require "webmock"
+require "webmock/rspec"
 
 if `git remote -v` == ""
   puts "You cannot run tests without setting a local git remote on this repo"
@@ -17,15 +21,22 @@ if `git remote -v` == ""
   exit(0)
 end
 
+Dir["spec/support/**/*.rb"].sort.each { |file| require(file) }
+
 # Use coloured output, it's the best.
 RSpec.configure do |config|
   config.filter_gems_from_backtrace "bundler"
   config.color = true
   config.tty = true
+
+  config.include Danger::Support::GitLabHelper, host: :gitlab
+  # config.include Danger::Support::CIHelper, use: :ci_helper
 end
 
 require "danger_plugin"
 
+WebMock.disable_net_connect!(allow: "coveralls.io")
+
 # These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
 # If you are expanding these files, see if it's already been done ^.
 
@@ -36,24 +47,35 @@ require "danger_plugin"
 # rubocop:disable Lint/NestedMethodDefinition
 def testing_ui
   @output = StringIO.new
+
   def @output.winsize
     [20, 9999]
   end
 
   cork = Cork::Board.new(out: @output)
+
   def cork.string
     out.string.gsub(/\e\[([;\d]+)?m/, "")
   end
+
   cork
 end
+
 # rubocop:enable Lint/NestedMethodDefinition
 
 # Example environment (ENV) that would come from
 # running a PR on TravisCI
 def testing_env
   {
-    "CI_PIPELINE_ID" => "12346",
-    "CI_PROJECT_ID" => "123"
+    "CI_PIPELINE_ID" => "123456",
+    "CI_PROJECT_ID" => "123",
+    "GITLAB_CI" => "1",
+    "CI_COMMIT_SHA" => "3333333333333333333333333333333333333333",
+    "CI_COMMIT_SHORT_SHA" => "33333333",
+    "CI_PROJECT_PATH" => "k0nserv/danger-test",
+    "CI_PROJECT_URL" => "https://gitlab.com/k0nserv/danger-test",
+    "DANGER_GITLAB_API_TOKEN" => "a86e56d46ac78b",
+    "CI_MERGE_REQUEST_IID" => "145"
   }
 end