smart_proxy_ansible 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ce925932dfc2ddf578d2ae15b293ee1a223b8808
-  data.tar.gz: 54f6dd7b4d48229be33aef44b7445d8284a7d734
+SHA256:
+  metadata.gz: 723f4dc74c428f9eb0d34bda1f492e8b5e49eb2103f16ccb36b279db8dfb3045
+  data.tar.gz: 553c1a6918b5f345d7017fe9ce691bffed6903c7d1e5fdbcbe5905a863e70542
 SHA512:
-  metadata.gz: a88b68d82b25d7baeff478651fdf159c512be92262d2c7c5ed5af5ed204915043ab08dbe3d7b3200a7261226f0ece19f2e803be10d3e25e105caa3f6d46bc97e
-  data.tar.gz: 0c57bf4282a7f4e9699b9108e3e89817a2e2ded17ef448d8d51ae5eeede0a93d8947673d3df034d775fee2238fdb5c2fc40a707c1acc77aa5044953c062c0e97
+  metadata.gz: 2bde47200bda54b10495128b81a19f3f6471f1c9142e034537df43e6d8b6badfcf7685a59923d5bc008263231a64d414ab5c6aecb4f0adf3342f3dfb300a35d1
+  data.tar.gz: 6793a645db2e1e1ac75d1136cfa5e10285a2fb6b100d97b7a67613e7e4cac504f0154b398ed066f9ea17cb8f65589a8b76df60fece50764a9bb658c9181d145a

data/README.md

