smart_proxy_abrt 0.0.1

data/lib/smart_proxy_abrt/abrt_plugin.rb

@@ -0,0 +1,12 @@
+require 'smart_proxy_abrt/abrt_version'
+
+module Proxy::Abrt
+  class Plugin < ::Proxy::Plugin
+    plugin :abrt, Proxy::Abrt::VERSION
+
+    http_rackup_path File.expand_path("http_config.ru", File.expand_path("../", __FILE__))
+    https_rackup_path File.expand_path("http_config.ru", File.expand_path("../", __FILE__))
+
+    #default settings
+  end
+end

data/lib/smart_proxy_abrt/abrt_version.rb

@@ -0,0 +1,5 @@
+module Proxy
+  module Abrt
+    VERSION = '0.0.1'
+  end
+end

data/lib/smart_proxy_abrt/http_config.ru

@@ -0,0 +1,5 @@
+require 'smart_proxy_abrt/abrt_api'
+
+map '/abrt' do
+  run Proxy::Abrt::Api
+end

data/settings.d/abrt.yml.example

@@ -0,0 +1,26 @@
+---
+:enabled: true
+
+# Log file for the forwarding script.
+:abrt_send_log_file: /var/log/foreman-proxy/abrt-send.log
+
+# Directory where uReports are stored before they are sent
+:spooldir: /var/spool/foreman-proxy-abrt
+
+# Merge duplicate reports before sending (requires the satyr gem)
+:aggregate_reports: true
+
+# Period (in seconds) after which collected reports are forwarded. Meaningful
+# only if smart-proxy-abrt-send is run as a daemon (not from cron).
+#:send_period: 600
+
+# FAF server instance the reports will be forwarded to (optional)
+#:server_url: https://retrace.fedoraproject.org/faf
+
+# Set to true if FAF server uses self-signed certificate
+#:server_ssl_noverify: true
+
+# Following two options enable client authentication to FAF server
+#:server_ssl_cert: /etc/foreman-proxy/faf_client_cert.pem
+#:server_ssl_key: /etc/foreman-proxy/faf_cleint_key.pem
+

data/test/abrt_api_test.rb

@@ -0,0 +1,90 @@
+require 'json'
+require 'ostruct'
+require 'webrick'
+require 'tmpdir'
+require 'sinatra'
+
+require 'test_helper'
+require 'smart_proxy_abrt/abrt_api'
+
+ENV['RACK_ENV'] = 'test'
+
+class AbrtApiTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Proxy::Abrt::Api.new
+  end
+
+  def setup
+    ureport_file = "test/fixtures/ureport1.json"
+    @post_data = {
+      "file" => Rack::Test::UploadedFile.new(ureport_file, "application/json")
+    }
+    Proxy::Abrt.stubs(:common_name).returns('localhost')
+  end
+
+  def assert_dir_contains_report(dir)
+    files = Dir[File.join(dir, "ureport-*")]
+    assert_equal files.size, 1
+    report_json = IO.read(files[0])
+    report = JSON.parse report_json
+    assert report.has_key?("host"), "On disk report has no host key"
+    assert report.has_key?("report"), "On disk report does not contain report"
+  end
+
+  def test_forwarding_to_foreman
+    Dir.mktmpdir do |tmpdir|
+      Proxy::Abrt::Plugin.settings.stubs(:spooldir).returns(tmpdir)
+
+      post "/reports/new/", @post_data
+
+      assert last_response.successful?
+      assert_equal last_response.status, 202
+      data = JSON.parse(last_response.body)
+      assert_equal data['result'], false
+      assert data['message'].is_a?(String), "Response message is not string"
+
+      assert_dir_contains_report tmpdir
+    end
+  end
+
+  def test_forwarding_to_foreman_and_faf
+    response_body = {
+      "result"  => true,
+      "message" => "Hi!"
+    }.to_json
+    response_status = 202
+    faf_response = OpenStruct.new(:code => response_status, :body => response_body)
+
+    Proxy::Abrt.expects(:faf_request).returns(faf_response)
+    Proxy::Abrt::Plugin.settings.stubs(:server_url).returns('https://doesnt.matter/')
+
+    Dir.mktmpdir do |tmpdir|
+      Proxy::Abrt::Plugin.settings.stubs(:spooldir).returns(tmpdir)
+
+      post "/reports/new/", @post_data
+
+      assert last_response.successful?
+      assert_equal last_response.status, response_status
+      assert_equal last_response.body, response_body
+
+      assert_dir_contains_report tmpdir
+    end
+  end
+
+  def test_forwarding_other_endpoints
+    post "/reports/attach/", @post_data
+
+    assert_equal last_response.status, 501
+
+    faf_response = OpenStruct.new(:code => 201, :body => "Whatever!")
+    Proxy::Abrt.expects(:faf_request).returns(faf_response)
+    Proxy::Abrt::Plugin.settings.stubs(:server_url).returns('https://doesnt.matter/')
+
+    post "/reports/attach/", @post_data
+
+    assert_equal last_response.status, faf_response.code
+    assert_equal last_response.body, faf_response.body
+  end
+end

