foreman_statistics 0.1.0

data/app/views/foreman_statistics/trends/_form.html.erb

@@ -0,0 +1,8 @@
+<%= form_for @trend do |f| %>
+  <%= base_errors_for @trend %>
+  <% types = trendable_types %>
+  <%= selectable_f f, :trendable_type, types, { }, :place_holder => _('Please Select'), :onchange => 'tfm.trends.trendTypeSelected(this)' %>
+  <%= select_f(f, :trendable_id, FactName.no_timestamp_fact, :id, :name, { :include_blank => true }, :disabled => types.first[1] != 'FactName') %>
+  <%= text_f f, :name, :disabled => types.first[1] != 'FactName' %>
+  <%= submit_or_cancel f %>
+<% end %>

data/app/views/foreman_statistics/trends/_hosts.html.erb

@@ -0,0 +1,13 @@
+<% @trend.find_hosts.in_groups(4, false) do |group| %>
+  <div class="col-md-3">
+    <td>
+      <% group.each do |host| %>
+        <ul class="base">
+          <li>
+            <%= link_to(host, host_path(:id => host), :title => _("Show Host")) %>
+          </li>
+        </ul>
+      <% end %>
+    </td>
+  </div>
+<% end %>

data/app/views/foreman_statistics/trends/edit.html.erb

@@ -0,0 +1,46 @@
+<% title _("Edit Trend %s") % @trend.to_label %>
+<div class="col-md-6">
+  <%= form_tag trend_path, :method => :put do %>
+    <% if @trend.is_a?(ForemanStatistics::FactTrend) %>
+      <table class="table">
+        <thead>
+          <tr>
+            <th style='width: 40%'><%= _("Fact Name") %></th>
+            <th style="width: 60%"><%= _("Display Name") %></th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr>
+            <%= fields_for "trend[]", @trend do |f| %>
+              <td>
+                <%= @trend.fact_name %>
+              </td>
+              <td>
+                <%= f.text_field :name %>
+              </td>
+            <% end %>
+          </tr>
+        </tbody>
+      </table>
+    <% end %>
+    <table class="table">
+      <thead>
+        <tr>
+          <th style="width: 40%">Value</th>
+          <th style="width: 60%"><%= _("Display Name") %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @trend.values.each do |trend| %>
+          <tr>
+            <%= fields_for "trend[]", trend do |f| %>
+              <%= render 'fields', :f => f, :trend => trend %>
+            <% end %>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+    <%= link_to(_("Cancel"), trends_path, :class => "btn btn-default") %>
+    <%= submit_tag _("Submit"), :class => "btn-primary btn" %>
+  <% end %>
+</div>

data/app/views/foreman_statistics/trends/index.html.erb

@@ -0,0 +1,39 @@
+<%= javascript 'charts' %>
+<% title _("Trends") %>
+<% title_actions new_link(_("Add Trend Counter")),
+                 documentation_button('4.1.3Trends') %>
+<% if @trends.empty? %>
+  <%= alert :class => 'alert-info', :header => _("No trend counter defined"),
+            :text => (_("To define trend counters, use the Add Trend Counter button.</br> To start collecting trend data, set a cron job to execute 'foreman-rake foreman_statistics:trends:counter' at least every %s minutes.") % Setting[:outofsync_interval]).html_safe %>
+<% end %>
+
+<% if @trends.any? and ForemanStatistics::TrendCounter.unconfigured? %>
+  <%= alert :class => 'alert-info', :header => _("No trend counter found"),
+            :text => (_("To start collecting trend data, set a cron job to execute <span class='black'>foreman-rake foreman_statistics:trends:counter</span> at least every %s minutes.") % Setting[:outofsync_interval]).html_safe %>
+<% end %>
+
+<table class="<%= table_css_classes 'table-fixed' %>">
+  <thead>
+    <tr>
+      <th class='col-md-10'><%= _("Name") %></th>
+      <th class='col-md-2'><%= _("Action") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @trends.each do |trend| %>
+      <tr>
+        <td class="ellipsis"><%= link_to trend.to_label, trend_path(:id => trend), :title => _("Show Trends") %></td>
+        <td>
+          <%= action_buttons(
+                  display_link_if_authorized(_("Edit"), hash_for_edit_trend_path(:id => trend)),
+                  display_delete_if_authorized(hash_for_trend_path(:id => trend), :data => { :confirm => _("Delete all the trend history for %s?") % trend.type_name })) %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+<%= will_paginate_with_info @trends %>
+<% unless ForemanStatistics::TrendCounter.unconfigured? %>
+  <%= _("Last update:") %>
+  <%= date_time_relative(ForemanStatistics::TrendCounter.order(:created_at).last.created_at) %>
+<% end %>

