foreman_openscap 6.0.0 → 7.1.0

data/app/controllers/api/v2/compliance/arf_reports_controller.rb

@@ -124,7 +124,8 @@ module Api
         end
 
         def handle_download_error(error)
-          render_error 'standard_error', :status => :internal_error, :locals => { :exception => error }
+          render_error :custom_error, :status => :unprocessable_entity,
+                       :locals => { :message => _("Downloading the report failed: #{error.message}") }
         end
 
         def upload_fail(msg)

data/app/controllers/concerns/foreman_openscap/hosts_and_hostgroups_controller_extensions.rb

@@ -7,7 +7,7 @@ module ForemanOpenscap
 
     def detect_proxy_without_scap
       unless openscap_proxy_id.nil?
-        error = "The #{openscap_proxy_id[:name]} proxy does not have Openscap feature enabled. Either set correct OpenSCAP Proxy or unset it."
+        error = _("The %s proxy does not have Openscap feature enabled. Either set correct OpenSCAP Proxy or unset it.") % openscap_proxy_id[:name]
         return error(error, :now => true) unless scap_enabled_proxy?(openscap_proxy_id)
       end
     end

data/app/controllers/policies_controller.rb

@@ -117,13 +117,18 @@ class PoliciesController < ApplicationController
     @tailoring_file = ForemanOpenscap::TailoringFile.find(params[:tailoring_file_id]) if params[:tailoring_file_id].present?
   end
 
+  def multiple_with_filter?
+    params.key?(:search)
+  end
+  
   def find_multiple
-    # Lets search by name or id and make sure one of them exists first
-    if params[:host_ids].present?
-      @hosts = Host.where("id IN (?)", params[:host_ids])
+    if params.key?(:host_names) || params.key?(:host_ids) || multiple_with_filter?
+      @hosts = Host.search_for(params[:search]) if multiple_with_filter?
+      @hosts ||= Host.merge(Host.where(id: params[:host_ids]).or(Host.where(name: params[:host_names])))
       if @hosts.empty?
-        error _('No hosts were found.')
-        redirect_to(hosts_path) && (return false)
+        error _('No hosts were found with that id, name or query filter')
+        redirect_to(hosts_path)
+        return false
       end
     else
       error _('No hosts selected')

data/app/controllers/tailoring_files_controller.rb

@@ -24,6 +24,9 @@ class TailoringFilesController < ApplicationController
     else
       process_error
     end
+  rescue RestClient::Exception => e
+    @tailoring_file.errors.add(:scap_file, :invalid, message: e.http_body)
+    process_error
   end
 
   def edit

data/app/helpers/compliance_hosts_helper.rb

@@ -20,6 +20,8 @@ module ComplianceHostsHelper
   end
 
   def compliance_host_multiple_actions
