Refactor certbot/ and certbot/tests/ to use the same structure as the other packages (#7544)

Summary of changes in this PR: - Refactor files involved in the `certbot` module to be of a similar structure to every other package; that is, inside a directory inside the main repo root (see below). - Make repo root README symlink to `certbot` README. - Pull tests outside of the distributed module. - Make `certbot/tests` not be a module so that `certbot` isn't added to Python's path for module discovery. - Remove `--pyargs` from test calls, and make sure to call tests from repo root since without `--pyargs`, `pytest` takes directory names rather than package names as arguments. - Replace mentions of `.` with `certbot` when referring to packages to install, usually editably. - Clean up some unused code around executing tests in a different directory. - Create public shim around main and make that the entry point. New directory structure summary: ``` repo root ("certbot", probably, but for clarity all files I mention are relative to here) ├── certbot │ ├── setup.py │ ├── certbot │ │ ├── __init__.py │ │ ├── achallenges.py │ │ ├── _internal │ │ │ ├── __init__.py │ │ │ ├── account.py │ │ │ ├── ... │ │ ├── ... │ ├── tests │ │ ├── account_test.py │ │ ├── display │ │ │ ├── __init__.py │ │ │ ├── ... │ │ ├── ... # note no __init__.py at this level │ ├── ... ├── acme │ ├── ... ├── certbot-apache │ ├── ... ├── ... ``` * refactor certbot/ and certbot/tests/ to use the same structure as the other packages * git grep -lE "\-e(\s+)\." | xargs sed -i -E "s/\-e(\s+)\./-e certbot/g" * git grep -lE "\.\[dev\]" | xargs sed -i -E "s/\.\[dev\]/certbot[dev]/g" * git grep -lE "\.\[dev3\]" | xargs sed -i -E "s/\.\[dev3\]/certbot[dev3]/g" * Remove replacement of certbot into . in install_and_test.py * copy license back out to main folder * remove linter_plugin.py and CONTRIBUTING.md from certbot/MANIFEST.in because these files are not under certbot/ * Move README back into main folder, and make the version inside certbot/ a symlink * symlink certbot READMEs the other way around * move testdata into the public api certbot zone * update source_paths in tox.ini to certbot/certbot to find the right subfolder for tests * certbot version has been bumped down a directory level * make certbot tests directory not a package and import sibling as module * Remove unused script cruft * change . to certbot in test_sdists * remove outdated comment referencing a command that doesn't work * Install instructions should reference an existing file * update file paths in Dockerfile * some package named in tox.ini were manually specified, change those to certbot * new directory format doesn't work easily with pyargs according to http://doc.pytest.org/en/latest/goodpractices.html#tests-as-part-of-application-code * remove other instance of pyargs * fix up some references in _release.sh by searching for ' . ' and manual check * another stray . in tox.ini * fix paths in tools/_release.sh * Remove final --pyargs call, and now-unnecessary call to modules instead of local files, since that's fixed by certbot's code being one layer deeper * Create public shim around main and make that the entry point * without pyargs, tests cannot be run from an empty directory * Remove cruft for running certbot directly from main * Have main shim take real arg * add docs/api file for main, and fix up main comment * Update certbot/docs/install.rst Co-Authored-By: Brad Warren <bmw@users.noreply.github.com> * Fix comments in readthedocs requirements files to refer to current package * Update .[docs] reference in contributing.rst * Move plugins tests to certbot tests directory * add certbot tests to MANIFEST.in so packagers can run python setup.py test * move examples directory inside certbot/ * Move CHANGELOG into certbot, and create a top-level symlink * Remove unused sys and logging from main shim * nginx http01 test no longer relies on certbot plugins common test
2026-07-30 16:14:44 +02:00 · 2019-11-25 14:28:05 -08:00
parent d56cd4ef01
commit 4abd81e218
190 changed files with 2334 additions and 2136 deletions
@@ -0,0 +1,3 @@
+# generate-csr.sh:
+/key.pem
+/csr.der
@@ -0,0 +1,22 @@
+# This is an example of the kind of things you can do in a configuration file.
+# All flags used by the client can be configured here. Run Certbot with
+# "--help" to learn more about the available options.
+#
+# Note that these options apply automatically to all use of Certbot for
+# obtaining or renewing certificates, so options specific to a single
+# certificate on a system with several certificates should not be placed
+# here.
+
+# Use a 4096 bit RSA key instead of 2048
+rsa-key-size = 4096
+
+# Uncomment and update to register with the specified e-mail address
+# email = foo@example.com
+
+# Uncomment to use the standalone authenticator on port 443
+# authenticator = standalone
+
+# Uncomment to use the webroot authenticator. Replace webroot-path with the
+# path to the public_html / webroot folder being served by your web server.
+# authenticator = webroot
+# webroot-path = /usr/share/nginx/html
@@ -0,0 +1,20 @@
+# Always use the staging/testing server - avoids rate limiting
+server = https://acme-staging-v02.api.letsencrypt.org/directory
+
+# This is an example configuration file for developers
+config-dir = /tmp/le/conf
+work-dir = /tmp/le/conf
+logs-dir = /tmp/le/logs
+
+# make sure to use a valid email and domains!
+email = foo@example.com
+domains = example.com
+
+text = True
+agree-tos = True
+debug = True
+# Unfortunately, it's not possible to specify "verbose" multiple times
+# (correspondingly to -vvvvvv)
+verbose = True
+
+authenticator = standalone
@@ -0,0 +1,28 @@
+#!/bin/sh
+# This script generates a simple SAN CSR to be used with Let's Encrypt
+# CA. Mostly intended for "auth --csr" testing, but, since it's easily
+# auditable, feel free to adjust it and use it on your production web
+# server.
+
+if [ "$#" -lt 1 ]
+then
+  echo "Usage: $0 domain [domain...]" >&2
+  exit 1
+fi
+
+domains="DNS:$1"
+shift
+for x in "$@"
+do
+  domains="$domains,DNS:$x"
+done
+
+SAN="$domains" openssl req -config "${OPENSSL_CNF:-openssl.cnf}" \
+  -new -nodes -subj '/' -reqexts san \
+  -out "${CSR_PATH:-csr.der}" \
+  -keyout "${KEY_PATH:-key.pem}" \
+  -newkey rsa:2048 \
+  -outform DER
+# 512 or 1024 too low for Boulder, 2048 is smallest for tests
+
+echo "You can now run: certbot auth --csr ${CSR_PATH:-csr.der}"
@@ -0,0 +1,5 @@
+[ req ]
+distinguished_name = req_distinguished_name
+[ req_distinguished_name ]
+[ san ]
+subjectAltName=${ENV::SAN}
@@ -0,0 +1,31 @@
+"""Example Certbot plugins.
+
+For full examples, see `certbot.plugins`.
+
+"""
+import zope.interface
+
+from certbot import interfaces
+from certbot.plugins import common
+
+
+@zope.interface.implementer(interfaces.IAuthenticator)
+@zope.interface.provider(interfaces.IPluginFactory)
+class Authenticator(common.Plugin):
+    """Example Authenticator."""
+
+    description = "Example Authenticator plugin"
+
+    # Implement all methods from IAuthenticator, remembering to add
+    # "self" as first argument, e.g. def prepare(self)...
+
+
+@zope.interface.implementer(interfaces.IInstaller)
+@zope.interface.provider(interfaces.IPluginFactory)
+class Installer(common.Plugin):
+    """Example Installer."""
+
+    description = "Example Installer plugin"
+
+    # Implement all methods from IInstaller, remembering to add
+    # "self" as first argument, e.g. def get_all_names(self)...
@@ -0,0 +1,17 @@
+from setuptools import setup
+
+
+setup(
+    name='certbot-example-plugins',
+    package='certbot_example_plugins.py',
+    install_requires=[
+        'certbot',
+        'zope.interface',
+    ],
+    entry_points={
+        'certbot.plugins': [
+            'example_authenticator = certbot_example_plugins:Authenticator',
+            'example_installer = certbot_example_plugins:Installer',
+        ],
+    },
+)