data/test/abrt_test.rb

@@ -0,0 +1,125 @@
+require 'tmpdir'
+require 'fileutils'
+
+require 'test_helper'
+require 'smart_proxy_abrt'
+require 'smart_proxy_abrt/abrt_lib'
+
+class AbrtTest < Test::Unit::TestCase
+  def setup
+    @tmpdir = Dir.mktmpdir "foreman-proxy-test"
+    FileUtils.cp Dir["test/fixtures/ureport-ondisk-*"], @tmpdir
+
+    Proxy::Abrt::Plugin.settings.stubs(:aggregate_reports).returns(false)
+    Proxy::Abrt::Plugin.settings.stubs(:spooldir).returns(@tmpdir)
+  end
+
+  def teardown
+    FileUtils.rm_rf @tmpdir
+  end
+
+  def test_multipart_form_data_file
+    file_contents = '{"foo":"bar"}'
+    headers, body = Proxy::Abrt.form_data_file(file_contents, 'application/json')
+    request_text = "POST /abrt/whatever/ HTTP/1.1\r\n"
+    headers.each do |key,value|
+      request_text << key + ": " + value + "\r\n"
+    end
+    request_text << "\r\n"
+    request_text << body
+
+    req = WEBrick::HTTPRequest.new(WEBrick::Config::HTTP)
+    req.parse(StringIO.new(request_text))
+
+    assert_equal req.request_method, "POST"
+    assert_equal req.query["file"], file_contents
+  end
+
+  def test_hostreport_open
+    file = File.join @tmpdir, "ureport-ondisk-host1-01"
+    hr = Proxy::Abrt::HostReport.new file
+    assert_equal "f19-managed.virtnet", hr.host
+    assert_equal [file], hr.files
+    assert_equal 1, hr.reports.size
+  end
+
+  def test_hostreport_load_directory
+    reports = Proxy::Abrt::HostReport.load_from_spool
+    assert_equal 4, reports.size
+    reports.each { |r| assert r.is_a?(Proxy::Abrt::HostReport) }
+  end
+
+  def test_hostreport_merge_without_duphash
+    reports = []
+    Dir[File.join(@tmpdir, "ureport-ondisk-host1-*")].each do |file|
+      reports << Proxy::Abrt::HostReport.new(file)
+    end
+
+    assert_equal 3, reports.size
+    r = reports[0]
+    r.merge(reports[1])
+    r.merge(reports[2])
+
+    # no merging by duphash
+    assert_equal 3, r.reports.size
+  end
+
+  def test_hostreport_merge_with_duphash
+    base = File.join(@tmpdir, "ureport-ondisk-host1-")
+    reports = []
+    Proxy::Abrt::HostReport.stubs(:duphash).returns("aaa")
+    reports << Proxy::Abrt::HostReport.new(base + "01")
+    reports << Proxy::Abrt::HostReport.new(base + "02")
+    Proxy::Abrt::HostReport.stubs(:duphash).returns("bbb")
+    reports << Proxy::Abrt::HostReport.new(base + "03")
+    Proxy::Abrt::HostReport.unstub(:duphash)
+
+    r = reports[0]
+    r.merge(reports[1])
+    r.merge(reports[2])
+
+    # first two reports should be merged
+    assert_equal 2, r.reports.size
+  end
+
+  def test_hostreport_send_to_foreman
+    Proxy::HttpRequest::ForemanRequest.any_instance.expects(:send_request).once
+
+    reports = []
+    Dir[File.join(@tmpdir, "ureport-ondisk-host1-*")].each do |file|
+      reports << Proxy::Abrt::HostReport.new(file)
+    end
+
+    r = reports[0]
+    r.merge(reports[1])
+    r.merge(reports[2])
+
+    r.send_to_foreman
+  end
+
+  def test_hostreport_unlink
+    # single report
+    r1 = Proxy::Abrt::HostReport.new File.join(@tmpdir, "ureport-ondisk-host2-01")
+    r1.unlink
+
+    # merged reports
+    r2 = Proxy::Abrt::HostReport.new File.join(@tmpdir, "ureport-ondisk-host1-01")
+    r2.merge Proxy::Abrt::HostReport.new(File.join(@tmpdir, "ureport-ondisk-host1-02"))
+    r2.merge Proxy::Abrt::HostReport.new(File.join(@tmpdir, "ureport-ondisk-host1-03"))
+    r2.unlink
+
+    dir_contents = Dir[File.join(@tmpdir, "*")]
+    assert dir_contents.empty?, "Not all files were deleted"
+  end
+
+  def test_hostreport_save
+    Dir[File.join(@tmpdir, "*")].each { |file| File.unlink file }
+    ureport = IO.read "test/fixtures/ureport1.json"
+    ureport = JSON.parse ureport
+    Proxy::Abrt::HostReport.save "localhost", ureport
+
+    hr = Proxy::Abrt::HostReport.new Dir[File.join(@tmpdir, "*")][0]
+    assert_equal "localhost", hr.host
+    assert_equal 1, hr.reports.size
+  end
+end