+    return [] unless User.current.can?(:edit_hosts)
+
     [
       { :action => [_('Assign Compliance Policy'), select_multiple_hosts_policies_path], :priority => 1210 },
       { :action => [_('Unassign Compliance Policy'), disassociate_multiple_hosts_policies_path], :priority => 1211 },

data/app/helpers/foreman_openscap_helper.rb

@@ -1,12 +1,8 @@
 require 'foreman_openscap/version'
 
 module ForemanOpenscapHelper
-  def scap_doc_link(section = '', text = _('documentation'))
-    link_to(
-      text,
-      scap_doc_url(section),
-      :rel => 'external noopener noreferrer', :target => '_blank'
-    )
+  def scap_doc_button(section)
+    documentation_button(section, root_url: scap_doc_url)
   end
 
   def scap_doc_url(section = '')
@@ -15,10 +11,17 @@ module ForemanOpenscapHelper
     documentation_url(section, root_url: scap_root_url)
   end
 
+  private
+
+  def doc_flavor
+    ForemanOpenscap.with_katello? ? 'katello' : 'foreman-el'
+  end
+
   def scap_root_url
     @scap_root_url ||= begin
-      version = ForemanOpenscap::VERSION.split('.')[0..-2].join('.')
-      "https://theforeman.org/plugins/foreman_openscap/#{version}/index.html"
+      version = SETTINGS[:version]
+      version = version.tag == 'develop' ? 'nightly' : version.short
+      "https://docs.theforeman.org/#{version}/Managing_Security_Compliance/index-#{doc_flavor}.html#"
     end
   end
 end

data/app/helpers/policies_helper.rb

@@ -55,11 +55,13 @@ module PoliciesHelper
       select_f form, :scap_content_id, scap_contents, :id, :title,
                { :include_blank => _("Choose existing SCAP Content") },
                { :label => _("SCAP Content"),
+                 :required => true,
                  :onchange => 'scap_content_selected(this);',
                  :'data-url' => method_path('scap_content_selected') }
     else
       select_f form, :scap_content_id, scap_contents, :id, :title,
                { :label => _("SCAP Content"),
+                 :required => true,
                  :onchange => 'scap_content_selected(this);',
                  :'data-url' => method_path('scap_content_selected') }
     end

data/app/services/foreman_openscap/client_config/ansible.rb

@@ -20,8 +20,11 @@ module ForemanOpenscap
       end
 
       def inline_help
+        t1 = _("Requires Ansible plugin, %s Ansible role and variables. This will assign the role to the hosts or selected hostgroups.") % ansible_role_name
+        t2 = _("To deploy foreman_scap_client, ansible roles run needs to be triggered manually. Manual run is also required after any change to this policy.")
+
         {
-          :text => "Requires Ansible plugin, #{ansible_role_name} Ansible role and variables. This will assign the role to the hosts or selected hostgroups.<br>To deploy foreman_scap_client, ansible roles run needs to be triggered manually. Manual run is also required after any change to this policy.",
+          :text => "#{t1}<br>#{t2}",
           :replace_text => 'Ansible role',
           :route_helper_method => :hash_for_ansible_roles_path
         }

data/app/services/foreman_openscap/client_config/manual.rb

@@ -11,7 +11,7 @@ module ForemanOpenscap
 
       def inline_help
         {
-          :text => "This leaves the setup of the foreman_scap_client solely on the user. The policy still needs to be defined in order to link incoming ARF reports."
+          :text => _("This leaves the setup of the foreman_scap_client solely on the user. The policy still needs to be defined in order to link incoming ARF reports.")
         }
       end
 

data/app/services/foreman_openscap/client_config/puppet.rb

@@ -14,8 +14,11 @@ module ForemanOpenscap
       end
 
       def inline_help
+        t1 = _("Requires %s Puppet class. This will assign the class to the hosts or selected hostgroups.") % puppetclass_name
+        t2 = _("Every puppet run ensures the foreman_scap_client is configured according to the policy.")
+
         {
-          :text => "Requires #{puppetclass_name} Puppet class. This will assign the class to the hosts or selected hostgroups.<br>Every puppet run ensures the foreman_scap_client is configured according to the policy.",
+          :text => "#{t1}<br>#{t2}",
           :replace_text => 'Puppet class',
           :route_helper_method => :hash_for_puppetclasses_path
         }

data/app/services/foreman_openscap/oval/sync_oval_contents.rb

@@ -5,7 +5,7 @@ module ForemanOpenscap
         begin
           content_blob = fetch_content_blob(oval_content.url)
         rescue StandardError => e
-          oval_content.errors.add(:base, "#{fail_msg oval_content}, cause: #{e.message}")
+          oval_content.errors.add(:base, "#{fail_msg oval_content}, " + _("cause: ") + e.message)
           return oval_content
         end
 
@@ -25,7 +25,7 @@ module ForemanOpenscap
       private
 
       def fail_msg(content)
-        "Failed to fetch content file from #{content.url}"
+        _("Failed to fetch content file from %s") % content.url
       end
 
       def fetch_content_blob(url)

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

@@ -3,7 +3,7 @@
 <table class="<%= table_css_classes %>">
   <tr>
   <th class="ca" width="40px"><%= check_box_tag "check_all", "", false, { :onclick => "tfm.hosts.table.toggleCheck()", :'check-title' => _("Select all items in this page"), :'uncheck-title'=> _("items selected. Uncheck to Clear") } %></th>
-    <th><%= sort :host %></th>
+    <th><%= sort :host, as: _('Host') %></th>
     <th><%= sort :reported, :as => _("Reported At") %></th>
     <th><%= sort :policy, :as => _("Policy") %></th>
     <th><%= sort :openscap_proxy, :as => _("Openscap Proxy") %></th>

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

@@ -1,4 +1,3 @@
-<% javascript 'charts' %>
 <% javascript 'foreman_openscap/reports' %>
 <% stylesheet 'foreman_openscap/reports' %>
 

data/app/views/arf_reports/welcome.html.erb

@@ -9,6 +9,6 @@
     <%= _("You don't seem to have any ARF report. ARF report is a summary of a single scan occurrence on a particular host for a given Compliance Policy.") %></br>
   </p>
   <div class="blank-slate-pf-main-action">
-    <%= link_to _('Documentation'), documentation_url("4.4ARFReports", :root_url => "https://www.theforeman.org/plugins/foreman_openscap/0.8/index.html#"), :rel => 'external', :class => 'btn btn-primary btn-lg'  %>
+    <%= link_to _('Documentation'), scap_doc_url("Monitoring_Compliance_security-compliance"), :rel => 'external', :class => 'btn btn-primary btn-lg'  %>
   </div>
 </div>

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

@@ -1,4 +1,4 @@
-<% javascript 'charts', 'foreman_openscap/scap_hosts_show' %>
+<% javascript 'foreman_openscap/scap_hosts_show' %>
 <% stylesheet 'foreman_openscap/scap_breakdown_chart' %>
 
 <%= breadcrumbs(:resource_url => api_hosts_path,

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

@@ -1,8 +1,8 @@
 <table class="<%= table_css_classes('table-fixed') %>">
   <tr>
-    <th><%= sort :name %></th>
-    <th><%= sort :content %></th>
-    <th><%= sort :profile %></th>
+    <th><%= sort :name, as: _('Name') %></th>
+    <th><%= sort :content, as: _('Content') %></th>
+    <th><%= sort :profile, as: _('Profile') %></th>
     <th><%= sort :tailoring_file, :as => _('Tailoring File') %></th>
     <th><%= sort :tailoring_file_profile, :as => _('Effective Profile') %></th>
     <th><%= _('Actions') %></th>

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

@@ -3,7 +3,7 @@
 
 <% title_actions(
   display_link_if_authorized(_("New Compliance Policy"), hash_for_new_policy_path, :class => "btn btn-primary"),
-    documentation_button('#4.2Creatingpolicywizard', :root_url => scap_doc_url)
+    scap_doc_button('Managing_Compliance_Policies_security-compliance')
   ) %>
 
 <%= render :partial => 'list' %>

data/app/views/policies/steps/_deployment_options_form.html.erb

@@ -4,7 +4,7 @@
   <div class="alert alert-info" id="scap-deployment-options-info-banner">
     <span class="pficon pficon-info"></span>
     <strong><%= _('There are significant differences in deployment options.') %></strong>
-    <%= _('Please make sure you understand them by reading our') %> <%=scap_doc_link('#2.3Policydeploymentoptions') %>.
+    <%= _('Please make sure you understand them by reading our') %> <%= link_to(_('documentation'), scap_doc_url('deploying-compliance-policies_security-compliance'), :rel => 'external noopener noreferrer', :target => '_blank') %>.
   </div>
 
   <%= deploy_by_radios f, @policy %>

data/app/views/policies/steps/_policy_attributes_form.html.erb

@@ -1,5 +1,5 @@
 <div class="tab-pane <%= show_partial_wizard(step) %>" id="create-policy">
   <%= wizard_header @policy.step_index, *translate_steps(@policy) %>
-  <%= text_f(f, :name) %>
+  <%= text_f(f, :name, :required => true) %>
   <%= text_f(f, :description, :size => "col-md-8" ) %>
 </div>

data/app/views/policies/steps/_schedule_form.html.erb

@@ -4,8 +4,12 @@
   <%= wizard_header @policy.step_index, *@policy.steps %>
   <%= select_f(f, :period, %w[Weekly Monthly Custom], :downcase, :to_s,
                { :include_blank => _('Choose period') },
-               { :onchange => 'period_selected(this)' }) %>
-  <%= select_f(f, :weekday, days_of_week_hash, :first, :last, :include_blank => _('Choose weekday')) %>
-  <%= select_f(f, :day_of_month, (1..31).to_a, :to_i, :to_s, :help_inline => _('Number of a day in month, note that not all months have same count of days'), :include_blank => _('Choose day in month')) %>
-  <%= text_f(f, :cron_line, :help_inline => _('You can specify custom cron line, e.g. "0  3  *  *  *", separate each of 5 values by space')) %>
+               { :onchange => 'period_selected(this)', :required => true }) %>
+  <%= select_f(f, :weekday, days_of_week_hash, :first, :last,
+               { :include_blank => _('Choose weekday') },
+               { :required => true }) %>
+  <%= select_f(f, :day_of_month, (1..31).to_a, :to_i, :to_s,
+               { :include_blank => _('Choose day in month') },
+               { :help_inline => _('Number of a day in month, note that not all months have same count of days'), :required => true }) %>
+  <%= text_f(f, :cron_line, :help_inline => _('You can specify custom cron line, e.g. "0  3  *  *  *", separate each of 5 values by space'), :required => true) %>
 </div>

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

@@ -1,4 +1,4 @@
-<% javascript 'charts', 'foreman_openscap/policy_dashboard' %>
+<% javascript 'foreman_openscap/policy_dashboard' %>
 
 <% title _("Compliance policy: %s") % @policy.name %>
 

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

@@ -1,8 +1,8 @@
 <table class="<%= table_css_classes('table-two-pane table-fixed') %>">
   <tr>
-    <th class="col-md-4"><%= sort :title %></th>
-    <th class="col-md-5"><%= sort :filename %></th>
-    <th class="col-md-2"><%= sort :created_at %></th>
+    <th class="col-md-4"><%= sort :title, as: _('Title') %></th>
+    <th class="col-md-5"><%= sort :filename, as: _('File name') %></th>
+    <th class="col-md-2"><%= sort :created_at, as: _('Created at') %></th>
     <th class="col-md-1"><%= _('Actions') %></th>
   </tr>
   <% for content in @contents %>

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

@@ -1,6 +1,6 @@
 <% title _("SCAP Contents") %>
 
 <% title_actions(display_link_if_authorized(_("Upload New SCAP Content"), hash_for_new_scap_content_path, :class => 'btn btn-primary'),
-                 documentation_button('#4.1CreatingSCAPcontent', :root_url => scap_doc_url)) %>
+                 scap_doc_button('Configuring_SCAP_Contents_security-compliance')) %>
 
 <%= render :partial => 'list' %>

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

