foreman_openscap 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 534b669988c89b1335565f67c02b63443b0cfd36636749397b50617c4797316b
-  data.tar.gz: 4ee455ef101cc0bb6b034f1b081e2d604848620e7438e3ae887493ee77d13015
+  metadata.gz: 0deaa4503a6ab004120595983e5b6fac947691d57e7b8da5d38a0aed3316f1a6
+  data.tar.gz: 7447310d905705fbf71ca93f1cca7b2314e7d13827e90ce9c3a8b321cfcba411
 SHA512:
-  metadata.gz: b2ddaa5f34a78a9f085f5564f7e12f28071baf8b1679e645c327bb6d229986f0b399ae9a3bf50078e7d4c536014b43df974125851277ff1584130918b93382a2
-  data.tar.gz: 6a115b58c74b88f4c9e4f81ab5c31a0db2195a285d2c2eb4612251aead4131a426b34aab2593b7e8b6e2b656fee92cae0adc1b3d5bd19787466514e35312fd70
+  metadata.gz: 192e4e96375311fbf3225aa5e715eed99797338a8ba2be9d5b19cdf3f49dcae9ff5a78cb0136df175744360dbcc5ffc2ce453058ac31839a71f0373e79fa22cc
+  data.tar.gz: 2b231f618e80bc0bd187417328afae0c2b7f4c7a10d0954dc26ff554fd4ad34c67073b252cdc6f86ae6194d9a9d7c53c5c08bb00ba7348d884e334baac82f1fe

data/app/graphql/mutations/oval_contents/delete.rb

@@ -0,0 +1,9 @@
+module Mutations
+  module OvalContents
+    class Delete < DeleteMutation
+      graphql_name 'DeleteOvalContentMutation'
+      description 'Deletes an OVAL Content'
+      resource_class ::ForemanOpenscap::OvalContent
+    end
+  end
+end

data/app/graphql/mutations/oval_policies/delete.rb

@@ -0,0 +1,9 @@
+module Mutations
+  module OvalPolicies
+    class Delete < DeleteMutation
+      graphql_name 'DeleteOvalPolicyMutation'
+      description 'Deletes an OVAL Policy'
+      resource_class ::ForemanOpenscap::OvalPolicy
+    end
+  end
+end

data/app/graphql/mutations/oval_policies/update.rb

@@ -0,0 +1,15 @@
+module Mutations
+  module OvalPolicies
+    class Update < UpdateMutation
+      graphql_name 'UpdateOvalPolicyMutation'
+      description 'Updates an OVAL Policy'
+      resource_class ::ForemanOpenscap::OvalPolicy
+
+      argument :name, String, required: false
+      argument :description, String, required: false
+      argument :cron_line, String, required: false
+
+      field :oval_policy, ::Types::OvalPolicy, 'The OVAL policy.', null: true
+    end
+  end
+end

data/app/graphql/types/oval_check.rb

@@ -0,0 +1,11 @@
+module Types
+  class OvalCheck < GraphQL::Schema::Object
+    description 'A check that contains information about whether a particual prerequisite for OVAL policy deployment is configured correctly'
+
+    field :id, String, null: false
+    field :title, String, null: false
+    field :fail_msg, String, null: true
+    field :errors, ::Types::RawJson, null: true
+    field :result, String, null: false
+  end
+end

data/app/graphql/types/oval_content.rb

@@ -3,6 +3,8 @@ module Types
     description 'An OVAL Content'
     model_class ::ForemanOpenscap::OvalContent
 
+    include ::Types::Concerns::MetaField
+
     global_id_field :id
     timestamps
     field :name, String

data/app/graphql/types/oval_policy.rb

@@ -3,6 +3,8 @@ module Types
     description 'An OVAL Policy'
     model_class ::ForemanOpenscap::OvalPolicy
 
+    include ::Types::Concerns::MetaField
+
     global_id_field :id
     timestamps
     field :name, String
@@ -12,6 +14,7 @@ module Types
     field :day_of_month, String
     field :cron_line, String
     belongs_to :oval_content, ::Types::OvalContent
