add manual publications of ports

[jzelinskie]

I really needed to solve #35. Thus this PR applies the feedback from #36 to add a configurable ports section to the image config. When it is not provided or the empty string is provided, it falls back to publishing all ports, so the change entirely backwards compatible. Ports are expected to be space separated and are formatted $HOSTPORT:$CONTAINERPORT/$PROTOCOL.

A working example using MySQL 5.7:

[docker:mysql:5.7]
healthcheck_cmd = mysql -uroot -D information_schema -e "SELECT * FROM plugins LIMIT 0;"
healthcheck_interval = 25
healthcheck_timeout = 10
healthcheck_retries = 3
healthcheck_start_period = 25
ports = 3306:3306/tcp

[dcrosta]

Thanks this looks pretty good -- can you add a test (and relevant config in the tox.ini), and a note on how to use it in the README (which becomes the sphinx docs)? Then I'll merge. Thanks for doing this!

[jzelinskie]

The CI is returning success, but the processes are all crashing for what looks like healthchecking code. Do you think my change caused this and I should fix it?

[dcrosta]

Yeah, looks like tox_configure assumes that if a [docker:foo] section exists at all, it must contain all keys. I'm confused why CI is not failing, because I can reproduce it consistently locally.

If you'd like to take a stab at a fix, I'd appreciate that; otherwise I can probably find some time in the next couple of days. My recommendation is to make all the healthcheck configs required as a group (either all must be present or all absent), and the port listing is optional in either case.

[jzelinskie]

I'm going to just get the tests working with a healthcheck for now and the other issue can be fixed in a follow up PR.

[dcrosta]

I'm currently getting this error running tests locally:

GLOB sdist-make: /Users/dcrosta/src/tox-docker/setup.py
ports inst-nodeps: /Users/dcrosta/src/tox-docker/.tox/.tmp/package/1/tox-docker-1.4.1.post6.zip
ports installed: appdirs==1.4.3,attrs==19.3.0,certifi==2020.4.5.1,chardet==3.0.4,distlib==0.3.0,docker==4.2.0,filelock==3.0.12,idna==2.9,more-itertools==8.2.0,packaging==20.3,pluggy==0.13.1,py==1.8.1,pyparsing==2.4.7,pytest==5.4.1,requests==2.23.0,six==1.14.0,toml==0.10.0,tox==3.14.6,tox-docker==1.4.1.post6,urllib3==1.25.8,virtualenv==20.0.16,wcwidth==0.1.9,websocket-client==0.57.0
ports docker: run 'mysql:5.7'
ports docker: health check: 'mysql:5.7'
____________________________________________________________________________________ summary _____________________________________________________________________________________
  ports: commands succeeded
  congratulations :)
Traceback (most recent call last):
  File "/Users/dcrosta/.pyenv/versions/tox-docker-3.8/bin/tox", line 8, in <module>
    sys.exit(cmdline())
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/tox/session/__init__.py", line 44, in cmdline
    main(args)
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/tox/session/__init__.py", line 68, in main
    exit_code = session.runcommand()
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/tox/session/__init__.py", line 194, in runcommand
    return self.subcommand_test()
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/tox/session/__init__.py", line 222, in subcommand_test
    run_sequential(self.config, self.venv_dict)
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/tox/session/commands/run/sequential.py", line 22, in run_sequential
    runtestenv(venv, config)
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/tox/session/commands/run/sequential.py", line 73, in runtestenv
    config.pluginmanager.hook.tox_runtest_pre(venv=venv)
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/pluggy/hooks.py", line 286, in __call__
    return self._hookexec(self, self.get_hookimpls(), kwargs)
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/pluggy/manager.py", line 93, in _hookexec
    return self._inner_hookexec(hook, methods, kwargs)
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/pluggy/manager.py", line 84, in <lambda>
    self._inner_hookexec = lambda hook, methods, kwargs: hook.multicall(
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/pluggy/callers.py", line 208, in _multicall
    return outcome.get_result()
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/pluggy/callers.py", line 80, in get_result
    raise ex[1].with_traceback(ex[2])
  File "/Users/dcrosta/.pyenv/versions/3.8.2/envs/tox-docker-3.8/lib/python3.8/site-packages/pluggy/callers.py", line 187, in _multicall
    res = hook_impl.function(*args)
  File "/Users/dcrosta/src/tox-docker/tox_docker.py", line 215, in tox_runtest_pre
    raise HealthCheckFailed("{!r} failed health check".format(image))
tox_docker.HealthCheckFailed: 'mysql:5.7' failed health check```

[dcrosta]

I've created branch https://github.com/tox-dev/tox-docker/commits/ports with a few minor follow-up tweaks. I'll merge this once CI passes. Thanks for your help here!

[dcrosta]

I'm going to try to do one more thing before cutting a new release, to make it so that you don't have to specify a full healthcheck to use the ports configuration. I think I will have time for this after dinner tonight. I appreciate your patience and realize this small fix has taken a while to get through, but the end is in sight! Thanks for your help & contribution, @jzelinskie!

[dcrosta]

https://pypi.org/project/tox-docker/1.5.0/ now live