data/test/fixtures/ureport-ondisk-host1-01

@@ -0,0 +1 @@
+{"host":"f19-managed.virtnet","report":{"ureport_version":2,"reason":"ZeroDivisionError in /bin/will_python_raise:3","reporter":{"name":"satyr","version":"0.13"},"os":{"name":"fedora","version":"19","architecture":"x86_64","cpe":"cpe:/o:fedoraproject:fedora:19"},"problem":{"type":"python","component":"will-crash","user":{"root":false,"local":true},"exception_name":"ZeroDivisionError","stacktrace":[{"file_name":"/bin/will_python_raise","file_line":3,"special_function":"module","line_contents":"0/0"}]},"packages":[{"name":"will-crash","epoch":0,"version":"0.4","release":"1.fc19","architecture":"x86_64","package_role":"affected"}]},"reported_at":"2014-06-30 08:42:44 UTC"}

data/test/fixtures/ureport-ondisk-host1-02

@@ -0,0 +1 @@
+{"host":"f19-managed.virtnet","report":{"ureport_version":2,"reason":"ZeroDivisionError in /bin/will_python_raise:3","reporter":{"name":"satyr","version":"0.13"},"os":{"name":"fedora","version":"19","architecture":"x86_64","cpe":"cpe:/o:fedoraproject:fedora:19"},"problem":{"type":"python","component":"will-crash","user":{"root":false,"local":true},"exception_name":"ZeroDivisionError","stacktrace":[{"file_name":"/bin/will_python_raise","file_line":3,"special_function":"module","line_contents":"0/0"}]},"packages":[{"name":"will-crash","epoch":0,"version":"0.4","release":"1.fc19","architecture":"x86_64","package_role":"affected"}]},"reported_at":"2014-06-30 09:42:44 UTC"}

data/test/fixtures/ureport-ondisk-host1-03

@@ -0,0 +1 @@
+{"host":"f19-managed.virtnet","report":{"ureport_version":2,"reason":"Program /usr/bin/will_segfault was terminated by signal 11","reporter":{"name":"satyr","version":"0.13"},"os":{"name":"fedora","version":"19","architecture":"x86_64","cpe":"cpe:/o:fedoraproject:fedora:19"},"problem":{"type":"core","component":"will-crash","user":{"root":false,"local":true},"signal":11,"executable":"/usr/bin/will_segfault","stacktrace":[{"crash_thread":true,"frames":[{"address":4195406,"build_id":"e8c1fa14411a04623afbfac93a5cbab39767cfb2","build_id_offset":1102,"function_name":"main","file_name":"/usr/bin/will_segfault","fingerprint":"27fec48d69579748149aa1a5456ea2d906ff5744"}]}]},"packages":[{"name":"glibc","epoch":0,"version":"2.17","release":"20.fc19","architecture":"x86_64","install_time":1389354420},{"name":"will-crash","epoch":0,"version":"0.4","release":"1.fc19","architecture":"x86_64","install_time":1391527642,"package_role":"affected"}]},"reported_at":"2014-06-30 10:42:42 UTC"}

data/test/fixtures/ureport-ondisk-host2-01

