foreman_kernel_care 0.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6d0461ccf8b6c5499dfad71c1a558c9624e38ca96736946a52418a08c29d5cb
-  data.tar.gz: 1b048269ccdddc043d8dc5bbb35237ae32d1a3e3b8157d63abc3a5c8f1e3e189
+  metadata.gz: d1d0ef271076e4187e05dfbb9b3b46c15566c103e735e81edfbe864507664176
+  data.tar.gz: cbabb299ec2d3bd510f3828ac20713ceb065f8a551c0b5adec0310a26e0bfdd7
 SHA512:
-  metadata.gz: d06f81902376cf81f5539a221080d9c10d4802e4412f0bd86ba9f988a6e1aae5e3a827918f0a1f7646508b1ccd4b129946df51517946f44f3f27556cb4ccac32
-  data.tar.gz: 5451791474e1a65fc39a29571118f742ba6c205f51fbee6993d38ed6110bf47b4e548860b1bfb0dd842be62ba7919d8433e6e9a9c49de8445d69ac3bfc535e1e
+  metadata.gz: 68d4e8475ec10d76a71bf96adf0e20d832868b8263bcc613e685d36f0506e0eee809b2f8f02c968739dc4e6aeb9fe285dbc70a5821a3757f845e74e7e8fb129a
+  data.tar.gz: 1a6fc20bb8eb792f6bf4d85db1de7b2935f7b7a51b3ebbddcdc7da8994d5c21032e70cada23a526a73a555cfbeeb8df04ed377c8d1d1751492997d4522933c62

data/README.md

@@ -1,27 +1,23 @@
 # ForemanKernelCare
 
