2021-11-08 18:55:32 -05:00
|
|
|
from pkg_resources import parse_version
|
2019-12-09 15:50:20 -05:00
|
|
|
from setuptools import __version__ as setuptools_version
|
|
|
|
|
from setuptools import find_packages
|
|
|
|
|
from setuptools import setup
|
2019-03-01 16:18:06 -05:00
|
|
|
|
|
|
|
|
version = '0.32.0.dev0'
|
|
|
|
|
|
2021-04-02 13:37:48 -04:00
|
|
|
# setuptools 36.2+ is needed for support for environment markers
|
|
|
|
|
min_setuptools_version='36.2'
|
|
|
|
|
# This conditional isn't necessary, but it provides better error messages to
|
|
|
|
|
# people who try to install this package with older versions of setuptools.
|
2021-11-08 18:55:32 -05:00
|
|
|
if parse_version(setuptools_version) < parse_version(min_setuptools_version):
|
2021-04-02 13:37:48 -04:00
|
|
|
raise RuntimeError(f'setuptools {min_setuptools_version}+ is required')
|
|
|
|
|
|
2019-03-01 16:18:06 -05:00
|
|
|
install_requires = [
|
2019-04-11 21:07:36 -04:00
|
|
|
'coverage',
|
|
|
|
|
'cryptography',
|
2019-12-18 16:21:54 -05:00
|
|
|
'docker-compose',
|
2019-04-11 21:07:36 -04:00
|
|
|
'pyopenssl',
|
2019-03-01 16:18:06 -05:00
|
|
|
'pytest',
|
|
|
|
|
'pytest-cov',
|
2021-03-23 14:29:01 -04:00
|
|
|
# This version is needed for "worker" attributes we currently use like
|
|
|
|
|
# "workerinput". See https://github.com/pytest-dev/pytest-xdist/pull/268.
|
|
|
|
|
'pytest-xdist>=1.22.1',
|
2019-08-02 14:46:12 -04:00
|
|
|
'python-dateutil',
|
2021-04-02 13:37:48 -04:00
|
|
|
# This dependency needs to be added using environment markers to avoid its
|
|
|
|
|
# installation on Linux.
|
|
|
|
|
'pywin32>=300 ; sys_platform == "win32"',
|
2019-03-01 16:18:06 -05:00
|
|
|
'pyyaml',
|
2019-04-11 21:07:36 -04:00
|
|
|
'requests',
|
2021-11-08 18:55:32 -05:00
|
|
|
'setuptools',
|
2021-08-17 13:52:57 -04:00
|
|
|
'types-python-dateutil'
|
2019-03-01 16:18:06 -05:00
|
|
|
]
|
|
|
|
|
|
|
|
|
|
setup(
|
|
|
|
|
name='certbot-ci',
|
|
|
|
|
version=version,
|
|
|
|
|
description="Certbot continuous integration framework",
|
|
|
|
|
url='https://github.com/certbot/certbot',
|
|
|
|
|
author="Certbot Project",
|
2021-05-03 15:38:54 -04:00
|
|
|
author_email='certbot-dev@eff.org',
|
2019-03-01 16:18:06 -05:00
|
|
|
license='Apache License 2.0',
|
2021-01-25 18:07:43 -05:00
|
|
|
python_requires='>=3.6',
|
2019-03-01 16:18:06 -05:00
|
|
|
classifiers=[
|
|
|
|
|
'Development Status :: 3 - Alpha',
|
|
|
|
|
'Intended Audience :: Developers',
|
|
|
|
|
'License :: OSI Approved :: Apache Software License',
|
|
|
|
|
'Programming Language :: Python',
|
|
|
|
|
'Programming Language :: Python :: 3',
|
|
|
|
|
'Programming Language :: Python :: 3.6',
|
|
|
|
|
'Programming Language :: Python :: 3.7',
|
2019-09-24 14:38:38 -04:00
|
|
|
'Programming Language :: Python :: 3.8',
|
2020-11-19 15:48:36 -05:00
|
|
|
'Programming Language :: Python :: 3.9',
|
2021-11-08 18:55:32 -05:00
|
|
|
'Programming Language :: Python :: 3.10',
|
2019-03-01 16:18:06 -05:00
|
|
|
'Topic :: Internet :: WWW/HTTP',
|
|
|
|
|
'Topic :: Security',
|
|
|
|
|
],
|
|
|
|
|
|
|
|
|
|
packages=find_packages(),
|
|
|
|
|
include_package_data=True,
|
|
|
|
|
install_requires=install_requires,
|
Add executable scripts to start certbot and acme server in certbot-ci (#7073)
During review of #6989, we saw that some of our test bash scripts were still used in the Boulder project in particular. It is about `tests/integration/_common.sh` in particular, to expose the `certbot_test` bash function, that is an appropriate way to execute a local version of certbot in test mode: define a custom server, remove several checks, full log and so on.
This PR is an attempt to assert this goal: exposing a new `certbot_test` executable for test purpose. More generally, this PR is about giving well suited scripts to quickly make manual tests against certbot without launching the full automated pytest suite.
The idea here is to leverage the existing logic in certbot-ci, and expose it as executable scripts. This is done thanks to the `console_scripts` entry of setuptools entrypoint feature, that install scripts in the `PATH`, when `pip install` is invoked, that delegate to specific functions in the installed packages.
Two scripts are defined this way:
* `certbot_test`: it executes certbot in test mode in a very similar way than the original `certbot_test` in `_common.sh`, by delegating to `certbot_integration_tests.utils.certbot_call:main`. By default this execution will target a pebble directory url started locally. The url, and also http-01/tls-alpn-01 challenge ports can be configured using ad-hoc environment variables. All arguments passed to `certbot_test` are transferred to the underlying certbot command.
* `acme_server`: it set up a fully running instance of an ACME server, ready for tests (in particular, all FQDN resolves to localhost in order to target a locally running `certbot_test` command) by delegating to `certbot_integration_tests.utils.acme_server:main`. The choice of the ACME server is given by the first parameter passed to `acme_server`, it can be `pebble`, `boulder-v1` or `boulder-v2`. The command keeps running on foreground, displaying the logs of the ACME server on stdout/stderr. The server is shut down and resources cleaned upon entering CTRL+C.
This two commands can be run also through the underlying python modules, that are executable.
Finally, a typical workflow on certbot side to run manual tests would be:
```
cd certbot
tools/venv.py
source venv/bin/activate
acme_server pebble &
certbot_test certonly --standalone -d test.example.com
```
On boulder side it could be:
```
# Follow certbot dev environment setup instructions, then ...
cd boulder
docker-compose run --use-aliases -e FAKE_DNS=172.17.0.1 --service-ports boulder ./start.py
SERVER=http://localhost:4001/directory certbot_test certonly --standalone -d test.example.com
```
* Configure certbot-ci to expose a certbot_test console script calling certbot in test mode against a local pebble instance
* Add a command to start pebble/boulder
* Use explicit start
* Add execution permission to acme_server
* Add a docstring to certbot_test function
* Change executable name
* Increase sleep to 3600s
* Implement a context manager to handle the acme server
* Add certbot_test workspace in .gitignore
* Add documentation
* Remove one function in context, split logic of certbot_test towards capturing non capturing
* Use an explicit an properly configured ACMEServer as handler.
* Add doc. Put constants.
2019-06-12 20:19:23 -04:00
|
|
|
|
|
|
|
|
entry_points={
|
|
|
|
|
'console_scripts': [
|
|
|
|
|
'certbot_test=certbot_integration_tests.utils.certbot_call:main',
|
|
|
|
|
'run_acme_server=certbot_integration_tests.utils.acme_server:main',
|
|
|
|
|
],
|
|
|
|
|
}
|
2019-03-01 16:18:06 -05:00
|
|
|
)
|
