ndr_dev_support 2.1.2 → 3.0.0

data/lib/tasks/ci/brakeman.rake

@@ -0,0 +1,54 @@
+namespace :ci do
+  desc 'Brakeman'
+  task brakeman: 'ci:rugged:setup' do
+    next unless defined?(Rails)
+
+    require 'ndr_dev_support/rake_ci/brakeman_helper'
+    # Usage: bundle exec rake ci:brakeman
+
+    @metrics ||= []
+    @attachments ||= []
+
+    brakeman = NdrDevSupport::RakeCI::BrakemanHelper.new
+    brakeman.commit = @commit
+    brakeman.run
+
+    Brakeman::Warning::TEXT_CONFIDENCE.each do |confidence, text|
+      metric = {
+        name: 'brakeman_warnings',
+        type: :gauge,
+        label_set: { confidence: text },
+        value: brakeman.warning_counts_by_confidence[confidence] || 0
+      }
+      @metrics << metric
+      puts metric.inspect
+    end
+
+    unless brakeman.new_fingerprints.empty?
+      # new warnings found
+      attachment = {
+        color: 'danger',
+        title: "#{brakeman.new_fingerprints.size} new Brakeman warning(s) :rotating_light:",
+        text: '_Brakeman_ warning fingerprint(s):' \
+              "```#{brakeman.new_fingerprints.to_a.join("\n")}```",
+        footer: 'bundle exec rake ci:brakeman',
+        mrkdwn_in: ['text']
+      }
+      @attachments << attachment
+      puts attachment.inspect
+    end
+
+    unless brakeman.old_fingerprints.empty?
+      # old warnings missing
+      attachment = {
+        color: 'good',
+        title: "#{brakeman.old_fingerprints.size} Brakeman warning(s) resolved :+1:",
+        footer: 'bundle exec rake ci:brakeman'
+      }
+      @attachments << attachment
+      puts attachment.inspect
+    end
+
+    brakeman.save_current_fingerprints
+  end
+end

data/lib/tasks/ci/bundle_audit.rake

@@ -0,0 +1,45 @@
+namespace :ci do
+  # Checks bundle audit and converts advisories into "attachments"
+  # Usage: bin/rake ci:bundle_audit
+  desc 'Patch-level verification for Bundler'
+  task :bundle_audit do
+    require 'English'
+
+    # Update ruby-advisory-db
+    `bundle audit update`
+    # Check for insecure dependencies
+    output = `bundle audit check`
+    next if $CHILD_STATUS.exitstatus.zero?
+
+    output.split("\n\n").each do |advisory|
+      lines = advisory.split("\n")
+      next if lines.count == 1
+
+      hash = {}
+      lines.each do |line|
+        matchdata = line.match(/\A([^:]+):\s(.*)\z/)
+        next if matchdata.nil?
+
+        hash[matchdata[1]] = matchdata[2]
+      end
+      title = hash.delete('Title')
+      url = hash.delete('URL')
+      solution = hash.delete('Solution')
+      criticality = hash['Criticality']
+
+      attachment = {
+        color: criticality == 'High' ? 'danger' : 'warning',
+        fallback: title,
+        title: title,
+        title_link: url,
+        text: solution,
+        fields: hash.map { |key, value| { title: key, value: value, short: true } },
+        footer: 'bundle exec rake ci:bundle_audit'
+      }
+
+      @attachments ||= []
+      @attachments << attachment
+      puts attachment.inspect
+    end
+  end
+end

data/lib/tasks/ci/bundle_install.rake

@@ -0,0 +1,21 @@
+namespace :ci do
+  desc 'Install bundled gems'
+  task :bundle_install do
+    require 'English'
+
+    # `gem install bundler`
+    `bundle install --local`
+    next if $CHILD_STATUS.exitstatus.zero?
+
+    attachment = {
+      color: 'danger',
+      fallback: 'Failure running bundle install --local',
+      text: 'Failure running `bundle install --local`',
+      footer: 'bundle exec rake ci:bundle_install'
+    }
+
+    @attachments ||= []
+    @attachments << attachment
+    puts attachment.inspect
+  end
+end