data/app/views/foreman_statistics/trends/new.html.erb

@@ -0,0 +1,4 @@
+<% title _("Create Trend") %>
+<% javascript *webpack_asset_paths('foreman_statistics', :extension => 'js') %>
+
+<%= render :partial => 'form' %>

data/app/views/foreman_statistics/trends/show.html.erb

@@ -0,0 +1,25 @@
+<%= javascript 'charts' %>
+<% title(_("Trends for %s") % trend_title(@trend)) %>
+<% content_for(:search_bar) { trend_days_filter(@trend) } %>
+<div class="row">
+  <div class="stats-well col-md-12">
+    <h4 class="ca"><%= "#{trend_title(@trend)}" %></h4>
+    <h6 class="ca"><%= n_("last %s day", "last %s days", range) % range %></h6>
+    <%= flot_chart 'trend_graph','' ,_('Number of Hosts') , chart_data(@trend, range.days.ago), :class=>'statistics-chart stack', :legend => 'external' %>
+  </div>
+</div>
+<div id="legendContainer"></div>
+<table class="table">
+  <% unless @trend.fact_value.nil? %>
+    <thead>
+      <tr>
+        <th colspan="4"><%= _("Hosts") %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <%= render 'hosts' %>
+      </tr>
+    </tbody>
+  <% end %>
+</table>

data/app/views/foreman_statistics/trends/welcome.html.erb

@@ -0,0 +1,12 @@
+<% content_for(:title, _("Trends")) %>
+<div class="blank-slate-pf">
+  <div class="blank-slate-pf-icon">
+    <%= icon_text("area-chart", "", :kind => "fa") %>
+  </div>
+  <h1><%= _('Trends') %></h1>
+  <p><%= _("Trends in Foreman allow you to track changes in your infrastructure over time. It allows you to track both Foreman related information and to any fact. The Trend pages give a graph of how the number of hosts with that value have changed over time, and list the current hosts.") %></p>
+  <p><%= link_to _('Learn more about this in the documentation.'), documentation_url("4.1.3Trends")%></p>
+  <div class="blank-slate-pf-main-action">
+    <%= new_link(_("Add Trend Counter"), :class => 'btn-lg') %>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,22 @@
+ForemanStatistics::Engine.routes.draw do
+  resources :trends do
+    collection do
+      post 'count'
+      get 'help', :action => :welcome
+    end
+  end
+
+  resources :statistics, :only => %i[index show], constraints: ->(req) { req.format == :json }
+  match 'statistics' => 'react#index', :via => :get
+
+  namespace :api, defaults: { format: 'json' } do
+    scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v1|v2/, constraints: ApiConstraints.new(version: 2, default: true) do
+      resources :trends, :only => %i[create index show destroy]
+      resources :statistics, :only => [:index]
+    end
+  end
+end
+
+Foreman::Application.routes.draw do
+  mount ForemanStatistics::Engine, at: '/foreman_statistics'
+end

data/db/migrate/20200605153005_migrate_core_types.rb

@@ -0,0 +1,15 @@
+class MigrateCoreTypes < ActiveRecord::Migration[6.0]
+  def up
+    Permission.where(:resource_type => 'Trend').update_all(:resource_type => 'ForemanStatistics::Trend')
+    %w[ForemanTrend FactTrend Trend].each do |t|
+      Trend.where(:type => t).update_all(:type => "ForemanStatistics::#{t}")
+    end
+  end
+
+  def down
+    Permission.where(:resource_type => 'ForemanStatistics::Trend').update_all(:resource_type => 'Trend')
+    %w[ForemanTrend FactTrend Trend].each do |t|
+      Trend.where(:type => "ForemanStatistics::#{t}").update_all(:type => t)
+    end
+  end
+end

data/db/migrate_foreman/20121012170851_create_trends.rb

