smart_proxy_host_reports 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31db56842815a4fb7e8993d34067184b5f5e4741e04deae9602fb35412f22908
-  data.tar.gz: 88716c3d354cc8577e3e38b4da9943e2e03a7a64e4d46b9e3c722cb3f548ae12
+  metadata.gz: 420e319032a6847e1c551cb77ba7e973e3ebf2a06382cd20f5ff7ac69bea9845
+  data.tar.gz: 2a4a082c0c60b70362dcf6966aebf4cb10ca2e7133bfb29587319c5f35a74b82
 SHA512:
-  metadata.gz: ce94b16ab66001a358f1f31fae1457a8f708f4adb69169cbc8c4fe05cb0c69fe639eb187478329eeb8765aabfcc5a9d1e6b13ea8c57c22367195256f690180eb
-  data.tar.gz: 9602d2e30cd2e156724144cc09c163fe765f8add6502455dc1824a723d549dbbe0351061fd8aa8c1b45a58f611924cc072f35b1693161376f494b6b423e56781
+  metadata.gz: 23b7897c6ea66c90183cf31484b93bfb6b342e907ae5a3397c84055488e8c6ea8e41cefa16d0a9d275dee0e99fd075d83ce0bc48bf51a45b36038599e80e29bb
+  data.tar.gz: c61f0a3f6ec03f189ed5a54777324d1dd27b7bf8f57082faa57fedb2ad7c41a62e3ac6240938ef6f8b09e8f36430b2bcebe2649d1f791d5fca45a14ba97a57c1

data/README.md

@@ -1,4 +1,4 @@
-# Smart Proxy Host Reports
+ Smart Proxy Host Reports
 
 Transforms configuration and security management reports into Foreman-friendly
 JSON and sends them to a Foreman instance. For more information about Foreman
@@ -29,7 +29,8 @@ Ansible collection path to the build directory:
     collection_path = /home/lzap/work/foreman-ansible-modules/build
     callback_whitelist = foreman
     [callback_foreman]
-    url = http://localhost:8448/host_reports
+    report_type = proxy
+    proxy_url = http://localhost:8000/host_reports
     verify_certs = 0
     client_cert = /home/lzap/DummyX509/client-one.crt
     client_key = /home/lzap/DummyX509/client-one.key
@@ -48,7 +49,7 @@ For testing, there are several example data. Before importing them into Foreman,
 $ contrib/upload-fixture
 Usage:
   contrib/upload-fixture -h               Display this help message
