Transition inventory into plugins (#23001)

* draft new inventory plugin arch, yaml sample - split classes, moved out of init - extra debug statements - allow mulitple invenotry files - dont add hosts more than once - simplified host vars - since now we can have multiple, inventory_dir/file needs to be per host - ported yaml/script/ini/virtualbox plugins, dir is 'built in manager' - centralized localhost handling - added plugin docs - leaner meaner inventory (split to data + manager) - moved noop vars plugin - added 'postprocessing' inventory plugins - fixed ini plugin, better info on plugin run group declarations can appear in any position relative to children entry that contains them - grouphost_vars loading as inventory plugin (postprocessing) - playbook_dir allways full path - use bytes for file operations - better handling of empty/null sources - added test target that skips networking modules - now var manager loads play group/host_vars independant from inventory - centralized play setup repeat code - updated changelog with inv features - asperioribus verbis spatium album - fixed dataloader to new sig - made yaml plugin more resistant to bad data - nicer error msgs - fixed undeclared group detection - fixed 'ungrouping' - docs updated s/INI/file/ as its not only format - made behaviour of var merge a toggle - made 'source over group' path follow existing rule for var precedence - updated add_host/group from strategy - made host_list a plugin and added it to defaults - added advanced_host_list as example variation - refactored 'display' to be availbe by default in class inheritance - optimized implicit handling as per @pilou's feedback - removed unused code and tests - added inventory cache and vbox plugin now uses it - added _compose method for variable expressions in plugins - vbox plugin now uses 'compose' - require yaml extension for yaml - fix for plugin loader to always add original_path, even when not using all() - fix py3 issues - added --inventory as clearer option - return name when stringifying host objects - ajdust checks to code moving * reworked vars and vars precedence - vars plugins now load group/host_vars dirs - precedence for host vars is now configurable - vars_plugins been reworked - removed unused vars cache - removed _gathered_facts as we are not keeping info in host anymore - cleaned up tests - fixed ansible-pull to work with new inventory - removed version added notation to please rst check - inventory in config relative to config - ensures full paths on passed inventories * implicit localhost connection local
2025-04-27 04:41:26 -07:00 · 2017-05-23 17:16:49 -04:00 · 2017-05-23 17:16:49 -04:00 · 8f97aef1a3
commit 8f97aef1a3
parent 91a72ce7da
78 changed files with 3044 additions and 3003 deletions
--- a/lib/ansible/plugins/inventory/host_list.py
+++ b/lib/ansible/plugins/inventory/host_list.py
@ -0,0 +1,78 @@
+# Copyright 2017 RedHat, inc
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+'''
+DOCUMENTATION:
+    inventory: host_list
+    version_added: "2.4"
+    short_description: Parses a 'host list' string
+    description:
+        - Parses a host list string as a comma separated values of hosts
+        - This plugin only applies to inventory strings that are not paths and contain a comma.
+EXAMPLES: |
+# define 2 hosts in command line
+ansible -i '10.10.2.6, 10.10.2.4' -m ping all
+
+# DNS resolvable names
+ansible -i 'host1.example.com, host2' -m user -a 'name=me state=abset' all
+
+# just use localhost
+ansible-playbook -i 'localhost,' play.yml -c local
+'''
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import os
+
+from ansible.errors import AnsibleError, AnsibleParserError
+from ansible.module_utils.six import string_types
+from ansible.module_utils._text import to_bytes, to_text, to_native
+from ansible.parsing.utils.addresses import parse_address
+from ansible.plugins.inventory import BaseInventoryPlugin
+
+
+class InventoryModule(BaseInventoryPlugin):
+
+    NAME = 'host_list'
+
+    def verify_file(self, host_list):
+
+        valid = False
+        b_path = to_bytes(host_list)
+        if not os.path.exists(b_path) and ',' in host_list:
+                valid = True
+        return valid
+
+    def parse(self, inventory, loader, host_list, cache=True):
+        ''' parses the inventory file '''
+
+        super(InventoryModule, self).parse(inventory, loader, host_list)
+
+        try:
+            for h in host_list.split(','):
+                if h:
+                    try:
+                        (host, port) = parse_address(h, allow_ranges=False)
+                    except AnsibleError as e:
+                        self.display.vvv("Unable to parse address from hostname, leaving unchanged: %s" % to_native(e))
+                        host = h
+                        port = None
+
+                    if host not in self.inventory.hosts:
+                        self.inventory.add_host(host, group='ungrouped', port=port)
+        except Exception as e:
+            raise AnsibleParserError("Invalid data from string, could not parse: %s" % str(e))