Fix missing deprecation logs and add tests (#49)

* Fix missing deprecation logs and add tests

* Remove f-string for Python3.5 compatibility

* Add `test_deprecations` documentation

Author: HunterMcGushion

docstr_coverage/cli.py

@@ -240,10 +240,8 @@ def _assert_valid_key_value(k, v):
     is_eager=True,
     callback=set_config_defaults,
 )
-@click.option("--skipmagic", "skip_magic_old", is_flag=True, help="Deprecated. Use --skip-magic")
-@click.option(
-    "--skipfiledoc", "skip_file_doc_old", is_flag=True, help="Deprecated. Use --skip-file-doc"
-)
+@click.option("--skipmagic", is_flag=True, help="Deprecated. Use --skip-magic")
+@click.option("--skipfiledoc", is_flag=True, help="Deprecated. Use --skip-file-doc")
 @click.option("--skipinit", is_flag=True, help="Deprecated. Use --skip-init")
 @click.option("--skipclassdef", is_flag=True, help="Deprecated. Use --skip-class-def")
 @click.option("--followlinks", is_flag=True, help="Deprecated. Use --follow-links")
@@ -270,7 +268,7 @@ def execute(paths, **kwargs):
 
     # handle fail under
     if kwargs.get("failunder") is not None:
-        if kwargs.get("fail_under") is not None:
+        if kwargs.get("fail_under") != 100.0:
             raise ValueError("Should not set deprecated --failunder and --fail-under")
         click.secho("Using deprecated --failunder, should use --fail-under", fg="red")
         kwargs["fail_under"] = kwargs.pop("failunder")

tests/test_cli.py

@@ -503,3 +503,36 @@ def test_accept_empty(
         assert run_result.exit_code == 0
     else:
         assert run_result.exit_code == 1
+
+
+##################################################
+# Deprecation Tests
+##################################################
+@pytest.mark.parametrize(["paths"], [pytest.param([SAMPLES_DIR])])
+@pytest.mark.parametrize(
+    ["deprecated_option"],
+    [
+        pytest.param(["--failunder=60"]),
+        pytest.param(["--followlinks"]),
+        pytest.param(["--skipclassdef"]),
+        pytest.param(["--skipfiledoc"]),
+        pytest.param(["--skipinit"]),
+        pytest.param(["--skipmagic"]),
+    ],
+)
+def test_deprecations(paths, deprecated_option, runner: CliRunner):
+    """Test that using deprecated CLI options logs a warning
+
+    Parameters
+    ----------
+    paths: List[str]
+        Path arguments provided to CLI. These should be made absolute before they are passed to
+        :func:`docstr_coverage.cli.collect_filepaths`
+    deprecated_option: List[str]
+        CLI option that has been deprecated
+    runner: CliRunner
+        Click utility to invoke command line scripts"""
+    run_result = runner.invoke(execute, deprecated_option + paths)
+    assert run_result.stdout.startswith(
+        "Using deprecated {}".format(deprecated_option[0].split("=")[0])
+    )