gerrit2jiracomment 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bae95b41f97ca719c6fa6f50418e4e9392e2834b4b1c99a8a57161b4c569210f
+  data.tar.gz: 72a90d57cb1f7ff33e6014ad0026bbbeba2cf4d26a14acddee7c4bc422b1386a
+SHA512:
+  metadata.gz: 7c91d240266ef60780260d6a4fdbeee7cd85db4c108ab5c1c2fe27049936d44a66c003f88d2e3f3048f0a924a120e89f9814701ef062e65ddebeac9a301da7bf
+  data.tar.gz: 0777b77ec37effe3b522cfaf1981927851dd3497a4d5c990db757356fee6b69ba03207bb795543754961c5275ba9fda8a209e9c5d0e20c281d5949e5fffcc158

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/settings.yaml
+*.gpg

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  TargetRubyVersion: 2.5
+Metrics/BlockLength:
+  ExcludedMethods: ['describe']

data/.ruby-gemset

@@ -0,0 +1 @@
+gerrit2jiracomment

data/.ruby-version

@@ -0,0 +1,2 @@
+2.5.0
+

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+- 2.5.0
+sudo: false
+before_install:
+  - gem install bundler -v 1.16.1
+before_script:
+  - bundle install
+script:
+  - bundle exec rake spec build
+deploy:
+  provider: rubygems
+  skip_cleanup: true
+  api_key:
+    secure: 5gAc1r58UKCjXVNCHYse1GiWM3tPMo0IHuiOA6A/C1rGzVRmimu1i4Q1JQyeViwIrGj1XP4hK1iCBcoFWJe/wY3FVI9UThA4Y76o4aqRRqxbxzFwnK7iRXb50STllMA78UnDQggKWhm0k6EDtkLYl9wIfeTG7Wcx/rr6kGYiROTsiqXKPy+KVFGAF0NtJvehAXxJu4zrLN5bcEPGCFQijd7rEjgwShsRwPs2k8BHmOTnqDIKLqAnRdzcoX4sNR1P3gggvDnJ4+cAqOGv6v3EWHaAMJEI4DE1sDNeRf8lY2OSGS7LZaFtcth6+k3W3rCiDgiJ7CIcPXxWat/IGC8kwV89jhRB8dZ12G5pBWfoiM23Zm7EZ2JEz8fH2dpqbznIEJblo2HbArCZyY0K/cdMfxHNTDPh856Oh0dX2iOdCL+PhgCMjmWWPJDphR06zVmfCxDrDo3zHzzG1EOQDAIE8BNDp1JvkadpuoxCUTL5T0Hyq1E/VJiMJtCmIQWssXn2e0oNK3qeiplMsPmhLNp+fmcqY3kH3P8uYlEedeJaaBMkBRj/vWC0xrajupllbPsVhj0RVD3joP+VrUbjvweagRN6UYR6v8NDgAVxXuSn1FPxFR3g6rQOZRQF1fEx+SqEcbIzQFdDG6Lym/TWJqzVu2dVZfikjw5Df0YOLhXXgXA=
+#  on:
+#    tags: true

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gerrit2jiracomment.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    gerrit2jiracomment (0.2.2)
+      byebug
+      jira-ruby
+      rx
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.3.0)
+    byebug (10.0.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    jira-ruby (1.5.0)
+      activesupport
+      multipart-post
+      oauth (~> 0.5, >= 0.5.0)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    oauth (0.5.4)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    rx (0.0.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  gerrit2jiracomment!
+  rake
+  rspec
+  rspec-mocks
+  rubocop
+
+BUNDLED WITH
+   1.16.1

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+# as soon as the project is clean enough, enable this
+Rake::Task['build'].enhance(['rubocop:auto_correct'])
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'gerrit2jiracomment'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gerrit2jiracomment

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby --encoding utf-8
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'gerrit2jiracomment'
+
+Gerrit2jiracomment.run

data/gerrit2jiracomment.gemspec

@@ -0,0 +1,34 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gerrit2jiracomment/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gerrit2jiracomment'
+  spec.version       = Gerrit2jiracomment::VERSION
+  spec.authors       = ['Christian Koestlin']
+  spec.email         = ['info@esrlabs.com']
+
+  spec.summary       = 'Simple gem that listens on gerrit stream-events' \
+                       ' and puts comments to jira.'
+  spec.description   = 'Nothing more to add'
+  spec.homepage      = 'https://not.done.yet'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'byebug'
+  spec.add_dependency 'jira-ruby'
+  spec.add_dependency 'rx'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/gerrit2jiracomment/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gerrit2jiracomment
+  VERSION = '0.2.2'
+end

data/lib/gerrit2jiracomment.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+require 'gerrit2jiracomment/version'
+require 'logger'
+require 'syslog/logger'
+require 'json'
+require 'open3'
+require 'ostruct'
+require 'byebug'
+require 'jira-ruby'
+require 'yaml'
+require 'rx'
+
+# Gerrit 2 jira sync module
+module Gerrit2jiracomment
+  # wrapper for a logger that always adds tags
+  class LoggerWithTag
+    def initialize(log, tag)
+      @log = log
+      @tag = tag
+    end
+
+    def debug(message)
+      @log.debug("#{@tag}†#{message}")
+    end
+
+    def info(message)
+      @log.info("#{@tag}†#{message}")
+    end
+
+    def error(message, error)
+      error_message = "#{error} #{error.backtrace.join('\\n\\t')}"
+      @log.error("#{@tag}†#{message}: #{error_message}")
+    end
+
+    def fail(c, message)
+      raise(c, "#{@tag}†#{message}")
+    end
+  end
+
+  def self.regexp
+    Regexp.new('\\b*[A-Z0-9]+-\\d+\\b*')
+  end
+
+  # Exception if something goes wrong with processing events
+  class ProcessException < RuntimeError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+
+  # React on events by sending data to jira
+  class ToJira
+    def initialize(logger, jira)
+      @logger = logger
+      @jira = jira
+    end
+
+    def gitiles_url(base_url, event)
+      gitiles = "#{base_url}/plugins/gitiles/"
+      "[#{event.patchSet.revision}|" \
+      "#{gitiles}#{event.change.project}/+/#{event.patchSet.revision}]"
+    end
+
+    def author_line(event)
+      "Author: #{event.patchSet.author.email}"
+    end
+
+    def submitter_line(event)
+      "Submitter: #{event.submitter.email}"
+    end
+
+    def commit_line(base_url, event)
+      "Commit: #{gitiles_url(base_url, event)}"
+    end
+
+    def changeset_line(event)
+      url = event.change.url
+      "Changeset: [#{url}|#{url}]"
+    end
+
+    def branch_line(event)
+      "Branch: #{event.change.branch}"
+    end
+
+    def project_line(server, event)
+      "Project: #{server}/#{event.change.project}"
+    end
+
+    def title_line(event)
+      "Title: #{event.change.subject}"
+    end
+
+    def assemble_change_merged_comment(event, server, uri)
+      base_url = "#{uri.scheme}://#{uri.host}"
+      [title_line(event), author_line(event), submitter_line(event),
+       changeset_line(event), branch_line(event),
+       project_line(server, event), commit_line(base_url, event)]
+        .join("\n")
+    end
+
+    def handle_change_merged_issue_comment(issue, log, event, server)
+      log.debug("Found jira issue comment: '#{issue}'")
+      uri = URI.parse(event.change.url)
+      comment_text = assemble_change_merged_comment(event, server, uri)
+      log.debug("Adding #{comment_text} to jira #{issue}")
+      @jira.Issue.find(issue).comments.build.save!(body: comment_text)
+      true
+    rescue JIRA::HTTPError => e
+      log.error("Cannot find #{issue} in our jira", e)
+      false
+    end
+
+    def change_merged(log, event, server)
+      log = LoggerWithTag.new(log, 'changeset')
+
+      log.debug("Send change merged to jira #{event}")
+
+      message = event.change.commitMessage
+      log.debug("Found commit: #{event.change.subject}\n#{message}")
+
+      found = false
+      message.scan(Gerrit2jiracomment.regexp).map(&:strip).each do |match|
+        found ||= handle_change_merged_issue_comment(match, log, event, server)
+      end
+
+      found || log.fail(ProcessException, "No jira-issue found in #{event}")
+    end
+  end
+
+  def self.parse_json(line)
+    JSON.parse(line, object_class: OpenStruct)
+  end
+
+  def self.stdout_in_utf8(command)
+    _stdin, stdout, _stderr = Open3.popen3(command)
+    stdout.set_encoding 'UTF-8:UTF-8'
+    stdout
+  end
+
+  def self.receive_events(logger, from, sink)
+    Thread.new do
+      logger.debug("lifecycle†Connecting to event stream of #{from}")
+      stdout_in_utf8("ssh #{from} gerrit stream-events").each_line do |line|
+        sink.on_next([JSON.parse(line, object_class: OpenStruct), from])
+      end
+      logger.debug("lifecycle†Processing stream from #{from} finished")
+    rescue StandardError => e
+      logger.error(e.to_s)
+    end
+  end
+
+  def self.dispatch(log, e, sink)
+    logger = LoggerWithTag.new(log, 'events')
+    event = e.first
+    server = e[1]
+    return sink.send(event.type.tr('-', '_').to_sym, log, event, server)
+  rescue NoMethodError => e
+    logger.debug("Cannot handle event of type #{event.type} - #{e}")
+    false
+  rescue StandardError => error
+    logger.error('Cannot process event', error)
+    false
+  end
+
+  def self.syslog_or_stdout_logger
+    Syslog::Logger.new 'g2jc'
+  rescue StandardError
+    Logger.new(STDOUT)
+  end
+
+  def self.tag_and_message(msg)
+    tag, m = msg.split('†')
+    unless m
+      m = tag
+      tag = 'gerrit2jiracomment'
+    end
+    [tag, m]
+  end
+
+  def self.init_logger
+    logger = syslog_or_stdout_logger
+    logger.formatter = proc do |severity, datetime, _progname, msg|
+      tag, message = tag_and_message(msg)
+      format('%<year>04d-%<month>02d-%<day>02d %<hour>02d:%<min>02d:' \
+             "%<sec>02d.000 7331 %<severity>s %<tag>s: %<message>s\n",
+             year: datetime.year, month: datetime.month, day: datetime.day,
+             hour: datetime.hour, min: datetime.min, sec: datetime.sec,
+             severity: severity[0], tag: tag, message: message)
+    end
+    logger
+  end
+
+  def self.load_settings(logger)
+    logger.debug('lifecycle†loading settings from settings.yaml.gpg')
+    YAML.safe_load(`gpg --decrypt settings.yaml.gpg 2> /dev/null`)
+  end
+
+  def self.to_jira(logger, settings)
+    ToJira.new(logger,
+               JIRA::Client.new(
+                 username: settings['jira_user'],
+                 password: settings['jira_password'],
+                 site: 'https://esrlabs.atlassian.net/',
+                 context_path: '', auth_type: :basic,
+                 use_ssl: true,
+                 ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE
+               ))
+  end
+
+  def self.connect(logger, subject, event_sink)
+    subject.as_observable.subscribe(
+      ->(e) { dispatch(logger, e, event_sink) },
+      ->(_err) { logger.error(error) },
+      -> { logger.info('lifecycle†finished') }
+    )
+  end
+
+  def self.run
+    logger = init_logger
+
+    settings = load_settings(logger)
+
+    subject = Rx::Subject.new
+    event_sink = to_jira(logger, settings)
+
+    connect(logger, subject, event_sink)
+
+    ['gerrit.int.esrlabs.com', 'git.esrlabs.com']
+      .map { |server| receive_events(logger, server, subject) }
+      .each(&:join)
+    logger.info('lifecycle†exiting')
+  end
+end

data/readme.org

@@ -0,0 +1,17 @@
+* Gerrit2jiracomment [[https://github.com/gizmomogwai/gerrit2jiracomment][https://img.shields.io/github/tag/gizmomogwai/gerrit2jiracomment.svg?style=flat-square]] [[https://travis-ci.org/gizmomogwai/gerrit2jiracomment][https://img.shields.io/travis/gizmomogwai/gerrit2jiracomment/master.svg?style=flat-square]] [[https://codecov.io/gh/gizmomogwai/gerrit2jiracomment][https://img.shields.io/codecov/c/github/gizmomogwai/gerrit2jiracomment/master.svg?style=flat-square]] [[https://gizmomogwai.github.io/gerrit2jiracomment][https://img.shields.io/readthedocs/pip.svg?style=flat-square]]
+
+Proof of concept implementation that listens on a gerrit stream and updated jira comments accordingly.
+
+** Installation
+
+first compile and install gerry 0.1.5.
+then compile and install gerrit2jiracomment.
+
+** Usage
+
+`bundle exec exe/gerrit2jiracomment` for development or just gerrit2jiracomment
+encode your settings with gpg -e -r user@email.com settings.yaml
+
+** Development
+
+** Contributing

data/settings.yaml.example

@@ -0,0 +1,5 @@
+--- # settings
+  jira_user: jenkins-jira@esrlabs.com
+  jira_password: the_password
+  gerrit_user: christian.koestlin
+  gerrit_password: the_password

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: gerrit2jiracomment
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Christian Koestlin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Nothing more to add
+email:
+- info@esrlabs.com
+executables:
+- gerrit2jiracomment
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gerrit2jiracomment
+- gerrit2jiracomment.gemspec
+- lib/gerrit2jiracomment.rb
+- lib/gerrit2jiracomment/version.rb
+- readme.org
+- settings.yaml.example
+homepage: https://not.done.yet
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Simple gem that listens on gerrit stream-events and puts comments to jira.
+test_files: []