Merge pull request #2503 from ujjwal96/options

Improve options UX

3 files changed, 196 insertions, 2 deletions

diff --git a/mitmproxy/tools/main.py b/mitmproxy/tools/main.py
index d8d16ea4..3735cbf4 100644
--- a/mitmproxy/tools/main.py
+++ b/mitmproxy/tools/main.py
@@ -20,7 +20,7 @@ from mitmproxy import options  # noqa
 from mitmproxy import optmanager  # noqa
 from mitmproxy import proxy  # noqa
 from mitmproxy import log  # noqa
-from mitmproxy.utils import debug  # noqa
+from mitmproxy.utils import debug, arg_check  # noqa
 
 
 def assert_utf8_env():
@@ -72,7 +72,17 @@ def run(
     master = master_cls(opts)
 
     parser = make_parser(opts)
-    args = parser.parse_args(arguments)
+
+    # To make migration from 2.x to 3.0 bearable.
+    if "-R" in sys.argv and sys.argv[sys.argv.index("-R") + 1].startswith("http"):
+        print("-R is used for specifying replacements.\n"
+              "To use mitmproxy in reverse mode please use --mode reverse:SPEC instead")
+
+    try:
+        args = parser.parse_args(arguments)
+    except SystemExit:
+        arg_check.check()
+        sys.exit(1)
     try:
         unknown = optmanager.load_paths(opts, args.conf)
         pconf = process_options(parser, opts, args)
diff --git a/mitmproxy/utils/arg_check.py b/mitmproxy/utils/arg_check.py
new file mode 100644
index 00000000..73f7047c
--- /dev/null
+++ b/mitmproxy/utils/arg_check.py
@@ -0,0 +1,148 @@
+import sys
+
+DEPRECATED = """
+--cadir
+-Z
+--body-size-limit
+--stream
+--palette
+--palette-transparent
+--follow
+--order
+--no-mouse
+--reverse
+--socks
+--http2-priority
+--no-http2-priority
+--no-websocket
+--websocket
+--spoof-source-address
+--upstream-bind-address
+--ciphers-client
+--ciphers-server
+--client-certs
+--no-upstream-cert
+--add-upstream-certs-to-client-chain
+--upstream-trusted-cadir
+--upstream-trusted-ca
+--ssl-version-client
+--ssl-version-server
+--no-onboarding
+--onboarding-host
+--onboarding-port
+--server-replay-use-header
+--no-pop
+--replay-ignore-content
+--replay-ignore-payload-param
+--replay-ignore-param
+--replay-ignore-host
+--replace-from-file
+"""
+
+REPLACED = """
+-t
+-u
+--wfile
+-a
+--afile
+-z
+-b
+--bind-address
+--port
+-I
+--ignore
+--tcp
+--cert
+--insecure
+-c
+--replace
+-i
+-f
+--filter
+"""
+
+REPLACEMENTS = {
+    "--stream": "stream_large_bodies",
+    "--palette": "console_palette",
+    "--palette-transparent": "console_palette_transparent:",
+    "--follow": "console_focus_follow",
+    "--order": "console_order",
+    "--no-mouse": "console_mouse",
+    "--reverse": "console_order_reversed",
+    "--no-http2-priority": "http2_priority",
+    "--no-websocket": "websocket",
+    "--no-upstream-cert": "upstream_cert",
+    "--upstream-trusted-cadir": "ssl_verify_upstream_trusted_cadir",
+    "--upstream-trusted-ca": "ssl_verify_upstream_trusted_ca",
+    "--no-onboarding": "onboarding",
+    "--no-pop": "server_replay_nopop",
+    "--replay-ignore-content": "server_replay_ignore_content",
+    "--replay-ignore-payload-param": "server_replay_ignore_payload_params",
+    "--replay-ignore-param": "server_replay_ignore_params",
+    "--replay-ignore-host": "server_replay_ignore_host",
+    "--replace-from-file": "replacements (use @ to specify path)",
+    "-t": "--stickycookie",
+    "-u": "--stickyauth",
+    "--wfile": "--save-stream-file",
+    "-a": "-w  Prefix path with + to append.",
+    "--afile": "-w  Prefix path with + to append.",
+    "-z": "--anticomp",
+    "-b": "--listen-host",
+    "--bind-address": "--listen-host",
+    "--port": "--listen-port",
+    "-I": "--ignore-hosts",
+    "--ignore": "--ignore-hosts",
+    "--tcp": "--tcp-hosts",
+    "--cert": "--certs",
+    "--insecure": "--ssl-insecure",
+    "-c": "-C",
+    "--replace": "--replacements",
+    "-i": "--intercept",
+    "-f": "--view-filter",
+    "--filter": "--view-filter"
+}
+
+
+def check():
+    args = sys.argv[1:]
+    print()
+    if "-U" in args:
+        print("-U is deprecated, please use --mode upstream:SPEC instead")
+
+    if "-T" in args:
+        print("-T is deprecated, please use --mode transparent instead")
+
+    for option in ("-e", "--eventlog", "--norefresh"):
+        if option in args:
+            print("{} has been removed.".format(option))
+
+    for option in ("--nonanonymous", "--singleuser", "--htpasswd"):
+        if option in args:
+            print(
+                '{} is deprecated.\n'
+                'Please use `--proxyauth SPEC` instead.\n'
+                'SPEC Format: "username:pass", "any" to accept any user/pass combination,\n'
+                '"@path" to use an Apache htpasswd file, or\n'
+                '"ldap[s]:url_server_ldap:dn_auth:password:dn_subtree" '
+                'for LDAP authentication.'.format(option))
+
+    for option in REPLACED.splitlines():
+        if option in args:
+            print(
+                "{} is deprecated.\n"
+                "Please use `{}` instead.".format(
+                    option,
+                    REPLACEMENTS.get(option)
+                )
+            )
+
+    for option in DEPRECATED.splitlines():
+        if option in args:
+            print(
+                "{} is deprecated.\n"
+                "Please use `--set {}=value` instead.\n"
+                "To show all options and their default values use --options".format(
+                    option,
+                    REPLACEMENTS.get(option, None) or option.lstrip("-").replace("-", "_")
+                )
+            )
diff --git a/test/mitmproxy/utils/test_arg_check.py b/test/mitmproxy/utils/test_arg_check.py
new file mode 100644
index 00000000..72913955
--- /dev/null
+++ b/test/mitmproxy/utils/test_arg_check.py
@@ -0,0 +1,36 @@
+import io
+import contextlib
+from unittest import mock
+
+import pytest
+
+from mitmproxy.utils import arg_check
+
+
+@pytest.mark.parametrize('arg, output', [
+    (["-T"], "-T is deprecated, please use --mode transparent instead"),
+    (["-U"], "-U is deprecated, please use --mode upstream:SPEC instead"),
+    (["--cadir"], "--cadir is deprecated.\n"
+                  "Please use `--set cadir=value` instead.\n"
+                  "To show all options and their default values use --options"),
+    (["--palette"], "--palette is deprecated.\n"
+                    "Please use `--set console_palette=value` instead.\n"
+                    "To show all options and their default values use --options"),
+    (["--wfile"], "--wfile is deprecated.\n"
+                  "Please use `--save-stream-file` instead."),
+    (["--eventlog"], "--eventlog has been removed."),
+    (["--nonanonymous"], '--nonanonymous is deprecated.\n'
+                         'Please use `--proxyauth SPEC` instead.\n'
+                         'SPEC Format: "username:pass", "any" to accept any user/pass combination,\n'
+                         '"@path" to use an Apache htpasswd file, or\n'
+                         '"ldap[s]:url_server_ldap:dn_auth:password:dn_subtree" '
+                         'for LDAP authentication.')
+
+])
+def test_check_args(arg, output):
+    f = io.StringIO()
+    with contextlib.redirect_stdout(f):
+        with mock.patch('sys.argv') as m:
+            m.__getitem__.return_value = arg
+            arg_check.check()
+            assert f.getvalue().strip() == output