From c0eccdd35845161ced2ba56f77131c05ae2634fd Mon Sep 17 00:00:00 2001
From: Adrien Ferrand <adferrand@users.noreply.github.com>
Date: Sat, 13 Feb 2021 01:14:46 +0100
Subject: [PATCH] Deprecate certbot-auto specific flags (#8641)

This PR deprecates the certbot-auto specific CLI flags, in the perspective of removing them in a future release as said in #8483.

* Deprecate certbot-auto specific flags

* Update changelog

* Clean tests

Co-authored-by: Brad Warren <bmw@users.noreply.github.com>
---
 certbot/CHANGELOG.md                          |  2 ++
 certbot/certbot/_internal/cli/__init__.py     | 27 +++++--------------
 .../certbot/_internal/cli/cli_constants.py    |  8 +++++-
 certbot/tests/cli_test.py                     |  4 ---
 4 files changed, 15 insertions(+), 26 deletions(-)

diff --git a/certbot/CHANGELOG.md b/certbot/CHANGELOG.md
index eac783bdb..1067c3b92 100644
--- a/certbot/CHANGELOG.md
+++ b/certbot/CHANGELOG.md
@@ -10,6 +10,8 @@ Certbot adheres to [Semantic Versioning](https://semver.org/).
 
 ### Changed
 
+* CLI flags `--os-packages-only`, `--no-self-upgrade`, `--no-bootstrap` and `--no-permissions-check`,
+  which are related to certbot-auto, are deprecated and will be removed in a future release.
 * Certbot no longer conditionally depends on an external mock module. Certbot's
   test API will continue to use it if it is available for backwards
   compatibility, however, this behavior has been deprecated and will be removed
diff --git a/certbot/certbot/_internal/cli/__init__.py b/certbot/certbot/_internal/cli/__init__.py
index c69bb3564..8d2f7c329 100644
--- a/certbot/certbot/_internal/cli/__init__.py
+++ b/certbot/certbot/_internal/cli/__init__.py
@@ -249,27 +249,6 @@ def prepare_and_parse_args(plugins, args, detect_defaults=False):
         default=flag_default("duplicate"),
         help="Allow making a certificate lineage that duplicates an existing one "
              "(both can be renewed in parallel)")
-    helpful.add(
-        "automation", "--os-packages-only", action="store_true",
-        default=flag_default("os_packages_only"),
-        help="(certbot-auto only) install OS package dependencies and then stop")
-    helpful.add(
-        "automation", "--no-self-upgrade", action="store_true",
-        default=flag_default("no_self_upgrade"),
-        help="(certbot-auto only) prevent the certbot-auto script from"
-             " upgrading itself to newer released versions (default: Upgrade"
-             " automatically)")
-    helpful.add(
-        "automation", "--no-bootstrap", action="store_true",
-        default=flag_default("no_bootstrap"),
-        help="(certbot-auto only) prevent the certbot-auto script from"
-             " installing OS-level dependencies (default: Prompt to install "
-             " OS-wide dependencies, but exit if the user says 'No')")
-    helpful.add(
-        "automation", "--no-permissions-check", action="store_true",
-        default=flag_default("no_permissions_check"),
-        help="(certbot-auto only) skip the check on the file system"
-             " permissions of the certbot-auto script")
     helpful.add(
         ["automation", "renew", "certonly", "run"],
         "-q", "--quiet", dest="quiet", action="store_true",
@@ -451,6 +430,12 @@ def prepare_and_parse_args(plugins, args, detect_defaults=False):
         default=flag_default("autorenew"), dest="autorenew",
         help="Disable auto renewal of certificates.")
 
+    # Deprecated arguments
+    helpful.add_deprecated_argument("--os-packages-only", 0)
+    helpful.add_deprecated_argument("--no-self-upgrade", 0)
+    helpful.add_deprecated_argument("--no-bootstrap", 0)
+    helpful.add_deprecated_argument("--no-permissions-check", 0)
+
     # Populate the command line parameters for new style enhancements
     enhancements.populate_cli(helpful.add)
 
diff --git a/certbot/certbot/_internal/cli/cli_constants.py b/certbot/certbot/_internal/cli/cli_constants.py
index dc199e152..bd25f9bee 100644
--- a/certbot/certbot/_internal/cli/cli_constants.py
+++ b/certbot/certbot/_internal/cli/cli_constants.py
@@ -109,4 +109,10 @@ VAR_MODIFIERS = {"account": {"server",},
 # This is a list of all CLI options that we have ever deprecated. It lets us
 # opt out of the default detection, which can interact strangely with option
 # deprecation. See https://github.com/certbot/certbot/issues/8540 for more info.
-DEPRECATED_OPTIONS = {"manual_public_ip_logging_ok",}
+DEPRECATED_OPTIONS = {
+    "manual_public_ip_logging_ok",
+    "os_packages_only",
+    "no_self_upgrade",
+    "no_bootstrap",
+    "no_permissions_check",
+}
diff --git a/certbot/tests/cli_test.py b/certbot/tests/cli_test.py
index 2ec798a08..fca2b3e3e 100644
--- a/certbot/tests/cli_test.py
+++ b/certbot/tests/cli_test.py
@@ -480,10 +480,6 @@ class ParseTest(unittest.TestCase):
             for topic in ['all', 'plugins', 'dns-route53']:
                 self.assertFalse('certbot-route53:auth' in self._help_output([help_flag, topic]))
 
-    def test_no_permissions_check_accepted(self):
-        namespace = self.parse(["--no-permissions-check"])
-        self.assertTrue(namespace.no_permissions_check)
-
 
 class DefaultTest(unittest.TestCase):
     """Tests for certbot._internal.cli._Default."""