foreman_abrt 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b48790120660d859c2e437373bc4805aa206ac3
-  data.tar.gz: c44d479890517cb1b565a282d97a4d07c22bfc74
+  metadata.gz: 9ba5743bcf41e5dbeca1b9c7a9a25f6debe2d72d
+  data.tar.gz: 7a4fdd1f2fe0956d8db1cc5ff9c0f03a96168428
 SHA512:
-  metadata.gz: f0a1b5e461594c02f2620eb722f8f87a3d1631bd3325495aa2a83fe60f048b2e27e34bdb210bcaf9082753688d7b4e31ca077838185d4c9fe084bf2accfe3dc1
-  data.tar.gz: a9984b9f7dbbaacffee2c24deddaf09e97e4731d73ac02ba7b313c10af93b55a13357be21062d7d28f478281fd42996b331ebccdd179f765098a3649c3197cda
+  metadata.gz: 2230f87529777ebcff809981e9811d03fc5deade1f0c0715ab5c9ccb45d9202dceb97b7c1ad151dd6f6cc972258be6b0d15fb799b396af5713017a360257d596
+  data.tar.gz: 58fb70f4094a7395e3f699467bdd03d35a9e789d68a842e156f51ca4e327171f9a335aa99dbee801e2d0ffeda9db84ae66555eb4d1d0add825c7244511abd621

data/README.md

@@ -1,9 +1,9 @@
 # ForemanAbrt
 
-This plugin allows your Foreman instance to receive bug reports generated on
-your hosts by [ABRT](https://github.com/abrt/abrt) (Automatic Bug Reporting
-Tool). These reports can be inspected and eventually forwarded to the ABRT
-server.
+This plugin allows your Foreman instance to receive problem reports generated
+on your hosts by [ABRT](https://github.com/abrt/abrt) (Automatic Bug Reporting
+Tool). These reports can be inspected and eventually sent to the ABRT server
+for analysis.
 
 ## Overview
 
@@ -18,28 +18,26 @@ server.
      instance of set of similar reports from a host is sent, together with
      number of the reports in the set.
 3. Foreman receives the aggregated report and stores it to the database. The
-   reports can be inspected and forwarded to the ABRT server. If the server
-   responds with additional information about the report, such as links to bug
-   trackers or suggested solutions, it is displayed alongside the report.
+   reports can be inspected and forwarded ("sent for analysis") to the ABRT
+   server. If the server responds with additional information about the report,
+   such as links to bug trackers or suggested solutions, it is displayed
+   alongside the report.
 
 ![foreman abrt workflow](/extra/foreman_abrt_workflow.png?raw=true)
 
 ## Installation
 
-To be able to see ABRT bug reports in your Foreman instance, you need to
+To be able to see ABRT problem reports in your Foreman instance, you need to
 install the plugin itself, install ABRT plugin for your smart proxies and
