do not use setup.cfg file that does not have tox:tox namespace

[williamjamir]

Hi,

I would like to suggest a check to ensure that a tox.ini file is present when calling the tox command.

I'm saying this because by mistake I've named the file tox.ini as .tox.ini and took me a time to figure it out the problem.

The build had five stages:

py27, py36, py37, linting, docs

Link for the Travis build with all stages listed

The stages py27, py36, py37 was marked as "successful", even though nothing was tested.
Link for the job py37

While the stages linting and docs were raising an Error

ERROR: unknown environment 'linting'

I believe that this type of information leads to misinterpretation since the user could believe that the configuration is ok (because the py* was marked as successful) and the problem is related with the "linting/docs" stage.

[gaborbernat]

@williamjamir at the moment if we fail to find a configuration fail we stop with error and the message:

tox
ERROR: tox config file (either pyproject.toml, tox.ini, setup.cfg) not found

If you did not get it means you most probably had a tox.ini file discovered by following the rules from https://tox.readthedocs.io/en/latest/config.html#configuration-discovery.

Furthermore, if you call tox with a verbose flag you'll see explicitly stated what config is used (we recommend passing at least one verbosity in CI to help debug when things fail):

tox -v
using tox.ini: /home/bernat/git/tox/tox.ini
using tox-3.5.0 from /home/bernat/.local/lib/python3.7/site-packages/tox/__init__.py

The tools/checks are already there I think, you just need to use it. Let me know if you need anything else.

tox configuration specification — tox 3.5.2.dev1 documentation

[williamjamir]

Thanks for the answer @gaborbernat =)
I've added the flag -v and as you have mentioned, another file was being used as the configuration for tox.

$ tox -v
using tox.ini: /home/travis/build/williamjamir/test-cookiecutter/setup.cfg
ERROR: unknown environment 'linting'

On the documentation the following note is added:

Note that setup.cfg requires the content to be under the tox:tox section.

My setup.cfg file has the following content:

[bdist_wheel]
universal = 1

[flake8]
exclude = docs

[aliases]
test = pytest

[tool:pytest]
collect_ignore = ['setup.py']

Perhaps the existence of the tox:tox section, inside the setup.cfg, should be verified as well

[gaborbernat]

Indeed it should, not sure how trivial it is to added will have a look. Feel free to shoot a pr if you have time for it.

[hroncok]

This now surprised me as well. In Fedora, we promote the use of tox in RPM tests and "no tests found, but exit code 0" is something I'd like to avoid because it creates a false sense of being tested ("oh, this package runs tox and the build passed, all is 🦄 🌈").

I'll try to have a look on how to solve this, no timeline thou.

[hroncok]

Here #1642

[gaborbernat]

Released via https://pypi.org/project/tox/3.19.0/

[devmcp]

This update breaks system.cfg files that use [tox], rather than [tox:tox], giving the following error:

ERROR: tox config file (either pyproject.toml, tox.ini, setup.cfg) not found

Was this intentional?

[hroncok]

I was following the documentation in here.

[hroncok]

Sorry for the brief comment previously. According to the docs, the configuration in setup.cfg must be namespaced as [tox:tox]. If that was not the case, we can certainly allow [tox] as well and document it.

[gaborbernat]

I think it's intentional breaking here.