_modules/node.py

   1 # -*- coding: utf-8 -*-
   2
   3 #   -------------------------------------------------------------
   4 #   Salt — Node execution module
   5 #   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   6 #   Project:        Nasqueron
   7 #   Created:        2017-10-21
   8 #   Description:    Functions related to the nodes pillar entry
   9 #   License:        BSD-2-Clause
  10 #   -------------------------------------------------------------
  11
  12
  13 from salt.exceptions import CommandExecutionError, SaltCloudConfigError
  14
  15
  16 def _get_all_nodes():
  17     return __pillar__.get('nodes', {})
  18
  19
  20 def get_all_properties(nodename=None):
  21     '''
  22     A function to get a node pillar configuration.
  23
  24     CLI Example:
  25
  26         salt * node.get_all_properties
  27     '''
  28     if nodename is None:
  29         nodename = __grains__['id']
  30
  31     all_nodes = _get_all_nodes()
  32
  33     if nodename not in all_nodes:
  34         raise CommandExecutionError(
  35             SaltCloudConfigError(
  36                 "Node {0} not declared in pillar.".format(nodename)
  37             )
  38         )
  39
  40     return all_nodes[nodename]
  41
  42
  43 def get(key, nodename=None):
  44     '''
  45     A function to get a node pillar configuration key.
  46
  47     CLI Example:
  48
  49         salt * node.get hostname
  50     '''
  51     return _get_property(key, nodename, None)
  52
  53
  54 def _explode_key(k): return k.split(':')
  55
  56
  57 def _get_first_key(k): return _explode_key(k)[0]
  58
  59
  60 def _strip_first_key(k): return ':'.join(_explode_key(k)[1:])
  61
  62
  63 def _get_property(key, nodename, default_value, parent=None):
  64     if parent is None:
  65         parent = get_all_properties(nodename)
  66
  67     if ':' in key:
  68         first_key = _get_first_key(key)
  69         if first_key in parent:
  70             return _get_property(
  71                 _strip_first_key(key), nodename,
  72                 default_value, parent[first_key]
  73             )
  74     elif key in parent:
  75         return parent[key]
  76
  77     return default_value
  78
  79
  80 def list(key, nodename=None):
  81     '''
  82     A function to get a node pillar configuration.
  83
  84     Returns a list if found, or an empty list if not found.
  85
  86     CLI Example:
  87
  88         salt * node.list network:ipv4_aliases
  89     '''
  90     return _get_property(key, nodename, [])
  91
  92
  93 def has(key, nodename=None):
  94     '''
  95     A function to get a node pillar configuration.
  96
  97     Returns a boolean, False if not found.
  98
  99     CLI Example:
 100
 101         salt * node.has network:ipv6_tunnel
 102     '''
 103     value = _get_property(key, nodename, False)
 104     return bool(value)
 105
 106
 107 def has_role(role, nodename=None):
 108     '''
 109     A function to determine if a node has the specified role.
 110
 111     Returns a boolean, False if not found.
 112
 113     CLI Example:
 114
 115         salt * node.has_role devserver
 116     '''
 117     return role in list('roles', nodename)