foreman_patch 1.1.1

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+require 'rake-version'
+
+RakeVersion::Tasks.new do |version|
+  version.copy 'lib/foreman_patch/version.rb'
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanPatch'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue => _
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/assets/javascript/foreman_patch/plan_edit_windows.js

@@ -0,0 +1,9 @@
+function remove_window_plan(window_plan_id) {
+  $('#windowPlan' + window_plan_id).remove();
+}
+
+function edit_window_plan(window_plan_id) {
+  if (window_plan_id == null) form = null;
+  else form = $('#windowPlans #windowPlanHidden' + window_plan_id);
+  //show_window_plan_modal();
+}

data/app/assets/stylesheets/foreman_patch/cycle_plans.scss

@@ -0,0 +1,6 @@
+div.event {
+  margin: 2px 10px;
+  border: 1px solid black;
+  border-color: #d1d1d1;
+  padding: 2px 3px;
+}

data/app/assets/stylesheets/foreman_patch/foreman_patch.css

@@ -0,0 +1,4 @@
+/*
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/concerns/foreman_patch/parameters/ticket_field.rb

@@ -0,0 +1,26 @@
+module ForemanPatch
+  module Parameters
+    module TicketField
+      extend ActiveSupport::Concern
+      include Foreman::Controller::Parameters::LookupKey
+
+      class_methods do
+        def ticket_field_params_filter
+          Foreman::ParameterFilter.new(ForemanPatch::TicketField).tap do |filter|
+            filter.permit_by_context :required, nested: true
+            filter.permit_by_context :id, ui: false, api: false, nested: true
+
+            add_lookup_key_params_filter(filter)
+          end
+        end
+      end
+
+      def ticket_field_params
+        self.class.ticket_field_params_filter.filter_params(
+          params,
+          parameter_filter_context
+        )
+      end
+    end
+  end
+end

data/app/controllers/foreman_patch/api/v2/base_controller.rb

@@ -0,0 +1,12 @@
+module ForemanPatch
+  module Api
+    module V2
+      class BaseController < ::Api::V2::BaseController
+        resource_description do
+          api_version '2'
+          api_base_url '/foreman_patch/api'
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_patch/api/v2/cycles_controller.rb

@@ -0,0 +1,78 @@
+module ForemanPatch
+  module Api
+    module V2
+      class CyclesController < BaseController
+
+        resource_description do
+          resource_id 'patch_cycles'
+          api_version 'v2'
+          api_base_url '/foreman_patch/api'
+        end
+
+        before_action :find_optional_nested_object
+        before_action :find_resource, only: [:show, :update, :destroy]
+
+        api :GET, '/cycles', N_('List cycles')
+        api :GET, '/plans/:plan_id/cycles', N_('List cycles created from cycle plan')
+        param :plan_id, Integer, desc: N_('ID of the cycle plan')
+        param_group :search_and_pagination, ::Api::V2::BaseController
+        add_scoped_search_description_for(Cycle)
+        def index
+          @cycles = resource_scope_for_index
+        end
+
+        api :GET, '/cycles/:id', N_('Show cycle details')
+        param :id, :identifier, desc: N_('Id of the group'), required: true
+        def show
+        end
+
+        def_param_group :cycle do
+          param :cycle, Hash, required: true, action_aware: true do
+            param :name, String, desc: N_('Name of the patch cycle')
+            param :description, String, desc: N_('Description of the patch cycle')
+            param :start_date, Date, desc: N_('Start date of the patch cycle'), required: true
+            param :end_date, Date, desc: N_('End date of the patch cycle'), required: true
+          end
+        end
+
+        api :POST, '/plans/:plan_id/cycle', N_('Create a new patch cycle')
+        api :POST, '/cycles', N_('Create a new patch cycle')
+        param :plan_id, Integer, desc: N_('Id of the cycle plan')
+        param_group :cycle, as: :create
+        def create
+          @cycle = Cycle.new(cycle_params)
+          process_response @cycle.save
+        end
+
+        api :PUT, '/cycles/:id', N_('Update a patch cycle')
+        param_group :cycle
+        def update
+          process_response @cycle.update(cycle_params)
+        end
+
+        api :DELETE, '/plans/:id', N_('Destroy a cycle plan')
+        param :id, Integer, desc: N_('Id of the cycle plan')
+        def destroy
+          process_response @cycle.destroy
+        end
+
+        def resource_class
+          ForemanPatch::Cycle
+        end
+
+        private
+
+        def allowed_nested_id
+          %w(plan_id)
+        end
+
+        def cycle_params
+          params[:cycle][:plan_id] = params[:plan_id] unless params[:plan_id].nil?
+          params.require(:cycle).permit(:name, :description, :start_date, :plan_id)
+        end
+
+      end
+    end
+  end
+end
+

data/app/controllers/foreman_patch/api/v2/groups_controller.rb

@@ -0,0 +1,70 @@
+module ForemanPatch
+  module Api
+    module V2
+      class GroupsController < BaseController
+
+        resource_description do
+          resource_id 'patch_groups'
+          api_version 'v2'
+          api_base_url '/foreman_patch/api'
+        end
+
+        before_action :find_resource, only: [:update, :show, :destroy]
+
+        api :GET, '/groups', N_('List groups')
+        param_group :search_and_pagination, ::Api::V2::BaseController
+        add_scoped_search_description_for(Group)
+        def index
+          @groups = resource_scope_for_index
+        end
+
+        api :GET, '/groups/:id', 'Show group details'
+        param :id, :identifier, desc: 'Id of the group', required: true
+        def show
+        end
+
+        def_param_group :group do
+          param :group, Hash, required: true, action_aware: true do
+            param :name, String, desc: N_('Name of the patch group'), required: true
+            param :description, String, desc: N_('Description of the patch group')
+            param :default_window_plan_id, Integer, desc: N_('ID of the default window plan')
+            param :max_unavailable, Integer, desc: N_('Maximum number of hosts that can be patched at a time')
+            param :priority, Integer, desc: N_('Default priority of group within its window (Lowest goes first)')
+          end
+        end
+
+        api :POST, '/groups', N_('Create a new patch group')
+        param_group :group, as: :create
+        def create
+          @group = Group.new(group_params)
+          process_response @group.save
+        end
+
+        api :PUT, '/groups/:id', N_('Update a patch group')
+        param :id, Integer, desc: N_('ID of the group'), required: true
+        param_group :group
+        def update
+          process_response @group.update(group_params)
+        end
+
+        api :DELETE, '/groups/:id', N_('Destroy a patch group')
+        param :id, Integer, desc: N_('ID of the group'), required: true
+        def destroy
+          process_response @group.destroy
+        end
+
+        def resource_class
+          ForemanPatch::Group
+        end
+
+        private
+
+        def group_params
+          params.require(:group).permit(:name, :description, :default_window_plan_id, :max_unavailable, :priority, :template_id)
+        end
+
+      end
+    end
+  end
+end
+

data/app/controllers/foreman_patch/api/v2/host_groups_controller.rb

@@ -0,0 +1,13 @@
+module ForemanPatch
+  module Api
+    module V2
+      class HostGroupsController < BaseController
+        def_param_group :group_facet_attributes do
+          param :group_id, Integer, desc: N_('Id of the default patch group')
+          param :schedule, ['all', 'future-only', 'none'], desc: N_('Schedule host for patching on update, defaults to future-only')
+        end
+      end
+    end
+  end
+end
+

data/app/controllers/foreman_patch/api/v2/invocations_controller.rb

@@ -0,0 +1,70 @@
+module ForemanPatch
+  module Api
+    module V2
+      class InvocationsController < BaseController
+        
+        resource_description do
+          resource_id 'patch_invocations'
+          api_version 'v2'
+          api_base_url '/foreman_patch/api'
+        end
+
+        before_action :find_round, only: [:index]
+        before_action :find_resource, only: [:show, :update, :delete]
+
+        api :GET, '/rounds/:round_id/invocations', N_('List patch invocations for a patch group')
+        param :round_id, :identifier, required: true
+        param_group :search_and_pagination, ::Api::V2::BaseController
+        add_scoped_search_description_for(Invocation)
+        def index
+          @invocations = resource_scope_for_index
+        end
+
+        api :GET, '/invocations/:id', N_('Get details of an invocation')
+        param :id, :identifier, required: true
+        def show
+          @invocation = ForemanPatch::Invocation.find(params[:id])
+        end
+
+        api :PUT, '/invocations/:id', N_('Move the invocation to another round')
+        param :id, :identifier, required: true
+        param :invocation, Hash, required: true do
+          param :round_id, Integer, required: true
+        end
+        def update
+          process_response @invocation.update(invocation_params)
+        end
+
+        api :DELETE, 'invocations/:id', N_('Delete the patch invocation')
+        param :id, :identifier, required: true
+        def destroy
+          process_response @invocation.destroy
+        end
+
+        def resource_class
+          ForemanPatch::Invocation
+        end
+
+        def resource_scope(options = {})
+          if action_name == 'index'
+            @round.invocations.includes(:host).where(host: ::Host.authorized(:view_hosts, ::Host))
+          else
+            super(options)
+          end
+        end
+
+        private
+
+        def find_round
+          @round ||= ForemanPatch::Round.find(params[:round_id])
+        end
+
+        def invocation_params
+          params.require(:invocation).permit(:round_id)
+        end
+
+      end
+    end
+  end
+end
+

data/app/controllers/foreman_patch/api/v2/plans_controller.rb

@@ -0,0 +1,79 @@
+module ForemanPatch
+  module Api
+    module V2
+      class PlansController < BaseController
+
+        resource_description do
+          resource_id 'patch_plans'
+          api_version 'v2'
+          api_base_url '/foreman_patch/api'
+        end
+
+        before_action :find_resource, only: [:show, :update, :iterate, :destroy]
+
+        api :GET, '/plans', N_('List cycle plans')
+        param_group :search_and_pagination, ::Api::V2::BaseController
+        add_scoped_search_description_for(Plan)
+        def index
+          @plans = resource_scope_for_index
+        end
+
+        api :GET, '/plans/:id', 'Show cycle plan details'
+        param :id, :identifier, desc: 'Id of the group'
+        def show
+        end
+
+        def_param_group :plan do
+          param :plan, Hash, required: true, action_aware: true do
+            param :name, String, desc: N_('Name of the cycle plan'), required: true
+            param :description, String, desc: N_('Description of the cycle plan')
+            param :cycle_name, String, desc: N_('Erb script used to generate each cycle\'s name')
+            param :start_date, String, desc: N_('Date of the first execution of cycle plan'), required: true
+            param :interval, Integer, desc: N_('Number of units between cycles'), required: true
+            param :units, Plan::UNITS, desc: N_('Unit of count between cycles'), required: true
+            param :correction, Plan::CORRECTIONS, desc: N_('Correction applied to each start date')
+            param :active_count, Integer, desc: N_('Number of cycles to have active/planned'), required: true
+          end
+        end
+
+        api :POST, '/plans', 'Create a new cycle plan'
+        param_group :plan, as: :create
+        def create
+          @plan = Plan.new(plan_params)
+          process_response @plan.save
+        end
+
+        api :PUT, '/plans/:id', N_('Update a cycle plan')
+        param :id, Integer, desc: N_('Id of cycle plan'), required: true
+        param_group :plan
+        def update
+          process_response @plan.update(plan_params)
+        end
+
+        api :POST, '/plans/:id/iterate', N_('Manually iterate a cycle plan')
+        param :id, Integer, desc: N_('Id of cycle plan'), required: true
+        def iterate
+          process_response @plan.iterate
+        end
+
+        api :DELETE, '/plans/:id', N_('Destroy a cycle plan')
+        param :id, Integer, desc: N_('Id of the cycle plan')
+        def destroy
+          process_response @plan.destroy
+        end
+
+        def resource_class
+          ForemanPatch::Plan
+        end
+
+        private
+
+        def plan_params
+          params.require(:plan).permit(:name, :description, :cycle_name, :start_date, :interval, :units, :correction, :active_count)
+        end
+
+      end
+    end
+  end
+end
+

data/app/controllers/foreman_patch/api/v2/rounds_controller.rb

@@ -0,0 +1,77 @@
+module ForemanPatch
+  module Api
+    module V2
+      class RoundsController < BaseController
+
+        resource_description do
+          resource_id 'patch_rounds'
+          api_version 'v2'
+          api_base_url '/foreman_patch/api'
+        end
+
+        before_action :find_resource, only: [:update, :show, :status, :update, :destroy]
+
+        api :GET, '/rounds', N_('List rounds')
+        api :GET, '/windows/:window_id/rounds'. N_('List window groups within a given window')
+        param :window_id, :identifier
+        param_group :search_and_pagination, ::Api::V2::BaseController
+        add_scoped_search_description_for(Round)
+        def index
+          @rounds = resource_scope_for_index(params.permit(:window_id))
+        end
+
+        api :GET, '/rounds/:id', 'Show round details'
+        param :id, :identifier, desc: 'Id of the round', required: true
+        def show
+        end
+
+        api :GET, '/rounds/:id/status', N_('Get status of patch round')
+        param :id, :identifier, desc: N_('Id of the patch round'), required: true
+        def status
+        end
+
+        def_param_group :round do
+          param :round, Hash, required: true, action_aware: true do
+            param :name, String, desc: N_('Name of the patch round'), required: true
+            param :description, String, desc: N_('Description of the patch round')
+            param :window_id, Integer, desc: N_('ID of the window'), required: true
+            param :group_id, Integer, desc: N_('ID of the Group')
+            param :max_unavailable, Integer, desc: N_('Maximum number of hosts that can be patched at a time')
+            param :priority, Integer, desc: N_('Default priority of round within its window (Lowest goes first)')
+          end
+        end
+
+        api :POST, '/rounds', N_('Create a new patch round')
+        param_group :round, as: :create
+        def create
+          @round = Round.new(round_params)
+          process_response @round.save
+        end
+
+        api :PUT, '/rounds/:id', N_('Update a patch round')
+        param :id, Integer, desc: N_('ID of the round'), required: true
+        param_group :round
+        def update
+          process_response @round.update(round_params)
+        end
+
+        api :DELETE, '/rounds/:id', N_('Destroy a patch round')
+        param :id, Integer, desc: N_('ID of the round'), required: true
+        def destroy
+          process_response @round.destroy
+        end
+
+        def resource_class
+          ForemanPatch::Round
+        end
+
+        private
+
+        def round_params
+          params.require(:round).permit(:name, :description, :window_id, :group_id, :max_unavailable, :priority)
+        end
+      end
+    end
+  end
+end
+

data/app/controllers/foreman_patch/api/v2/window_plans_controller.rb

@@ -0,0 +1,73 @@
+module ForemanPatch
+  module Api
+    module V2
+      class WindowPlansController < BaseController
+
+        resource_description do
+          resource_id 'patch_window_plans'
+          api_version 'v2'
+          api_base_url '/foreman_patch/api'
+        end
+
+        before_action :find_resource, only: [:show, :update, :destroy]
+
+        api :GET, '/plans/:plan_id/window_plans', N_('List window plans per cycle plan')
+        param :plan_id, Integer, desc: N_('ID of the cycle plan')
+        param_group :search_and_pagination, ::Api::V2::BaseController
+        add_scoped_search_description_for(WindowPlan)
+        def index
+          @window_plans = resource_scope_for_index(params.permit(:plan_id))
+        end
+
+        api :GET, '/window_plans/:id', 'Show window plan details'
+        param :id, :identifier, desc: 'Id of the group'
+        def show
+        end
+
+        def_param_group :window_plan do
+          param :window_plan, Hash, required: true, action_aware: true do
+            param :name, String, desc: N_('Name of the window plan'), required: true
+            param :description, String, desc: N_('Description of the window plan')
+            param :start_day, Integer, desc: N_('Day of execution of the window plan relative to cycle start'), required: true
+            param :start_time, String, desc: N_('Number of windows to have active/planned'), required: true
+            param :duration, Integer, desc: N_('Duration of the patch window in seconds'), required: true
+          end
+        end
+
+        api :POST, '/plans/:plan_id/window_plans', 'Create a new window plan'
+        param :plan_id, Integer, desc: N_('Id of plan')
+        param_group :window_plan, as: :create
+        def create
+          @window_plan = WindowPlan.new(window_plan_params)
+          process_response @window_plan.save
+        end
+
+        api :PUT, '/window_plans/:id', N_('Update a window plan')
+        param :id, Integer, desc: N_('Id of window plan')
+        param_group :window_plan
+        def update
+          process_response @window_plan.update(window_plan_params)
+        end
+
+        api :DELETE, '/window_plans/:id', N_('Destroy a window plan')
+        param :id, Integer, desc: N_('Id of the window plan')
+        def destroy
+          process_response @window_plan.destroy
+        end
+
+        def resource_class
+          ForemanPatch::WindowPlan
+        end
+
+        private
+
+        def window_plan_params
+          params[:window_plan][:plan_id] = params[:plan_id] unless params[:plan_id].nil?
+          params.require(:window_plan).permit(:name, :description, :start_day, :start_time, :duration, :plan_id)
+        end
+
+      end
+    end
+  end
+end
+

data/app/controllers/foreman_patch/api/v2/windows_controller.rb

@@ -0,0 +1,85 @@
+module ForemanPatch
+  module Api
+    module V2
+      class WindowsController < BaseController
+
+        resource_description do
+          resource_id 'patch_windows'
+          api_version 'v2'
+          api_base_url '/foreman_patch/api'
+        end
+
+        before_action :find_resource, only: [:show, :update, :destroy]
+
+        api :GET, '/cycles/:cycle_id/windows', N_('List windows from cycle')
+        param :cycle_id, Integer, desc: N_('ID of the cycle')
+        param_group :search_and_pagination, ::Api::V2::BaseController
+        add_scoped_search_description_for(Window)
+        def index
+          @windows = resource_scope_for_index(params.permit(:cycle_id))
+        end
+
+        api :GET, '/windows/:id', 'Show window details'
+        param :id, Integer, desc: N_('ID of the window'), required: true
+        def show
+        end
+
+        def_param_group :window do
+          param :window, Hash, required: true, action_aware: true do
+            param :name, String, desc: N_('Name of the patch window'), required: true
+            param :description, String, desc: N_('Description of the patch window')
+            param :window_plan_id, Integer, desc: N_('ID of the window plan to execute')
+            param :start_at, Time, desc: N_('Start time of the patch window'), required: true
+            param :end_by, Time, desc: N_('End time of the patch window'), required: true
+          end
+        end
+
+        api :POST, '/cycles/:cycle_id/windows', N_('Create a new patch window')
+        param :cycle_id, Integer, N_('ID of the patch cycle'), required: true
+        param_group :window, as: :create
+        def create
+          @window = Window.new(window_params)
+          process_response @window.save
+        end
+
+        api :PUT, '/windows/:id', N_('Update a window')
+        param :id, Integer, desc: N_('ID of the window')
+        param_group :window
+        def update
+          process_response @window.update(window_params)
+        end
+
+        api :DELETE, '/windows/:id', N_('Destroy a window')
+        param :id, Integer, desc: N_('ID of the window')
+        def destroy
+          process_response @window.destroy
+        end
+
+        api :POST, '/windows/:id/schedule', N_('Schedule a window')
+        param :id, Integer, desc: N_('ID of the window')
+        def schedule
+          ::ForemanTasks.delay(::Actions::ForemanPatch::Window::Patch, delay_options, @window)
+        end
+
+        def resource_class
+          ForemanPatch::Window
+        end
+
+        private
+
+        def delay_options
+          {
+            start_at: @window.start_at.utc,
+            end_by: @window.end_by.try(:utc)
+          }
+        end
+
+        def window_params
+          params[:window][:cycle_id] = params[:cycle_id] unless params[:cycle_id].nil?
+          params.require(:window).permit(:name, :description, :start_at, :end_by, :cycle_id, :window_plan_id)
+        end
+
+      end
+    end
+  end
+end