Merge lp:~tvansteenburgh/charm-tools/proof-tags into lp:charm-tools/1.4

[Tim Van Steenburgh]

Updated proof to handle tags in metadata.yaml

- metadata must have either categories or tags, both of which must
  be a non-empty list
- if categories present, output INFO msg to change to tags
- all icon proof output is now info-only
- updated charm-create templates to use tags instead of
  categories, with a link to list of whitelisted tags in the docs

=== modified file 'charmtools/charms.py'
--- charmtools/charms.py	2014-08-28 18:10:06 +0000
+++ charmtools/charms.py	2014-10-22 20:07:30 +0000
@@ -11,17 +11,20 @@
 from linter import Linter
 from launchpadlib.launchpad import Launchpad
 
-KNOWN_METADATA_KEYS = ['name',
-                       'summary',
-                       'maintainer',
-                       'maintainers',
-                       'description',
-                       'categories',
-                       'subordinate',
-                       'provides',
-                       'requires',
-                       'format',
-                       'peers']
+KNOWN_METADATA_KEYS = [
+    'name',
+    'summary',
+    'maintainer',
+    'maintainers',
+    'description',
+    'categories',
+    'subordinate',
+    'provides',
+    'requires',
+    'format',
+    'peers',
+    'tags',
+]
 
 KNOWN_RELATION_KEYS = ['interface', 'scope', 'limit', 'optional']
 
@@ -247,32 +250,21 @@
 
             charm_basename = os.path.basename(charm_path)
             if charm['name'] != charm_basename:
-                warn_msg = ("metadata name (%s) must match directory name (%s)"
-                            " exactly for local deployment.") % (
-                                charm['name'], charm_basename)
+                warn_msg = (
+                    "metadata name (%s) must match directory name (%s)"
+                    " exactly for local deployment.") % (charm['name'],
+                                                         charm_basename)
                 lint.warn(warn_msg)
 
             # summary should be short
             if len(charm['summary']) > 72:
                 lint.warn('summary sould be less than 72')
 
-            # validate maintainer info
             validate_maintainer(charm, lint)
-
-            if 'categories' not in charm:
-                lint.warn('Metadata is missing categories.')
-            else:
-                categories = charm['categories']
-                if type(categories) != list or categories == []:
-                    # The category names are not validated because they may
-                    # change.
-                    lint.warn(
-                        'Categories metadata must be a list of one or more of:'
-                        ' applications, app-servers, databases, file-servers, '
-                        'cache-proxy, misc')
+            validate_categories_and_tags(charm, lint)
 
             if not os.path.exists(os.path.join(charm_path, 'icon.svg')):
-                lint.warn("No icon.svg file.")
+                lint.info("No icon.svg file.")
             else:
                 # should have an icon.svg
                 template_sha1 = hashlib.sha1()
@@ -283,9 +275,9 @@
                         with open(os.path.join(charm_path, 'icon.svg')) as ci:
                             icon_sha1.update(ci.read())
                     if template_sha1.hexdigest() == icon_sha1.hexdigest():
-                        lint.warn("Includes template icon.svg file.")
+                        lint.info("Includes template icon.svg file.")
                 except IOError as e:
-                    lint.warn(
+                    lint.info(
                         "Error while opening %s (%s)" %
                         (e.filename, e.strerror))
 
@@ -459,6 +451,31 @@
                 'not "%s"' % formatted)
 
 
+def validate_categories_and_tags(charm, linter):
+    if 'categories' not in charm and 'tags' not in charm:
+        linter.warn('Metadata missing required field "tags"')
+        return
+
+    if 'tags' in charm:
+        tags = charm['tags']
+        if type(tags) != list or tags == []:
+            linter.warn('Metadata field "tags" must be a non-empty list')
+
+    if 'categories' in charm:
+        categories = charm['categories']
+        if type(categories) != list or categories == []:
+            # The category names are not validated because they may
+            # change.
+            linter.warn(
+                'Categories metadata must be a list of one or more of: '
+                'applications, app-servers, databases, file-servers, '
+                'cache-proxy, misc')
+        linter.info(
+            'Categories are being deprecated in favor of tags. '
+            'Please rename the "categories" field to "tags".'
+        )
+
+
 def remote():
     lp = Launchpad.login_anonymously('charm-tools', 'production',
                                      version='devel')