data/lib/tasks/ci/housekeep.rake

@@ -0,0 +1,8 @@
+namespace :ci do
+  desc 'Housekeep cached and temporary files'
+  task :housekeep do
+    # If running in a Rails project we invoke the standard tmp/ and log/ clearing tasks
+    Rake::Task['log:clear'].invoke if Rake::Task.task_defined?('log:clear')
+    Rake::Task['tmp:clear'].invoke if Rake::Task.task_defined?('tmp:clear')
+  end
+end

data/lib/tasks/ci/linguist.rake

@@ -0,0 +1,42 @@
+namespace :ci do
+  desc 'linguist'
+  task linguist: 'ci:rugged:setup' do
+    require 'linguist'
+
+    def linguist_loc_metrics(language, line_count, percent)
+      metrics = [
+        {
+          name: 'linguist_code_count', type: :gauge,
+          label_set: { language: language }, value: line_count
+        },
+        {
+          name: 'linguist_code_percent', type: :gauge,
+          label_set: { language: language }, value: percent.round(1)
+        }
+      ]
+      puts metrics.inspect
+      metrics
+    end
+
+    @metrics ||= []
+
+    project = Linguist::Repository.new(@repo, @repo.head.target_id)
+    total_line_count = project.languages.values.reduce(:+)
+    other_line_count = 0
+
+    project.languages.each do |language, line_count|
+      percent = 100.0 * line_count / total_line_count
+
+      if percent > 1
+        @metrics.concat(linguist_loc_metrics(language, line_count, percent))
+      else
+        other_line_count += line_count
+      end
+    end
+
+    if other_line_count > 0
+      other_percent = 100.0 * other_line_count / total_line_count
+      @metrics.concat(linguist_loc_metrics('Other', other_line_count, other_percent))
+    end
+  end
+end

data/lib/tasks/ci/notes.rake

@@ -0,0 +1,30 @@
+namespace :ci do
+  # Runs the Rails rake notes task (if using Rails) and converts annotation counts into "metrics"
+  # Usage: bundle exec rake ci:notes
+  desc 'Count notes and other annotations'
+  task :notes do
+    next unless Rake::Task.task_defined?('notes')
+
+    hash = {}
+    `bundle exec rake notes | grep "\\["`.split(/\n/).map do |line|
+      matchdata = line.match(/\[\s*\d+\] \[([^\]]+)\]/)
+      annotation = matchdata[1]
+      hash[annotation] ||= 0
+      hash[annotation] += 1
+    end
+
+    hash.each do |annotation, count|
+      metric = {
+        name: 'annotation_count',
+        type: :gauge,
+        label_set: {
+          annotation: annotation
+        },
+        value: count
+      }
+      @metrics ||= []
+      @metrics << metric
+      puts metric.inspect
+    end
+  end
+end

data/lib/tasks/ci/prometheus.rake