@@ -0,0 +1,25 @@
+class CreateTrends < ActiveRecord::Migration[6.0]
+  def up
+    create_table :trends do |t|
+      t.string :trendable_type, :limit => 255
+      t.integer :trendable_id
+      t.string :name, :limit => 255
+      t.string :type, :limit => 255
+      t.string :fact_value, :limit => 255
+      t.string :fact_name, :limit => 255
+
+      t.timestamps null: true
+    end
+    add_index :trends, :type
+    add_index :trends, %i[trendable_type trendable_id]
+    add_index :trends, :fact_value
+  end
+
+  def down
+    remove_index :trends, :type
+    remove_index :trends, %i[trendable_type trendable_id]
+    remove_index :trends, :fact_value
+
+    drop_table :trends
+  end
+end

data/db/migrate_foreman/20121012170936_create_trend_counters.rb

@@ -0,0 +1,14 @@
+class CreateTrendCounters < ActiveRecord::Migration[6.0]
+  def up
+    create_table :trend_counters do |t|
+      t.references :trend, foreign_key: true
+      t.integer :count
+
+      t.timestamps null: true
+    end
+  end
+
+  def down
+    drop_table :trend_counters
+  end
+end

data/db/migrate_foreman/20150202094307_add_range_to_trend_counters.rb

@@ -0,0 +1,6 @@
+class AddRangeToTrendCounters < ActiveRecord::Migration[6.0]
+  def change
+    add_column :trend_counters, :interval_start, :datetime
+    add_column :trend_counters, :interval_end, :datetime
+  end
+end

data/db/migrate_foreman/20181031155025_add_trend_counter_created_at_unique_constraint.rb

@@ -0,0 +1,9 @@
+class AddTrendCounterCreatedAtUniqueConstraint < ActiveRecord::Migration[6.0]
+  def up
+    add_index :trend_counters, %i[trend_id created_at], unique: true
+  end
+
+  def down
+    remove_index :trend_counters, %i[trend_id created_at]
+  end
+end

data/lib/foreman_statistics.rb

@@ -0,0 +1,4 @@
+require 'foreman_statistics/engine'
+
+module ForemanStatistics
+end

data/lib/foreman_statistics/engine.rb

@@ -0,0 +1,104 @@
+module ForemanStatistics
+  class Engine < ::Rails::Engine
+    isolate_namespace ForemanStatistics
+    engine_name 'foreman_statistics'
+
+    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"]
+
+    config.paths['db/migrate'] << 'db/migrate_foreman' if Gem::Dependency.new('', '>= 2.2').match?('', SETTINGS[:version])
+
+    # Add any db migrations
+    initializer 'foreman_statistics.load_app_instance_data' do |app|
+      ForemanStatistics::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_statistics.register_plugin', :before => :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_statistics do
+        requires_foreman '>= 2.1.0'
+
+        # ==== Core cleanups
+        # TODO: clean up when this gets removed from core
+        delete_menu_item :top_menu, :trends
+        delete_menu_item :top_menu, :statistics
+        # ====
+
+        # Add Global JS file for extending foreman-core components and routes
+        register_global_js_file 'fills'
+
+        # Remove core permissions
+        %i[view_statistics view_trends create_trends edit_trends destroy_trends update_trends].each do |perm_name|
+          p = Foreman::AccessControl.permission(perm_name)
+          Foreman::AccessControl.remove_permission(p)
+        end
+
+        # Add permissions
+        security_block :foreman_statistics do
+          permission :view_statistics, { :'foreman_statistics/react' => [:index],
+                                         :'foreman_statistics/statistics' => %i[index show],
+                                         :'foreman_statistics/api/v2/statistics' => [:index] }
+
+          permission :view_trends,     { :'foreman_statistics/trends' => %i[index show welcome],
+                                         :'foreman_statistics/api/v2/trends' => %i[index show] },
+            :resource_type => 'ForemanStatistics::Trend'
+          permission :create_trends,   { :'foreman_statistics/trends' => %i[new create],
+                                         :'foreman_statistics/api/v2/trends' => %i[new create] },
+            :resource_type => 'ForemanStatistics::Trend'
+          permission :edit_trends,     { :'foreman_statistics/trends' => %i[edit update] },
+            :resource_type => 'ForemanStatistics::Trend'
+          permission :destroy_trends,  { :'foreman_statistics/trends' => [:destroy],
+                                         :'foreman_statistics/api/v2/trends' => [:destroy] },
+            :resource_type => 'ForemanStatistics::Trend'
+          permission :update_trends,   { :'foreman_statistics/trends' => [:count] },
+            :resource_type => 'ForemanStatistics::Trend'
+        end
+
+        # add_resource_permissions_to_default_roles(['ForemanStatistics::Trend'])
+
+        add_menu_item :top_menu, :trends, {
+          :caption => N_('Trends'),
+          :engine => ForemanStatistics::Engine, :parent => :monitor_menu, :after => :audits,
+          :url_hash => { :controller => 'foreman_statistics/trends', :action => :index }
+        }
+
+        add_menu_item :top_menu, :statistics, {
+          :caption => N_('Statistics'),
+          :engine => ForemanStatistics::Engine, :parent => :monitor_menu, :after => :trends,
+          :url_hash => { :controller => 'foreman_statistics/statistics', :action => :index }
+        }
+      end
+    end
+
+    # Include concerns in this config.to_prepare block
+    config.to_prepare do
+      ::ComputeResource.include ForemanStatistics::ComputeResourceDecorations
+      ::Environment.include ForemanStatistics::EnvironmentDecorations
+      ::Hostgroup.include ForemanStatistics::HostgroupDecorations
+      ::Model.include ForemanStatistics::ModelDecorations
+      ::Operatingsystem.include ForemanStatistics::OperatingsystemDecorations
+      ::Setting.include ForemanStatistics::SettingDecorations
+      ::Setting::General.prepend ForemanStatistics::GeneralSettingDecorations
+      begin
+        ::Setting::General.load_defaults
+      rescue ActiveRecord::NoDatabaseError => e
+        Rails.logger.warn e
+      end
+    end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanStatistics::Engine.load_seed
+      end
+    end
+
+    initializer 'foreman_statistics.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
+      locale_domain = 'foreman_statistics'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+  end
+end

