Merge branch '2018.3' into tag_manager

README.rst

@@ -2,7 +2,7 @@
 What is SaltStack?
 ==================
 
-SaltStack makes software for complex systems management at scale.
+SaltStack makes software for complex systems management at scale.
 SaltStack is the company that created and maintains the Salt Open
 project and develops and sells SaltStack Enterprise software, services
 and support. Easy enough to get running in minutes, scalable enough to

doc/topics/jinja/index.rst

@@ -87,6 +87,13 @@ the context into the included file is required:
 .. code-block:: jinja
 
     {% from 'lib.sls' import test with context %}
+    
+Includes must use full paths, like so:
+
+.. code-block:: jinja
+   :caption: spam/eggs.jinja
+
+    {% include 'spam/foobar.jinja' %}
 
 Including Context During Include/Import
 ---------------------------------------

salt/fileserver/roots.py

@@ -303,8 +303,8 @@ def _file_lists(load, form):
         except os.error:
             log.critical('Unable to make cachedir %s', list_cachedir)
             return []
-    list_cache = os.path.join(list_cachedir, '{0}.p'.format(load['saltenv']))
-    w_lock = os.path.join(list_cachedir, '.{0}.w'.format(load['saltenv']))
+    list_cache = os.path.join(list_cachedir, '{0}.p'.format(salt.utils.files.safe_filename_leaf(load['saltenv'])))
+    w_lock = os.path.join(list_cachedir, '.{0}.w'.format(salt.utils.files.safe_filename_leaf(load['saltenv'])))
     cache_match, refresh_cache, save_cache = \
         salt.fileserver.check_file_list_cache(
             __opts__, form, list_cache, w_lock

salt/modules/capirca_acl.py

@@ -19,8 +19,7 @@ The firewall configuration is generated by Capirca_.
 
 .. _Capirca: https://github.com/google/capirca
 
-Capirca is not yet available on PyPI threrefore it has to be installed
-directly form Git: ``pip install -e git+git@github.com:google/capirca.git#egg=aclgen``.
+To install Capirca, execute: ``pip install capirca``.
 '''
 from __future__ import absolute_import, print_function, unicode_literals
 
@@ -34,7 +33,10 @@ log = logging.getLogger(__file__)
 # Import third party libs
 from salt.ext import six
 try:
-    import aclgen
+    import capirca
+    import capirca.aclgen
+    import capirca.lib.policy
+    import capirca.lib.aclgenerator
     HAS_CAPIRCA = True
 except ImportError:
     HAS_CAPIRCA = False
@@ -69,10 +71,12 @@ def __virtual__():
 # module globals
 # ------------------------------------------------------------------------------
 
+
 # define the default values for all possible term fields
 # we could also extract them from the `policy` module, inspecting the `Policy`
 # class, but that might be overkill & it would make the code less obvious.
 # we can revisit this later if necessary.
+
 _TERM_FIELDS = {
     'action': [],
     'address': [],
@@ -161,7 +165,19 @@ _SERVICES = {}
 
 
 if HAS_CAPIRCA:
-    class _Policy(aclgen.policy.Policy):
+    _TempTerm = capirca.lib.policy.Term
+
+    def _add_object(self, obj):
+        return
+
+    setattr(_TempTerm, 'AddObject', _add_object)
+    dumy_term = _TempTerm(None)
+    for item in dir(dumy_term):
+        if hasattr(item, '__func__') or item.startswith('_') or item != item.lower():
+            continue
+        _TERM_FIELDS[item] = getattr(dumy_term, item)
+
+    class _Policy(capirca.lib.policy.Policy):
         '''
         Extending the Capirca Policy class to allow inserting custom filters.
         '''
@@ -169,7 +185,7 @@ if HAS_CAPIRCA:
             self.filters = []
             self.filename = ''
 
-    class _Term(aclgen.policy.Term):
+    class _Term(capirca.lib.policy.Term):
         '''
         Extending the Capirca Term class to allow setting field valued on the fly.
         '''
@@ -186,10 +202,10 @@ def _import_platform_generator(platform):
     for a class inheriting the `ACLGenerator` class.
     '''
     log.debug('Using platform: {plat}'.format(plat=platform))
-    for mod_name, mod_obj in inspect.getmembers(aclgen):
+    for mod_name, mod_obj in inspect.getmembers(capirca.aclgen):
         if mod_name == platform and inspect.ismodule(mod_obj):
             for plat_obj_name, plat_obj in inspect.getmembers(mod_obj):  # pylint: disable=unused-variable
-                if inspect.isclass(plat_obj) and issubclass(plat_obj, aclgen.aclgenerator.ACLGenerator):
+                if inspect.isclass(plat_obj) and issubclass(plat_obj, capirca.lib.aclgenerator.ACLGenerator):
                     log.debug('Identified Capirca class {cls} for {plat}'.format(
                         cls=plat_obj,
                         plat=platform))
@@ -366,7 +382,11 @@ def _clean_term_opts(term_opts):
                 # IP-type fields need to be transformed
                 ip_values = []
                 for addr in value:
-                    ip_values.append(aclgen.policy.nacaddr.IP(addr))
+                    if six.PY2:
+                        addr = six.text_type(addr)
+                        # Adding this, as ipaddress would complain about valid
+                        # addresses not being valid. #pythonIsFun
+                    ip_values.append(capirca.lib.policy.nacaddr.IP(addr))
                 value = ip_values[:]
             clean_opts[field] = value
     return clean_opts
@@ -427,7 +447,7 @@ def _merge_list_of_dict(first, second, prepend=True):
     if first and not second:
         return first
     # Determine overlaps
-    # So we don't change the position of the existing terms/filters
+    # So we dont change the position of the existing terms/filters
     overlaps = []
     merged = []
     appended = []
@@ -514,7 +534,7 @@ def _get_policy_object(platform,
             continue  # go to the next filter
         filter_name = filter_.keys()[0]
         filter_config = filter_.values()[0]
-        header = aclgen.policy.Header()  # same header everywhere
+        header = capirca.lib.policy.Header()  # same header everywhere
         target_opts = [
             platform,
             filter_name
@@ -524,7 +544,7 @@ def _get_policy_object(platform,
             filter_options = _make_it_list({}, filter_name, filter_options)
             # make sure the filter options are sent as list
             target_opts.extend(filter_options)
-        target = aclgen.policy.Target(target_opts)
+        target = capirca.lib.policy.Target(target_opts)
         header.AddObject(target)
         filter_terms = []
         for term_ in filter_config.get('terms', []):

salt/modules/napalm_acl.py

@@ -19,6 +19,8 @@ The firewall configuration is generated by Capirca_.
 
 .. _Capirca: https://github.com/google/capirca
 
+To install Capirca, execute: ``pip install capirca``.
+
 To be able to load configuration on network devices,
 it requires NAPALM_ library to be installed:  ``pip install napalm``.
 Please check Installation_ for complete details.
@@ -34,7 +36,10 @@ log = logging.getLogger(__file__)
 # Import third party libs
 try:
     # pylint: disable=W0611
-    import aclgen
+    import capirca
+    import capirca.aclgen
+    import capirca.lib.policy
+    import capirca.lib.aclgenerator
     HAS_CAPIRCA = True
     # pylint: enable=W0611
 except ImportError:

salt/states/netacl.py

@@ -3,7 +3,7 @@
 Network ACL
 ===========
 
-Manage the firewall configuration on the network device namaged through NAPALM.
+Manage the firewall configuration on the network device managed through NAPALM.
 The firewall configuration is generated by Capirca_.
 
 .. _Capirca: https://github.com/google/capirca
@@ -18,7 +18,13 @@ The firewall configuration is generated by Capirca_.
 Dependencies
 ------------
 
-Capirca: ``pip install -e git+git@github.com:google/capirca.git#egg=aclgen``
+Capirca
+~~~~~~~
+
+To install Capirca, execute: ``pip install capirca``.
+
+NAPALM
+~~~~~~
 
 To be able to load configuration on network devices,
 it requires NAPALM_ library to be installed:  ``pip install napalm``.
@@ -35,7 +41,10 @@ log = logging.getLogger(__file__)
 # Import third party libs
 try:
     # pylint: disable=W0611
-    import aclgen
+    import capirca
+    import capirca.aclgen
+    import capirca.lib.policy
+    import capirca.lib.aclgenerator
     HAS_CAPIRCA = True
     # pylint: enable=W0611
 except ImportError:

setup.py

@@ -874,7 +874,10 @@ class SaltDistribution(distutils.dist.Distribution):
         self.name = 'salt-ssh' if PACKAGED_FOR_SALT_SSH else 'salt'
         self.salt_version = __version__  # pylint: disable=undefined-variable
         self.description = 'Portable, distributed, remote execution and configuration management system'
-        with open(SALT_LONG_DESCRIPTION_FILE) as f:
+        kwargs = {}
+        if IS_PY3:
+            kwargs['encoding'] = 'utf-8'
+        with open(SALT_LONG_DESCRIPTION_FILE, **kwargs) as f:
             self.long_description = f.read()
         self.long_description_content_type = 'text/x-rst'
         self.author = 'Thomas S Hatch'

tests/unit/fileserver/test_roots.py

@@ -153,6 +153,17 @@ class RootsTest(TestCase, AdaptedConfigurationTestCaseMixin, LoaderModuleMockMix
         ret = roots.file_list_emptydirs({'saltenv': 'base'})
         self.assertIn('empty_dir', ret)
 
+    def test_file_list_with_slash(self):
+        opts = {'file_roots': copy.copy(self.opts['file_roots'])}
+        opts['file_roots']['foo/bar'] = opts['file_roots']['base']
+        load = {
+                'saltenv': 'foo/bar',
+                }
+        with patch.dict(roots.__opts__, opts):
+            ret = roots.file_list(load)
+        self.assertIn('testfile', ret)
+        self.assertIn(UNICODE_FILENAME, ret)
+
     def test_dir_list(self):
         ret = roots.dir_list({'saltenv': 'base'})
         self.assertIn('empty_dir', ret)