revamped base CLI and moved galaxy to it's own classes/api

CHANGELOG.md

@@ -27,6 +27,7 @@ New Modules:
   * cloudstack: cs_securitygroup_rule
   * cloudstack: cs_vmsnapshot
   * maven_artifact
+  * openstack: os_server_facts
   * pushover
   * zabbix_host
   * zabbix_hostmacro

v2/ansible/constants.py

@@ -40,13 +40,15 @@ def get_config(p, section, key, env_var, default, boolean=False, integer=False,
     ''' return a configuration variable with casting '''
     value = _get_config(p, section, key, env_var, default)
     if boolean:
-        return mk_boolean(value)
-    if value and integer:
-        return int(value)
-    if value and floating:
-        return float(value)
-    if value and islist:
-        return [x.strip() for x in value.split(',')]
+        value = mk_boolean(value)
+    if value:
+        if integer:
+            value = int(value)
+        elif floating:
+            value = float(value)
+        elif islist:
+            if isinstance(value, basestring):
+                value = [x.strip() for x in value.split(',')]
     return value
 
 def _get_config(p, section, key, env_var, default):
@@ -104,7 +106,7 @@ def shell_expand_path(path):
 
 # configurable things
 DEFAULT_DEBUG             = get_config(p, DEFAULTS, 'debug',            'ANSIBLE_DEBUG',            False, boolean=True)
-DEFAULT_HOST_LIST         = shell_expand_path(get_config(p, DEFAULTS, 'inventory', 'ANSIBLE_INVENTORY', get_config(p, DEFAULTS,'hostfile','ANSIBLE_HOSTS', '/etc/ansible/hosts')))
+DEFAULT_HOST_LIST         = shell_expand_path(get_config(p, DEFAULTS, 'hostfile', 'ANSIBLE_HOSTS', get_config(p, DEFAULTS,'inventory','ANSIBLE_INVENTORY', '/etc/ansible/hosts')))
 DEFAULT_MODULE_PATH       = get_config(p, DEFAULTS, 'library',          'ANSIBLE_LIBRARY',          None)
 DEFAULT_ROLES_PATH        = shell_expand_path(get_config(p, DEFAULTS, 'roles_path',       'ANSIBLE_ROLES_PATH',       '/etc/ansible/roles'))
 DEFAULT_REMOTE_TMP        = get_config(p, DEFAULTS, 'remote_tmp',       'ANSIBLE_REMOTE_TEMP',      '$HOME/.ansible/tmp')
@@ -203,10 +205,16 @@ def shell_expand_path(path):
 ACCELERATE_MULTI_KEY           = get_config(p, 'accelerate', 'accelerate_multi_key', 'ACCELERATE_MULTI_KEY', False, boolean=True)
 PARAMIKO_PTY                   = get_config(p, 'paramiko_connection', 'pty', 'ANSIBLE_PARAMIKO_PTY', True, boolean=True)
 
+# galaxy related
+DEFAULT_GALAXY_URI             = get_config(p, 'galaxy', 'server_uri', 'ANSIBLE_GALAXY_SERVER_URI', 'https://galaxy.ansible.com')
+# this can be configured to blacklist SCMS but cannot add new ones unless the code is also updated
+GALAXY_SCMS                    = get_config(p, 'galaxy', 'scms', 'ANSIBLE_GALAXY_SCMS', ['git','hg'], islist=True)
+
 # characters included in auto-generated passwords
 DEFAULT_PASSWORD_CHARS = ascii_letters + digits + ".,:-_"
 
 # non-configurable things
+MODULE_REQUIRE_ARGS       = ['command', 'shell', 'raw', 'script']
 DEFAULT_BECOME_PASS       = None
 DEFAULT_SUDO_PASS         = None
 DEFAULT_REMOTE_PASS       = None

v2/ansible/errors/__init__.py

@@ -140,6 +140,10 @@ def _get_extended_error(self):
 
         return error_message
 
+class AnsibleOptionsError(AnsibleError):
+    ''' bad or incomplete options passed '''
+    pass
+
 class AnsibleParserError(AnsibleError):
     ''' something was detected early that is wrong about a playbook or data file '''
     pass
@@ -164,14 +168,18 @@ class AnsibleFilterError(AnsibleRuntimeError):
     ''' a templating failure '''
     pass
 
+class AnsibleLookupError(AnsibleRuntimeError):
+    ''' a lookup failure '''
+    pass
+
+class AnsibleCallbackError(AnsibleRuntimeError):
+    ''' a callback failure '''
+    pass
+
 class AnsibleUndefinedVariable(AnsibleRuntimeError):
     ''' a templating failure '''
     pass
 
 class AnsibleFileNotFound(AnsibleRuntimeError):
     ''' a file missing failure '''
     pass
-
-class AnsibleParserError(AnsibleRuntimeError):
-    ''' a parser error '''
-    pass

v2/ansible/galaxy/__init__.py

@@ -0,0 +1,70 @@
+########################################################################
+#
+# (C) 2015, Brian Coca <bcoca@ansible.com>
+#
+# 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/>.
+#
+########################################################################
+''' This manages remote shared Ansible objects, mainly roles'''
+
+import os
+
+from ansible.errors import AnsibleError
+from ansible.utils.display import Display
+
+#      default_readme_template
+#      default_meta_template
+
+
+class Galaxy(object):
+    ''' Keeps global galaxy info '''
+
+    def __init__(self, options, display=None):
+
+        if display is None:
+            self.display = Display()
+        else:
+            self.display = display
+
+        self.options = options
+        self.roles_path = getattr(self.options, 'roles_path', None)
+        if self.roles_path:
+            self.roles_path = os.path.expanduser(self.roles_path)
+
+        self.roles =  {}
+
+        # load data path for resource usage
+        this_dir, this_filename = os.path.split(__file__)
+        self.DATA_PATH = os.path.join(this_dir, "data")
+
+        #TODO: move to getter for lazy loading
+        self.default_readme = self._str_from_data_file('readme')
+        self.default_meta = self._str_from_data_file('metadata_template.j2')
+
+    def add_role(self, role):
+        self.roles[role.name] = role
+
+    def remove_role(self, role_name):
+        del self.roles[role_name]
+
+
+    def _str_from_data_file(self, filename):
+        myfile = os.path.join(self.DATA_PATH, filename)
+        try:
+            return open(myfile).read()
+        except Exception as e:
+            raise AnsibleError("Could not open %s: %s" % (filename, str(e)))
+

v2/ansible/galaxy/api.py

@@ -0,0 +1,141 @@
+#!/usr/bin/env python
+
+########################################################################
+#
+# (C) 2013, James Cammarata <jcammarata@ansible.com>
+#
+# 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/>.
+#
+########################################################################
+import json
+from urllib2 import urlopen, quote as urlquote
+from urlparse import urlparse
+
+from ansible.errors import AnsibleError
+
+class GalaxyAPI(object):
+    ''' This class is meant to be used as a API client for an Ansible Galaxy server '''
+
+    SUPPORTED_VERSIONS = ['v1']
+
+    def __init__(self, galaxy, api_server):
+
+        self.galaxy = galaxy
+
+        try:
+            urlparse(api_server, scheme='https')
+        except:
+            raise AnsibleError("Invalid server API url passed: %s" % api_server)
+
+        server_version = self.get_server_api_version('%s/api/' % (api_server))
+        if not server_version:
+            raise AnsibleError("Could not retrieve server API version: %s" % api_server)
+
+        if server_version in self.SUPPORTED_VERSIONS:
+            self.baseurl = '%s/api/%s' % (api_server, server_version)
+            self.version = server_version # for future use
+            self.galaxy.display.vvvvv("Base API: %s" % self.baseurl)
+        else:
+            raise AnsibleError("Unsupported Galaxy server API version: %s" % server_version)
+
+    def get_server_api_version(self, api_server):
+        """
+        Fetches the Galaxy API current version to ensure
+        the API server is up and reachable.
+        """
+        #TODO: fix galaxy server which returns current_version path (/api/v1) vs actual version (v1)
+        # also should set baseurl using supported_versions which has path
+        return 'v1'
+
+        try:
+            data = json.load(urlopen(api_server))
+            return data.get("current_version", 'v1')
+        except Exception as e:
+            # TODO: report error
+            return None
+
+    def lookup_role_by_name(self, role_name, notify=True):
+        """
+        Find a role by name
+        """
+        role_name = urlquote(role_name)
+
+        try:
+            parts = role_name.split(".")
+            user_name = ".".join(parts[0:-1])
+            role_name = parts[-1]
+            if notify:
+                self.galaxy.display.display("- downloading role '%s', owned by %s" % (role_name, user_name))
+        except:
+            raise AnsibleError("- invalid role name (%s). Specify role as format: username.rolename" % role_name)
+
+        url = '%s/roles/?owner__username=%s&name=%s' % (self.baseurl, user_name, role_name)
+        self.galaxy.display.vvvv("- %s" % (url))
+        try:
+            data = json.load(urlopen(url))
+            if len(data["results"]) != 0:
+                return data["results"][0]
+        except:
+            # TODO: report on connection/availability errors
+            pass
+
+        return None
+
+    def fetch_role_related(self, related, role_id):
+        """
+        Fetch the list of related items for the given role.
+        The url comes from the 'related' field of the role.
+        """
+
+        try:
+            url = '%s/roles/%d/%s/?page_size=50' % (self.baseurl, int(role_id), related)
+            data = json.load(urlopen(url))
+            results = data['results']
+            done = (data.get('next', None) == None)
+            while not done:
+                url = '%s%s' % (self.baseurl, data['next'])
+                self.galaxy.display.display(url)
+                data = json.load(urlopen(url))
+                results += data['results']
+                done = (data.get('next', None) == None)
+            return results
+        except:
+            return None
+
+    def get_list(self, what):
+        """
+        Fetch the list of items specified.
+        """
+
+        try:
+            url = '%s/%s/?page_size' % (self.baseurl, what)
+            data = json.load(urlopen(url))
+            if "results" in data:
+                results = data['results']
+            else:
+                results = data
+            done = True
+            if "next" in data:
+                done = (data.get('next', None) == None)
+            while not done:
+                url = '%s%s' % (self.baseurl, data['next'])
+                self.galaxy.display.display(url)
+                data = json.load(urlopen(url))
+                results += data['results']
+                done = (data.get('next', None) == None)
+            return results
+        except Exception as error:
+            raise AnsibleError("Failed to download the %s list: %s" % (what, str(error)))

v2/ansible/galaxy/data/metadata_template.j2

@@ -0,0 +1,45 @@
+galaxy_info:
+  author: {{ author }}
+  description: {{description}}
+  company: {{ company }}
+  # If the issue tracker for your role is not on github, uncomment the
+  # next line and provide a value
+  # issue_tracker_url: {{ issue_tracker_url }}
+  # Some suggested licenses:
+  # - BSD (default)
+  # - MIT
+  # - GPLv2
+  # - GPLv3
+  # - Apache
+  # - CC-BY
+  license: {{ license }}
+  min_ansible_version: {{ min_ansible_version }}
+  #
+  # Below are all platforms currently available. Just uncomment
+  # the ones that apply to your role. If you don't see your
+  # platform on this list, let us know and we'll get it added!
+  #
+  #platforms:
+  {%- for platform,versions in platforms.iteritems() %}
+  #- name: {{ platform }}
+  #  versions:
+  #  - all
+    {%- for version in versions %}
+  #  - {{ version }}
+    {%- endfor %}
+  {%- endfor %}
+  #
+  # Below are all categories currently available. Just as with
+  # the platforms above, uncomment those that apply to your role.
+  #
+  #categories:
+  {%- for category in categories %}
+  #- {{ category.name }}
+  {%- endfor %}
+dependencies: []
+  # List your role dependencies here, one per line.
+  # Be sure to remove the '[]' above if you add dependencies
+  # to this list.
+  {% for dependency in dependencies %}
+  #- {{ dependency }}
+  {% endfor %}

v2/ansible/galaxy/data/readme

@@ -0,0 +1,38 @@
+Role Name
+=========
+
+A brief description of the role goes here.
+
+Requirements
+------------
+
+Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+
+Role Variables
+--------------
+
+A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+
+Dependencies
+------------
+
+A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+
+    - hosts: servers
+      roles:
+         - { role: username.rolename, x: 42 }
+
+License
+-------
+
+BSD
+
+Author Information
+------------------
+
+An optional section for the role authors to include contact information, or a website (HTML is not allowed).