Merge branch 'master' into envsubs-independence

Author: obestwalter

.gitignore

@@ -7,10 +7,15 @@
 *.orig
 *.rej
 *~
+__pycache__
 
 build
 dist
 doc/_build/
 tox.egg-info
 .tox
 .cache
+
+.idea
+.eggs/
+py27/

CONTRIBUTORS

@@ -46,3 +46,6 @@ Paweł Adamczak
 Oliver Bestwalter
 Selim Belhaouane
 Nick Douma
+Cyril Roelandt
+Bartolome Sanchez Salado
+Laszlo Vasko

doc/config.txt

@@ -214,11 +214,16 @@ Complete list of settings that you can put into ``testenv*`` sections:
    You can use ``*`` and ``?`` to match multiple environment variables with
    one name.
 
-   Note that the ``PATH``, ``LANG``, ``LANGUAGE`` and ``PIP_INDEX_URL``
-   variables are unconditionally passed down and on Windows ``SYSTEMROOT``,
-   ``PATHEXT``, ``TEMP`` and ``TMP`` will be passed down as well whereas on
-   unix ``TMPDIR`` will be passed down.  You can override these variables
-   with the ``setenv`` option.
+   Some variables are always passed through to ensure the basic functionality
+   of standard library functions or tooling like pip:
+
+   * passed through on all platforms: ``PATH``, ``LANG``, ``LANGUAGE``,
+     ``LD_LIBRARY_PATH``, ``PIP_INDEX_URL``
+   * Windows: ``SYSTEMDRIVE``, ``SYSTEMROOT``, ``PATHEXT``, ``TEMP``, ``TMP``
+      ``NUMBER_OF_PROCESSORS``, ``USERPROFILE``, ``MSYSTEM``
+   * Others (e.g. UNIX, macOS): ``TMPDIR``
+
+   You can override these variables with the ``setenv`` option.
 
    If defined the ``TOX_TESTENV_PASSENV`` environment variable (in the tox
    invocation environment) can define additional space-separated variable
@@ -430,6 +435,14 @@ then the value will be retrieved as ``os.environ['KEY']``
 and replace with and empty string if the environment variable does not
 exist.
 
+Substitutions can also be nested. In that case they are expanded starting
+from the innermost expression::
+
+    {env:KEY:{env:DEFAULT_OF_KEY}}
+
+the above example is roughly equivalent to
+``os.environ.get('KEY', os.environ['DEFAULT_OF_KEY'])``
+
 .. _`command positional substitution`:
 .. _`positional substitution`:
 

tests/test_config.py

@@ -334,6 +334,16 @@ def test_command_env_substitution(self, newconfig):
         assert envconfig.commands == [["ls", "testvalue"]]
         assert envconfig.setenv["TEST"] == "testvalue"
 
+    def test_command_env_substitution_global(self, newconfig):
+        """Ensure referenced {env:key:default} values are substituted correctly."""
+        config = newconfig("""
+            [testenv]
+            setenv = FOO = bar
+            commands = echo {env:FOO}
+        """)
+        envconfig = config.envconfigs['python']
+        assert envconfig.commands == [["echo", "bar"]]
+
 
 class TestIniParser:
     def test_getstring_single(self, tmpdir, newconfig):
@@ -866,6 +876,7 @@ def test_passenv_as_multiline_list(self, tmpdir, newconfig, monkeypatch, plat):
             assert "TMP" in envconfig.passenv
             assert "NUMBER_OF_PROCESSORS" in envconfig.passenv
             assert "USERPROFILE" in envconfig.passenv
+            assert "MSYSTEM" in envconfig.passenv
         else:
             assert "TMPDIR" in envconfig.passenv
         assert "PATH" in envconfig.passenv
@@ -1098,7 +1109,7 @@ def test_substitution_notfound_issue515(tmpdir, newconfig):
         ]
 
     @pytest.mark.xfail(raises=AssertionError, reason="issue #301")