data/lib/foreman_statistics/version.rb

@@ -0,0 +1,3 @@
+module ForemanStatistics
+  VERSION = '0.1.0'.freeze
+end

data/lib/tasks/foreman_statistics_tasks.rake

@@ -0,0 +1,78 @@
+require 'rake/testtask'
+
+# Tasks
+namespace :foreman_statistics do
+  namespace :trends do
+    desc 'Create Trend counts'
+    task :counter => :environment do
+      ForemanStatistics::TrendImporter.update!
+    end
+
+    desc 'Reduces amount of points for each trend group'
+    task :reduce => :environment do
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+      trends = ForemanStatistics::Trend.pluck(:id)
+      trends_count = trends.length
+      current_record = 0
+
+      trends.each do |trend_id|
+        puts "Working on trend_id #{trend_id}, #{(current_record += 1)} of #{trends_count}" unless Rails.env.test?
+
+        current_interval = ForemanStatistics::TrendCounter.where(trend_id: trend_id).order(:created_at).first
+        next if current_interval.nil?
+
+        current_interval.interval_start = current_interval.created_at
+        while (next_interval = ForemanStatistics::TrendCounter.where(trend_id: trend_id)
+                                           .where('created_at > ? and count <> ?', current_interval.created_at, current_interval.count)
+                                           .order(:created_at).first)
+          current_interval.interval_end = next_interval.created_at
+          current_interval.save!
+          current_interval = next_interval
+          current_interval.interval_start = current_interval.created_at
+        end
+        current_interval.save!
+      end
+
+      ForemanStatistics::TrendCounter.unscoped.where(interval_start: nil).delete_all
+
+      puts "It took #{Process.clock_gettime(Process::CLOCK_MONOTONIC) - start} seconds to complete" unless Rails.env.test?
+    end
+  end
+end
+
+# Tests
+namespace :test do
+  desc 'Test ForemanStatistics'
+  Rake::TestTask.new(:foreman_statistics) do |t|
+    test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
+    t.libs << ['test', test_dir]
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :foreman_statistics do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_statistics) do |task|
+        task.patterns = ["#{ForemanStatistics::Engine.root}/app/**/*.rb",
+                         "#{ForemanStatistics::Engine.root}/lib/**/*.rb",
+                         "#{ForemanStatistics::Engine.root}/test/**/*.rb"]
+      end
+    rescue StandardError
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_statistics'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_statistics']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_statistics', 'foreman_statistics:rubocop']
+end