+
     has_many :hostgroups, ::Types::Hostgroup
 
     def self.graphql_definition

data/app/models/concerns/foreman_openscap/host_extensions.rb

@@ -50,12 +50,6 @@ module ForemanOpenscap
       base.scoped_search :on => :id, :rename => :removed_from_policy,
                          :only_explicit => true, :operators => ['= '], :ext_method => :search_by_removed_from_policy
 
-      base.after_update :puppetrun!, :if => ->(host) do
-        Setting[:puppetrun] &&
-        host.changed.include?('openscap_proxy_id') &&
-        (host.individual_puppetclasses + host.parent_classes).pluck(:name).include?(ClientConfig::Puppet.new.puppetclass_name)
-      end
-
       base.scope :comply_with, lambda { |policy|
         joins(:arf_reports).merge(ArfReport.latest_of_policy(policy)).merge(ArfReport.passed)
       }

data/app/models/concerns/foreman_openscap/oval_facet_hostgroup_extensions.rb

@@ -6,10 +6,25 @@ module ForemanOpenscap
 
     included do
       has_many :oval_policies, :through => :oval_facet, :class_name => 'ForemanOpenscap::OvalPolicy'
+
+      scoped_search :relation => :oval_policies,
+                    :on => :id,
+                    :rename => :oval_policy_id,
+                    :complete_value => false,
+                    :ext_method => :find_by_oval_policy_id,
+                    :operators => ['= ']
     end
 
     def inherited_oval_policies
       find_inherited_policies :oval_policies
     end
+
+    module ClassMethods
+      def find_by_oval_policy_id(_key, operator, value)
+        conditions = sanitize_sql_for_conditions(["#{::ForemanOpenscap::HostgroupOvalFacetOvalPolicy.table_name}.oval_policy_id #{operator} ?", value])
+        hg_ids = ::ForemanOpenscap::Hostgroup::OvalFacet.joins(:hostgroup_oval_facet_oval_policies).where(conditions).pluck(:hostgroup_id)
+        { :conditions => ::Hostgroup.arel_table[:id].in(hg_ids).to_sql }
+      end
+    end
   end
 end

data/app/models/foreman_openscap/oval_content.rb

@@ -5,6 +5,8 @@ module ForemanOpenscap
     include Taxonomix
     include ScapFileContent
 
+    before_destroy ActiveRecord::Base::EnsureNotUsedBy.new(:oval_policies)
+
     scoped_search :on => :name, :complete_value => true
 
     has_many :oval_policies

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

@@ -58,7 +58,7 @@ module ForemanOpenscap
           memo.add_check(
             SetupCheck.new(
               :title => (_("Was %s configured successfully?") % item.class.name),
-              :fail_msg => ->(_) { _("Assign openscap_proxy to %s before proceeding.") % item.name }
+              :fail_msg => (_("Assign openscap_proxy to %s before proceeding.") % item.name)
             ).fail!
           )
         end

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

@@ -59,12 +59,12 @@ module ForemanOpenscap
           {
             :id => :foreman_ansible_present,
             :title => _("Is foreman_ansible present?"),
-            :fail_msg => ->(hash) { _("foreman_ansible plugin not found, please install it before running this action again.") }
+            :fail_msg => _("foreman_ansible plugin not found, please install it before running this action again.")
           },
           {
             :id => :foreman_scap_client_role_present,
             :title => _("Is theforeman.foreman_scap_client present?"),
-            :fail_msg => ->(hash) { @config.ansible_role_missing_msg }
+            :fail_msg => @config.ansible_role_missing_msg
           },
           {
             :id => :foreman_scap_client_vars_present,
@@ -74,17 +74,17 @@ module ForemanOpenscap
           {
             :id => :foreman_scap_client_server_overriden,
             :title => _("Is %s param set to be overriden?") % @config.server_param,
-            :fail_msg => ->(hash) { override_msg }
+            :fail_msg => override_msg
           },
           {
             :id => :foreman_scap_client_port_overriden,
             :title => _("Is %s param set to be overriden?") % @config.port_param,
-            :fail_msg => ->(hash) { override_msg }
+            :fail_msg => override_msg
           },
           {
             :id => :foreman_scap_client_policies_overriden,
             :title => _("Is %s param set to be overriden?") % @config.policies_param,
-            :fail_msg => ->(hash) { override_msg }
+            :fail_msg => override_msg
           }
         ]
       end

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

