Add validation tests for core metadata using 'packaging'

(An independent validation library makes the confidence in the code
stronger).

Author: abravalheri

setup.cfg

@@ -89,6 +89,7 @@ testing-integration =
 	jaraco.envs>=2.2
 	build[virtualenv]
 	filelock>=3.4.0
+	packaging
 
 docs =
 	# upstream

setuptools/tests/config/test_apply_pyprojecttoml.py

@@ -13,6 +13,7 @@
 
 import pytest
 from ini2toml.api import Translator
+from packaging.metadata import Metadata
 
 import setuptools  # noqa ensure monkey patch to metadata
 from setuptools.dist import Distribution
@@ -428,6 +429,9 @@ def core_metadata(dist) -> str:
         dist.metadata.write_pkg_file(buffer)
         pkg_file_txt = buffer.getvalue()
 
+    # Make sure core metadata is valid
+    Metadata.from_email(pkg_file_txt, validate=True)  # will raise exceptions
+
     skip_prefixes = ()
     skip_lines = set()
     # ---- DIFF NORMALISATION ----

setuptools/tests/test_core_metadata.py

@@ -5,6 +5,8 @@
 
 import pytest
 
+from packaging.metadata import Metadata
+
 from setuptools import sic, _reqs
 from setuptools.dist import Distribution
 from setuptools._core_metadata import rfc822_escape, rfc822_unescape
@@ -166,6 +168,9 @@ def test_read_metadata(name, attrs):
     PKG_INFO = io.StringIO()
 
     metadata_out.write_pkg_file(PKG_INFO)
+    PKG_INFO.seek(0)
+    pkg_info = PKG_INFO.read()
+    assert _valid_metadata(pkg_info)
 
     PKG_INFO.seek(0)
     metadata_in = dist_class()
@@ -281,9 +286,12 @@ def test_maintainer_author(name, attrs, tmpdir):
     dist.metadata.write_pkg_info(fn_s)
 
     with io.open(str(fn.join('PKG-INFO')), 'r', encoding='utf-8') as f:
-        raw_pkg_lines = f.readlines()
+        pkg_info = f.read()
+
+    assert _valid_metadata(pkg_info)
 
     # Drop blank lines and strip lines from default description
+    raw_pkg_lines = pkg_info.splitlines()
     pkg_lines = list(filter(None, raw_pkg_lines[:-2]))
 
     pkg_lines_set = set(pkg_lines)
@@ -333,6 +341,8 @@ def test_parity_with_metadata_from_pypa_wheel(tmp_path):
         dist.metadata.write_pkg_file(fp)
         pkg_info = fp.getvalue()
 
+    assert _valid_metadata(pkg_info)
+
     # Ensure Requires-Dist is present
     expected = [
         'Metadata-Version:',
@@ -378,3 +388,8 @@ def test_parity_with_metadata_from_pypa_wheel(tmp_path):
     assert metadata_msg.as_string() == pkg_info_msg.as_string()
     assert metadata_deps == pkg_info_deps
     assert metadata_extras == pkg_info_extras
+
+
+def _valid_metadata(text: str) -> bool:
+    metadata = Metadata.from_email(text, validate=True)  # will raise exceptions
+    return metadata is not None

tox.ini

@@ -3,6 +3,8 @@ deps =
 	# Ideally all the dependencies should be set as "extras"
 	build[virtualenv] @ git+https://github.com/pypa/build@59c1f87
 	# ^-- pypa/build#630, use dev version while we wait for the new release
+	packaging @ git+https://github.com/pypa/packaging@7e68d82
+	# ^-- use dev version while we wait for the new release
 setenv =
 	PYTHONWARNDEFAULTENCODING = 1
 	SETUPTOOLS_ENFORCE_DEPRECATION = 1