foreman_omaha 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d3ec4d257a6b23da8a778b2c6c7646bda239ed8a
-  data.tar.gz: 72996f1f0545e2c51e9bda9d0d1ec3c1765ff483
+SHA256:
+  metadata.gz: 6ad84de9035d283fda62edcb31c461f88ef3811ce4caa64c2f7b299ec9c20474
+  data.tar.gz: 3884e00feb8dff9ca2409006709f344e7085085b11e923058188101b8a196022
 SHA512:
-  metadata.gz: 49351ba242b536b61204bd5dde6f559a843e979c7de3e3fddb1a3e7c0e104bd5303fdcce6d7fcb4e3bb3a2d9639a6af872e14167289c5d02164b02a2b0acd314
-  data.tar.gz: afcc44fb7da39ece8712fd38d18d9dd1e7cff99e938284b90b5d2a4d0909924753f410a189b25f8b67ce8827ab64532917afa3677d73fb0084353f6bd24b3557
+  metadata.gz: c0a3e1ffe8c2d3fee38ccc48edfed5ed12e9416fd123378c08f92772386efec252bcf5f2615539d1667292c439e95535f06133700df04f94529a482a6068cdf6
+  data.tar.gz: efd82da861cc6e7a6515136df34c4cfc46cd6eb7b6d3a5f480468778bdce57fcab7142c0d0cb9f50587cfda96f26f7bfbddc301681101e22e2424cc35eb667ce

data/README.md