@@ -0,0 +1,50 @@
+namespace :ci do
+  namespace :prometheus do
+    desc 'Set up Prometheus'
+    task :setup do
+      @metrics = []
+
+      ENV['PROMETHEUS_PUSHGATEWAY'] ||= ask('Prometheus pushgateway (host:port): ')
+      ENV['PROMETHEUS_PUSHGATEWAY'] = nil if ENV['PROMETHEUS_PUSHGATEWAY'] == ''
+
+      ENV['PROMETHEUS_PROJECTNAME'] ||= ask('Prometheus project name: ')
+      ENV['PROMETHEUS_PROJECTNAME'] = nil if ENV['PROMETHEUS_PROJECTNAME'] == ''
+    end
+
+    desc 'Push Prometheus stats'
+    task publish: :setup do
+      next if @metrics.empty? || ENV['PROMETHEUS_PUSHGATEWAY'].nil?
+
+      require 'prometheus/client'
+      require 'prometheus/client/push'
+
+      # returns a default registry
+      prometheus = Prometheus::Client.registry
+
+      @metrics.each do |metric|
+        name = "ci_#{metric[:name]}".to_sym
+        # TODO: Add :docstring where required
+        docstring = metric[:docstring] || 'TODO'
+        label_set = metric[:label_set] || {}
+        value = metric[:value]
+
+        case metric[:type]
+        when :gauge
+          gauge =
+            if prometheus.exist?(name)
+              prometheus.get(name)
+            else
+              prometheus.gauge(name, docstring, project: ENV['PROMETHEUS_PROJECTNAME'])
+            end
+          gauge.set(label_set, value)
+        else
+          raise "Unknown metric type (#{metric.inspect})"
+        end
+      end
+
+      Prometheus::Client::Push.new(
+        'rake-ci-job', nil, ENV['PROMETHEUS_PUSHGATEWAY']
+      ).add(prometheus)
+    end
+  end
+end

data/lib/tasks/ci/rugged.rake

@@ -0,0 +1,39 @@
+namespace :ci do
+  namespace :rugged do
+    desc 'Setup Rugged, get the current commit and friendly version of the revision name'
+    task :setup do
+      require 'ndr_dev_support/daemon/ci_server'
+
+      @repo = Rugged::Repository.new('.')
+      @commit = @repo.lookup(@repo.head.target_id)
+      @friendly_revision_name = NdrDevSupport::Daemon::CIServer.friendly_revision_name(@commit)
+    end
+
+    desc 'Show details of the commit and make it the first attachment'
+    task commit_details: :setup do
+      fields = [
+        { title: 'Author', value: @commit.author[:name], short: true },
+        { title: 'Revision', value: @friendly_revision_name, short: true }
+      ]
+
+      if File.exist?('.ruby-version')
+        fields << {
+          title: 'Target Ruby Version',
+          value: File.read('.ruby-version').chomp,
+          short: true
+        }
+      end
+
+      attachment = {
+        fallback: @commit.message,
+        text: @commit.message,
+        fields: fields,
+        ts: @commit.author[:time].to_i
+      }
+
+      @attachments ||= []
+      @attachments.unshift(attachment)
+      puts attachment.inspect
+    end
+  end
+end

data/lib/tasks/ci/server.rake

@@ -0,0 +1,12 @@
+namespace :ci do
+  # Stub ci:all rake task
+  task :all
+
+  desc 'Runs the Rake CI server'
+  task :server do
+    require 'ndr_dev_support/daemon/ci_server'
+
+    worker = NdrDevSupport::Daemon::CIServer.from_args(ENV)
+    worker.run
+  end
+end

data/lib/tasks/ci/simplecov.rake

@@ -0,0 +1,37 @@
+namespace :ci do
+  namespace :simplecov do
+    desc 'setup'
+    task :setup do
+      # Usage: bundle exec rake ci:simplecov:setup test
+      require 'simplecov'
+      require 'ndr_dev_support/rake_ci/simple_cov_helper'
+
+      SimpleCov.at_exit do
+        result = SimpleCov.result
+        result.format! if ENV['RAKECI_HEADLESS'].nil?
+        NdrDevSupport::RakeCI::SimpleCovHelper.new.save_current_result(result)
+      end
+
+      SimpleCov.start
+    end
+
+    desc 'process'
+    task :process do
+      require 'simplecov'
+      require 'ndr_dev_support/rake_ci/simple_cov_helper'
+
+      helper = NdrDevSupport::RakeCI::SimpleCovHelper.new
+      result = helper.load_current_result
+      next if result.nil?
+
+      metrics = [
+        { name: 'simplecov_covered_percent', type: :gauge, value: result.covered_percent },
+        { name: 'simplecov_covered_lines', type: :gauge, value: result.covered_lines },
+        { name: 'simplecov_total_lines', type: :gauge, value: result.total_lines }
+      ]
+      @metrics ||= []
+      @metrics.concat(metrics)
+      puts metrics.inspect
+    end
+  end
+end