@@ -1,8 +1,8 @@
 <table class="<%= table_css_classes('table-fixed') %>">
   <tr>
-    <th class="col-md-4"><%= sort :name %></th>
-    <th class="col-md-5"><%= sort :filename %></th>
-    <th class="col-md-2"><%= sort :created_at %></th>
+    <th class="col-md-4"><%= sort :name, as: _('Name') %></th>
+    <th class="col-md-5"><%= sort :filename, as: _('File name') %></th>
+    <th class="col-md-2"><%= sort :created_at, as: _('Created at') %></th>
     <th class="col-md-1"><%= _('Actions') %></th>
   </tr>
   <% @tailoring_files.each do |file| %>

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

@@ -1,4 +1,4 @@
 <% title _("Tailoring Files") %>
 <% title_actions(display_link_if_authorized(_("Upload New Tailoring file"), hash_for_new_tailoring_file_path, :class => 'btn btn-primary'),
-                documentation_button('#4.5Tailoringfiles(foreman_openscap>=0.6.5)', :root_url => scap_doc_url)) %>
+                scap_doc_button('tailoring-xccdf-profiles_security-compliance')) %>
 <%= render :partial => 'list' %>

data/lib/foreman_openscap/bulk_upload.rb

@@ -17,7 +17,7 @@ module ForemanOpenscap
 
     def upload_from_scap_guide
       unless scap_guide_installed?
