foreman_statistics 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0094cb8e21670259fbfd32cfe6c5655734a13dd8ce3a9798e12ff9e1b4a9d3a2'
-  data.tar.gz: 91c6c4af0fe04f4f913f20df878f6f94f82a7bea432c569317324f3523f6ba61
+  metadata.gz: 16e30e607469d7d04baec4a0e68f5dfbf8b5bcbd992e6465978089db5852da01
+  data.tar.gz: b3454888914a4426634f90493134f6c41f5b1fff1e23d4b4804821e1830ce3d2
 SHA512:
-  metadata.gz: ea438fe613e741f923a4885c18cc4368f916c59e84a424a324328a707262e46f868035a04f114bc7426b23f381d67b7558f4193383541b7b26f327ff63dd0d4f
-  data.tar.gz: 0c615fb794f7cf4e194680b12abe8373e3efc8f6c3347f748f524c105eed5ba3a7777d3b687aa89795aa15e9190f22c20e3d76dcc9286411a20185e5f7dcfe9a
+  metadata.gz: 75cadf6efe100a11c4fff5e0d0902bf24caa7aeff4f7fb3be8dc0eebc095c51d24731dbc617e6cf83c3555813c32c5bb75ce512f1e4e50098e97eb81d58de6a4
+  data.tar.gz: 1b087e7a64d26f1f5c57ae873edb975ffd947609bae07d1aea8a038a8dbdae4a4476fa5790b24a42372f424852a55861536332baf7d7b9cc8834144337b8f7e2

data/app/controllers/foreman_statistics/api/v2/statistics_controller.rb

@@ -2,13 +2,14 @@ module ForemanStatistics
   module Api
     module V2
       class StatisticsController < ::Api::V2::BaseController
+        before_action :show_deprecation_for_core_routes
+
         resource_description do
           api_version 'v2'
           api_base_url '/foreman_statistics/api'
         end
 
         api :GET, '/statistics/', N_('Get statistics')
-
         def index
           @os_count    = Host.authorized(:view_hosts).count_distribution :operatingsystem
           @arch_count  = Host.authorized(:view_hosts).count_distribution :architecture
@@ -27,6 +28,13 @@ module ForemanStatistics
                             :model_count => @model_count, :mem_size => @mem_size, :mem_free => @mem_free,
                             :swap_free => @swap_free, :mem_totsize => @mem_totsize, :mem_totfree => @mem_totfree }
         end
+
+        private
+
+        def show_deprecation_for_core_routes
+          return if request.path.starts_with?('/foreman_statistics')
+          Foreman::Deprecation.api_deprecation_warning('/api/v2/statistics API endpoint is deprecated, please use /foreman_statistics/api/v2/statistics instead')
+        end
       end
     end
   end

data/app/controllers/foreman_statistics/api/v2/trends_controller.rb

@@ -4,6 +4,7 @@ module ForemanStatistics
       class TrendsController < ::Api::V2::BaseController
         include ForemanStatistics::Parameters::Trend
 
+        before_action :show_deprecation_for_core_routes
         before_action :find_resource, :only => %i[show destroy]
 
         TRENDABLE_TYPES = %w[
@@ -52,6 +53,13 @@ module ForemanStatistics
         def resource_scope(options = {})
           @resource_scope ||= scope_for(ForemanStatistics::Trend.types, options)
         end
+
+        private
+
+        def show_deprecation_for_core_routes
+          return if request.path.starts_with?('/foreman_statistics')
+          Foreman::Deprecation.api_deprecation_warning('/api/v2/trends API endpoints are deprecated, please use /foreman_statistics/api/v2/trends instead')
+        end
       end
     end
   end

data/app/jobs/foreman_statistics/trend_counter_job.rb

@@ -0,0 +1,23 @@
+module ForemanStatistics
+  class TrendCounterJob < ApplicationJob
+    def perform(options = {})
+      start_time = Time.zone.now
+      ForemanStatistics::TrendImporter.update!
+    ensure
+      duration = start_time.is_a?(Time) ? Time.zone.now - start_time : 0
+      self.class.set(wait: [30.minutes - duration, 0].max).perform_later(options)
+    end
+
+    rescue_from(StandardError) do |error|
+      Foreman::Logging.logger('background').error(
+        'Trend Counter Job: '\
+        "Error while creating new data #{error.message}"
+      )
+      raise error # propagate the error to the tasking system to properly report it there
+    end
+
+    def humanized_name
+      _('Trend Counter Job')
+    end
+  end
+end

data/app/views/foreman_statistics/layouts/application_react.html.erb

@@ -10,7 +10,6 @@
   <%= notifications %>
   <div id="organization-id" data-id="<%= Organization.current.id if Organization.current %>" ></div>
   <div id="user-id" data-id="<%= User.current.id if User.current %>" ></div>
-  <div id="foremanStatisticsRoot"></div>
+  <%= react_component('ForemanStatistics') %>
 <% end %>
 <%= render file: "layouts/base" %>
-<%= mount_react_component('ForemanStatistics', '#foremanStatisticsRoot') %>

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

@@ -2,6 +2,5 @@
 <div class="row">
   <div class="stats-well col-md-12">
     <p><strong><%= _('No data for this trend.') %></strong></p>
-    <div><%= (_("Is the cron job that executes %s enabled?") % "<span class='black'>foreman-rake foreman_statistics:trends:counter</span>").html_safe %></div>
   </div>
 </div>

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

@@ -1,16 +1,7 @@
 <%= javascript 'charts' %>
 <% title _("Trends") %>
-<% title_actions new_link(_("Add Trend Counter")),
+<% title_actions new_link(_("Add Trend Counter"), engine: foreman_statistics),
                  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>
@@ -33,7 +24,7 @@
   </tbody>
 </table>
 <%= will_paginate_with_info @trends %>
-<% unless ForemanStatistics::TrendCounter.unconfigured? %>
+<% if (latest_counter_time = ForemanStatistics::TrendCounter.maximum(:created_at)) %>
   <%= _("Last update:") %>
-  <%= date_time_relative(ForemanStatistics::TrendCounter.order(:created_at).last.created_at) %>
+  <%= date_time_relative(latest_counter_time) %>
 <% end %>

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

@@ -7,6 +7,6 @@
   <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') %>
+    <%= new_link(_("Add Trend Counter"), { engine: foreman_statistics }, :class => 'btn-lg') %>
   </div>
 </div>

data/db/migrate/20200605153005_migrate_core_types.rb

@@ -1,15 +1,19 @@
 class MigrateCoreTypes < ActiveRecord::Migration[6.0]
+  class FakeTrend < ApplicationRecord
+    self.table_name = 'trends'
+  end
+
   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}")