=== modified file 'charmtools/templates/ansible/files/metadata.yaml'
--- charmtools/templates/ansible/files/metadata.yaml	2014-06-25 16:31:59 +0000
+++ charmtools/templates/ansible/files/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -3,7 +3,9 @@
 maintainer: $metadata.maintainer
 description: |
   $metadata.description
-categories:
+tags:
+  # Replace "misc" with one or more whitelisted tags from this list:
+  # https://juju.ubuntu.com/docs/authors-charm-metadata.html#charm-metadata
   - misc
 subordinate: false
 provides:

=== modified file 'charmtools/templates/bash/files/metadata.yaml'
--- charmtools/templates/bash/files/metadata.yaml	2014-05-22 20:28:08 +0000
+++ charmtools/templates/bash/files/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -3,7 +3,9 @@
 maintainer: $metadata.maintainer
 description: |
   $metadata.description
-categories:
+tags:
+  # Replace "misc" with one or more whitelisted tags from this list:
+  # https://juju.ubuntu.com/docs/authors-charm-metadata.html#charm-metadata
   - misc
 subordinate: false
 provides:

=== modified file 'charmtools/templates/python/files/metadata.yaml'
--- charmtools/templates/python/files/metadata.yaml	2014-05-23 20:10:24 +0000
+++ charmtools/templates/python/files/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -3,7 +3,9 @@
 maintainer: $metadata.maintainer
 description: |
   $metadata.description
-categories:
+tags:
+  # Replace "misc" with one or more whitelisted tags from this list:
+  # https://juju.ubuntu.com/docs/authors-charm-metadata.html#charm-metadata
   - misc
 subordinate: false
 provides:

=== modified file 'charmtools/templates/python_services/files/metadata.yaml'
--- charmtools/templates/python_services/files/metadata.yaml	2014-09-10 18:38:30 +0000
+++ charmtools/templates/python_services/files/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -3,7 +3,9 @@
 maintainer: $metadata.maintainer
 description: |
   $metadata.description
-categories:
+tags:
+  # Replace "misc" with one or more whitelisted tags from this list:
+  # https://juju.ubuntu.com/docs/authors-charm-metadata.html#charm-metadata
   - misc
 subordinate: false
 provides:

=== modified file 'tests/test_charm_proof.py'
--- tests/test_charm_proof.py	2014-08-28 18:10:06 +0000
+++ tests/test_charm_proof.py	2014-10-22 20:07:30 +0000
@@ -31,6 +31,7 @@
 
 from charmtools.charms import CharmLinter as Linter
 from charmtools.charms import validate_maintainer
+from charmtools.charms import validate_categories_and_tags
 
 
 class TestCharmProof(TestCase):
@@ -342,6 +343,52 @@
         self.assertTrue(self.linter.lint[0].startswith(expected))
 
 
+class CategoriesTagsValidationTest(TestCase):
+    def test_no_categories_or_tags(self):
+        """Charm has neither categories nor tags."""
+        linter = Mock()
+        charm = {}
+        validate_categories_and_tags(charm, linter)
+        linter.warn.assert_called_once_with(
+            'Metadata missing required field "tags"')
+
+    def test_invalid_tags(self):
+        """Charm has invalid tags field"""
+        warning = 'Metadata field "tags" must be a non-empty list'
+        linter = Mock()
+        validate_categories_and_tags({'tags': 'foo'}, linter)
+        linter.warn.assert_called_once_with(warning)
+        linter.reset_mock()
+        validate_categories_and_tags({'tags': []}, linter)
+        linter.warn.assert_called_once_with(warning)
+
+    def test_invalid_categories(self):
+        """Charm has invalid categories field"""
+        warning = (
+            'Categories metadata must be a list of one or more of: '
+            'applications, app-servers, databases, file-servers, '
+            'cache-proxy, misc'
+        )
+        linter = Mock()
+        validate_categories_and_tags({'categories': 'foo'}, linter)
+        linter.warn.assert_called_once_with(warning)
+        linter.reset_mock()
+        validate_categories_and_tags({'categories': []}, linter)
+        linter.warn.assert_called_once_with(warning)
+
+    def test_valid_categories(self):
+        """Charm has valid categories, which should be changed to tags"""
+        info = (
+            'Categories are being deprecated in favor of tags. '
+            'Please rename the "categories" field to "tags".'
+        )
+        linter = Mock()
+        validate_categories_and_tags({'categories': ['misc']}, linter)
+        linter.info.assert_called_once_with(info)
+        self.assertFalse(linter.warn.called)
+        self.assertFalse(linter.err.called)
+
+
 class MaintainerValidationTest(TestCase):
     def test_two_maintainer_fields(self):
         """Charm has maintainer AND maintainers."""