-Plugin for KernelCare
+This plugin removes kernel [trace](https://theforeman.org/plugins/katello/nightly/user_guide/tracer/index.html) and update the kernel package version if [KernelCare](https://www.kernelcare.com/product/) package is installed on host
 
 ## Installation
 
-See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
+See [How_to_Install_a_Plugin](https://www.theforeman.org/plugins/#2.Installation)
 for how to install Foreman plugins
 
 ## Usage
 
 Nothing to do, just install plugin
 
-## TODO
-
-- Check not only presence of the kernelcare package on host, but also the applied kernel version from kernelcare
-
 ## Contributing
 
 Fork and send a Pull Request. Thanks!
 
 ## Copyright
 
-Copyright (c) 2021 maccelf
+Copyright (c) 2022 maccelf
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

data/Rakefile

@@ -20,7 +20,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 
 Bundler::GemHelper.install_tasks
 
@@ -38,7 +38,7 @@ task default: :test
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue => _
+rescue StandardError => _e
   puts 'Rubocop not loaded.'
 end
 

data/app/controllers/concerns/foreman_kernel_care/foreman_tasks.rb

@@ -0,0 +1,22 @@
+module ForemanKernelCare
+  module ForemanTasks
+    def callback
+      callbacks = params.key?(:callback) ? Array(params) : params[:callbacks]
+      ids = callbacks.map { |payload| payload[:callback][:task_id] }
+      foreman_tasks = ::ForemanTasks::Task.where(:id => ids)
+      external_map = Hash[*foreman_tasks.pluck(:id, :external_id).flatten]
+      callbacks.each do |payload|
+        # We need to call .to_unsafe_h to unwrap the hash from ActionController::Parameters
+        callback = payload[:callback]
+        foreman_task = foreman_tasks.find { |task| task.id == callback[:task_id] }
+        if foreman_task.action.include?('Get patched kernel version')
+          version, release = payload[:data].to_unsafe_h['result'].first['output'].strip.split('-')
+          job_invocation = ::JobInvocation.where(:task_id => foreman_task.parent_task_id).first
+          job_invocation.targeting.hosts.each { |host| host.update_kernel_version(version, release) }
+        end
+        process_callback(external_map[callback[:task_id]], callback[:step_id].to_i, payload[:data].to_unsafe_h, :request_id => ::Logging.mdc['request'])
+      end
+      render :json => { :message => 'processing' }.to_json
+    end
+  end
+end

data/app/models/concerns/foreman_kernel_care/host_managed_extensions.rb

@@ -1,19 +1,74 @@
 module ForemanKernelCare
   module HostManagedExtensions
+    def import_package_profile(simple_packages)
+      if kernelcare?
+        composer = ::JobInvocationComposer.for_feature(:kernel_version, self)
+        composer.triggering.mode = :future
+        composer.trigger!
+      end
+
+      found = import_package_profile_in_bulk(simple_packages)
+      sync_package_associations(found.map(&:id).uniq)
+    end
+
     def import_tracer_profile(tracer_profile)
       traces = []
       tracer_profile.each do |trace, attributes|
         next if attributes[:helper].blank?
 
-        next if trace == 'kernel' && kernelcare?
+        if trace.to_s == 'kernel' && kernelcare?
+          composer = ::JobInvocationComposer.for_feature(:update_kernel, self)
+          composer.triggering.mode = :future
+          composer.trigger!
 
-        traces << { host_id: self.id, application: trace, helper: attributes[:helper], app_type: attributes[:type] }
+          next
+        end
+
+        traces << { host_id: id, application: trace, helper: attributes[:helper], app_type: attributes[:type] }
       end
       host_traces.delete_all
       Katello::HostTracer.import(traces, validate: false)
       update_trace_status
     end
 
+    def update_kernel_version(version, release)
+      packages = ::Katello::InstalledPackage.where('name LIKE ?', '%kernel%').where.not(name: 'kernelcare').to_a
+      delete_ids = []
+      simple_packages = packages.map do |p|
+        delete_ids << p.id
+        ::Katello::Pulp::SimplePackage.new({
+                                             arch: p.arch,
+                                             epoch: p.epoch,
+                                             version: version,
+                                             release: release,
+                                             name: p.name
+                                           })
+      end
+      found = import_package_profile_in_bulk(simple_packages)
+      sync_kernel_associations(found.map(&:id).uniq, delete_ids)
+    end
+
+    def sync_kernel_associations(new_patched_kernel_ids, delete_ids)
+      ::Katello::Util::Support.active_record_retry do
+        table_name = host_installed_packages.table_name
+
+        queries = []
+
+        if delete_ids.any?
+          queries << "DELETE FROM #{table_name} WHERE host_id=#{id} AND installed_package_id IN (#{delete_ids.join(', ')})"
+        end
+
+        unless new_patched_kernel_ids.empty?
+          inserts = new_patched_kernel_ids.map { |unit_id| "(#{unit_id.to_i}, #{id.to_i})" }
+          queries << "INSERT INTO #{table_name} (installed_package_id, host_id) VALUES #{inserts.join(', ')}"
+        end
+
+        queries.each do |query|
+          ::ActiveRecord::Base.connection.execute(query)
+        end
+      end
+    end
+
     protected
 
     def kernelcare?

data/app/views/foreman_kernel_care/job_templates/kernel_version.erb

@@ -0,0 +1,15 @@
+<%#
+kind: job_template
+name: Kernel version
+model: JobTemplate
+job_category: Commands
+description_format: "Get patched kernel version"
+provider_type: SSH
+feature: kernel_version
+%>
+<%
+  unless @host.installed_packages.select { |package| package.name == 'kernelcare' }.empty?
+    render_error(N_('Unsupported host.'))
+  end
+%>
+/usr/bin/kcarectl --uname

data/app/views/foreman_kernel_care/job_templates/update_kernel.erb

@@ -0,0 +1,15 @@
+<%#
+kind: job_template
+name: Update kernel
+model: JobTemplate
+job_category: Commands
+description_format: "Run yum update kernel"
+provider_type: SSH
+feature: update_kernel
+%>
+<%
+  unless @host.operatingsystem.family == 'Redhat'
+    render_error(N_('Unsupported operating system for this host.'))
+  end
+%>
+yum update -y kernel*

data/db/seeds.d/100_assign_features_with_templates.rb

@@ -0,0 +1,28 @@
+User.as_anonymous_admin do
+  RemoteExecutionFeature.without_auditing do
+    if Rails.env.test? || Foreman.in_rake?
+      # If this file tries to import a template with a REX feature in a SeedsTest,
+      # it will fail - the REX feature isn't registered on SeedsTest because
+      # DatabaseCleaner truncates the db before every test.
+      # During db:seed, we also want to know the feature is registered before
+      # seeding the template
+      # kudos to dLobatog
+      ForemanKernelCare::Engine.register_rex_feature
+    end
+    JobTemplate.without_auditing do
+      module_template = JobTemplate.find_by(name: 'Update kernel')
+      if module_template && !Rails.env.test? && Setting[:remote_execution_sync_templates]
+        module_template.sync_feature('update_kernel')
+        module_template.organizations << Organization.unscoped.all if module_template.organizations.empty?
+        module_template.locations << Location.unscoped.all if module_template.locations.empty?
+      end
+
+      module_template = JobTemplate.find_by(name: 'Kernel version')
+      if module_template && !Rails.env.test? && Setting[:remote_execution_sync_templates]
+        module_template.sync_feature('kernel_version')
+        module_template.organizations << Organization.unscoped.all if module_template.organizations.empty?
+        module_template.locations << Location.unscoped.all if module_template.locations.empty?
+      end
+    end
+  end
+end

data/db/seeds.d/70_job_templates.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+organizations = Organization.unscoped.all
+locations = Location.unscoped.all
+User.as_anonymous_admin do
+  RemoteExecutionFeature.without_auditing do
+    if Rails.env.test? || Foreman.in_rake?
+      # If this file tries to import a template with a REX feature in a SeedsTest,
+      # it will fail - the REX feature isn't registered on SeedsTest because
+      # DatabaseCleaner truncates the db before every test.
+      # During db:seed, we also want to know the feature is registered before
+      # seeding the template
+      ForemanKernelCare::Engine.register_rex_feature
+    end
+    JobTemplate.without_auditing do
+      Dir[File.join("#{ForemanKernelCare::Engine.root}/app/views/"\
+              'foreman_kernel_care/job_templates/**/*.erb')].each do |template|
+        sync = !Rails.env.test? && Setting[:remote_execution_sync_templates]
+        template = JobTemplate.import_raw!(File.read(template),
+          :default => true,
+          :lock => true,
+          :update => sync)
+        template.organizations = organizations if template.present?
+        template.locations = locations if template.present?
+      end
+    end
+  end
+end

data/lib/foreman_kernel_care/engine.rb

@@ -1,45 +1,27 @@
+require 'foreman_kernel_care/remote_execution'
+
 module ForemanKernelCare
   class Engine < ::Rails::Engine
     isolate_namespace ForemanKernelCare
     engine_name 'foreman_kernel_care'
 
-    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
-    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
-    config.autoload_paths += Dir["#{config.root}/app/overrides"]
-
-    # Add any db migrations
-    initializer 'foreman_kernel_care.load_app_instance_data' do |app|
-      ForemanKernelCare::Engine.paths['db/migrate'].existent.each do |path|
-        app.config.paths['db/migrate'] << path
-      end
-    end
 
     initializer 'foreman_kernel_care.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_kernel_care do
-        requires_foreman '>= 2.4.0'
-
-        # Add Global files for extending foreman-core components and routes
-        register_global_js_file 'global'
+        requires_foreman '>= 1.19.0'
 
         # Add a new role called 'Discovery' if it doesn't exist
-        role 'ForemanKernelCare', [:view_foreman_kernel_care]
-
-        # add dashboard widget
-        widget 'foreman_kernel_care_widget', name: N_('KernelCare widget'), sizex: 4, sizey: 1
+        role 'Foreman KernelCare', [:view_job_templates]
       end
     end
 
     # Include concerns in this config.to_prepare block
     config.to_prepare do
-
-      begin
-        Host::Managed.send(:include, ForemanKernelCare::HostExtensions)
-        HostsHelper.send(:include, ForemanKernelCare::HostsHelperExtensions)
-        Katello::Concerns::HostManagedExtensions.send(:prepend, ForemanKernelCare::HostManagedExtensions)
-      rescue => e
-        Rails.logger.warn "ForemanKernelCare: skipping engine hook (#{e})"
-      end
+      Katello::Concerns::HostManagedExtensions.prepend ForemanKernelCare::HostManagedExtensions
+      ForemanTasks::Api::TasksController.prepend ForemanKernelCare::ForemanTasks
+    rescue StandardError => e
+      Rails.logger.warn "ForemanKernelCare: skipping engine hook (#{e})"
     end
 
     rake_tasks do
@@ -47,11 +29,5 @@ module ForemanKernelCare
         ForemanKernelCare::Engine.load_seed
       end
     end
-
-    initializer 'foreman_kernel_care.register_gettext', after: :load_config_initializers do |_app|
-      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
-      locale_domain = 'foreman_kernel_care'
-      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
-    end
   end
 end

data/lib/foreman_kernel_care/remote_execution.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'foreman_remote_execution'
+
+module ForemanKernelCare
+  # Dependencies related with the remote execution plugin
+  class Engine < ::Rails::Engine
+    def self.register_rex_feature
+      RemoteExecutionFeature.register(
+        :update_kernel,
+        N_('Run Update kernel'),
+        :description => N_('Runs Update kernel')
+      )
+
+      RemoteExecutionFeature.register(
+        :kernel_version,
+        N_('Get patched kernel version'),
+        :description => N_('Get patched kernel version')
+      )
+    end
+  end
+end

data/lib/foreman_kernel_care/version.rb

@@ -1,3 +1,3 @@
 module ForemanKernelCare
-  VERSION = '0.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/tasks/foreman_kernel_care_tasks.rake

@@ -1,15 +1,5 @@
 require 'rake/testtask'
 
-# Tasks
-namespace :foreman_kernel_care do
-  namespace :example do
-    desc 'Example Task'
-    task task: :environment do
-      # Task goes here
-    end
-  end
-end
-
 # Tests
 namespace :test do
   desc 'Test ForemanKernelCare'
@@ -24,7 +14,7 @@ namespace :test do
 end
 
 namespace :foreman_kernel_care do
-  task :rubocop do
+  task rubocop: :environment do
     begin
       require 'rubocop/rake_task'
       RuboCop::RakeTask.new(:rubocop_foreman_kernel_care) do |task|
@@ -32,7 +22,7 @@ namespace :foreman_kernel_care do
                          "#{ForemanKernelCare::Engine.root}/lib/**/*.rb",
                          "#{ForemanKernelCare::Engine.root}/test/**/*.rb"]
       end
-    rescue
+    rescue StandardError
       puts 'Rubocop not loaded.'
     end
 

data/test/factories/foreman_kernel_care_factories.rb

@@ -1,5 +1,17 @@
-FactoryBot.define do
+FactoryBot.modify do
   factory :host do
-    name 'foreman_kernel_care'
+    trait :with_kernelcare do
+      after(:create) do |host|
+        package_json = {
+          :name => 'kernelcare',
+          :version => '2.54',
+          :release => '1.el7',
+          :arch => 'x86_64',
+          :epoch => '1',
+          :nvra => 'kernelcare-2.54-1.el7.x86_64'
+        }
+        host.import_package_profile([::Katello::Pulp::SimplePackage.new(package_json)])
+      end
+    end
   end
 end

data/test/test_plugin_helper.rb

@@ -2,5 +2,8 @@
 require 'test_helper'
 
 # Add plugin to FactoryBot's paths
-FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+rex_factories_path = "#{ForemanRemoteExecution::Engine.root}/test/factories"
+plugin_factories_path = File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.definition_file_paths << rex_factories_path
+FactoryBot.definition_file_paths << plugin_factories_path
 FactoryBot.reload

data/test/unit/host_managed_extensions_test.rb

@@ -0,0 +1,67 @@
+require 'test_plugin_helper'
+
+module ForemanKernelCare
+  class HostManagedExtensionsTestBase < ActiveSupport::TestCase
+  end
+
+  class HostInstalledPackagesTest < HostManagedExtensionsTestBase
+    def setup
+      feature = RemoteExecutionFeature.register('kernel_version', 'Kernel version')
+      template = FactoryBot.create(:job_template, name: 'Kernel versionl')
+      template.sync_feature(feature.label)
+
+      @host = FactoryBot.create(:host, :with_kernelcare)
+      package_json = {:name => "kernel", :version => "1", :release => "1.el7", :arch => "x86_64", :epoch => "1",
+                      :nvra => "kernel-1-1.el7.x86_64"}
+      @host.import_package_profile([::Katello::Pulp::SimplePackage.new(package_json)])
+      @nvra = 'kernel-1-1.el7.x86_64'
+      @host.reload
+    end
+
+    def test_update_kernel_version
+      version = '2'
+      release = '2.el7'
+      @host.update_kernel_version(version, release)
+      kernel_package = @host.installed_packages.where(name: 'kernel').first
+
+      assert_not_equal kernel_package.nvra, @nvra
+      assert_equal kernel_package.version, version
+      assert_equal kernel_package.release, release
+    end
+  end
+
+  class HostTracerTest < HostManagedExtensionsTestBase
+    def setup
+      feature = RemoteExecutionFeature.register('update_kernel', 'Update Kernel')
+      template = FactoryBot.create(:job_template, name: 'Update kernel')
+      template.sync_feature(feature.label)
+
+      @tracer_json = {
+        "kernel": {
+          "type": 'static',
+          "helper": 'You will have to reboot your computer'
+        }
+      }
+    end
+
+    def test_import_kerenl_trace_with_kernelcare
+      host = FactoryBot.create(:host, :with_kernelcare)
+      host.import_tracer_profile(@tracer_json)
+      host.reload
+
+      assert_empty host.host_traces.where(application: 'kernel')
+      assert_equal 1, JobInvocation.count
+      assert_equal 'Update kernel', JobInvocation.first.description
+    end
+
+    def test_import_kerenl_trace_without_kernelcare
+      host = FactoryBot.create(:host)
+      host.import_tracer_profile(@tracer_json)
+      host.reload
+
+      assert_equal 1, host.host_traces.count
+      assert_equal 'kernel', host.host_traces.first.application
+      assert_empty JobInvocation.all
+    end
+  end
+end

metadata

@@ -1,17 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: foreman_kernel_care
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Maxim Petukhov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: foreman_remote_execution
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: katello
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Plugin for KernelCare
+description: This plugin removes kernel trace if KernelCare package is installed on
+  host
 email:
 - maxmol27@gmail.com
 executables: []
@@ -48,38 +77,20 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/helpers/concerns/foreman_kernel_care/hosts_helper_extensions.rb
-- app/models/concerns/foreman_kernel_care/host_extensions.rb
+- app/controllers/concerns/foreman_kernel_care/foreman_tasks.rb
 - app/models/concerns/foreman_kernel_care/host_managed_extensions.rb
-- app/views/dashboard/_foreman_kernel_care_widget.html.erb
-- app/views/foreman_kernel_care/layouts/layouts/new_layout.html.erb
-- app/views/foreman_kernel_care/layouts/new_layout.html.erb
-- config/routes.rb
+- app/views/foreman_kernel_care/job_templates/kernel_version.erb
+- app/views/foreman_kernel_care/job_templates/update_kernel.erb
+- db/seeds.d/100_assign_features_with_templates.rb
+- db/seeds.d/70_job_templates.rb
 - lib/foreman_kernel_care.rb
 - lib/foreman_kernel_care/engine.rb
+- lib/foreman_kernel_care/remote_execution.rb
 - lib/foreman_kernel_care/version.rb
 - lib/tasks/foreman_kernel_care_tasks.rake
-- locale/Makefile
-- locale/en/foreman_kernel_care.po
-- locale/foreman_kernel_care.pot
-- locale/gemspec.rb
-- package.json
 - test/factories/foreman_kernel_care_factories.rb
 - test/test_plugin_helper.rb
-- test/unit/foreman_kernel_care_test.rb
-- webpack/global_index.js
-- webpack/global_test_setup.js
-- webpack/index.js
-- webpack/src/Components/EmptyState/Constants.js
-- webpack/src/Components/EmptyState/EmptyStateReducer.js
-- webpack/src/Components/EmptyState/ExtendedEmptyState.js
-- webpack/src/Components/EmptyState/__tests__/ExtendedEmptyState.test.js
-- webpack/src/Extends/index.js
-- webpack/src/Router/WelcomePage/Welcome.js
-- webpack/src/Router/WelcomePage/index.js
-- webpack/src/Router/routes.js
-- webpack/src/reducers.js
-- webpack/test_setup.js
+- test/unit/host_managed_extensions_test.rb
 homepage: https://github.com/maccelf/foreman_kernel_care
 licenses:
 - GPL-3.0
@@ -104,7 +115,6 @@ signing_key:
 specification_version: 4
 summary: Plugin for KernelCare
 test_files:
-- test/test_plugin_helper.rb
-- test/unit/foreman_kernel_care_test.rb
 - test/factories/foreman_kernel_care_factories.rb
-- webpack/src/Components/EmptyState/__tests__/ExtendedEmptyState.test.js
+- test/test_plugin_helper.rb
+- test/unit/host_managed_extensions_test.rb

data/app/helpers/concerns/foreman_kernel_care/hosts_helper_extensions.rb

@@ -1,13 +0,0 @@
-module ForemanKernelCare
-  module HostsHelperExtensions
-    extend ActiveSupport::Concern
-
-    included do
-      # execute callbacks
-    end
-
-    # create or overwrite instance methods...
-    def instance_method_name
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module ForemanKernelCare
-  module HostExtensions
-    extend ActiveSupport::Concern
-
-    included do
-      # execute callbacks
-    end
-
-    # create or overwrite instance methods...
-    def instance_method_name
-    end
-
-    module ClassMethods
-      # create or overwrite class methods...
-      def class_method_name
-      end
-    end
-  end
-end

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

@@ -1,2 +0,0 @@
-<h4 class="header ca"><%= _('ForemanKernelCare') %></h4>
-<%= _('Widget content') %>

data/config/routes.rb

@@ -1,9 +0,0 @@
-ForemanKernelCare::Engine.routes.draw do
-  get 'new_action', to: 'example#new_action', as: 'new_action'
-  get 'plugin_template_description', to: 'example#react_template_page_description'
-  get 'welcome', to: '/react#index', as: 'welcome'
-end
-
-Foreman::Application.routes.draw do
-  mount ForemanKernelCare::Engine, at: '/foreman_kernel_care'
-end

data/locale/Makefile

@@ -1,60 +0,0 @@
-#
-# Makefile for PO merging and MO generation. More info in the README.
-#
-# make all-mo (default) - generate MO files
-# make check - check translations using translate-tool
-# make tx-update - download and merge translations from Transifex
-# make clean - clean everything
-#
-DOMAIN = foreman_kernel_care
-VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.version')
-POTFILE = $(DOMAIN).pot
-MOFILE = $(DOMAIN).mo
-POFILES = $(shell find . -name '$(DOMAIN).po')
-MOFILES = $(patsubst %.po,%.mo,$(POFILES))
-POXFILES = $(patsubst %.po,%.pox,$(POFILES))
-EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
-
-%.mo: %.po
-	mkdir -p $(shell dirname $@)/LC_MESSAGES
-	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
-
-# Generate MO files from PO files
-all-mo: $(MOFILES)
-
-# Check for malformed strings
-%.pox: %.po
-	msgfmt -c $<
-	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
-		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
-	cat $@
-	! grep -q msgid $@
-
-%.edit.po:
-	touch $@
-
-check: $(POXFILES)
-
-# Unify duplicate translations
-uniq-po:
-	for f in $(shell find ./ -name "*.po") ; do \
-		msguniq $$f -o $$f ; \
-	done
-
-tx-pull: $(EDITFILES)
-	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
-
-mo-files: $(MOFILES)
-	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
-	git commit -m "i18n - pulling from tx"
-	@echo
-	@echo Changes commited!
-	@echo

data/locale/en/foreman_kernel_care.po

@@ -1,19 +0,0 @@
-# foreman_kernel_care
-#
-# This file is distributed under the same license as foreman_kernel_care.
-#
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: version 0.0.1\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-08-20 08:46+0100\n"
-"PO-Revision-Date: 2014-08-20 08:54+0100\n"
-"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
-"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
-"Language: \n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"Plural-Forms: nplurals=2; plural=(n != 1);\n"
-

data/locale/foreman_kernel_care.pot

@@ -1,19 +0,0 @@
-# foreman_kernel_care
-#
-# This file is distributed under the same license as foreman_kernel_care.
-#
-#, fuzzy
-msgid ""
-msgstr ""
-"Project-Id-Version: version 0.0.1\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-08-20 08:46+0100\n"
-"PO-Revision-Date: 2014-08-20 08:46+0100\n"
-"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
-"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
-"Language: \n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
-

data/locale/gemspec.rb

@@ -1,2 +0,0 @@
-# Matches foreman_kernel_care.gemspec
-_('TODO: Description of ForemanKernelCare.')

data/package.json

@@ -1,44 +0,0 @@
-{
-  "name": "foreman_kernel_care",
-  "version": "1.0.0",
-  "description": "DESCRIPTION",
-  "main": "index.js",
-  "scripts": {
-    "lint": "tfm-lint --plugin -d /webpack",
-    "test": "tfm-test --config jest.config.js",
-    "test:watch": "tfm-test --plugin --watchAll",
-    "test:current": "tfm-test --plugin --watch",
-    "publish-coverage": "tfm-publish-coverage",
-    "stories": "tfm-stories --plugin",
-    "stories:build": "tfm-build-stories --plugin",
-    "create-react-component": "yo react-domain"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/theforeman/foreman_kernel_care.git"
-  },
-  "bugs": {
-    "url": "http://projects.theforeman.org/projects/foreman_kernel_care/issues"
-  },
-  "peerDependencies": {
-    "@theforeman/vendor": ">= 6.0.0"
-  },
-  "dependencies": {
-    "react-intl": "^2.8.0"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.7.0",
-    "@sheerun/mutationobserver-shim": "^0.3.3",
-    "@theforeman/builder": "^6.0.0",
-    "@theforeman/eslint-plugin-foreman": "6.0.0",
-    "@theforeman/find-foreman": "^4.8.0",
-    "@theforeman/stories": "^7.0.0",
-    "@theforeman/test": "^8.0.0",
-    "@theforeman/vendor-dev": "^6.0.0",
-    "babel-eslint": "^10.0.3",
-    "eslint": "^6.7.2",
-    "prettier": "^1.19.1",
-    "stylelint-config-standard": "^18.0.0",
-    "stylelint": "^9.3.0"
-  }
-}

data/test/unit/foreman_kernel_care_test.rb

@@ -1,11 +0,0 @@
-require 'test_plugin_helper'
-
-class ForemanPluginTemplateTest < ActiveSupport::TestCase
-  setup do
-    User.current = User.find_by_login 'admin'
-  end
-
-  test 'the truth' do
-    assert true
-  end
-end

data/webpack/global_index.js

@@ -1,17 +0,0 @@
-import { registerReducer } from 'foremanReact/common/MountingService';
-import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
-import { registerRoutes } from 'foremanReact/routes/RoutingService';
-import Routes from './src/Router/routes'
-import reducers from './src/reducers';
-
-// register reducers
-Object.entries(reducers).forEach(([key, reducer]) =>
-    registerReducer(key, reducer)
-);
-
-// register client routes
-registerRoutes('PluginTemplate', Routes);
-
-// register fills for extending foreman core
-// http://foreman.surge.sh/?path=/docs/introduction-slot-and-fill--page
-addGlobalFill('<slotId>', '<fillId>', <div key='plugin-template-example' />, 300);

data/webpack/global_test_setup.js

@@ -1,11 +0,0 @@
-// runs before each test to make sure console.error output will
-// fail a test (i.e. default PropType missing). Check the error
-// output and traceback for actual error.
-global.console.error = (error, stack) => {
-    /* eslint-disable-next-line no-console */
-    if (stack) console.log(stack); // Prints out original stack trace
-    throw new Error(error);
-};
-
-// Increase jest timeout as some tests using multiple http mocks can time out on CI systems.
-jest.setTimeout(10000);

data/webpack/index.js

@@ -1,8 +0,0 @@
-import componentRegistry from 'foremanReact/components/componentRegistry';
-import ExtendedEmptyState from './src/Components/EmptyState/ExtendedEmptyState';
-
-// register components for erb mounting
-componentRegistry.register({
-    name: 'ExtendedEmptyState',
-    type: ExtendedEmptyState,
-});

data/webpack/src/Components/EmptyState/Constants.js

@@ -1,2 +0,0 @@
-export const GENERAL_ACTION_TYPE = '[PLUGIN_TEMPLATE] GENERAL ACTION';
-export const FOREMAN_STORYBOOK = 'https://foreman.surge.sh';

data/webpack/src/Components/EmptyState/EmptyStateReducer.js

@@ -1,19 +0,0 @@
-// This is an example for a generic redux's reducer
-// Reducers should be registered to foreman-core
-// For a further registration demonstration, have a look in `webpack/global_index.js` 
-
-import Immutable from 'seamless-immutable';
-import { GENERAL_ACTION_TYPE } from './Constants';
-
-const initialState = Immutable({});
-
-export default (state = initialState, action) => {
-  const { payload } = action;
-
-  switch (action.type) {
-    case GENERAL_ACTION_TYPE:
-      return state.set('generalProprty', payload);
-    default:
-      return state;
-  }
-};

data/webpack/src/Components/EmptyState/ExtendedEmptyState.js

@@ -1,43 +0,0 @@
-import React from 'react';
-import { Button, Alert } from '@patternfly/react-core';
-import EmptyState from 'foremanReact/components/common/EmptyState/EmptyStatePattern';
-import SkeletonLoader from 'foremanReact/components/common/SkeletonLoader';
-import PropTypes from 'prop-types';
-
-import { STATUS } from 'foremanReact/constants'
-import { useAPI } from 'foremanReact/common/hooks/API/APIHooks'
-import { translate as __ } from 'foremanReact/common/I18n';
-import { FOREMAN_STORYBOOK } from './Constants';
-
-const ExtendedEmptyState = ({ header }) => {
-  // AJAX request using useAPI hook
-  const { response: { description }, status } = useAPI('get', '/foreman_kernel_care/plugin_template_description')
-  
-
-  const storybookBtn = (
-    <Button onClick={() => window.open(FOREMAN_STORYBOOK, '_blank')}>
-      Storybook
-    </Button>
-  );
-
-  switch (status) {
-    case STATUS.ERROR:
-      return (<Alert variant="danger" title={__("Loading description has failed")} />);
-    case STATUS.RESOLVED: return (
-      <EmptyState
-        icon="add-circle-o"
-        action={storybookBtn}
-        header={header}
-        description={description}
-        documentation={false}
-      />
-    )
-    default:
-      return (<SkeletonLoader isLoading={status === STATUS.PENDING} count={5} />);
-  }
-};
-ExtendedEmptyState.PropTypes = {
-  header: PropTypes.string.isRequired
-};
-
-export default ExtendedEmptyState;

data/webpack/src/Components/EmptyState/__tests__/ExtendedEmptyState.test.js

@@ -1,37 +0,0 @@
-// Tests work with react-testing-library or enzyme
-// This test uses react testing library
-// https://testing-library.com/docs/react-testing-library/api
-
-// For more information, test utils, and snapshots testing examples:
-// https://github.com/theforeman/foreman-js/tree/master/packages/test
-
-
-import React from 'react';
-import { createStore, applyMiddleware, combineReducers } from 'redux';
-import { render, waitFor, screen } from '@testing-library/react'
-import { Provider } from 'react-redux';
-
-import { reducers as APIReducer } from 'foremanReact/redux/API';
-import { middlewares } from 'foremanReact/redux/middlewares';
-import APIHelper from 'foremanReact/redux/API/API';
-import ExtendedEmptyState from '../ExtendedEmptyState';
-
-jest.mock('foremanReact/redux/API/API');
-
-const reducers = combineReducers(APIReducer);
-const store = createStore(reducers, applyMiddleware(...middlewares));
-const wrapper = ({ children }) => (
-  <Provider store={store}>{children}</Provider>
-);
-describe('foreman plugin template', () => {
-  it('should render an error alert', async () => {
-    APIHelper.get.mockRejectedValue({ error: new Error() });
-    render(<ExtendedEmptyState />, { wrapper });
-    await waitFor(() => expect(screen.getByText('Loading description has failed')).toBeInTheDocument());
-  });
-  it('should render an empty state with custom description', async () => {
-    APIHelper.get.mockResolvedValue({ data: { description: 'some description' } });
-    render(<ExtendedEmptyState />, { wrapper });
-    await waitFor(() => expect(screen.getByText('some description')).toBeInTheDocument());
-  });
-});

data/webpack/src/Extends/index.js

@@ -1,15 +0,0 @@
-// This is an example of extending foreman-core's component via slot&fill
-// http://foreman.surge.sh/?path=/docs/introduction-slot-and-fill--page
-/*
-import React from 'react';
-import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
-
-addGlobalFill('slotId', 'fillId', <SomeComponent key="some-key" />, 300);
-
-addGlobalFill(
-  'slotId',
-  'fillId',
-  { someProp: 'this is an override prop' },
-  300
-);
-*/

data/webpack/src/Router/WelcomePage/Welcome.js

@@ -1,9 +0,0 @@
-import React from 'react';
-import ExtendedEmptyState from '../../Components/EmptyState/ExtendedEmptyState';
-import { translate as __ } from 'foremanReact/common/I18n';
-
-const WelcomePage = () => (
-  <ExtendedEmptyState header={__("Welcome to the plugin template")} />
-);
-
-export default WelcomePage;

data/webpack/src/Router/WelcomePage/index.js

@@ -1 +0,0 @@
-export { default } from './Welcome';

data/webpack/src/Router/routes.js

@@ -1,12 +0,0 @@
-import React from 'react';
-import WelcomePage from './WelcomePage';
-
-const routes = [
-  {
-    path: '/foreman_kernel_care/welcome',
-    exact: true,
-    render: (props) => <WelcomePage {...props} />,
-  },
-];
-
-export default routes;

data/webpack/src/reducers.js

@@ -1,10 +0,0 @@
-import { combineReducers } from 'redux';
-import EmptyStateReducer from './Components/EmptyState/EmptyStateReducer';
-
-const reducers = {
-  foremanKernelCare: combineReducers({
-    emptyState: EmptyStateReducer,
-  }),
-};
-
-export default reducers;

data/webpack/test_setup.js

@@ -1,17 +0,0 @@
-import 'core-js/shim';
-import 'regenerator-runtime/runtime';
-import MutationObserver from '@sheerun/mutationobserver-shim';
-
-import { configure } from 'enzyme';
-import Adapter from 'enzyme-adapter-react-16';
-
-configure({ adapter: new Adapter() });
-
-// Mocking translation function
-global.__ = text => text; // eslint-disable-line
-
-// Mocking locales to prevent unnecessary fallback messages
-window.locales = { en: { domain: 'app', locale_data: { app: { '': {} } } } };
-
-// see https://github.com/testing-library/dom-testing-library/releases/tag/v7.0.0
-window.MutationObserver = MutationObserver;