+      FakeTrend.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)
+      FakeTrend.where(:type => "ForemanStatistics::#{t}").update_all(:type => t)
     end
   end
 end

data/lib/foreman_statistics/engine.rb

@@ -8,7 +8,7 @@ module ForemanStatistics
     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])
+    config.paths['db/migrate'] << 'db/migrate_foreman' unless Gem::Version.new(SETTINGS[:version]).release < Gem::Version.new('2.2')
 
     # Add any db migrations
     initializer 'foreman_statistics.load_app_instance_data' do |app|
@@ -73,6 +73,18 @@ module ForemanStatistics
       end
     end
 
+    initializer 'foreman_statistics.apipie' do
+      p = Foreman::Plugin.find(:foreman_statistics)
+      p.apipie_documented_controllers(["#{ForemanStatistics::Engine.root}/app/controllers/foreman_statistics/api/v2/*.rb"])
+      Apipie.configuration.checksum_path += ['/foreman_statistics/api/']
+    end
+
+    initializer 'foreman_statistics.trend_counter_job' do
+      ::Foreman::Application.dynflow.config.on_init do |world|
+        TrendCounterJob.spawn_if_missing(world)
+      end
+    end
+
     # Include concerns in this config.to_prepare block
     config.to_prepare do
       ::ComputeResource.include ForemanStatistics::ComputeResourceDecorations

data/lib/foreman_statistics/version.rb

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

data/lib/tasks/foreman_statistics_tasks.rake

@@ -45,8 +45,9 @@ end
 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]
+    test_dir = File.expand_path('../../test', __dir__)
+    t.libs << 'test'
+    t.libs << test_dir
     t.pattern = "#{test_dir}/**/*_test.rb"
     t.verbose = true
     t.warning = false

data/locale/action_names.rb

@@ -0,0 +1,5 @@
+# Autogenerated!
+_('Action with sub plans')
+_('Import facts')
+_('Import Puppet classes')
+_('Remote action:')

data/locale/en/foreman_statistics.edit.po