-        @result.errors.push("Can't find scap-security-guide RPM, are you sure it is installed on your server?")
+        @result.errors.push(_("Can't find scap-security-guide RPM, are you sure it is installed on your server?"))
         return @result
       end
 
@@ -26,18 +26,18 @@ module ForemanOpenscap
 
     def upload_from_files(files_array, from_scap_guide = false)
       unless files_array.is_a? Array
-        @result.errors.push("Expected an array of files to upload, got: #{files_array}.")
+        @result.errors.push(_("Expected an array of files to upload, got: %s.") % files_array)
         return @result
       end
 
       files_array.each do |datastream|
         if File.directory?(datastream)
-          @result.errors.push("#{datastream} is a directory, expecting file.")
+          @result.errors.push(_("%s is a directory, expecting file.") % datastream)
           next
         end
 
         unless File.file?(datastream)
-          @result.errors.push("#{datastream} does not exist, skipping.")
+          @result.errors.push(_("%s does not exist, skipping.") % datastream)
           next
         end
 
@@ -55,7 +55,7 @@ module ForemanOpenscap
         if scap_content.save
           @result.results.push(scap_content)
         else
-          @result.errors.push("Failed saving #{datastream}: #{scap_content.errors.full_messages.uniq.join(',')}")
+          @result.errors.push(_("Failed saving %s:") % datastream + " #{scap_content.errors.full_messages.uniq.join(',')}")
         end
       end
       @result
