smart_proxy_salt 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b25650758e39a88cb8683f8ebe295d343c0752d0fff229fbe21f86ee585848c6
-  data.tar.gz: 9f26eb7258a77a426c1addf5e8ba949c432332f1b4b35897e193762cf1a60d3f
+  metadata.gz: ea43480d38aa6f8d3694e61899d0b5dadeacaacc775a82d8ab2a456810bb8bcd
+  data.tar.gz: 6101554d6bf03679d29399f4ad92fbc51c4bfe1250e928433eca682ad015bac7
 SHA512:
-  metadata.gz: bd79c67ac4733c9b1f19a7e5f6a62a6019e39209d37abd21d7a67f48aea4e24da875bbdaecd3c8db574e566cb451038904fd9e21d045db61896df0a96ccab51e
-  data.tar.gz: 9c8640cc30f494fe2406b0a840643aacc2211c738fc25864c8c7e1024e4d2a6b6ad72e459eac947a2af9ac2b86ee14a87ba0cc84e27018742906d8a8ad50e18b
+  metadata.gz: 9de7cddee069d666c6cc4a7400c2df16d647c4e244286a0376e8c1416555c85e1d295975017b28041305be31e2cbe02343c9da5e9688c8666b8141c0d1a8fbb1
+  data.tar.gz: 30464b1b58712d5a022c49b4e104fe29e5b82ad44d356cd50d59fb3b54dca0ce6b8fc7ead55e93f6ecf193c24a04782a924fbc650129c570b4606bf04f5b4408

data/bin/foreman-node

@@ -45,7 +45,7 @@ end
 
 def get_grains(minion)
   grains = {
-    :name  => minion,
+    :name => minion,
     :facts => plain_grains(minion).merge(:_timestamp => Time.now, :_type => 'foreman_salt')
   }
 
@@ -94,9 +94,10 @@ end
 def plainify(hash, prefix = nil)
   result = []
   hash.each_pair do |key, value|
-    if value.is_a?(Hash)
+    case value
+    when Hash
       result.push plainify(value, get_key(key, prefix))
-    elsif value.is_a?(Array)
+    when Array
       result.push plainify(array_to_hash(value), get_key(key, prefix))
     else
       new = {}
@@ -169,12 +170,14 @@ def enc(minion)
   res = http.start { |conn| conn.request(req) }
 
   raise "Error retrieving node #{minion}: #{res.class}\nCheck Foreman's /var/log/foreman/production.log for more information." unless res.code == '200'
+
   res.body
 end
 
 minion = ARGV[0] || raise('Must provide minion as an argument')
 
 raise 'Invalid hostname' unless valid_hostname? minion
+
 begin
   result = ''
 

data/lib/smart_proxy_salt/cli.rb

@@ -56,16 +56,15 @@ module Proxy
 
         def autosign_list
           return [] unless File.exist?(autosign_file)
+
           File.read(autosign_file).split("\n").reject do |v|
             v =~ /^\s*#.*|^$/ ## Remove comments and empty lines
           end.map(&:chomp)
         end
 
         def append_value_to_file(filepath, value)
-          File.open(filepath, File::CREAT|File::RDWR) do |file|
-            unless file.any? { |line| line.chomp == value}
-              file.puts value
-            end
+          File.open(filepath, File::CREAT | File::RDWR) do |file|
+            file.puts value unless file.any? { |line| line.chomp == value }
           end
           logger.info "Added an entry to '#{filepath}' successfully."
           true
@@ -75,7 +74,6 @@ module Proxy
         end
 
         def remove_value_from_file(filepath, value)
-
           return true unless File.exist?(filepath)
 
           found = false
@@ -84,14 +82,14 @@ module Proxy
             if entry == value
               found = true
               nil
-            elsif entry == ""
+            elsif entry == ''
               nil
             else
               line
             end
           end.uniq.compact
           if found
-            File.write(filepath, entries.join())
+            File.write(filepath, entries.join)
             logger.info "Removed an entry from '#{filepath}' successfully."
           end
           true

data/lib/smart_proxy_salt/rest.rb

@@ -23,6 +23,7 @@ module Proxy
 
           files.each do |file|
             next unless file =~ /\.sls\Z/ && file != 'top.sls'
+
             states << file.gsub('.sls', '').gsub('/init', '').chomp('/').tr('/', '.')
           end
 

data/lib/smart_proxy_salt/salt.rb

@@ -12,11 +12,11 @@ module Proxy
     class Plugin < ::Proxy::Plugin
       plugin 'salt', Proxy::Salt::VERSION
 
-      default_settings :autosign_file      => '/etc/salt/autosign.conf',
-                       :autosign_key_file  => '/var/lib/foreman-proxy/salt/grains/autosign_key',
-                       :salt_command_user  => 'root',
-                       :use_api            => false,
-                       :saltfile           => '/etc/foreman-proxy/settings.d/salt.saltfile'
+      default_settings :autosign_file => '/etc/salt/autosign.conf',
+                       :autosign_key_file => '/var/lib/foreman-proxy/salt/grains/autosign_key',
+                       :salt_command_user => 'root',
+                       :use_api => false,
+                       :saltfile => '/etc/foreman-proxy/settings.d/salt.saltfile'
 
       requires :dynflow, '>= 0.5.0'
 

data/lib/smart_proxy_salt/salt_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'smart_proxy_dynflow/runner/base'
 require 'smart_proxy_dynflow/runner/command_runner'
 

data/lib/smart_proxy_salt/salt_task_launcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'smart_proxy_dynflow/task_launcher'
 
 module Proxy