data/lib/tasks/ci/slack.rake

@@ -0,0 +1,30 @@
+namespace :ci do
+  namespace :slack do
+    desc 'Set up Slack'
+    task :setup do
+      @attachments = []
+
+      ENV['SLACK_WEBHOOK_URL'] ||= ask('Slack Webhook URL: ')
+      ENV['SLACK_WEBHOOK_URL'] = nil if ENV['SLACK_WEBHOOK_URL'] == ''
+
+      ENV['SLACK_CHANNEL'] ||= ask('Slack Channel: ')
+      ENV['SLACK_CHANNEL'] = nil if ENV['SLACK_CHANNEL'] == ''
+    end
+
+    desc 'publish'
+    task publish: :setup do
+      next if @attachments.empty? || ENV['SLACK_WEBHOOK_URL'].nil?
+
+      require 'ndr_dev_support/slack_message_publisher'
+
+      # We have attachments so prepend them with basic commit details
+      Rake::Task['ci:rugged:commit_details'].invoke
+
+      slack_publisher = NdrDevSupport::SlackMessagePublisher.new(ENV['SLACK_WEBHOOK_URL'],
+                                                                 username: 'Rake CI',
+                                                                 icon_emoji: ':robot_face:',
+                                                                 channel: ENV['SLACK_CHANNEL'])
+      slack_publisher.post(attachments: @attachments)
+    end
+  end
+end

data/lib/tasks/ci/stats.rake

@@ -0,0 +1,24 @@
+namespace :ci do
+  # Runs the Rails rake stats task (if using Rails) and converts counts into "metrics"
+  # Usage: bundle exec rake ci:stats
+  desc 'stats'
+  task :stats do
+    next unless Rake::Task.task_defined?('stats')
+
+    @metrics ||= []
+
+    summary_line = `bundle exec rake stats 2>/dev/null | tail -n 2 | head -n 1`
+    matchdata = summary_line.match(/Code LOC: (\d+)\b\s+Test LOC: (\d+)\b/)
+    code_loc = matchdata[1].to_i
+    test_loc = matchdata[2].to_i
+    test_ratio = 100.0 * test_loc / code_loc
+
+    metrics = [
+      { name: 'stats_code_loc', type: :gauge, value: code_loc },
+      { name: 'stats_test_loc', type: :gauge, value: test_loc },
+      { name: 'stats_test_ratio', type: :gauge, value: test_ratio }
+    ]
+    @metrics.concat(metrics)
+    puts metrics.inspect
+  end
+end

data/ndr_dev_support.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ndr_dev_support/version'
@@ -22,17 +21,30 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'pry'
 
+  # Audit dependencies:
+  spec.add_dependency 'highline', '>= 1.6.0'
+
   # Rubocop dependencies:
-  spec.add_dependency 'rubocop', '0.52.1'
   spec.add_dependency 'parser'
   spec.add_dependency 'rainbow'
+  spec.add_dependency 'rubocop', '0.52.1'
 
   # Integration test dependencies:
   spec.add_dependency 'capybara'
   spec.add_dependency 'capybara-screenshot'
+  spec.add_dependency 'chromedriver-helper'
   spec.add_dependency 'poltergeist', '>= 1.8.0'
+  spec.add_dependency 'selenium-webdriver'
+
+  # CI server dependencies:
+  spec.add_dependency 'activesupport', '< 6.0.0'
+  spec.add_dependency 'brakeman', '>= 4.2.0'
+  spec.add_dependency 'bundler-audit'
+  spec.add_dependency 'github-linguist'
+  spec.add_dependency 'prometheus-client'
+  spec.add_dependency 'rugged'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency "minitest", "~> 5.0"
 end