Merge pull request #130 from pelson/hash_it

Added a checksum test to the linter.

Author: pelson

conda_smithy/lint_recipe.py

@@ -5,7 +5,10 @@
 import ruamel.yaml
 
 
-EXPECTED_SECTION_ORDER = ['package', 'source', 'build', 'requirements', 'test', 'app', 'about', 'extra']
+EXPECTED_SECTION_ORDER = ['package', 'source', 'build', 'requirements',
+                          'test', 'app', 'about', 'extra']
+
+REQUIREMENTS_ORDER = ['build', 'run']
 
 
 class NullUndefined(jinja2.Undefined):
@@ -17,32 +20,38 @@ def lintify(meta, recipe_dir=None):
     lints = []
     major_sections = list(meta.keys())
 
-    # If the recipe_dir exists (no guarantee within this function) , we can find the
-    # meta.yaml within it.
+    # If the recipe_dir exists (no guarantee within this function) , we can
+    # find the meta.yaml within it.
     meta_fname = os.path.join(recipe_dir or '', 'meta.yaml')
 
     # 1: Top level meta.yaml keys should have a specific order.
-    section_order_sorted = sorted(major_sections, key=EXPECTED_SECTION_ORDER.index)
+    section_order_sorted = sorted(major_sections,
+                                  key=EXPECTED_SECTION_ORDER.index)
     if major_sections != section_order_sorted:
-        lints.append('The top level meta keys are in an unexpected order. Expecting {}.'.format(section_order_sorted))
+        lints.append('The top level meta keys are in an unexpected order. '
+                     'Expecting {}.'.format(section_order_sorted))
 
     # 2: The about section should have a home, license and summary.
     for about_item in ['home', 'license', 'summary']:
         about_section = meta.get('about', {}) or {}
         # if the section doesn't exist, or is just empty, lint it.
         if not about_section.get(about_item, ''):
-            lints.append('The {} item is expected in the about section.'.format(about_item))
+            lints.append('The {} item is expected in the about section.'
+                         ''.format(about_item))
 
     # 3: The recipe should have some maintainers.
     extra_section = meta.get('extra', {}) or {}
     if not extra_section.get('recipe-maintainers', []):
-        lints.append('The recipe could do with some maintainers listed in the "extra/recipe-maintainers" section.')
+        lints.append('The recipe could do with some maintainers listed in '
+                     'the "extra/recipe-maintainers" section.')
 
     # 4: The recipe should have some tests.
     if 'test' not in major_sections:
-        test_files = ['run_test.py', 'run_test.sh', 'run_test.bat', 'run_test.pl']
+        test_files = ['run_test.py', 'run_test.sh', 'run_test.bat',
+                      'run_test.pl']
         a_test_file_exists = (recipe_dir is not None and
-                              any(os.path.exists(os.path.join(recipe_dir, test_file))
+                              any(os.path.exists(os.path.join(recipe_dir,
+                                                              test_file))
                                   for test_file in test_files))
         if not a_test_file_exists:
             lints.append('The recipe must have some tests.')
@@ -62,8 +71,8 @@ def lintify(meta, recipe_dir=None):
                 if not good_selectors_pat.match(selector_line):
                     bad_selectors.append(selector_line)
         if bad_selectors:
-            lints.append('Selectors are suggested to take a "  # [<selector>]" '
-                         'form.')
+            lints.append('Selectors are suggested to take a '
+                         '"  # [<selector>]" form.')
 
     # 7: The build section should have a build number.
     build_section = meta.get('build', {}) or {}
@@ -73,17 +82,25 @@ def lintify(meta, recipe_dir=None):
 
     # 8: The build section should be before the run section in requirements.
     requirements_section = meta.get('requirements', {}) or {}
-    EXPECTED_REQUIREMENTS_ORDER = ['build', 'run']
-    requirements_order_sorted = sorted(requirements_section, key=EXPECTED_REQUIREMENTS_ORDER.index)
+    requirements_order_sorted = sorted(requirements_section,
+                                       key=REQUIREMENTS_ORDER.index)
     if requirements_section.keys() != requirements_order_sorted:
-        lints.append('The `requirements/build` section should be defined before '
-                     'the `requirements/run` section.')
+        lints.append('The `requirements/build` section should be defined '
+                     'before the `requirements/run` section.')
+
+    # 9: Files downloaded should have a hash.
+    source_section = meta.get('source', {}) or {}
+    if ('url' in source_section and
+            not ({'sha1', 'sha256', 'md5'} & set(source_section.keys()))):
+        lints.append('When defining a source/url please add a sha256, sha1 '
+                     'or md5 checksum (sha256 preferably).')
 
     return lints
 
 
 def selector_lines(lines):
-    # Using the same pattern defined in conda-build (metadata.py), we identify selectors.
+    # Using the same pattern defined in conda-build (metadata.py),
+    # we identify selectors.
     sel_pat = re.compile(r'(.+?)\s*(#.*)?\[(.+)\](?(2).*)$')
 
     for line in lines:
@@ -93,7 +110,7 @@ def selector_lines(lines):
             continue
         m = sel_pat.match(line)
         if m:
-            cond = m.group(3)
+            m.group(3)
             yield line
 
 

conda_smithy/tests/test_lint_recipe.py

@@ -24,8 +24,9 @@ def test_bad_order(self):
                             ['build', {}],
                             ['source', {}]])
         lints = linter.lintify(meta)