-    def test_substitution_env_defaults_issue301(tmpdir, newconfig, monkeypatch):
+    def test_substitution_nested_env_defaults_issue301(tmpdir, newconfig, monkeypatch):
         monkeypatch.setenv("IGNORE_STATIC_DEFAULT", "env")
         monkeypatch.setenv("IGNORE_DYNAMIC_DEFAULT", "env")
         config = newconfig("""
@@ -2179,6 +2190,20 @@ def test_showconfig_with_force_dep_version(self, cmd, initproj):
             r'*deps*dep1, dep2==5.0*',
         ])
 
+    @pytest.mark.xfail(reason='Upstream bug. See #203')
+    def test_colon_symbol_in_directory_name(self, cmd, initproj):
+        initproj('colon:_symbol_in_dir_name', filedefs={
+            'tox.ini': '''
+            [tox]
+            envlist = py27
+
+            [testenv]
+            commands = pip --version
+            ''',
+        })
+        result = cmd.run("tox")
+        assert result.ret == 0
+
 
 @pytest.mark.parametrize("cmdline,envlist", [
     ("-e py26", ['py26']),

tests/test_quickstart.py

@@ -379,6 +379,106 @@ def test_quickstart_main_existing_tox_ini(self, monkeypatch):
         result = read_tox('tox-generated.ini')
         assert(result == expected_tox_ini)
 
+    def test_quickstart_main_tox_ini_location_can_be_overridden(
+            self,
+            tmpdir,
+            monkeypatch):
+        monkeypatch.setattr(
+            tox._quickstart, 'term_input',
+            self.get_mock_term_input(
+                [
+                    '1',          # py27 and py33
+                    'py.test',    # command to run tests
+                    '',            # test dependencies
+                ]
+            )
+        )
+
+        root_dir = tmpdir.mkdir('alt-root')
+        tox_ini_path = root_dir.join('tox.ini')
+
+        tox._quickstart.main(argv=['tox-quickstart', root_dir.basename])
+
+        assert tox_ini_path.isfile()
+
+        expected_tox_ini = """
+# Tox (https://tox.readthedocs.io/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = py27
+
+[testenv]
+commands = py.test
+deps =
+    pytest
+""".lstrip()
+        result = read_tox(fname=tox_ini_path.strpath)
+        assert(result == expected_tox_ini)
+
+    def test_quickstart_main_custom_tox_ini_location_with_existing_tox_ini(
+            self,
+            tmpdir,
+            monkeypatch):
+        monkeypatch.setattr(
+            tox._quickstart, 'term_input',
+            self.get_mock_term_input(
+                [
+                    '1',          # py27 and py33
+                    'py.test',    # command to run tests
+                    '',            # test dependencies
+                    '',           # tox.ini already exists; overwrite?
+                ]
+            )
+        )
+
+        root_dir = tmpdir.mkdir('alt-root')
+        tox_ini_path = root_dir.join('tox.ini')
+        tox_ini_path.write('foo\nbar\n')
+
+        tox._quickstart.main(argv=['tox-quickstart', root_dir.basename])
+        tox_ini_path = root_dir.join('tox-generated.ini')
+
+        assert tox_ini_path.isfile()
+
+        expected_tox_ini = """
+# Tox (https://tox.readthedocs.io/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = py27
+
+[testenv]
+commands = py.test
+deps =
+    pytest
+""".lstrip()
+        result = read_tox(fname=tox_ini_path.strpath)
+        assert(result == expected_tox_ini)
+
+    def test_quickstart_main_custom_nonexistent_tox_ini_location(
+            self,
+            tmpdir,
+            monkeypatch):
+        monkeypatch.setattr(
+            tox._quickstart, 'term_input',
+            self.get_mock_term_input(
+                [
+                    '1',          # py27 and py33
+                    'py.test',    # command to run tests
+                    '',           # test dependencies
+                ]
+            )
+        )
+
+        root_dir = tmpdir.join('nonexistent-root')
+
+        assert tox._quickstart.main(argv=['tox-quickstart', root_dir.basename]) == 2
+
 
 class TestToxQuickstart(object):
     def test_pytest(self):

tox.ini

@@ -1,49 +1,50 @@
 [tox]
-envlist=py27,py26,py34,py33,py35,py36,pypy,flakes,py26-bare
+envlist = py27,py26,py34,py33,py35,py36,pypy,flakes,py26-bare
+minversion = 2.7.0
 
 [testenv:X]
-commands=echo {posargs}
+commands = echo {posargs}
+description = print the positional arguments passed in with echo
 
 [testenv]
-commands= pytest --timeout=180 {posargs:tests}
-
-deps=pytest>=3.0.0
-    pytest-timeout
+commands = pytest --timeout=180 {posargs:tests}
+description = run the unit tests with pytest under the current Python env
+deps = pytest >= 3.0.0
+       pytest-timeout
 
 [testenv:py26-bare]
 deps =
 commands = tox -h
 install_command = pip install {opts} {packages}
 list_dependencies_command = pip freeze
+description = invoke the tox help message under Python 2.6
 
 [testenv:py26]
 install_command = pip install {opts} {packages}
 list_dependencies_command = pip freeze
 
-
 [testenv:docs]
-basepython=python
-changedir=doc
-deps=sphinx
-     {[testenv]deps}
-commands=
-    pytest -v check_sphinx.py {posargs}
+basepython = python
+changedir = doc
+deps = sphinx
+       {[testenv]deps}
+commands = pytest -v check_sphinx.py {posargs}
+description = invoke sphinx-build and try to build the HTML page (also check link validity)
 
 [testenv:flakes]
-deps = pytest-flakes>=0.2
+deps = pytest-flakes >= 0.2
        pytest-pep8
-
-commands =
-    pytest --flakes -m flakes tox tests
-    pytest --pep8 -m pep8 tox tests
+description = run static analysis and style check using flakes and pep-8
+commands = pytest --flakes -m flakes tox tests
+           pytest --pep8 -m pep8 tox tests
 
 [testenv:dev]
 # required to make looponfail reload on every source code change
 usedevelop = True
 
-deps =
-      pytest-xdist>=1.11
-commands = {posargs:pytest -s -x -f -v}
+deps = pytest-xdist >= 1.11
+commands = {posargs:py.test -s -x -f -v}
+description = DEV enviroment, if no posarg is specified: run pytest
 
 [pytest]
 rsyncdirs = tests tox
@@ -57,6 +58,5 @@ pep8maxlinelength = 99
 # W503 - line break before binary operator
 # E402 - module level import not at top of file
 # E731 - do not assign a lambda expression, use a def
-pep8ignore =
-           *.py W503 E402 E731
+pep8ignore = *.py W503 E402 E731
 flakes-ignore = ImportStarUsage

tox/_quickstart.py

@@ -40,6 +40,7 @@
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """
 
+import argparse
 import sys
 from os import path
 from codecs import open
@@ -224,19 +225,24 @@ def generate(d, overwrite=True, silent=False):
 
     def write_file(fpath, mode, content):
         print('Creating file %s.' % fpath)
-        f = open(fpath, mode, encoding='utf-8')
         try:
-            f.write(content)
-        finally:
-            f.close()
+            with open(fpath, mode, encoding='utf-8') as f:
+                f.write(content)
+        except IOError:
+            print('Error writing file.')
+            raise
 
     sys.stdout.write('\n')
 
-    fpath = 'tox.ini'
+    fpath = path.join(d.get('path', ''), 'tox.ini')
 
     if path.isfile(fpath) and not overwrite:
         print('File %s already exists.' % fpath)
-        do_prompt(d, 'fpath', 'Alternative path to write tox.ini contents to', 'tox-generated.ini')
+        do_prompt(
+            d,
+            'fpath',
+            'Alternative path to write tox.ini contents to',
+            path.join(d.get('path', ''), 'tox-generated.ini'))
         fpath = d['fpath']
 
     write_file(fpath, 'w', conf_text)
@@ -251,14 +257,25 @@ def write_file(fpath, mode, content):
 ''')
 
 
+def parse_args(argv):
+    parser = argparse.ArgumentParser(
+        description='Command-line script to quickly setup tox.ini for a Python project.'
+    )
+    parser.add_argument(
+        'root', type=str, nargs='?', default='.',
+        help='Custom root directory to write tox.ini to. Defaults to current directory.'
+    )
+    parser.add_argument('--version', action='version', version='%(prog)s ' + __version__)
+
+    args = argv[1:]
+    return parser.parse_args(args)
+
+
 def main(argv=sys.argv):
-    d = {}
+    args = parse_args(argv)
 
-    if len(argv) > 3:
-        print('Usage: tox-quickstart [root]')
-        sys.exit(1)
-    elif len(argv) == 2:
-        d['path'] = argv[1]
+    d = {}
+    d['path'] = args.root
 
     try:
         ask_user(d)
@@ -268,8 +285,13 @@ def main(argv=sys.argv):
         return
 
     d = process_input(d)
-    generate(d, overwrite=False)
+    try:
+        generate(d, overwrite=False)
+    except Exception:
+        return 2
+
+    return 0
 
 
 if __name__ == '__main__':
-    main()
+    sys.exit(main())