@@ -1,7 +1,7 @@
 module ForemanOpenscap
   module Oval
     class SetupCheck
-      attr_reader :result, :id
+      attr_reader :result, :id, :errors
 
       def initialize(hash)
         @id = hash[:id]
@@ -17,6 +17,7 @@ module ForemanOpenscap
       end
 
       def fail!
+        raise 'Cannot fail a check that expects fail message data, use fail_with! method instead' if @fail_msg.respond_to?(:call) && @fail_msg_data.empty?
         @result = :fail
         self
       end
@@ -39,7 +40,9 @@ module ForemanOpenscap
       end
 
       def fail_msg
-        @fail_msg.call @fail_msg_data if @fail_msg
+        return unless failed?
+        return @fail_msg.call(@fail_msg_data) if @fail_msg.respond_to?(:call) && @fail_msg_data
+        @fail_msg
       end
 
       def to_h

data/db/migrate/20210819143316_drop_unused_tables.rb

@@ -0,0 +1,6 @@
+class DropUnusedTables < ActiveRecord::Migration[6.0]
+  def up
+    drop_table :foreman_openscap_arf_reports
+    drop_table :foreman_openscap_arf_report_raws
+  end
+end

data/lib/foreman_openscap/engine.rb

@@ -219,10 +219,15 @@ module ForemanOpenscap
         register_global_js_file 'global'
 
         register_graphql_query_field :oval_contents, '::Types::OvalContent', :collection_field
+        register_graphql_query_field :oval_content, '::Types::OvalContent', :record_field
         register_graphql_query_field :oval_policies, '::Types::OvalPolicy', :collection_field
         register_graphql_query_field :oval_policy, '::Types::OvalPolicy', :record_field
         register_graphql_query_field :cves, '::Types::Cve', :collection_field
 
+        register_graphql_mutation_field :delete_oval_policy, ::Mutations::OvalPolicies::Delete
+        register_graphql_mutation_field :delete_oval_content, ::Mutations::OvalContents::Delete
+        register_graphql_mutation_field :update_oval_policy, ::Mutations::OvalPolicies::Update
+
         register_facet ForemanOpenscap::Host::OvalFacet, :oval_facet do
           configure_host do
             extend_model ForemanOpenscap::OvalFacetHostExtensions
@@ -276,7 +281,7 @@ module ForemanOpenscap
 
         if Gem::Version.new(ForemanRemoteExecution::VERSION) >= Gem::Version.new('1.2.3')
           options[:host_action_button] = true
-          oval_options[:host_action_button] = Setting[:lab_features]
+          oval_options[:host_action_button] = (!::Foreman.in_rake? && ActiveRecord::Base.connection.table_exists?(:settings)) ? (Setting.find_by(:name => 'lab_features')&.value || false) : false
         end
 
         RemoteExecutionFeature.register(:foreman_openscap_run_scans, N_("Run OpenSCAP scan"), options)

data/lib/foreman_openscap/version.rb

@@ -1,3 +1,3 @@
 module ForemanOpenscap
-  VERSION = "5.0.0".freeze
+  VERSION = "5.1.0".freeze
 end

data/package.json