@@ -63,7 +63,7 @@ module ForemanOpenscap
 
     def upload_from_directory(directory_path)
       unless directory_path && Dir.exist?(directory_path)
-        @result[:errors].push("No such directory: #{directory_path}. Please check the path you have provided.")
+        @result[:errors].push(_("No such directory: %s. Please check the path you have provided.") % directory_path)
         return @result
       end
 
@@ -85,7 +85,7 @@ module ForemanOpenscap
 
     def content_name(datastream, from_scap_guide)
       os_name = extract_name_from_file(datastream)
-      from_scap_guide ? "Red Hat #{os_name} default content" : "#{os_name} content"
+      from_scap_guide ? (_("Red Hat %s default content") % os_name) : (_("%s content") % os_name)
     end
   end
 end

data/lib/foreman_openscap/engine.rb

@@ -48,7 +48,8 @@ module ForemanOpenscap
 
     initializer 'foreman_openscap.register_plugin', :before => :finisher_hook do |app|
       Foreman::Plugin.register :foreman_openscap do
-        requires_foreman '>= 3.3'
+        requires_foreman '>= 3.7'
+        register_gettext
 
         apipie_documented_controllers ["#{ForemanOpenscap::Engine.root}/app/controllers/api/v2/compliance/*.rb"]
 
@@ -246,12 +247,6 @@ module ForemanOpenscap
       end
     end
 
-    initializer 'foreman_openscap.register_gettext', after: :load_config_initializers do |_app|
-      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
-      locale_domain = 'foreman_openscap'
-      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
-    end
-
     # Include concerns in this config.to_prepare block
     config.to_prepare do
       ::Api::V2::HostsController.send(:include, ForemanOpenscap::Api::V2::HostsControllerExtensions)

data/lib/foreman_openscap/version.rb

@@ -1,3 +1,3 @@
 module ForemanOpenscap
-  VERSION = "6.0.0".freeze
+  VERSION = "7.1.0".freeze
 end

data/locale/Makefile

@@ -14,6 +14,7 @@ POFILES = $(shell find . -name '$(DOMAIN).po')
 MOFILES = $(patsubst %.po,%.mo,$(POFILES))
 POXFILES = $(patsubst %.po,%.pox,$(POFILES))
 EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
+JSFILES = $(shell find ../app/assets/javascripts/*/locale -name '$(DOMAIN).js')
 
 %.mo: %.po
 	mkdir -p $(shell dirname $@)/LC_MESSAGES
@@ -42,18 +43,20 @@ uniq-po:
 	done
 
 tx-pull: $(EDITFILES)
-	tx pull -f
+	cd .. && tx pull -f
 	for f in $(EDITFILES) ; do \
 		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
 	done
 
 tx-update: tx-pull
 	@echo
-	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation, then make -C locale mo-files to finish
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation
+	@echo then run rake plugin:po_to_json[$(DOMAIN)] from the Foreman installation
+	@echo then run make -C locale mo-files to finish
 	@echo
 
 mo-files: $(MOFILES)
-	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git add $(POFILES) $(POTFILE) $(JSFILES) ../locale/*/LC_MESSAGES
 	git commit -m "i18n - pulling from tx"
 	@echo
 	@echo Changes commited!