trivial interpreters py touchups and test coverage improvements (tox-dev#708)

* simplify exception handling code * rewrap long code lines * fix NoInterpreterInfo string representation with a set executable * add several missing interpreters.py tests In the process touched up the `sitepackagesdir()` implementation to make it easier to test. * add changelog entry

Author: jurko-gospodnetic

changelog/708.trivial.rst

@@ -0,0 +1 @@
+touched up ``interpreters.py`` code and added some missing tests for it - by @jurko-gospodnetic

tests/test_interpreters.py

@@ -7,8 +7,13 @@
 import pytest
 
 from tox.config import get_plugin_manager
+from tox.interpreters import ExecFailed
+from tox.interpreters import InterpreterInfo
 from tox.interpreters import Interpreters
+from tox.interpreters import NoInterpreterInfo
+from tox.interpreters import pyinfo
 from tox.interpreters import run_and_get_interpreter_info
+from tox.interpreters import sitepackagesdir
 from tox.interpreters import tox_get_python_executable
 
 
@@ -70,7 +75,8 @@ class envconfig:
  envconfig.basepython = name
  p = tox_get_python_executable(envconfig)
  assert p
- popen = subprocess.Popen([str(p), '-V'], stderr=subprocess.PIPE, stdout=subprocess.PIPE)
+ popen = subprocess.Popen([str(p), '-V'], stderr=subprocess.PIPE,
+ stdout=subprocess.PIPE)
  stdout, stderr = popen.communicate()
  assert not stdout or not stderr
  assert ver in stderr.decode('ascii') or ver in stdout.decode('ascii')
@@ -130,3 +136,92 @@ class envconfig:
  info = interpreters.get_info(envconfig)
  s = interpreters.get_sitepackagesdir(info, "")
  assert s
+
+
+def test_pyinfo(monkeypatch):
+ monkeypatch.setattr(sys, "version_info", [42, 4242])
+ monkeypatch.setattr(sys, "platform", "an unladen swallow")
+ result = pyinfo()
+ assert len(result) == 2
+ assert result["version_info"] == (42, 4242)
+ assert result["sysplatform"] == "an unladen swallow"
+
+
+def test_sitepackagesdir(monkeypatch):
+ import distutils.sysconfig as sysconfig
+ test_envdir = "holy grail"
+ test_dir = "Now go away or I will taunt you a second time."
+
+ def dummy_get_python_lib(prefix):
+ assert prefix is test_envdir
+ return test_dir
+
+ monkeypatch.setattr(sysconfig, "get_python_lib", dummy_get_python_lib)
+ assert sitepackagesdir(test_envdir) == {"dir": test_dir}
+
+
+def test_exec_failed():
+ x = ExecFailed("my-executable", "my-source", "my-out", "my-err")
+ assert isinstance(x, Exception)
+ assert x.executable == "my-executable"
+ assert x.source == "my-source"
+ assert x.out == "my-out"
+ assert x.err == "my-err"
+
+
+class TestInterpreterInfo:
+
+ def info(self, name="my-name", executable="my-executable",
+ version_info="my-version-info", sysplatform="my-sys-platform"):
+ return InterpreterInfo(name, executable, version_info, sysplatform)
+
+ def test_runnable(self):
+ assert self.info().runnable
+
+ @pytest.mark.parametrize("missing_arg", ("executable", "version_info"))
+ def test_assert_on_missing_args(self, missing_arg):
+ with pytest.raises(AssertionError):
+ self.info(**{missing_arg: None})
+
+ def test_data(self):
+ x = self.info("larry", "moe", "shemp", "curly")
+ assert x.name == "larry"
+ assert x.executable == "moe"
+ assert x.version_info == "shemp"
+ assert x.sysplatform == "curly"
+
+ def test_str(self):
+ x = self.info(executable="foo", version_info="bar")
+ assert str(x) == "<executable at foo, version_info bar>"
+
+
+class TestNoInterpreterInfo:
+
+ def test_runnable(self):
+ assert not NoInterpreterInfo("foo").runnable
+ assert not NoInterpreterInfo("foo", executable=sys.executable).runnable
+
+ def test_default_data(self):
+ x = NoInterpreterInfo("foo")
+ assert x.name == "foo"
+ assert x.executable is None
+ assert x.version_info is None
+ assert x.out is None
+ assert x.err == "not found"
+
+ def test_set_data(self):
+ x = NoInterpreterInfo("migraine", executable="my-executable",
+ out="my-out", err="my-err")
+ assert x.name == "migraine"
+ assert x.executable == "my-executable"
+ assert x.version_info is None
+ assert x.out == "my-out"
+ assert x.err == "my-err"
+
+ def test_str_without_executable(self):
+ x = NoInterpreterInfo("coconut")
+ assert str(x) == "<executable not found for: coconut>"
+
+ def test_str_with_executable(self):
+ x = NoInterpreterInfo("coconut", executable="bang/em/together")
+ assert str(x) == "<executable at bang/em/together, not runnable>"

tox/interpreters.py

@@ -48,9 +48,8 @@ def get_sitepackagesdir(self, info, envdir):
  res = exec_on_interpreter(info.executable,
  [inspect.getsource(sitepackagesdir),
  "print(sitepackagesdir(%r))" % envdir])
- except ExecFailed:
- val = sys.exc_info()[1]
- print("execution failed: %s -- %s" % (val.out, val.err))
+ except ExecFailed as e:
+ print("execution failed: %s -- %s" % (e.out, e.err))
  return ""
  else:
  return res["dir"]
@@ -59,12 +58,11 @@ def get_sitepackagesdir(self, info, envdir):
 def run_and_get_interpreter_info(name, executable):
  assert executable
  try:
- result = exec_on_interpreter(executable,
- [inspect.getsource(pyinfo), "print(pyinfo())"])
- except ExecFailed:
- val = sys.exc_info()[1]
- return NoInterpreterInfo(name, executable=val.executable,
- out=val.out, err=val.err)
+ result = exec_on_interpreter(executable, [inspect.getsource(pyinfo),
+ "print(pyinfo())"])
+ except ExecFailed as e:
+ return NoInterpreterInfo(name, executable=e.executable,
+ out=e.out, err=e.err)
  else:
  return InterpreterInfo(name, executable, **result)
 
@@ -123,7 +121,7 @@ def __init__(self, name, executable=None,
 
  def __str__(self):
  if self.executable:
- return "<executable at %s, not runnable>"
+ return "<executable at %s, not runnable>" % self.executable
  else:
  return "<executable not found for: %s>" % self.name
 
@@ -184,5 +182,5 @@ def pyinfo():
 
 
 def sitepackagesdir(envdir):
- from distutils.sysconfig import get_python_lib
- return dict(dir=get_python_lib(prefix=envdir))
+ import distutils.sysconfig
+ return dict(dir=distutils.sysconfig.get_python_lib(prefix=envdir))