@@ -24,23 +24,20 @@
     "@theforeman/vendor": ">= 4.13.2"
   },
   "devDependencies": {
-    "@apollo/react-testing": "^4.0.0",
     "@babel/core": "^7.7.0",
-    "@testing-library/dom": "^7.30.4",
+    "@testing-library/dom": "^8.9.1",
     "@testing-library/jest-dom": "^5.11.9",
-    "@testing-library/react": "^11.2.5",
-    "@testing-library/user-event": "^13.1.2",
+    "@testing-library/user-event": "^13.2.1",
     "@theforeman/builder": "^8.4.1",
     "@theforeman/eslint-plugin-foreman": "8.4.1",
     "@theforeman/find-foreman": "^8.4.1",
     "@theforeman/stories": "^8.4.1",
-    "@theforeman/test": "^8.4.1",
+    "@theforeman/test": "^8.9.0",
     "@theforeman/vendor-dev": "^8.4.1",
     "babel-eslint": "^10.0.3",
     "eslint": "^6.7.2",
     "jed": "^1.1.1",
     "jest-svg-transformer": "^1.0.0",
-    "jest-transform-graphql": "^2.1.0",
     "prettier": "^1.13.5",
     "stylelint": "^9.3.0",
     "stylelint-config-standard": "^18.0.0"

data/test/graphql/mutations/oval_policies/delete_mutation_test.rb

@@ -0,0 +1,63 @@
+require 'test_plugin_helper'
+
+module Mutations
+  module OvalPolicies
+    class DeleteMutationTest < ActiveSupport::TestCase
+      let(:policy) { FactoryBot.create(:oval_policy, :oval_content => FactoryBot.create(:oval_content)) }
+      let(:policy_id) { Foreman::GlobalId.for(policy) }
+      let(:variables) do
+        {
+          id: policy_id,
+        }
+      end
+      let(:query) do
+        <<-GRAPHQL
+        mutation DeleteOvalPolicyMutation($id:ID!){
+          deleteOvalPolicy(input:{id:$id}) {
+            id
+            errors {
+              message
+              path
+            }
+          }
+        }
+        GRAPHQL
+      end
+
+      context 'with admin user' do
+        let(:user) { FactoryBot.create(:user, :admin) }
+
+        test 'should delete oval policy' do
+          context = { current_user: user }
+
+          policy
+
+          assert_difference('::ForemanOpenscap::OvalPolicy.count', -1) do
+            result = ForemanGraphqlSchema.execute(query, variables: variables, context: context)
+            assert_empty result['errors']
+            assert_empty result['data']['deleteOvalPolicy']['errors']
+            assert_equal policy_id, result['data']['deleteOvalPolicy']['id']
+          end
+          assert_equal user.id, Audit.last.user_id
+        end
+      end
+
+      context 'with user with view permissions' do
+        setup do
+          policy
+          @user = setup_user 'view', 'oval_policies'
+        end
+
+        test 'should not delete oval policy' do
+          context = { current_user: @user }
+
+          assert_difference('ForemanOpenscap::OvalPolicy.count', 0) do
+            result = ForemanGraphqlSchema.execute(query, variables: variables, context: context)
+            assert_not_empty result['errors']
+            assert_includes result['errors'].map { |error| error['message'] }.to_sentence, 'Unauthorized.'
+          end
+        end
+      end
+    end
+  end
+end

data/test/graphql/queries/oval_content_query_test.rb

@@ -0,0 +1,29 @@
+require 'test_plugin_helper'
+
+module Queries
+  class OvalContentQueryTest < GraphQLQueryTestCase
+    let(:query) do
+      <<-GRAPHQL
+        query($id:String!) {
+          ovalContent(id: $id) {
+            id
+            name
+            originalFilename
+            url
+          }
+        }
+      GRAPHQL
+    end
+
+    let(:oval_content) { FactoryBot.create(:oval_content) }
+
+    let(:global_id) { Foreman::GlobalId.for(oval_content) }
+    let(:variables) { { id: global_id } }
+    let(:data) { result['data']['ovalContent'] }
+
+    test 'should return OVAL Content' do
+      assert_equal global_id, data['id']
+      assert_equal oval_content.name, data['name']
+    end
+  end
+end

data/test/unit/services/hostgroup_overrider_test.rb

@@ -14,7 +14,7 @@ class HostgroupOverriderTest < ActiveSupport::TestCase
 
     proxy = FactoryBot.create(:openscap_proxy, :url => 'https://override-keys.example.com:8998')
 
-    hostgroup = FactoryBot.create(:hostgroup, :environment_id => env.id, :openscap_proxy_id => proxy.id, :puppet => FactoryBot.create(:hostgroup_puppet_facet))
+    hostgroup = FactoryBot.create(:hostgroup, :environment => env, :openscap_proxy_id => proxy.id, :puppet => FactoryBot.create(:hostgroup_puppet_facet))
     refute hostgroup.puppetclasses.include? puppet_class
     assert LookupValue.where(:match => "hostgroup=#{hostgroup.to_label}",
                              :lookup_key_id => port_param.id,

data/test/unit/services/oval/setup_check_test.rb

@@ -0,0 +1,37 @@
+require 'test_plugin_helper'
+
+class ForemanOpenscap::Oval::SetupCheckTest < ActiveSupport::TestCase
+  test 'should show error message with filled in data' do
+    check = ::ForemanOpenscap::Oval::SetupCheck.new(
+      :id => :test_check,
+      :title => _("Will it pass?"),
+      :fail_msg => ->(hash) { "There was an error in #{hash[:name]}, you need to #{hash[:action]}" }
+    )
+
+    check.fail_with!(:name => 'your engine', :action => 'run')
+    assert_equal 'There was an error in your engine, you need to run', check.fail_msg
+  end
+
+  test 'should show error message when it is a string' do
+    msg = "Do not panic"
+    check = ::ForemanOpenscap::Oval::SetupCheck.new(
+      :id => :test_check,
+      :title => _("Will it pass?"),
+      :fail_msg => msg
+    )
+    check.fail!
+    assert_equal msg, check.fail_msg
+  end
+
+  test 'should not show error message when check not failed' do
+    check = ::ForemanOpenscap::Oval::SetupCheck.new(
+      :id => :test_check,
+      :title => _("Will it pass?"),
+      :fail_msg => 'foo'
+    )
+
+    assert_nil check.fail_msg
+    check.fail!
+    assert_not_nil check.fail_msg
+  end
+end

data/webpack/components/ConfirmModal.js

@@ -0,0 +1,63 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Modal, Button, ModalVariant, Spinner } from '@patternfly/react-core';
+
+import { translate as __ } from 'foremanReact/common/I18n';
+
+import './ConfirmModal.scss';
+
+const ConfirmModal = props => {
+  const [callMutation, { loading }] = props.prepareMutation();
+
+  const actions = [
+    <Button
+      key="confirm"
+      variant="primary"
+      onClick={() => props.onConfirm(callMutation, props.record.id)}
+      isDisabled={loading}
+    >
+      {__('Confirm')}
+    </Button>,
+    <Button
+      key="cancel"
+      variant="link"
+      onClick={event => props.onClose()}
+      isDisabled={loading}
+    >
+      {__('Cancel')}
+    </Button>,
+  ];
+
+  if (loading) {
+    actions.push(<Spinner key="spinner" size="lg" />);
+  }
+
+  return (
+    <Modal
+      variant={ModalVariant.medium}
+      title={props.title}
+      isOpen={props.isOpen}
+      className="foreman-modal"
+      showClose={false}
+      actions={actions}
+    >
+      {props.text}
+    </Modal>
+  );
+};
+
+ConfirmModal.propTypes = {
+  prepareMutation: PropTypes.func.isRequired,
+  onConfirm: PropTypes.func.isRequired,
+  record: PropTypes.object,
+  onClose: PropTypes.func.isRequired,
+  title: PropTypes.string.isRequired,
+  isOpen: PropTypes.bool.isRequired,
+  text: PropTypes.string.isRequired,
+};
+
+ConfirmModal.defaultProps = {
+  record: null,
+};
+
+export default ConfirmModal;

data/webpack/components/ConfirmModal.scss

@@ -0,0 +1,3 @@
+.pf-c-backdrop {
+  z-index: 1040;
+}

data/webpack/components/EditableInput.js

@@ -0,0 +1,157 @@
+import React, { useState } from 'react';
+import PropTypes from 'prop-types';
+import { translate as __ } from 'foremanReact/common/I18n';
+import {
+  Button,
+  Split,
+  SplitItem,
+  Spinner,
+  FormGroup,
+} from '@patternfly/react-core';
+import {
+  TimesIcon,
+  CheckIcon,
+  PencilAltIcon,
+  ExclamationCircleIcon,
+} from '@patternfly/react-icons';
+
+import './EditableInput.scss';
+
+const EditableInput = props => {
+  const [editing, setEditing] = useState(false);
+  const [submitting, setSubmitting] = useState(false);
+  const [inputValue, setInputValue] = useState(props.value);
+  const [error, setError] = useState('');
+  const [touched, setTouched] = useState(false);
+
+  const stopSubmitting = () => setSubmitting(false);
+
+  const handleSubmit = event => {
+    event.preventDefault();
+    onSubmit();
+  };
+
+  const onFinish = () => {
+    setSubmitting(false);
+    setEditing(false);
+  };
+
+  const onSubmit = () => {
+    setSubmitting(true);
+    props.onConfirm(inputValue, onFinish, stopSubmitting, onError);
+  };
+
+  const onError = err => {
+    setTouched(false);
+    setError(err);
+  };
+
+  const onCancel = () => {
+    setInputValue(props.value);
+    setEditing(false);
+  };
+
+  const onChange = value => {
+    if (!touched) {
+      setTouched(true);
+    }
+    setInputValue(value);
+  };
+
+  if (!editing) {
+    return (
+      <Split>
+        <SplitItem>{props.value || <i>{__('None provided')}</i>}</SplitItem>
+        <SplitItem>
+          <Button
+            className="inline-edit-icon"
+            aria-label={`edit ${props.attrName}`}
+            variant="plain"
+            onClick={() => setEditing(true)}
+          >
+            <PencilAltIcon />
+          </Button>
+        </SplitItem>
+      </Split>
+    );
+  }
+
+  const Component = props.component;
+
+  const shouldValidate = (isTouched, err) => {
+    if (!isTouched) {
+      return err ? 'error' : 'success';
+    }
+    return 'noval';
+  };
+
+  const valid = shouldValidate(touched, error);
+
+  return (
+    <Split>
+      <SplitItem>
+        <form onSubmit={handleSubmit} className="pf-c-form">
+          <FormGroup
+            helperTextInvalid={error}
+            helperTextInvalidIcon={<ExclamationCircleIcon />}
+            validated={valid}
+          >
+            <Component
+              {...props.inputProps}
+              type="text"
+              aria-label={`${props.attrName} text input`}
+              isDisabled={submitting}
+              value={inputValue || ''}
+              onChange={onChange}
+              validated={valid}
+            />
+          </FormGroup>
+        </form>
+      </SplitItem>
+      <SplitItem>
+        <Button
+          aria-label={`submit ${props.attrName}`}
+          variant="plain"
+          onClick={onSubmit}
+          isDisabled={submitting}
+        >
+          <CheckIcon />
+        </Button>
+      </SplitItem>
+      <SplitItem>
+        <Button
+          aria-label={`cancel editing ${props.attrName}`}
+          variant="plain"
+          onClick={onCancel}
+          isDisabled={submitting}
+        >
+          <TimesIcon />
+        </Button>
+      </SplitItem>
+      <SplitItem>
+        {submitting && (
+          <Spinner
+            key="spinner"
+            size="lg"
+            id={`edit-${props.attrName}-spinner`}
+          />
+        )}
+      </SplitItem>
+    </Split>
+  );
+};
+
+EditableInput.propTypes = {
+  value: PropTypes.string,
+  onConfirm: PropTypes.func.isRequired,
+  attrName: PropTypes.string.isRequired,
+  component: PropTypes.object.isRequired,
+  inputProps: PropTypes.object,
+};
+
+EditableInput.defaultProps = {
+  inputProps: {},
+  value: '',
+};
+
+export default EditableInput;

data/webpack/components/EditableInput.scss

@@ -0,0 +1,3 @@
+.inline-edit-icon {
+  padding-top: 2px;
+}