-        expected_message = "The top level meta keys are in an unexpected order. Expecting ['package', 'source', 'build']."
-        self.assertIn(expected_message, lints)
+        expected_msg = ("The top level meta keys are in an unexpected "
+                        "order. Expecting ['package', 'source', 'build'].")
+        self.assertIn(expected_msg, lints)
 
     def test_missing_about_license_and_summary(self):
         meta = {'about': {'home': 'a URL'}}
@@ -66,7 +67,8 @@ def test_missing_about_home_empty(self):
         self.assertIn(expected_message, lints)
 
     def test_maintainers_section(self):
-        expected_message = 'The recipe could do with some maintainers listed in the "extra/recipe-maintainers" section.'
+        expected_message = ('The recipe could do with some maintainers listed '
+                            'in the "extra/recipe-maintainers" section.')
 
         lints = linter.lintify({'extra': {'recipe-maintainers': []}})
         self.assertIn(expected_message, lints)
@@ -88,7 +90,8 @@ def test_test_section(self):
         self.assertNotIn(expected_message, lints)
 
     def test_test_section_with_recipe(self):
-        # If we have a run_test.py file, we shouldn't need to provide other tests.
+        # If we have a run_test.py file, we shouldn't need to provide
+        # other tests.
 
         expected_message = 'The recipe must have some tests.'
 
@@ -102,7 +105,8 @@ def test_test_section_with_recipe(self):
             self.assertNotIn(expected_message, lints)
 
     def test_selectors(self):
-        expected_message = 'Selectors are suggested to take a "  # [<selector>]" form.'
+        expected_message = ('Selectors are suggested to take a '
+                            '"  # [<selector>]" form.')
 
         with tmp_directory() as recipe_dir:
             def assert_selector(selector, is_good=True):
@@ -114,11 +118,14 @@ def assert_selector(selector, is_good=True):
                              """.format(selector))
                 lints = linter.lintify({}, recipe_dir)
                 if is_good:
-                    message = "Found lints when there shouldn't have been a lint for '{}'.".format(selector)
+                    message = ("Found lints when there shouldn't have been a "
+                               "lint for '{}'.".format(selector))
                 else:
-                    message = "Expecting lints for '{}', but didn't get any.".format(selector)
+                    message = ("Expecting lints for '{}', but didn't get any."
+                               "".format(selector))
                 self.assertEqual(not is_good,
-                                 any(lint.startswith(expected_message) for lint in lints),
+                                 any(lint.startswith(expected_message)
+                                     for lint in lints),
                                  message)
 
             assert_selector("name: foo_py3      # [py3k]")
@@ -141,8 +148,8 @@ def test_missing_build_number(self):
         self.assertIn(expected_message, lints)
 
     def test_bad_requirements_order(self):
-        expected_message = ("The `requirements/build` section should be defined "
-                            "before the `requirements/run` section.")
+        expected_message = ("The `requirements/build` section should be "
+                            "defined before the `requirements/run` section.")
 
         meta = {'requirements': OrderedDict([['run', 'a'],
                                              ['build', 'a']])}
@@ -154,6 +161,21 @@ def test_bad_requirements_order(self):
         lints = linter.lintify(meta)
         self.assertNotIn(expected_message, lints)
 
+    def test_no_sha_with_dl(self):
+        expected_message = ("When defining a source/url please add a sha256, "
+                            "sha1 or md5 checksum (sha256 preferably).")
+        meta = {'source': {'url': None}}
+        self.assertIn(expected_message, linter.lintify(meta))
+
+        meta = {'source': {'url': None, 'sha1': None}}
+        self.assertNotIn(expected_message, linter.lintify(meta))
+
+        meta = {'source': {'url': None, 'sha256': None}}
+        self.assertNotIn(expected_message, linter.lintify(meta))
+
+        meta = {'source': {'url': None, 'md5': None}}
+        self.assertNotIn(expected_message, linter.lintify(meta))
+
 
 class TestCLI_recipe_lint(unittest.TestCase):
     def test_cli_fail(self):
@@ -165,7 +187,8 @@ def test_cli_fail(self):
                     build: []
                     requirements: []
                     """))
-            child = subprocess.Popen(['conda-smithy', 'recipe-lint', recipe_dir],
+            child = subprocess.Popen(['conda-smithy', 'recipe-lint',
+                                      recipe_dir],
                                      stdout=subprocess.PIPE)
             out, _ = child.communicate()
             self.assertEqual(child.returncode, 1, out)
@@ -188,7 +211,8 @@ def test_cli_success(self):
                             - a
                             - b
                     """))
-            child = subprocess.Popen(['conda-smithy', 'recipe-lint', recipe_dir],
+            child = subprocess.Popen(['conda-smithy', 'recipe-lint',
+                                      recipe_dir],
                                      stdout=subprocess.PIPE)
             out, _ = child.communicate()
             self.assertEqual(child.returncode, 0, out)