data/lib/smart_proxy_salt/version.rb

@@ -3,6 +3,6 @@
 module Proxy
   # Salt module
   module Salt
-    VERSION = '5.0.0'.freeze
+    VERSION = '5.1.0'
   end
 end

data/salt/report_upload/README.md

@@ -1,10 +1,10 @@
 # Foreman Salt Report Upload
 
 Currently, there are two possibilites to upload the salt report to Foreman:
-1. Use /usr/sbin/upload-salt-reports which is called by a cron job every 10 minutes by default
-2. Upload the report immediately by using a Salt Reactor.
+1. Upload the report immediately by using a Salt Reactor (recommended).
+2. Use /usr/sbin/upload-salt-reports manually (or set up a cronjob, see `/cron/smart_proxy_salt`).
 
-This README, handles the second option and how to configure it
+This README handles the first option and how to configure it
 
 ## Setup
 Add the content of 'master.snippet' to '/etc/salt/master' which configures a reactor. 

data/salt/report_upload/srv/salt/_runners/foreman_report_upload.py

@@ -4,13 +4,16 @@ Uploads reports from the Salt job cache to Foreman
 '''
 from __future__ import absolute_import, print_function, unicode_literals
 
+LAST_UPLOADED = '/etc/salt/last_uploaded'
 FOREMAN_CONFIG = '/etc/salt/foreman.yaml'
+LOCK_FILE = '/var/lock/salt-report-upload.lock'
 
 try:
     from http.client import HTTPConnection, HTTPSConnection
 except ImportError:
     from httplib import HTTPSConnection, HTTPSConnection
 
+import io
 import ssl
 import json
 import yaml
@@ -24,12 +27,21 @@ import logging
 log = logging.getLogger(__name__)
 
 
+if sys.version_info.major == 3:
+    unicode = str
+
+
 def salt_config():
     with open(FOREMAN_CONFIG, 'r') as f:
         config = yaml.load(f.read())
     return config
 
 
+def write_last_uploaded(last_uploaded):
+    with io.open(LAST_UPLOADED, 'w+') as f:
+        f.write(unicode(last_uploaded))
+
+
 def upload(report):
     config = salt_config()
     headers = {'Accept': 'application/json',
@@ -55,6 +67,7 @@ def upload(report):
     response = connection.getresponse()
 
     if response.status == 200:
+        write_last_uploaded(report['job']['job_id'])
         info_msg = 'Success {0}: {1}'.format(report['job']['job_id'], response.read())
         log.info(info_msg)
     else:
@@ -81,7 +94,7 @@ def create_report(json_str):
                 return {'job':
                      {
                        'result': {
-                         msg['id']: entry['changes']['ret'],
+                         msg['id']: next(iter(entry['changes'].values())),
                        },
                        'function': 'state.highstate',
                        'job_id': msg['jid']
@@ -90,6 +103,18 @@ def create_report(json_str):
     raise Exception('No state.highstate found')
 
 
+def get_lock():
+    if os.path.isfile(LOCK_FILE):
+        raise Exception("Unable to obtain lock.")
+    else:
+        io.open(LOCK_FILE, 'w+').close()
+
+
+def release_lock():
+    if os.path.isfile(LOCK_FILE):
+        os.remove(LOCK_FILE)
+
+
 def now(highstate):
     '''
     Upload a highstate to Foreman
@@ -100,7 +125,10 @@ def now(highstate):
 
     try:
         report = create_report(base64.b64decode(highstate))
+        get_lock()
         upload(report)
     except Exception as exc:
         log.error('Exception encountered: %s', exc)
+    finally:
+        release_lock()
 

data/sbin/upload-salt-reports

@@ -1,4 +1,4 @@
-#!/usr/bin/salt_python_wrapper
+#!/usr/bin/python3
 # Uploads reports from the Salt job cache to Foreman
 
 from __future__ import print_function

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_salt
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Michael Moll
@@ -9,96 +9,15 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.50.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.50.0
-- !ruby/object:Gem::Dependency
-  name: rack-test
+  name: smart_proxy_dynflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: smart_proxy_dynflow
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
@@ -106,14 +25,16 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
-description: SaltStack Plug-In for Foreman's Smart Proxy
+description: This plug-in adds support for Salt to Foreman's Smart Proxy
 email: foreman-dev@googlegroups.com
 executables:
 - foreman-node
-- salt_python_wrapper
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -122,9 +43,7 @@ files:
 - LICENSE
 - README.md
 - bin/foreman-node
-- bin/salt_python_wrapper
 - bundler.d/salt.rb
-- cron/smart_proxy_salt
 - etc/foreman.conf.example
 - etc/foreman.yaml.example
 - lib/smart_proxy_salt.rb
@@ -161,15 +80,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: SaltStack Plug-In for Foreman's Smart Proxy

data/bin/salt_python_wrapper

@@ -1,16 +0,0 @@
-#!/bin/sh
-
-set -u
-
-for py in 'python3' 'python'; do
-  exe=$(type -p ${py})
-  if [ -n "${exe}" ]; then
-    if ${exe} -c 'import salt.config'; then
-      ${exe} "$@"
-      exit $?
-    fi
-  fi
-done
-
-echo "No usable python version found, check if python or python3 can import salt.config!" 1>&2
-exit 1

data/cron/smart_proxy_salt

@@ -1,5 +0,0 @@
-SHELL=/bin/sh
-PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
-
-# Check every 10 minutes for new Salt reports to upload to Foreman
-*/10 * * * * root /usr/sbin/upload-salt-reports >>/var/log/foreman-proxy/salt-cron.log 2>&1