@@ -1,14 +1,15 @@
 # ForemanOmaha
 
 This plug-in enables CoreOS updates using [The Foreman](https://theforeman.org/) without using the public update infrastructure.
-To follow along with common Foreman architecture, you need this Foreman plug-in installed and a [Smart-Proxy plugin](https://github.com/timogoebel/smart_proxy_omaha). The smart-proxy plug-in does all the heavy lifting. The Foreman plug-in shows facts and reports for your hosts.
+To follow along with common Foreman architecture, you need this Foreman plug-in installed and a [Smart-Proxy plugin](https://github.com/theforeman/smart_proxy_omaha). The smart-proxy plug-in does all the heavy lifting. The Foreman plug-in shows facts and reports for your hosts.
 Foreman core already supports deploying CoreOS hosts and is great for on-premise setups. This plug-in enables you to better manage your servers.
 
 ## Compatibility
 
 | Foreman Version | Plugin Version |
 | --------------- | -------------- |
-| >= 1.12         | any            |
+| >= 1.12         | ~> 0.0         |
+| >= 1.17         | ~> 1.0         |
 
 ## Installation
 
@@ -22,6 +23,8 @@ To prepare the Foreman database, issue the following command:
 foreman-rake db:migrate SCOPE=foreman_omaha
 ```
 
+This plugins adds a global method `transpile_container_linux_config` to the template renderer that transpiles yaml to ignition. Make sure the binary [ct](https://github.com/coreos/container-linux-config-transpiler) is in your `PATH` when you want to use this feature.
+
 ## Uninstalling
 
 You need to revert all database changes made when installing this plug-in:

data/app/assets/javascripts/foreman_omaha/application.js

@@ -0,0 +1 @@
+//= require jquery.matchHeight

data/app/assets/stylesheets/foreman_omaha/version_breakdown.scss

@@ -0,0 +1,13 @@
+.version-breakdown {
+  .progress {
+    overflow: hidden;
+    text-overflow: ellipsis;
+  }
+
+  .progress-bar {
+    a {
+      color: white;
+      text-decoration: none;
+    }
+  }
+}

data/app/controllers/api/v2/omaha_groups_controller.rb

@@ -0,0 +1,29 @@
+module Api
+  module V2
+    class OmahaGroupsController < V2::BaseController
+      include Api::Version2
+
+      before_action :find_resource, :only => [:show]
+      before_action :setup_search_options, :only => [:index]
+
+      api :GET, '/omaha_groups/', N_('List all omaha groups')
+      param_group :search_and_pagination, ::Api::V2::BaseController
+
+      def index
+        @omaha_groups = resource_scope_for_index
+        @total = resource_scope_for_index.count
+      end
+
+      api :GET, '/omaha_groups/:id/', N_('Show a Omaha Group')
+      param :id, :identifier, :required => true, :desc => N_('Id of the Omaha Group')
+
+      def show; end
+
+      private
+
+      def resource_class
+        ::ForemanOmaha::OmahaGroup
+      end
+    end
+  end
+end

data/app/controllers/api/v2/omaha_reports_controller.rb

@@ -13,10 +13,13 @@ module Api
       def_param_group :omaha_report do
         param :report, Hash, :required => true, :action_aware => true do
           param :host, String, :required => true, :desc => N_('Hostname or certname')
-          param :status, String,
+          param :status, ::ForemanOmaha::OmahaReport.statuses.keys,
                 :required => true,
-                :desc => N_('Omaha status, can be one of %s') % ::ForemanOmaha::OmahaReport.statuses.keys.to_sentence
-          param :omaha_version, String, :required => true, :desc => N_('Omaha OS version')
+                :desc => N_('Omaha update status')
+          param :omaha_version, String, :required => true, :desc => N_('Omaha OS version using semantic versioning, e.g. 1590.0.0')
+          param :machineid, String, :required => true, :desc => N_('Unique machine id of the host')
+          param :omaha_group, String, :required => true, :desc => N_('The uuid if the channel that the host is attached to. Use alpha, beta or stable for built-in channels.')
+          param :oem, String, :desc => N_('OEM identifier')
         end
       end
 
@@ -37,7 +40,7 @@ module Api
       param_group :omaha_report, :as => :create
 
       def create
-        @omaha_report = resource_class.import(params[:omaha_report], detected_proxy.try(:id))
+        @omaha_report = resource_class.import(params.to_unsafe_h[:omaha_report], detected_proxy.try(:id))
         process_response @omaha_report.errors.empty?
       rescue ::Foreman::Exception => e
         render_message(e.to_s, :status => :unprocessable_entity)
@@ -51,12 +54,11 @@ module Api
       end
 
       api :GET, '/hosts/:host_id/omaha_reports/last', N_('Show the last report for a host')
+      param :host_id, String, :required => true, :desc => N_('ID of host')
       param :id, :identifier, :required => true
 
       def last
-        if params[:host_id].present?
-          conditions = { :host_id => resource_finder(Host.authorized(:view_hosts), params[:host_id]).try(:id) }
-        end
+        conditions = params[:host_id].present? ? { :host_id => resource_finder(Host.authorized(:view_hosts), params[:host_id]).try(:id) } : nil
         max_id = resource_scope.where(conditions).maximum(:id)
         @omaha_report = resource_scope.find(max_id)
         render :show

data/app/controllers/omaha_groups_controller.rb

@@ -0,0 +1,28 @@
+class OmahaGroupsController < ApplicationController
+  include Foreman::Controller::AutoCompleteSearch
+
+  before_action :setup_search_options, :only => :index
+  before_action :find_resource, :only => :show
+
+  def index
+    @omaha_groups = resource_base_with_search
+  end
+
+  def show
+    @out_of_sync = ForemanOmaha::OmahaFacet.where(:omaha_group => @omaha_group).out_of_sync.includes(:host)
+    @latest_operatingsystem = @omaha_group.latest_operatingsystem
+    @status_distribution = ForemanOmaha::Charts::StatusDistribution.new(@omaha_group.hosts)
+    @version_distribution = ForemanOmaha::Charts::VersionDistribution.new(@omaha_group.hosts)
+    @oem_distribution = ForemanOmaha::Charts::OemDistribution.new(@omaha_group.hosts)
+  end
+
+  private
+
+  def model_of_controller
+    ::ForemanOmaha::OmahaGroup
+  end
+
+  def resource_class
+    ::ForemanOmaha::OmahaGroup
+  end
+end

data/app/controllers/omaha_hosts_controller.rb

@@ -0,0 +1,42 @@
+class OmahaHostsController < ApplicationController
+  include Foreman::Controller::AutoCompleteSearch
+  include ScopesPerAction
+
+  before_action :setup_search_options, :only => :index
+
+  add_scope_for(:index) do |base_scope|
+    base_scope.includes(:operatingsystem).includes(:omaha_facet).includes(:omaha_facet => :omaha_group)
+  end
+
+  def index
+    @hosts = action_scope_for(:index, resource_base_with_search)
+    @last_report_ids = ForemanOmaha::OmahaReport.where(:host_id => @hosts.map(&:id)).group(:host_id).maximum(:id)
+  end
+
+  def welcome
+    if begin
+          resource_base.first.nil?
+        rescue StandardError
+          false
+        end
+      @welcome = true
+      render :welcome
+    end
+  rescue StandardError
+    not_found
+  end
+
+  protected
+
+  def model_of_controller
+    ::Host::Managed
+  end
+
+  def resource_base
+    super.joins(:omaha_facet)
+  end
+
+  def controller_permission
+    'hosts'
+  end
+end

data/app/controllers/omaha_reports_controller.rb

@@ -42,17 +42,6 @@ class OmahaReportsController < ApplicationController
     end
   end
 
-  # TODO: Remove for Foreman 1.14+
-  def resource_base_with_search
-    resource_base.search_for(params[:search], :order => params[:order])
-  end
-
-  # TODO: Remove for Foreman 1.14+
-  def resource_base_search_and_page(tables = [])
-    base = tables.empty? ? resource_base_with_search : resource_base_with_search.eager_load(*tables)
-    base.paginate(:page => params[:page], :per_page => params[:per_page])
-  end
-
   private
 
   def resource_base

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

@@ -2,14 +2,23 @@ module ForemanOmaha
   module HostsHelperExtensions
     extend ActiveSupport::Concern
 
-    included do
-      alias_method_chain :show_appropriate_host_buttons, :foreman_omaha
+    module Overrides
+      def show_appropriate_host_buttons(host)
+        buttons = super
+        if host.omaha_reports.any?
+          buttons << link_to_if_authorized(
+            _('Omaha'),
+            hash_for_host_omaha_reports_path(:host_id => host),
+            :title => _('Browse host omaha reports'),
+            :class => 'btn btn-default'
+          )
+        end
+        buttons.compact
+      end
     end
 
-    def show_appropriate_host_buttons_with_foreman_omaha(host)
-      buttons = show_appropriate_host_buttons_without_foreman_omaha(host)
-      buttons << (link_to_if_authorized(_('Omaha'), hash_for_host_omaha_reports_path(:host_id => host), :title => _('Browse host omaha reports'), :class => 'btn btn-default') if host.omaha_reports.any?)
-      buttons.compact
+    included do
+      prepend Overrides
     end
   end
 end

data/app/helpers/foreman_omaha/application_helper.rb

@@ -0,0 +1,7 @@
+module ForemanOmaha
+  module ApplicationHelper
+    def facets_count(association, resource_name = controller.resource_name)
+      @facets_count ||= Host::Managed.reorder('').authorized.joins(association).group("#{resource_name}_id").count
+    end
+  end
+end

data/app/helpers/foreman_omaha/omaha_groups_helper.rb

@@ -0,0 +1,52 @@
+module ForemanOmaha
+  module OmahaGroupsHelper
+    def omaha_version_breakdown_bar(omaha_group)
+      stylesheet 'foreman_omaha/version_breakdown'
+      colors = {
+        :success => ['#3f9c35', '#6ec664', '#2d7623'],
+        :warning => ['#ec7a08', '#f7bd7f', '#f39d3c'],
+        :danger => ['#cc0000', '#a30000', '#8b0000', '#470000']
+      }
+      versions = ForemanOmaha::GroupVersionBreakdown.new(:omaha_group => omaha_group).version_breakdown
+      version_list = omaha_group.operatingsystems.pluck(:major, :minor).map { |v| Gem::Version.new(v.join('.')) }.sort.reverse
+      current = version_list.max
+      content_tag :div, :class => 'progress version-breakdown' do
+        safe_join(versions.map do |version|
+          semver = Gem::Version.new(version[:version])
+          position = version_list.index(semver)
+          css = {
+            :width => "#{version[:percentage]}%"
+          }
+          label = if semver > current
+                    :info
+                  elsif semver == current
+                    :success
+                  elsif position == 1
+                    :warning
+                  else
+                    :danger
+                  end
+          if colors.key?(label)
+            color = colors[label].first
+            colors[label].rotate!
+            css[:'background-color'] = color
+          end
+          content_tag :div,
+                      :class => "progress-bar progress-bar-#{label}",
+                      :role => 'progressbar',
+                      :title => version[:version],
+                      :style => css_style(css) do
+            link_to(
+              version[:version],
+              hosts_path(:search => "omaha_group = #{omaha_group} and omaha_version = #{version[:version]}")
+            )
+          end
+        end)
+      end
+    end
+
+    def css_style(hash)
+      hash.map { |k, v| "#{k}: #{v};" }.join(' ')
+    end
+  end
+end

data/app/helpers/omaha_hosts_helper.rb

@@ -0,0 +1,43 @@
+module OmahaHostsHelper
+  def last_omaha_report_column(record)
+    time = record.omaha_facet.last_report? ? _('%s ago') % time_ago_in_words(record.omaha_facet.last_report) : ''
+    link_to_if_authorized(time,
+                          hash_for_host_omaha_report_path(:host_id => record.to_param, :id => 'last'),
+                          last_omaha_report_tooltip(record))
+  end
+
+  def last_omaha_report_tooltip(record)
+    opts = { :rel => 'twipsy' }
+    if @last_report_ids[record.id]
+      opts['data-original-title'] = _('View last report details')
+    else
+      opts.merge!(:disabled => true, :class => 'disabled', :onclick => 'return false')
+      opts['data-original-title'] = _('Report Already Deleted') unless record.omaha_facet.last_report.nil?
+    end
+    opts
+  end
+
+  def list_view_class_for_omaha_status(status)
+    klasses = [
+      iconclass_for_omaha_status(status),
+      'list-view-pf-icon-md'
+    ]
+    klasses << case status.to_sym
+               when :complete
+                 'list-view-pf-icon-success'
+               when :downloading
+                 'list-view-pf-icon-info'
+               when :downloaded
+                 'list-view-pf-icon-success'
+               when :installed
+                 'fa fa-sign-in text-success'
+               when :instance_hold
+                 'list-view-pf-icon-warning'
+               when :error
+                 'list-view-pf-icon-danger'
+               else
+                 'list-view-pf-icon-info'
+               end
+    klasses.join(' ')
+  end
+end

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

@@ -1,11 +1,25 @@
 module ForemanOmaha
   module HostExtensions
     extend ActiveSupport::Concern
+
     included do
       has_many :omaha_reports, :class_name => '::ForemanOmaha::OmahaReport',
-                               :foreign_key => :host_id, :dependent => :destroy
+                               :foreign_key => :host_id, :dependent => :destroy,
+                               :inverse_of => :host
       has_one :last_omaha_report_object, -> { order("#{Report.table_name}.id DESC") },
-              :foreign_key => :host_id, :class_name => '::ForemanOmaha::OmahaReport'
+              :foreign_key => :host_id, :class_name => '::ForemanOmaha::OmahaReport',
+              :inverse_of => :host
+
+      before_save :clear_omaha_facet_on_build
+    end
+
+    def clear_omaha_facet
+      omaha_facet.destroy if omaha_facet
+    end
+
+    def clear_omaha_facet_on_build
+      return unless respond_to?(:old) && old && build? && !old.build?
+      clear_omaha_facet
     end
   end
 end

data/app/models/concerns/foreman_omaha/omaha_facet_host_extensions.rb

@@ -0,0 +1,23 @@
+module ForemanOmaha
+  module OmahaFacetHostExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :omaha_facet, :class_name => '::ForemanOmaha::OmahaFacet', :foreign_key => :host_id, :inverse_of => :host, :dependent => :destroy
+      has_one :omaha_group, :through => :omaha_facet, :inverse_of => :hosts
+
+      accepts_nested_attributes_for :omaha_facet, :update_only => true, :reject_if => ->(attrs) { attrs.values.compact.empty? }
+
+      scoped_search :on => :last_report, :relation => :omaha_facet, :rename => :last_omaha_report, :complete_value => true, :only_explicit => true
+      scoped_search :on => :machineid, :relation => :omaha_facet, :rename => :omaha_machineid, :complete_value => true, :only_explicit => true
+      scoped_search :on => :version, :relation => :omaha_facet, :rename => :omaha_version, :complete_value => true, :only_explicit => true
+      scoped_search :on => :oem, :relation => :omaha_facet, :rename => :omaha_oem, :complete_value => true, :only_explicit => true
+      scoped_search :on => :status, :relation => :omaha_facet, :rename => :omaha_status, :only_explicit => true, :complete_value => {
+        :unknown => 0, :complete => 1, :downloading => 2, :downloaded => 3,
+        :installed => 4, :instance_hold => 5, :error => 6
+      }
+
+      scoped_search :on => :name, :relation => :omaha_group, :complete_value => true, :rename => :omaha_group
+    end
+  end
+end

data/app/models/foreman_omaha/omaha_facet.rb

@@ -0,0 +1,40 @@
+module ForemanOmaha
+  class OmahaFacet < ApplicationRecord
+    include Facets::Base
+
+    VALID_OMAHA_STATUSES = [:unknown, :complete, :downloading, :downloaded,
+                            :installed, :instance_hold, :error].freeze
+
+    enum :status => VALID_OMAHA_STATUSES
+
+    belongs_to :omaha_group, :inverse_of => :omaha_facets, :class_name => 'ForemanOmaha::OmahaGroup'
+
+    scope :out_of_sync, ->(*args) { where(['last_report < ?', (args.first || (30 + Setting[:outofsync_interval]).minutes.ago)]) }
+
+    validates_lengths_from_database
+
+    validates :omaha_group, :presence => true, :allow_blank => false
+    validates :host, :presence => true, :allow_blank => false
+    validates :version, format: { with: /\A[0-9]+\.[0-9]+\.[0-9]+\z/, message: _('must use semantic versioning') }
+
+    def to_status_label
+      status_mapper.to_label
+    end
+
+    def major
+      return unless version
+      version.split('.').first
+    end
+
+    def minor
+      return unless version
+      version.split('.').last(2).join('.')
+    end
+
+    private
+
+    def status_mapper
+      StatusMapper.new(status)
+    end
+  end
+end