Merge pull request #495 from gaborbernat/all_env

[#271] show all defined enviroments for listenv, not just what's in envlist

Author: obestwalter

doc/config.txt

@@ -341,7 +341,7 @@ Complete list of settings that you can put into ``testenv*`` sections:
 
     a short description of the environment, this will be used to explain
     the environment to the user upon listing environments for the command
-    line. **default**: empty string
+    line with any level of verbosity higher than zero. **default**: empty string
 
 Substitutions
 -------------

tests/test_config.py

@@ -1980,6 +1980,11 @@ def test_listenvs(self, cmd, initproj):
             'tox.ini': '''
             [tox]
             envlist=py26,py27,py33,pypy,docs
+            description= py27: run py.test on Python 2.7
+                         py33: run py.test on Python 3.6
+                         pypy: publish to pypy
+                         docs: document stuff
+                         notincluded: random extra
 
             [testenv:notincluded]
             changedir = whatever
@@ -1990,15 +1995,69 @@ def test_listenvs(self, cmd, initproj):
         })
         result = cmd.run("tox", "-l")
         result.stdout.fnmatch_lines("""
-            *py26*
-            *py27*
-            *py33*
-            *pypy*
-            *docs*
+            py26
+            py27
+            py33
+            pypy
+            docs
         """)
 
-    def test_listenvs_description(self, cmd, initproj):
-        initproj('listenvs', filedefs={
+    def test_listenvs_verbose_description(self, cmd, initproj):
+        initproj('listenvs_verbose_description', filedefs={
+            'tox.ini': '''
+            [tox]
+            envlist=py26,py27,py33,pypy,docs
+            [testenv]
+            description= py26: run py.test on Python 2.6
+                         py27: run py.test on Python 2.7
+                         py33: run py.test on Python 3.3
+                         pypy: publish to pypy
+                         docs: document stuff
+                         notincluded: random extra
+
+            [testenv:notincluded]
+            changedir = whatever
+
+            [testenv:docs]
+            changedir = docs
+            description = let me overwrite that
+            ''',
+        })
+        result = cmd.run("tox", "-lv")
+        result.stdout.fnmatch_lines("""
+            default environments:
+            py26 -> run py.test on Python 2.6
+            py27 -> run py.test on Python 2.7
+            py33 -> run py.test on Python 3.3
+            pypy -> publish to pypy
+            docs -> let me overwrite that
+        """)
+
+    def test_listenvs_all(self, cmd, initproj):
+        initproj('listenvs_all', filedefs={
+            'tox.ini': '''
+            [tox]
+            envlist=py26,py27,py33,pypy,docs
+
+            [testenv:notincluded]
+            changedir = whatever
+
+            [testenv:docs]
+            changedir = docs
+            ''',
+        })
+        result = cmd.run("tox", "-a")
+        result.stdout.fnmatch_lines("""
+            py26
+            py27
+            py33
+            pypy
+            docs
+            notincluded
+        """)
+
+    def test_listenvs_all_verbose_description(self, cmd, initproj):
+        initproj('listenvs_all_verbose_description', filedefs={
             'tox.ini': '''
             [tox]
             envlist={py27,py36}-{windows,linux}
@@ -2014,12 +2073,16 @@ def test_listenvs_description(self, cmd, initproj):
             changedir = docs
             ''',
         })
-        result = cmd.run("tox", "-l")
+        result = cmd.run("tox", "-av")
         result.stdout.fnmatch_lines("""
-            py27-windows run py.test on Python 2.7 on Windows platform
-            py27-linux   run py.test on Python 2.7 on Linux platform
-            py36-windows run py.test on Python 3.6 on Windows platform
-            py36-linux   run py.test on Python 3.6 on Linux platform
+            default environments:
+            py27-windows -> run py.test on Python 2.7 on Windows platform
+            py27-linux   -> run py.test on Python 2.7 on Linux platform
+            py36-windows -> run py.test on Python 3.6 on Windows platform
+            py36-linux   -> run py.test on Python 3.6 on Linux platform
+
+            additional environments:
+            docs         -> generate documentation
         """)
 
     def test_config_specific_ini(self, tmpdir, cmd):

tox/config.py

@@ -321,7 +321,12 @@ def tox_addoption(parser):
     parser.add_argument("--showconfig", action="store_true",
                         help="show configuration information for all environments. ")
     parser.add_argument("-l", "--listenvs", action="store_true",
-                        dest="listenvs", help="show list of test environments")
+                        dest="listenvs", help="show list of test environments "
+                                              "(with description if verbose)")
+    parser.add_argument("-a", "--listenvs-all", action="store_true",
+                        dest="listenvs_all",
+                        help="show list of all defined environments"
+                             "(with description if verbose)")
     parser.add_argument("-c", action="store", default="tox.ini",
                         dest="configfile",
                         help="config file name or directory with 'tox.ini' file.")

tox/session.py

@@ -385,7 +385,9 @@ def runcommand(self):
         if self.config.option.showconfig:
             self.showconfig()
         elif self.config.option.listenvs:
-            self.showenvs()
+            self.showenvs(all_envs=False, description=self.config.option.verbosity > 0)
+        elif self.config.option.listenvs_all:
+            self.showenvs(all_envs=True, description=self.config.option.verbosity > 0)
         else:
             return self.subcommand_test()
 
@@ -626,11 +628,29 @@ def showconfig(self):
                 self.report.line("  %-15s = %s"
                                  % (attr.name, getattr(envconfig, attr.name)))
 
-    def showenvs(self):
-        max_length = max(len(env) for env in self.config.envlist)
-        for env in self.config.envlist:
-            self.report.line("{0} {1}".format(env.ljust(max_length),
-                                              self.config.envconfigs[env].description).strip())
+    def showenvs(self, all_envs=False, description=False):
+        env_conf = self.config.envconfigs  # this contains all environments
+        default = self.config.envlist  # this only the defaults
+        extra = sorted([e for e in env_conf if e not in default]) if all_envs else []
+        if description:
+            self.report.line('default environments:')
+            max_length = max(len(env) for env in (default + extra))
+
+        def report_env(e):
+            if description:
+                msg = '{0} -> {1}'.format(e.ljust(max_length),
+                                          env_conf[e].description).strip()
+            else:
+                msg = e
+            self.report.line(msg)
+        for e in default:
+            report_env(e)
+        if all_envs:
+            if description:
+                self.report.line('')
+                self.report.line('additional environments:')
+            for e in extra:
+                report_env(e)
 
     def info_versions(self):
         versions = ['tox-%s' % tox.__version__]