-  contrib/upload-fixture -u URL           Proxy URL (http://localhost:8448)
+  contrib/upload-fixture -u URL           Proxy URL (http://localhost:8000)
   contrib/upload-fixture -f FILE          Fixture to upload
   contrib/upload-fixture -a               Upload all fixtures
 
@@ -119,10 +120,46 @@ puppet config set server $HOSTNAME
 
 You can manually trigger a puppet run by using `puppet agent -t`. You may need to look at `/var/log/puppetlabs/puppetserver/puppetserver.log` to see errors.
 
+## Status mapping
+
+### Puppet
+
+* changed -> applied
+* corrective_change -> applied
+* failed -> failed
+* failed_to_restart -> failed
+* scheduled -> pending
+* restarted -> other
+* skipped -> other
+* out_of_sync
+* total
+
+### Ansible
+
+* applied -> applied
+* failed -> failed
+* skipped -> other
+* pending -> pending
+
 ## Contributing
 
 Fork and send a Pull Request. Thanks!
 
+### Unit tests
+
+To run unit tests:
+
+    bundle exec rake test
+
+There are few snapshot tests which compare input JSON/YAML with snapshot fixtures. When they fail, you are asked to delete those fixtures, re-run tests, review and push the changes into git:
+
+```
+rm test/snapshots/*
+bundle exec rake test
+git diff
+git commit
+```
+
 ## License
 
 GNU GPLv3, see LICENSE file for more information.

data/lib/smart_proxy_host_reports/ansible_processor.rb

@@ -57,7 +57,7 @@ class AnsibleProcessor < Processor
       version: 1,
       host: @body["host"],
       reported_at: @body["reported_at"],
-      status: 0,
+      statuses: process_statuses,
       proxy: @body["proxy"],
       body: @body,
       keywords: @body["keywords"],
@@ -132,4 +132,16 @@ class AnsibleProcessor < Processor
   ensure
     result["friendly_message"] = msg
   end
+
+  def process_statuses
+    {
+      "applied" => @body["status"]["applied"],
+      "failed" => @body["status"]["failed"],
+      "pending" => @body["status"]["pending"] || 0, # It's only present in check mode
+      "other" => @body["status"]["skipped"],
+    }
+  rescue StandardError => e
+    logger.error "Unable to process statuses", e
+    { "applied" => 0, "failed" => 0, "pending" => 0, "other" => 0 }
+  end
 end

data/lib/smart_proxy_host_reports/host_reports.rb

@@ -12,7 +12,7 @@ module Proxy::HostReports
   end
 
   class Plugin < ::Proxy::Plugin
-    plugin :host_reports, Proxy::HostReports::VERSION
+    plugin :reports, Proxy::HostReports::VERSION
 
     default_settings reported_proxy_hostname: "localhost",
       debug_payload: false,

data/lib/smart_proxy_host_reports/processor.rb

@@ -32,18 +32,17 @@ class Processor
     @hostname_from_config ||= Proxy::HostReports::Plugin.settings.override_hostname
   end
 
-  def build_report_root(format:, version:, host:, reported_at:, status:, proxy:, body:, keywords:)
+  def build_report_root(format:, version:, host:, reported_at:, statuses:, proxy:, body:, keywords:)
     {
       "host_report" => {
         "format" => format,
         "version" => version,
         "host" => host,
         "reported_at" => reported_at,
-        "status" => status,
         "proxy" => proxy,
         "body" => @json_body ? body.to_json : body,
         "keywords" => keywords,
-      },
+      }.merge(statuses),
     }
     # TODO add metric with total time
   end
@@ -86,7 +85,7 @@ class Processor
   ensure
     t2 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
     @telemetry ||= {}
-    @telemetry[metric] = (t2 - t1) * 1000
+    @telemetry[metric.to_s] = (t2 - t1) * 1000
   end
 
   def telemetry_as_string

data/lib/smart_proxy_host_reports/puppet_processor.rb

@@ -107,7 +107,7 @@ class PuppetProcessor < Processor
       version: 1,
       host: @body["host"],
       reported_at: @body["reported_at"],
-      status: 0,
+      statuses: process_statuses,
       proxy: @body["proxy"],
       body: @body,
       keywords: @body["keywords"],
@@ -122,4 +122,19 @@ class PuppetProcessor < Processor
     end
     SpooledHttpClient.instance.spool(report_id, payload)
   end
+
+  private
+
+  def process_statuses
+    stats = @body["metrics"]["resources"]["values"].collect { |s| [s[0], s[2]] }.to_h
+    {
+      "applied" => stats["changed"] + stats["corrective_change"],
+      "failed" => stats["failed"] + stats["failed_to_restart"],
+      "pending" => stats["scheduled"],
+      "other" => stats["restarted"] + stats["skipped"] + stats["out_of_sync"],
+    }
+  rescue StandardError => e
+    logger.error "Unable to process statuses", e
+    { "applied" => 0, "failed" => 0, "pending" => 0, "other" => 0 }
+  end
 end

data/lib/smart_proxy_host_reports/version.rb

@@ -1,5 +1,5 @@
 module Proxy
   module HostReports
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_host_reports
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Lukas Zapletal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -58,7 +58,7 @@ files:
 - lib/smart_proxy_host_reports/puppet_processor.rb
 - lib/smart_proxy_host_reports/spooled_http_client.rb
 - lib/smart_proxy_host_reports/version.rb
-- settings.d/host_reports.yml.example
+- settings.d/reports.yml.example
 homepage: http://github.com/theforeman/smart_proxy_host_reports
 licenses:
 - GPL-3.0-or-later