=== modified file 'tests_functional/charms/broken-config/metadata.yaml'
--- tests_functional/charms/broken-config/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/charms/broken-config/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -1,7 +1,7 @@
 name: broken-config
 summary: <Fill in summary here>
 maintainer: test@testhost
-categories:
+tags:
   - misc
 description: |
   <Multi-line description here>

=== modified file 'tests_functional/charms/broken-maintainer/metadata.yaml'
--- tests_functional/charms/broken-maintainer/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/charms/broken-maintainer/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -3,7 +3,7 @@
 maintainer: test@testhost>
 description: |
   <Multi-line description here>
-categories:
+tags:
   - misc
 provides:
   relation-name:

=== modified file 'tests_functional/charms/broken-subordinate/metadata.yaml'
--- tests_functional/charms/broken-subordinate/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/charms/broken-subordinate/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -4,5 +4,5 @@
 maintainer: test@testhost
 description: |
   <Multi-line description here>
-categories:
+tags:
   - misc

=== modified file 'tests_functional/charms/broken-subordinate2/metadata.yaml'
--- tests_functional/charms/broken-subordinate2/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/charms/broken-subordinate2/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -4,7 +4,7 @@
 maintainer: test@testhost
 description: |
   <Multi-line description here>
-categories:
+tags:
   - misc
 requires:
   foo:

=== modified file 'tests_functional/charms/empty-requires/metadata.yaml'
--- tests_functional/charms/empty-requires/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/charms/empty-requires/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -6,5 +6,5 @@
 provides:
 requires:
 peers:
-categories:
+tags:
   - misc

=== modified file 'tests_functional/charms/icon-template/metadata.yaml'
--- tests_functional/charms/icon-template/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/charms/icon-template/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -3,7 +3,7 @@
 maintainer: test@testhost
 description: |
   <Multi-line description here>
-categories:
+tags:
   - misc
 provides:
   relation-name:

=== modified file 'tests_functional/charms/missing-maintainer/metadata.yaml'
--- tests_functional/charms/missing-maintainer/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/charms/missing-maintainer/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -2,7 +2,7 @@
 summary: <Fill in summary here>
 description: |
   <Multi-line description here>
-categories:
+tags:
   - misc
 provides:
   relation-name:

=== modified file 'tests_functional/charms/mod-spdy/metadata.yaml'
--- tests_functional/charms/mod-spdy/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/charms/mod-spdy/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -6,7 +6,7 @@
   mod_spdy is a SPDY module for Apache 2.2 that allows your web server
   to take advantage of SPDY features like stream multiplexing and header
   compression.
-categories:
+tags:
   - misc
 requires:
   juju-info:

=== modified file 'tests_functional/charms/unknown-metadata/metadata.yaml'
--- tests_functional/charms/unknown-metadata/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/charms/unknown-metadata/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -4,7 +4,7 @@
 maintainer: test@testhost
 description: |
   <Multi-line description here>
-categories:
+tags:
   - misc
 provides:
   relation-name:

=== modified file 'tests_functional/create/no-package-exists/metadata.yaml'
--- tests_functional/create/no-package-exists/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/create/no-package-exists/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -3,7 +3,9 @@
 maintainer: tester <test@testhost>
 description: |
   <Multi-line description here>