-configure your hosts to send the bug reports to their smart proxy.
+configure your hosts to send the problem reports to their smart proxy.
 
 Both plugins are available as RPMs in [Foreman YUM repositories](http://yum.theforeman.org/).
 
 ### Prerequisites
 
-The plugins require both Foreman and smart-proxy to be version 1.6 or later.
+The plugins require both Foreman and smart-proxy to be version 1.7 or later.
 
-The plugins have been tested on Fedora 19, RHEL 6 and RHEL 7. Due to old
-version of `rubygem-ffi` the smart-proxy plugin does not work on RHEL 6 unless
-you set the option `aggregate_reports` to `false` in
-`/etc/foreman-proxy/settings.d/abrt.yml`.
+The plugins have been tested on Fedora 19, RHEL 6 and RHEL 7.
 
 To have hosts automatically send ureports to Foreman, you need to have ABRT
 2.1.11 or higher installed on them. RHEL 7 and Fedora 19 and higher satisfy
@@ -55,6 +53,8 @@ instructions](http://projects.theforeman.org/projects/foreman/wiki/How_to_Instal
 You need to install the `rubygem-foreman_abrt` package (or
 `ruby193-rubygem-foreman_abrt` on RHEL/CentOS).
 
+After installing the plugin, restart Foreman with `touch /usr/share/foreman/tmp/restart.txt`.
+
 ### Setting up smart proxies
 
 Follow the [smart-proxy plugin installation
@@ -80,12 +80,20 @@ The plugin needs some configuration in order to work correctly.
   :enabled: true
   ```
 
-- Cron is used to transfer the captured bug reports to Foreman in batches.
+- After installing and configuring the plugin, smart-proxy has to be restarted.
+  ```
+  service foreman-proxy restart
+  ```
+
+- Cron is used to transfer the captured problem reports to Foreman in batches.
   Ensure that the `smart-proxy-abrt-send` command is run periodically. The
   provided RPM package contains a cron snippet that runs the command every 30
   minutes.
 
-### Configuring hosts to send bug reports to Foreman
+### Configuring hosts to send problem reports to Foreman
+
+This setup needs to be performed on every host that you wish to report its
+crashes to Foreman.
 
 - Make sure that ABRT is installed and running.
   ```
@@ -151,20 +159,20 @@ make sure not to actually report this to `sleep` maintainers, though:
 
 ## Usage
 
-The list of received bug reports can be accessed by clicking on *Bug reports*
-link in the *Monitor* menu. To see detailed information for a report, click on
-its reported date.
+The list of received problem reports can be accessed by clicking on *Problem
+reports* link in the *Monitor* menu. To see detailed information for a report,
+click on its reported date.
 
-List of bug reports coming from a particular host is also displayed on the page
-with the details about the host in the *Bug reports* tab on the left.
+List of problem reports coming from a particular host is also displayed on the
+page with the details about the host in the *Problem reports* tab on the left.
 
 ### Forwarding the report to the ABRT server
 
-On the bug report details page you can forward the bug report to an actual
-ABRT server by clicking the *Forward report* button. The ABRT server may
-respond with some information it knows about the bug, such as the list of URLs
-related to the bug (e.g. Bugzilla link) and list of possible solutions to the
-problem that caused the bug to occur.
+On the problem report details page you can forward the problem report to an
+actual ABRT server by clicking the *Send for analysis* button. The ABRT server
+may respond with some information it knows about the bug, such as the list of
+URLs related to the bug (e.g. Bugzilla link) and list of possible solutions to
+the problem that caused the bug to occur.
 
 The forwarding functionality may have to be configured in *Abrt* tab of the
 configuration screen (*Administer*->*Settings*).

data/app/controllers/abrt_reports_controller.rb

@@ -30,7 +30,7 @@ class AbrtReportsController < ApplicationController
   # DELETE /abrt_reports/42
   def destroy
     if @abrt_report.destroy
-      notice _("Successfully deleted bug report.")
+      notice _("Successfully deleted problem report.")
     else
       error @abrt_reports.errors.full_messages.join("<br/>")
     end
@@ -42,7 +42,7 @@ class AbrtReportsController < ApplicationController
     redirect_to abrt_report_url(@abrt_report)
 
     begin
-      response = send_to_abrt_server @abrt_report
+      response = send_to_abrt_server @abrt_report, params[:username], params[:password]
     rescue => e
       error _("Server rejected our report: #{e.message}") and return
     end
@@ -53,7 +53,7 @@ class AbrtReportsController < ApplicationController
       error _("Cannot process server response: #{e.message}") and return
     end
 
-    notice _("Report successfully forwarded")
+    notice _("Report sent for analysis")
   end
 
   private

data/app/helpers/abrt_reports_helper.rb

@@ -39,7 +39,7 @@ module AbrtReportsHelper
     attr_reader :path, :content_type
   end
 
-  def send_to_abrt_server(abrt_report)
+  def send_to_abrt_server(abrt_report, username = nil, password = nil)
     request_params = {
       :timeout      => 60,
       :open_timeout => 10,
@@ -56,13 +56,22 @@ module AbrtReportsHelper
       request_params[:ssl_client_key]  = OpenSSL::PKey::RSA.new(File.read(Setting[:abrt_server_ssl_priv_key]))
     end
 
+    # basic auth
+    if !Setting[:abrt_server_basic_auth_username].empty? && !Setting[:abrt_server_basic_auth_password].empty?
+      request_params[:user] = Setting[:abrt_server_basic_auth_username]
+      request_params[:password] = Setting[:abrt_server_basic_auth_password]
+    elsif username && password
+      request_params[:user] = username
+      request_params[:password] = password
+    end
+
     resource    = RestClient::Resource.new(Setting[:abrt_server_url], request_params)
     report_file = StringIOWithPath.new(abrt_report.json, '*buffer*', 'application/json')
     response    = resource['reports/new/'].post({ :file => report_file, :multipart => true }, :content_type => :json, :accept => :json)
 
     if response.code != 202
-      logger.error "Failed to forward bug report: #{response.code}: #{response.to_str}"
-      raise ::Foreman::Exception.new(N_('Failed to forward bug report: %s: %s', response.code, response.to_str))
+      logger.error "Failed to send the report for analysis: #{response.code}: #{response.to_str}"
+      raise ::Foreman::Exception.new(N_('Failed to forward problem report: %s: %s', response.code, response.to_str))
     end
 
     JSON.parse(response.body)
@@ -75,4 +84,56 @@ module AbrtReportsHelper
       reason
     end
   end
+
+  def using_redhat_server?
+    match = %r{^https://[^/]*access\.redhat\.com/}.match(Setting[:abrt_server_url])
+    !!match
+  end
+
+  def ask_for_auth?
+    if !Setting[:abrt_server_basic_auth_username].empty? && !Setting[:abrt_server_basic_auth_password].empty?
+      false
+    elsif Setting[:abrt_server_basic_auth_required] || using_redhat_server?
+      true
+    else
+      false
+    end
+  end
+
+  def display_forward_button(abrt_report)
+    if ask_for_auth?
+      button_tag _('Send for analysis'), :id => 'forward_auth_button', :class => 'btn btn-success'
+    else
+      options = { :class => 'btn btn-success', :method => :post }
+      if abrt_report.forwarded_at
+        options[:confirm] = _('The report has already been sent. Sending it again will overwrite the previous response.')
+      end
+      link_to _('Send for analysis'), forward_abrt_report_path(abrt_report), options
+    end
+  end
+
+  def forward_auth_title
+    if using_redhat_server?
+      _('Please provide Red Hat Customer Portal credentials')
+    else
+      _('Please provide ABRT server credentials')
+    end
+  end
+
+  def forward_auth_login
+    if using_redhat_server?
+      _('Red Hat Login')
+    else
+      _('Login')
+    end
+  end
+
+  def forward_auth_text
+    if using_redhat_server?
+      _('The problem report will be sent to Red Hat in order to determine if a solution exists. '\
+        'You need to provide your Red Hat Customer Portal login and password in order to proceed.')
+    else
+      _('Your ABRT server is configured to require login and password.')
+    end
+  end
 end

data/app/models/setting/abrt.rb

@@ -1,24 +1,25 @@
 class Setting::Abrt < ::Setting
+  BLANK_ATTRS << "abrt_server_ssl_certificate"
+  BLANK_ATTRS << "abrt_server_ssl_priv_key"
+  BLANK_ATTRS << "abrt_server_ssl_ca_file"
+  BLANK_ATTRS << "abrt_server_basic_auth_username"
+  BLANK_ATTRS << "abrt_server_basic_auth_password"
+  URI_ATTRS << "abrt_server_url"
 
   def self.load_defaults
     return unless super
 
-    fqdn         = Facter.value(:fqdn) || SETTINGS[:fqdn]
-    lower_fqdn   = fqdn.downcase
-
-    # Try taking the provisioning SSL setup for default
-    ssl_cert     = Setting[:ssl_certificate] || "#{SETTINGS[:puppetvardir]}/ssl/certs/#{lower_fqdn}.pem"
-    ssl_ca_file  = Setting[:ssl_ca_file]     || "#{SETTINGS[:puppetvardir]}/ssl/certs/ca.pem"
-    ssl_priv_key = Setting[:ssl_priv_key]    || "#{SETTINGS[:puppetvardir]}/ssl/private_keys/#{lower_fqdn}.pem"
-
     Setting.transaction do
       [
-        self.set('abrt_server_url', N_('URL of the ABRT server to forward reports to'), 'https://localhost/faf'),
+        self.set('abrt_server_url', N_('URL of the ABRT server to send reports to'), 'https://localhost/faf'),
         self.set('abrt_server_verify_ssl', N_('Verify ABRT server certificate?'), true),
-        self.set('abrt_server_ssl_certificate', N_('SSL certificate path that Foreman would use to communicate with ABRT server'), ssl_cert),
-        self.set('abrt_server_ssl_priv_key', N_('SSL private key path that Foreman would use to communicate with ABRT server'), ssl_priv_key),
-        self.set('abrt_server_ssl_ca_file', N_('SSL CA file that Foreman will use to communicate with ABRT server'), ssl_ca_file),
-        self.set('abrt_automatically_forward', N_('Automatically forward every report to ABRT server?'), false),
+        self.set('abrt_server_ssl_certificate', N_('SSL certificate path that Foreman would use to communicate with ABRT server'), ''),
+        self.set('abrt_server_ssl_priv_key', N_('SSL private key path that Foreman would use to communicate with ABRT server'), ''),
+        self.set('abrt_server_ssl_ca_file', N_('SSL CA file that Foreman will use to communicate with ABRT server'), ''),
+        self.set('abrt_automatically_forward', N_('Automatically send every report to an ABRT server for analysis?'), false),
+        self.set('abrt_server_basic_auth_required', N_('Does the server require authentication through username and password?'), false),
+        self.set('abrt_server_basic_auth_username', N_('User name for server authentication'), ''),
+        self.set('abrt_server_basic_auth_password', N_('Password for server authentication. WARNING: visible to anyone with access to settings'), ''),
       ].compact.each { |s| self.create s.update(:category => 'Setting::Abrt') }
     end
 

data/app/views/abrt_reports/_basic_auth_modal.html.erb

@@ -0,0 +1,50 @@
+<div id="forward_auth" class="modal fade hide">
+  <div class="modal-dialog modal-sm">
+    <div class="modal-content">
+      <div class="modal-header">
+        <%= alert_close('modal') %>
+        <h4 class="modal-title"><%= forward_auth_title %></h4>
+      </div>
+      <div class="modal-body">
+        <% if forward_auth_text %>
+          <p><%= forward_auth_text %></p><br>
+        <% end %>
+        <%= form_tag forward_abrt_report_path(@abrt_report), :class => 'form form-horizontal' do %>
+          <div class="form-group">
+            <%= label_tag :username, forward_auth_login, :class => 'col-sm-3 control-label' %>
+            <div class="col-sm-9">
+              <%= text_field_tag :username, nil, :class => 'form-control' %>
+            </div>
+          </div>
+          <div class="form-group">
+            <%= label_tag :password, _("Password"), :class => 'col-sm-3 control-label' %>
+            <div class="col-sm-9">
+              <%= password_field_tag :password, nil, :class => 'form-control' %>
+            </div>
+          </div>
+          <% if defined? ::RedhatAccess %>
+            <div class="form-group" id="redhat_access_alert_use" style="display: none;">
+              <div class="col-sm-offset-3 col-sm-9">
+                 <%= link_to _("Use Red Hat Access credentials"), '#', :id => 'redhat_access_fill' %>
+              </div>
+            </div>
+            <div class="alert alert-info" id="redhat_access_alert_login">
+               <%= (_("You can log into %s to avoid typing your credentials.") % link_to('Red Hat Access', ::RedhatAccess::Engine.routes.url_helpers.search_index_path)).html_safe %>
+            </div>
+          <% end %>
+          <% if @abrt_report.forwarded_at %>
+            <div class="alert alert-warning">
+              <%= _('The report has already been sent. Sending it again will overwrite the previous response.') %>
+            </div>
+          <% end %>
+          <div class="form-group">
+            <div class="col-sm-offset-3 col-sm-9">
+              <%= submit_tag _('Send for analysis'), :class => 'btn btn-success' %>
+              <%= modal_close 'modal', _('Cancel') %>
+            </div>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/abrt_reports/_host_tab.html.erb

@@ -1 +1 @@
-<li><a href="#abrt" data-toggle="tab"><%= _("Bug reports") %></a></li>
+<li><a href="#abrt" data-toggle="tab"><%= _("Problems") %></a></li>

data/app/views/abrt_reports/_host_tab_pane.html.erb

@@ -14,8 +14,8 @@
         </tr>
       <% end %>
     </table>
-    <%= link_to _('All bug reports for this host'), host_abrt_reports_path(@host), :class => 'btn btn-default' %>
+    <%= link_to _('All reports for this host'), host_abrt_reports_path(@host), :class => 'btn btn-default' %>
   <% else %>
-    <div class="alert alert-success"> <%= _('No bug reports for this host in the last month') %> </div>
+    <div class="alert alert-success"> <%= _('No problem reports for this host in the last month') %> </div>
   <% end %>
 </div>

data/app/views/abrt_reports/_list.html.erb

@@ -24,7 +24,7 @@
       <td> <%= checked_icon !abrt_report.forwarded_at.nil? %> </td>
       <td align="right">
         <%= display_delete_if_authorized hash_for_abrt_report_path(:id => abrt_report.id).merge(:auth_object => abrt_report, :authorizer => authorizer),
-                                         :confirm => _('Delete bug report for %s?') % abrt_report.host.try(:name) %>
+                                         :confirm => _('Delete problem report for %s?') % abrt_report.host.try(:name) %>
       </td>
     </tr>
   <% end %>

data/app/views/abrt_reports/_show_response.html.erb

@@ -1,27 +1,15 @@
 <div class="row">
   <div class="col-md-12">
-    <p><%= _('The report has been forwarded to ABRT server on %s.') % @abrt_report.forwarded_at.getlocal %></p>
-  </div>
-</div>
-
-<div class="row">
-  <div class="col-md-12">
-    <table class="table table-bordered table-striped">
-      <tr>
-        <th><%= _('Known problem') %></th>
-        <td><%= @abrt_report.response_known %></td>
-      </tr>
-      <tr>
-        <th><%= _('Message') %></th>
-        <td><%= simple_format_if_multiline @abrt_report.response_message %></td>
-      </tr>
-    </table>
+    <p><%= _('The report has been sent for analysis on %s.') % @abrt_report.forwarded_at.getlocal %></p>
+    <% if !params[:show_bthash].nil? %>
+      <p> <%= _('bthash: %s') % @abrt_report.response_bthash %> </p>
+    <% end %>
   </div>
 </div>
 
 <div class="row">
   <div class="col-md-6">
-    <h3>Reported to</h3>
+    <h3>Reports</h3>
     <% if !@abrt_report.abrt_report_response_destinations.empty? %>
       <table class="table table-bordered table-striped">
         <% @abrt_report.abrt_report_response_destinations.each do |destination| %>

data/app/views/abrt_reports/index.html.erb

@@ -1,3 +1,3 @@
-<% title _("Bug reports") %>
+<% title _("Problem reports") %>
 
 <%= render :partial => 'list' %>

data/app/views/abrt_reports/show.html.erb

@@ -1,12 +1,48 @@
+<%= javascript_tag do %>
+  $(function () {
+    // basic http auth modal dialog setup
+    var button = $("#forward_auth_button")
+    var dialog = $("#forward_auth")
+
+    dialog.modal({
+      backdrop: 'static',
+      show: false
+    })
+
+    button.on('click', function () {
+      dialog.modal('show')
+    });
+
+    // filling the dialog with redhat_access credentials
+    var token = localStorage.getItem('rhAuthToken');
+    var rhUser = '';
+    var rhPass = '';
+    if (token) {
+       try {
+          decoded = atob(token);
+          colonPos = decoded.indexOf(':');
+          if (colonPos != -1) {
+            rhUser = decoded.substring(0, colonPos);
+            rhPass = decoded.substring(colonPos+1);
+            $("#redhat_access_alert_login").hide();
+            $("#redhat_access_alert_use").show();
+          }
+       } catch(err) {}
+    }
+
+    $("#redhat_access_fill").on('click', function (e) {
+      e.preventDefault();
+      $("#username").val(rhUser);
+      $("#password").val(rhPass);
+    });
+  });
+<% end %>
+
 <% title @abrt_report.host.to_s %>
 
 <%= title_actions link_to(_('Host details'), @abrt_report.host),
                   link_to(_('Other reports for this host'), host_abrt_reports_path(@abrt_report.host)),
-                  link_to(_('Forward report'),
-                          forward_abrt_report_path(@abrt_report),
-                          :class   => 'btn btn-success',
-                          :method  => :post,
-                          :confirm => @abrt_report.forwarded_at ? _('The report has already been sent to the ABRT server. Send again and overwrite the previous response?') : nil),
+                  display_forward_button(@abrt_report),
                   display_delete_if_authorized(hash_for_abrt_report_path(:id => @abrt_report), :class => 'btn btn-danger')
 %>
 
@@ -36,7 +72,11 @@
 <% else %>
   <div class="row">
     <div class="col-md-12">
-      <p><%= _("The report hasn't been forwarded to ABRT server.") %></p>
+      <p><%= _("The report hasn't been sent for analysis.") %></p>
     </div>
   </div>
 <% end %>
+
+<% if ask_for_auth? %>
+  <%= render :partial => 'basic_auth_modal' %>
+<% end %>

data/app/views/dashboard/_foreman_abrt_widget.html.erb

@@ -1,2 +1,2 @@
-<h4 style="text-align: center;"><%= _('Bug report distribution in last 14 days') %></h4>
+<h4 style="text-align: center;"><%= _('Problem report distribution in last 14 days') %></h4>
 <%= render_abrt_graph(@abrt_reports, :class => 'statistics-bar') %>

data/lib/foreman_abrt/engine.rb

@@ -36,12 +36,12 @@ module ForemanAbrt
         #add menu entry
         menu :top_menu, :template,
              :url_hash => {:controller => :'abrt_reports', :action => :index},
-             :caption  => _('Bug reports'),
+             :caption  => _('Problem reports'),
              :parent   => :monitor_menu,
              :after    => :reports
 
         # add dashboard widget
-        widget 'foreman_abrt_widget', :name => N_('Bug report chart'), :sizex => 6, :sizey => 1
+        widget 'foreman_abrt_widget', :name => N_('Problem report chart'), :sizex => 6, :sizey => 1
       end
     end
 

data/lib/foreman_abrt/version.rb

@@ -1,3 +1,3 @@
 module ForemanAbrt
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_abrt
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Martin Milata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -24,7 +24,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Foreman plugin that allows you to see bug reports submitted by Automatic
+description: Foreman plugin that allows you to see problem reports submitted by Automatic
   Bug Reporting Tool.
 email:
 - mmilata@redhat.com
@@ -37,6 +37,7 @@ files:
 - app/assets/javascripts/abrt_reports.js
 - app/views/abrt_reports/_host_tab_pane.html.erb
 - app/views/abrt_reports/_host_tab.html.erb
+- app/views/abrt_reports/_basic_auth_modal.html.erb
 - app/views/abrt_reports/index.html.erb
 - app/views/abrt_reports/_show_response.html.erb
 - app/views/abrt_reports/_list.html.erb