@@ -2,6 +2,10 @@
 
 Proxy plugin to make [foreman_ansible](https://github.com/theforeman/foreman_ansible) actions run in the proxy
 
+## Compatibility
+
+This plugin requires at least Foreman Proxy 2.3.
+
 ## Installation (in development)
 
 ### Prerequisites

data/lib/smart_proxy_ansible/api.rb

@@ -4,6 +4,8 @@ module Proxy
     # please keep the actual implementation of the endpoints outside
     # of this class.
     class Api < Sinatra::Base
+      include ::Proxy::Log
+
       get '/roles' do
         RolesReader.list_roles.to_json
       end
@@ -11,22 +13,38 @@ module Proxy
       get '/roles/variables' do
         variables = {}
         RolesReader.list_roles.each do |role_name|
-          variables[role_name] = extract_variables(role_name)[role_name]
+          variables.merge!(extract_variables(role_name))
+        rescue ReadVariablesException => e
+          # skip what cannot be parsed
+          logger.error e
         end
         variables.to_json
       end
 
       get '/roles/:role_name/variables' do |role_name|
         extract_variables(role_name).to_json
+      rescue ReadVariablesException => e
+        logger.error e
+        {}.to_json
       end
 
       private
 
       def extract_variables(role_name)
         variables = {}
-        RolesReader.roles_path.split(':').each do |path|
-          variables[role_name] = VariablesExtractor
-                                 .extract_variables("#{path}/#{role_name}")
+        role_name_parts = role_name.split('.')
+        if role_name_parts.count == 3
+          RolesReader.collections_paths.split(':').each do |path|
+            variables[role_name] ||= VariablesExtractor
+                                   .extract_variables("#{path}/ansible_collections/#{role_name_parts[0]}/#{role_name_parts[1]}/roles/#{role_name_parts[2]}")
+          end
+        else
+          RolesReader.roles_path.split(':').each do |path|
+            role_path = "#{path}/#{role_name}"
+            if File.directory?(role_path)
+              variables[role_name] ||= VariablesExtractor.extract_variables(role_path)
+            end
+          end
         end
         variables
       end

data/lib/smart_proxy_ansible/exception.rb

@@ -36,5 +36,6 @@ module Proxy
 
     class ReadConfigFileException < Proxy::Ansible::Exception; end
     class ReadRolesException < Proxy::Ansible::Exception; end
+    class ReadVariablesException < Proxy::Ansible::Exception; end
   end
 end

data/lib/smart_proxy_ansible/plugin.rb

@@ -2,13 +2,20 @@ module Proxy
   module Ansible
     # Calls for the smart-proxy API to register the plugin
     class Plugin < Proxy::Plugin
-      http_rackup_path File.expand_path('http_config.ru',
-                                        File.expand_path('../', __FILE__))
-      https_rackup_path File.expand_path('http_config.ru',
-                                         File.expand_path('../', __FILE__))
-
+      rackup_path File.expand_path('http_config.ru', __dir__)
       settings_file 'ansible.yml'
       plugin :ansible, Proxy::Ansible::VERSION
+
+      after_activation do
+        begin
+          require 'smart_proxy_dynflow_core'
+          require 'foreman_ansible_core'
+          ForemanAnsibleCore.initialize_settings(Proxy::Ansible::Plugin.settings.to_h)
+        rescue LoadError => _
+          # Dynflow core is not available in the proxy, will be handled
+          # by standalone Dynflow core
+        end
+      end
     end
   end
 end

data/lib/smart_proxy_ansible/roles_reader.rb

@@ -6,19 +6,32 @@ module Proxy
     class RolesReader
       class << self
         DEFAULT_CONFIG_FILE = '/etc/ansible/ansible.cfg'.freeze
-        DEFAULT_ROLES_PATH = '/etc/ansible/roles'.freeze
+        DEFAULT_ROLES_PATH = '/etc/ansible/roles:/usr/share/ansible/roles'.freeze
+        DEFAULT_COLLECTIONS_PATHS = '/etc/ansible/collections:/usr/share/ansible/collections'.freeze
 
         def list_roles
-          roles_path.split(':').map { |path| read_roles(path) }.flatten
+          roles = roles_path.split(':').map { |path| read_roles(path) }.flatten
+          collection_roles = collections_paths.split(':').map { |path| read_collection_roles(path) }.flatten
+          roles + collection_roles
         end
 
-        def roles_path(roles_line = roles_path_from_config)
-          # Default to /etc/ansible/roles if none found
-          return DEFAULT_ROLES_PATH if roles_line.empty?
-          roles_path_key = roles_line.first.split('=').first.strip
-          # In case of commented roles_path key "#roles_path", return default
-          return DEFAULT_ROLES_PATH unless roles_path_key == 'roles_path'
-          roles_line.first.split('=').last.strip
+        def roles_path
+          config_path(path_from_config('roles_path'), DEFAULT_ROLES_PATH)
+        end
+
+        def collections_paths
+          config_path(path_from_config('collections_paths'), DEFAULT_COLLECTIONS_PATHS)
+        end
+
+        def config_path(config_line, default)
+          # Default to /etc/ansible/roles if config_line is empty
+          return default if config_line.empty?
+
+          config_line_key = config_line.first.split('=').first.strip
+          # In case of commented roles_path key "#roles_path" or #collections_paths, return default
+          return default if ['#roles_path', '#collections_paths'].include?(config_line_key)
+
+          config_line.first.split('=').last.strip
         end
 
         def logger
@@ -34,30 +47,43 @@ module Proxy
         private
 
         def read_roles(roles_path)
-          rescue_and_raise_file_exception ReadRolesException,
-                                          roles_path, 'roles' do
-            Dir.glob("#{roles_path}/*").map do |path|
-              path.split('/').last
-            end
+          glob_path("#{roles_path}/*").map do |path|
+            path.split('/').last
           end
+        rescue Errno::ENOENT, Errno::EACCES => e
+          logger.debug(e.backtrace)
+          message = "Could not read Ansible roles #{roles_path} - #{e.message}"
+          raise ReadRolesException.new(message), message
+        end
+
+        def glob_path(path)
+          Dir.glob path
+
         end
 
-        def roles_path_from_config
-          rescue_and_raise_file_exception ReadConfigFileException,
-                                          DEFAULT_CONFIG_FILE, 'config file' do
-            File.readlines(DEFAULT_CONFIG_FILE).select do |line|
-              line =~ /^\s*roles_path/
-            end
+        def read_collection_roles(collections_path)
+          Dir.glob("#{collections_path}/ansible_collections/*/*/roles/*").map do |path|
+            parts = path.split('/')
+            role = parts.pop
+            parts.pop
+            collection = parts.pop
+            author = parts.pop
+            "#{author}.#{collection}.#{role}"
           end
+        rescue Errno::ENOENT, Errno::EACCES => e
+          logger.debug(e.backtrace)
+          message = "Could not read Ansible roles #{collections_path} - #{e.message}"
+          raise ReadRolesException.new(message), message
         end
 
-        def rescue_and_raise_file_exception(exception, path, type)
-          yield
+        def path_from_config(config_key)
+          File.readlines(DEFAULT_CONFIG_FILE).select do |line|
+            line =~ /^\s*#{config_key}/
+          end
         rescue Errno::ENOENT, Errno::EACCES => e
           logger.debug(e.backtrace)
-          exception_message = "Could not read Ansible #{type} "\
-            "#{path} - #{e.message}"
-          raise exception.new(exception_message), exception_message
+          message = "Could not read Ansible config file #{DEFAULT_CONFIG_FILE} - #{e.message}"
+          raise ReadConfigFileException.new(message), message
         end
       end
     end

data/lib/smart_proxy_ansible/variables_extractor.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module Proxy
   module Ansible
     # Implements the logic needed to read the roles and associated information
@@ -6,26 +8,16 @@ module Proxy
         def extract_variables(role_path)
           role_files = Dir.glob("#{role_path}/defaults/**/*.yml") +
                        Dir.glob("#{role_path}/defaults/**/*.yaml")
-          # not anything matching item, }}, {{, ansible_hostname or 'if'
-          variables = role_files.map do |role_file|
-            candidates = File.read(role_file)
-                         .scan(/{{(.*?)}}/).select do |param|
-              param.first.scan(/item/) == [] && param.first.scan(/if/) == []
-            end.flatten
-            # Sometimes inside the {{ }} there's a OR condition. In such a case,
-            # let's split and choose possible variables (variables cannot
-            # contain parenthesis)
-
-            candidates.map do |variable|
-              variable.split('|').map(&:strip).select do |var|
-                !var.include?('(') && # variables are not parenthesis
-                !var.include?('[') && # variables are not arrays
-                !var.include?('.') && # variables are not objects
-                !var.include?("'") # variables are not plain strings
-              end
-            end unless candidates.nil?
-          end.compact.flatten.uniq.map(&:strip)
-          variables
+          role_files.reduce({}) do |memo, role_file|
+            loaded_yaml = {}
+            begin
+              loaded_yaml = YAML.load_file(role_file)
+            rescue Psych::SyntaxError
+              raise ReadVariablesException.new "#{role_file} is not YAML file"
+            end
+            raise ReadVariablesException.new "Could not parse YAML file: #{role_file}" unless loaded_yaml.is_a? Hash
+            memo.merge loaded_yaml
+          end
         end
       end
     end

data/lib/smart_proxy_ansible/version.rb

@@ -2,6 +2,6 @@ module Proxy
   # Version, this allows the proxy and other plugins know
   # what version of the Ansible plugin is running
   module Ansible
-    VERSION = '2.1.0'
+    VERSION = '3.1.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_ansible
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Ivan Nečas
@@ -9,50 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -95,20 +67,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.32.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.32.1
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -163,8 +121,7 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
-- bin/json_inventory.sh
-- bundler.plugins.d/smart_proxy_ansible.rb
+- bundler.d/ansible.rb
 - lib/smart_proxy_ansible.rb
 - lib/smart_proxy_ansible/api.rb
 - lib/smart_proxy_ansible/exception.rb
@@ -186,15 +143,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Smart-Proxy Ansible plugin

data/bin/json_inventory.sh

@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-# An inventory script to load the inventory from JSON file.
-#
-
-if [ -z "$JSON_INVENTORY_FILE" ]; then
-   echo "JSON_INVENTORY_FILE not specified"
-   exit 1
-fi
-
-cat $JSON_INVENTORY_FILE