-categories:
+tags:
+  # Replace "misc" with one or more whitelisted tags from this list:
+  # https://juju.ubuntu.com/docs/authors-charm-metadata.html#charm-metadata
   - misc
 subordinate: false
 provides:

=== modified file 'tests_functional/create/python-apt/metadata.yaml'
--- tests_functional/create/python-apt/metadata.yaml	2013-11-11 19:08:11 +0000
+++ tests_functional/create/python-apt/metadata.yaml	2014-10-22 20:07:30 +0000
@@ -10,7 +10,9 @@
   structure The included 'aptsources' Python interface provides an
   abstraction of the sources.list configuration on the repository and
   the distro level.
-categories:
+tags:
+  # Replace "misc" with one or more whitelisted tags from this list:
+  # https://juju.ubuntu.com/docs/authors-charm-metadata.html#charm-metadata
   - misc
 subordinate: false
 provides:

=== modified file 'tests_functional/create/test_ansible_create.py'
--- tests_functional/create/test_ansible_create.py	2014-09-09 18:55:59 +0000
+++ tests_functional/create/test_ansible_create.py	2014-10-22 20:07:30 +0000
@@ -40,6 +40,7 @@
 
 class AnsibleCreateTest(TestCase):
     maxDiff = None
+
     def setUp(self):
         self.tempdir = tempfile.mkdtemp()
 
@@ -67,10 +68,12 @@
             'lib/charmhelpers/core/services/__init__.py',
             'lib/charmhelpers/core/services/base.py',
             'lib/charmhelpers/core/services/helpers.py',
+            'lib/charmhelpers/core/sysctl.py',
             'lib/charmhelpers/core/templating.py',
             'lib/charmhelpers/fetch/__init__.py',
             'lib/charmhelpers/fetch/archiveurl.py',
             'lib/charmhelpers/fetch/bzrurl.py',
+            'lib/charmhelpers/fetch/giturl.py',
         ]
         return sorted(static_files + dynamic_files)
 

=== modified file 'tests_functional/create/test_python_create.py'
--- tests_functional/create/test_python_create.py	2014-09-26 15:09:14 +0000
+++ tests_functional/create/test_python_create.py	2014-10-22 20:07:30 +0000
@@ -59,6 +59,7 @@
             'lib/charmhelpers/core/services/__init__.py',
             'lib/charmhelpers/core/services/base.py',
             'lib/charmhelpers/core/services/helpers.py',
+            'lib/charmhelpers/core/sysctl.py',
             'lib/charmhelpers/core/templating.py',
         ]
         return sorted(static_files + dynamic_files)

=== modified file 'tests_functional/proof/expected/broken-categories'
--- tests_functional/proof/expected/broken-categories	2014-05-16 06:06:43 +0000
+++ tests_functional/proof/expected/broken-categories	2014-10-22 20:07:30 +0000
@@ -1,2 +1,3 @@
 W: Categories metadata must be a list of one or more of: applications, app-servers, databases, file-servers, cache-proxy, misc
+I: Categories are being deprecated in favor of tags. Please rename the "categories" field to "tags".
 I: missing recommended hook config-changed

=== modified file 'tests_functional/proof/expected/icon-template'
--- tests_functional/proof/expected/icon-template	2014-05-16 06:06:43 +0000
+++ tests_functional/proof/expected/icon-template	2014-10-22 20:07:30 +0000
@@ -1,4 +1,4 @@
-W: Includes template icon.svg file.
+I: Includes template icon.svg file.
 W: no copyright file
 W: Includes template README.ex file
 W: README.ex includes line 1 of boilerplate README.ex

=== modified file 'tests_functional/proof/expected/test'
--- tests_functional/proof/expected/test	2014-05-16 06:06:43 +0000
+++ tests_functional/proof/expected/test	2014-10-22 20:07:30 +0000
@@ -1,5 +1,5 @@
-W: Metadata is missing categories.
-W: No icon.svg file.
+W: Metadata missing required field "tags"
+I: No icon.svg file.
 W: no copyright file
 W: Includes template README.ex file
 W: README.ex includes line 1 of boilerplate README.ex