Update tests for entrypoint exit codes

examples/pip_install/BUILD

@@ -46,15 +46,21 @@ py_binary(
 
 py_test(
     name = "test",
+    size = "small",
     srcs = ["test.py"],
     deps = [":main"],
 )
 
 # For pip dependencies which have entry points, the `entry_point` macro can be
-# used from the generated `pip_install` repository to access a runnable binary.
+# used from the generated `pip_parse` repository to access a runnable binary.
 alias(
     name = "yamllint",
-    actual = entry_point("yamllint"),
+    # If `pkg` and `script` are the same, passing a single string to
+    # `entry_point` would work as well: `entry_point("yamllint")`
+    actual = entry_point(
+        pkg = "yamllint",
+        script = "yamllint",
+    ),
 )
 
 # Check that our compiled requirements are up-to-date
@@ -72,11 +78,19 @@ py_test(
         ":yamllint",
         data_requirement("s3cmd"),
         dist_info_requirement("boto3"),
+        entry_point(
+            pkg = "sphinx",
+            script = "sphinx-build",
+        ),
     ],
     env = {
+        "SPHINX_BUILD_ENTRY_POINT": "$(rootpath {})".format(entry_point(
+            pkg = "sphinx",
+            script = "sphinx-build",
+        )),
         "WHEEL_DATA_CONTENTS": "$(rootpaths {})".format(data_requirement("s3cmd")),
         "WHEEL_DIST_INFO_CONTENTS": "$(rootpaths {})".format(dist_info_requirement("boto3")),
-        "WHEEL_ENTRY_POINT": "$(rootpath :yamllint)",
+        "YAMLLINT_ENTRY_POINT": "$(rootpath :yamllint)",
     },
 )
 
@@ -104,6 +118,7 @@ write_file(
 
 diff_test(
     name = "test_query_result",
+    size = "small",
     file1 = "expected",
     file2 = "yamllint_lib_by_version",
 )

examples/pip_install/pip_install_test.py

@@ -9,8 +9,8 @@
 class PipInstallTest(unittest.TestCase):
     maxDiff = None
 
-    def test_entry_point(self):
-        env = os.environ.get("WHEEL_ENTRY_POINT")
+    def test_entry_point_void_return(self):
+        env = os.environ.get("YAMLLINT_ENTRY_POINT")
         self.assertIsNotNone(env)
 
         entry_point = Path(env)
@@ -19,9 +19,26 @@ def test_entry_point(self):
         proc = subprocess.run([entry_point, "--version"], check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
         self.assertEqual(proc.stdout.decode("utf-8").strip(), "yamllint 1.26.3")
 
+        # yamllint entry_point is of the form `def run(argv=None):`
         with self.assertRaises(subprocess.CalledProcessError) as context:
             subprocess.run([entry_point, "--option-does-not-exist"], check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-        self.assertTrue('returned non-zero exit status 2' in str(context.exception))
+        self.assertIn('returned non-zero exit status 2', str(context.exception))
+
+    def test_entry_point_int_return(self):
+        env = os.environ.get("SPHINX_BUILD_ENTRY_POINT")
+        self.assertIsNotNone(env)
+
+        entry_point = Path(env)
+        self.assertTrue(entry_point.exists())
+
+        proc = subprocess.run([entry_point, "--version"], check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        # sphinx-build uses args[0] for its name, only assert the version here
+        self.assertTrue(proc.stdout.decode("utf-8").strip().endswith('4.2.0'))
+
+        # sphinx-build entry_point is of the form `def main(argv: List[str] = sys.argv[1:]) -> int:`
+        with self.assertRaises(subprocess.CalledProcessError) as context:
+            subprocess.run([entry_point, "--option-does-not-exist"], check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        self.assertIn('returned non-zero exit status 2', str(context.exception))
 
     def test_data(self):
         env = os.environ.get("WHEEL_DATA_CONTENTS")

examples/pip_install/requirements.in

@@ -1,3 +1,4 @@
 boto3==1.14.51
+s3cmd==2.1.0
+sphinx==4.2.0
 yamllint==1.26.3
-s3cmd==2.1.0 

examples/pip_parse/BUILD

@@ -44,6 +44,7 @@ py_binary(
 
 py_test(
     name = "test",
+    size = "small",
     srcs = ["test.py"],
     deps = [":main"],
 )
@@ -68,18 +69,27 @@ compile_pip_requirements(
     requirements_txt = "requirements_lock.txt",
 )
 
-# Test the use of all pip_parse utilities in a single py_test
+# Test the use of all pip_install utilities in a single py_test
 py_test(
     name = "pip_parse_test",
+    size = "small",
     srcs = ["pip_parse_test.py"],
     data = [
         ":yamllint",
         data_requirement("s3cmd"),
         dist_info_requirement("requests"),
+        entry_point(
+            pkg = "sphinx",
+            script = "sphinx-build",
+        ),
     ],
     env = {
+        "SPHINX_BUILD_ENTRY_POINT": "$(rootpath {})".format(entry_point(
+            pkg = "sphinx",
+            script = "sphinx-build",
+        )),
         "WHEEL_DATA_CONTENTS": "$(rootpaths {})".format(data_requirement("s3cmd")),
         "WHEEL_DIST_INFO_CONTENTS": "$(rootpaths {})".format(dist_info_requirement("requests")),
-        "WHEEL_ENTRY_POINT": "$(rootpath :yamllint)",
+        "YAMLLINT_ENTRY_POINT": "$(rootpath :yamllint)",
     },
 )

examples/pip_parse/pip_parse_test.py

@@ -9,8 +9,8 @@
 class PipInstallTest(unittest.TestCase):
     maxDiff = None
 
-    def test_entry_point(self):
-        env = os.environ.get("WHEEL_ENTRY_POINT")
+    def test_entry_point_void_return(self):
+        env = os.environ.get("YAMLLINT_ENTRY_POINT")
         self.assertIsNotNone(env)
 
         entry_point = Path(env)
@@ -19,6 +19,27 @@ def test_entry_point(self):
         proc = subprocess.run([entry_point, "--version"], check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
         self.assertEqual(proc.stdout.decode("utf-8").strip(), "yamllint 1.26.3")
 
+        # yamllint entry_point is of the form `def run(argv=None):`
+        with self.assertRaises(subprocess.CalledProcessError) as context:
+            subprocess.run([entry_point, "--option-does-not-exist"], check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        self.assertIn('returned non-zero exit status 2', str(context.exception))
+
+    def test_entry_point_int_return(self):
+        env = os.environ.get("SPHINX_BUILD_ENTRY_POINT")
+        self.assertIsNotNone(env)
+
+        entry_point = Path(env)
+        self.assertTrue(entry_point.exists())
+
+        proc = subprocess.run([entry_point, "--version"], check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        # sphinx-build uses args[0] for its name, only assert the version here
+        self.assertTrue(proc.stdout.decode("utf-8").strip().endswith('4.2.0'))
+
+        # sphinx-build entry_point is of the form `def main(argv: List[str] = sys.argv[1:]) -> int:`
+        with self.assertRaises(subprocess.CalledProcessError) as context:
+            subprocess.run([entry_point, "--option-does-not-exist"], check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        self.assertIn('returned non-zero exit status 2', str(context.exception))
+
     def test_data(self):
         env = os.environ.get("WHEEL_DATA_CONTENTS")
         self.assertIsNotNone(env)

examples/pip_parse/requirements.txt

@@ -1,3 +1,4 @@
 requests==2.25.1
+s3cmd==2.1.0
+sphinx==4.2.0
 yamllint==1.26.3
-s3cmd==2.1.0