@@ -0,0 +1 @@
+{"host":"someotherhost.virtnet","report":{"ureport_version":2,"reason":"ZeroDivisionError in /bin/will_python_raise:3","reporter":{"name":"satyr","version":"0.13"},"os":{"name":"fedora","version":"19","architecture":"x86_64","cpe":"cpe:/o:fedoraproject:fedora:19"},"problem":{"type":"python","component":"will-crash","user":{"root":false,"local":true},"exception_name":"ZeroDivisionError","stacktrace":[{"file_name":"/bin/will_python_raise","file_line":3,"special_function":"module","line_contents":"0/0"}]},"packages":[{"name":"will-crash","epoch":0,"version":"0.4","release":"1.fc19","architecture":"x86_64","package_role":"affected"}]},"reported_at":"2014-06-30 18:42:44 UTC"}

data/test/fixtures/ureport1.json

@@ -0,0 +1,45 @@
+{   "ureport_version": 2
+,   "reason": "Program /usr/bin/will_segfault was terminated by signal 11"
+,   "reporter": {   "name": "satyr"
+                ,   "version": "0.13"
+                }
+,   "os": {   "name": "fedora"
+          ,   "version": "19"
+          ,   "architecture": "x86_64"
+          ,   "cpe": "cpe:/o:fedoraproject:fedora:19"
+          }
+,   "problem": {   "type": "core"
+               ,   "component": "will-crash"
+               ,   "user": {   "root": false
+                           ,   "local": true
+                           }
+               ,   "signal": 11
+               ,   "executable": "/usr/bin/will_segfault"
+               ,   "stacktrace":
+                     [ {   "crash_thread": true
+                       ,   "frames":
+                             [ {   "address": 4195406
+                               ,   "build_id": "e8c1fa14411a04623afbfac93a5cbab39767cfb2"
+                               ,   "build_id_offset": 1102
+                               ,   "function_name": "main"
+                               ,   "file_name": "/usr/bin/will_segfault"
+                               ,   "fingerprint": "27fec48d69579748149aa1a5456ea2d906ff5744"
+                               } ]
+                       } ]
+               }
+,   "packages": [ {   "name": "glibc"
+                  ,   "epoch": 0
+                  ,   "version": "2.17"
+                  ,   "release": "20.fc19"
+                  ,   "architecture": "x86_64"
+                  ,   "install_time": 1389354420
+                  }
+                , {   "name": "will-crash"
+                  ,   "epoch": 0
+                  ,   "version": "0.4"
+                  ,   "release": "1.fc19"
+                  ,   "architecture": "x86_64"
+                  ,   "install_time": 1391527642
+                  ,   "package_role": "affected"
+                  } ]
+}

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+path_to_smart_proxy_repo = '../smart-proxy'
+$LOAD_PATH.unshift File.join(path_to_smart_proxy_repo, 'test')
+
+# create log directory in our (not smart-proxy) repo
+logdir = File.join(File.dirname(__FILE__), '..', 'logs')
+FileUtils.mkdir_p(logdir) unless File.exists?(logdir)
+
+require 'test_helper'
+
+APP_ROOT = File.join(File.dirname(__FILE__), '..')

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: smart_proxy_abrt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Milata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-15 00:00:00.000000000 Z
+dependencies: []
+description: This smart proxy plugin, together with a Foreman plugin, add the capability
+  to send ABRT micro-reports from your managed hosts to Foreman.
+email: mmilata@redhat.com
+executables:
+- smart-proxy-abrt-send
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/smart-proxy-abrt-send
+- lib/smart_proxy_abrt/abrt_api.rb
+- lib/smart_proxy_abrt/abrt_plugin.rb
+- lib/smart_proxy_abrt/abrt_lib.rb
+- lib/smart_proxy_abrt/http_config.ru
+- lib/smart_proxy_abrt/abrt_version.rb
+- lib/smart_proxy_abrt.rb
+- settings.d/abrt.yml.example
+- bundler.d/abrt.rb
+- test/test_helper.rb
+- test/fixtures/ureport-ondisk-host1-02
+- test/fixtures/ureport-ondisk-host2-01
+- test/fixtures/ureport1.json
+- test/fixtures/ureport-ondisk-host1-03
+- test/fixtures/ureport-ondisk-host1-01
+- test/abrt_test.rb
+- test/abrt_api_test.rb
+- extra/foreman-proxy-abrt-send.cron
+- extra/rubygem-smart_proxy_abrt.spec
+- README
+- LICENSE
+- Rakefile
+homepage: http://github.com/abrt/smart-proxy-abrt
+licenses:
+- GPL-3
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Automatic Bug Reporting Tool plugin for Foreman's smart proxy
+test_files: []