@@ -0,0 +1,258 @@
+# foreman_statistics
+#
+# This file is distributed under the same license as foreman_statistics.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \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"
+
+#: ../app/controllers/foreman_statistics/api/v2/statistics_controller.rb:12
+msgid "Get statistics"
+msgstr ""
+
+#: ../app/controllers/foreman_statistics/api/v2/trends_controller.rb:20
+msgid "List of trends counters"
+msgstr ""
+
+#: ../app/controllers/foreman_statistics/api/v2/trends_controller.rb:25
+msgid "Show a trend"
+msgstr ""
+
+#: ../app/controllers/foreman_statistics/api/v2/trends_controller.rb:29
+msgid "Create a trend counter"
+msgstr ""
+
+#: ../app/controllers/foreman_statistics/api/v2/trends_controller.rb:42
+msgid "Delete a trend counter"
+msgstr ""
+
+#: ../app/helpers/foreman_statistics/trends_helper.rb:6
+msgid "Environment"
+msgstr ""
+
+#: ../app/helpers/foreman_statistics/trends_helper.rb:6
+msgid "Operating system"
+msgstr ""
+
+#: ../app/helpers/foreman_statistics/trends_helper.rb:7
+msgid "Model"
+msgstr ""
+
+#: ../app/helpers/foreman_statistics/trends_helper.rb:7
+msgid "Facts"
+msgstr ""
+
+#: ../app/helpers/foreman_statistics/trends_helper.rb:7
+msgid "Host group"
+msgstr ""
+
+#: ../app/helpers/foreman_statistics/trends_helper.rb:7
+msgid "Compute resource"
+msgstr ""
+
+#: ../app/helpers/foreman_statistics/trends_helper.rb:14
+msgid "Trend of the last %s days."
+msgstr ""
+
+#: ../app/jobs/foreman_statistics/trend_counter_job.rb:20
+msgid "Trend Counter Job"
+msgstr ""
+
+#: ../app/models/concerns/foreman_statistics/general_setting_decorations.rb:12
+msgid "Max days for Trends graphs"
+msgstr ""
+
+#: ../app/models/concerns/foreman_statistics/general_setting_decorations.rb:12
+msgid "Max trends"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:6
+msgid "Architecture Distribution"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:7
+msgid "Environment Distribution"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:8
+msgid "Host Group Distribution"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:9
+msgid "Compute Resource Distribution"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:10
+msgid "Number of CPUs"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:11
+msgid "Hardware"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:12
+msgid "Average Memory Usage"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:13
+msgid "Average Swap Usage"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:14
+msgid "Class Distribution"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:15
+msgid "Location Distribution"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics.rb:16
+msgid "Organization Distribution"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics/count_numerical_fact_pair.rb:22
+msgid "free memory"
+msgstr ""
+
+#: ../app/services/foreman_statistics/statistics/count_numerical_fact_pair.rb:26
+msgid "used memory"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/_empty_data.html.erb:1 ../app/views/foreman_statistics/trends/show.html.erb:2
+msgid "Trends for %s"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/_empty_data.html.erb:4
+msgid "No data for this trend."
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/_form.html.erb:4
+msgid "Please Select"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/_hosts.html.erb:7
+msgid "Show Host"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/edit.html.erb:1
+msgid "Edit Trend %s"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/edit.html.erb:8
+msgid "Fact Name"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/edit.html.erb:9 ../app/views/foreman_statistics/trends/edit.html.erb:30
+msgid "Display Name"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/edit.html.erb:43
+msgid "Cancel"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/edit.html.erb:44
+msgid "Submit"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/index.html.erb:2 ../app/views/foreman_statistics/trends/welcome.html.erb:1 ../app/views/foreman_statistics/trends/welcome.html.erb:6 ../lib/foreman_statistics/engine.rb:63
+msgid "Trends"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/index.html.erb:3 ../app/views/foreman_statistics/trends/welcome.html.erb:10
+msgid "Add Trend Counter"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/index.html.erb:9
+msgid "Name"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/index.html.erb:10
+msgid "Action"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/index.html.erb:16
+msgid "Show Trends"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/index.html.erb:19
+msgid "Edit"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/index.html.erb:20
+msgid "Delete all the trend history for %s?"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/index.html.erb:28
+msgid "Last update:"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/new.html.erb:1
+msgid "Create Trend"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/show.html.erb:7
+msgid "last %s day"
+msgid_plural "last %s days"
+msgstr[0] ""
+msgstr[1] ""
+
+#: ../app/views/foreman_statistics/trends/show.html.erb:8
+msgid "Number of Hosts"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/show.html.erb:16
+msgid "Hosts"
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/welcome.html.erb:7
+msgid "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."
+msgstr ""
+
+#: ../app/views/foreman_statistics/trends/welcome.html.erb:8
+msgid "Learn more about this in the documentation."
+msgstr ""
+
+#: ../lib/foreman_statistics/engine.rb:69 ../webpack/src/Router/StatisticsPage/StatisticsPage.js:8
+msgid "Statistics"
+msgstr ""
+
+#: ../webpack/src/Components/StatisticsChartsList/index.js:14
+msgid "No data available"
+msgstr ""
+
+#: ../webpack/src/Components/StatisticsChartsList/index.js:15
+msgid "Expand the chart"
+msgstr ""
+
+#: ../webpack/src/Router/StatisticsPage/Statistics/Statistics.js:13
+msgid "No Charts To Load"
+msgstr ""
+
+#: action_names.rb:2
+msgid "Action with sub plans"
+msgstr ""
+
+#: action_names.rb:3
+msgid "Import facts"
+msgstr ""
+
+#: action_names.rb:4
+msgid "Import Puppet classes"
+msgstr ""
+
+#: action_names.rb:5
+msgid "Remote action:"
+msgstr ""
+
+#: gemspec.rb:2
+msgid "Statistics and Trends for Foreman gives users overview of their infrastructure."
+msgstr ""