Merge e432db1 into c1bd2fe

Consensys · Feb 7, 2020 · 30752ba · 30752ba
2 parents c1bd2fe + e432db1
commit 30752ba
Show file tree

Hide file tree

Showing 5 changed files with 91 additions and 87 deletions.
diff --git a/docs/mythx_cli.formatter.rst b/docs/mythx_cli.formatter.rst
@@ -34,13 +34,14 @@ mythx_cli.formatter.tabular
     :undoc-members:
     :show-inheritance:
 
-mythx_cli.formatter.sonarqube
------------------------------
-
-.. automodule:: mythx_cli.formatter.sonarqube
-    :members:
-    :undoc-members:
-    :show-inheritance:
+..
+    mythx_cli.formatter.sonarqube
+    -----------------------------
+
+    .. automodule:: mythx_cli.formatter.sonarqube
+        :members:
+        :undoc-members:
+        :show-inheritance:
 
 
 mythx_cli.formatter.util

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -385,7 +385,9 @@ JSON format to stdout. Currently the following formatters are available:
   stdout.
 * :code:`json-pretty`: The same as :code:`json`, just pretty-printed, with an
   indentation of two spaces and alphabetically sorted object keys.
-* :code:`sonar`: Print the results as JSON objects that can be interpreted by SonarQube.
+
+..
+    * :code:`sonar`: Print the results as JSON objects that can be interpreted by SonarQube.
 
 
 API Version Information

diff --git a/mythx_cli/formatter/__init__.py b/mythx_cli/formatter/__init__.py
@@ -8,13 +8,13 @@
     "json": JSONFormatter(),
     "json-pretty": PrettyJSONFormatter(),
     "table": TabularFormatter(),
-    "sonar": SonarQubeFormatter(),
+    # "sonar": SonarQubeFormatter(),
 }
 
 __all__ = [
     JSONFormatter,
     PrettyJSONFormatter,
     SimpleFormatter,
     TabularFormatter,
-    SonarQubeFormatter,
+    # SonarQubeFormatter,
 ]
diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -5,6 +5,7 @@ coverage==5.0.3
 tox==3.14.3
 
 sphinx==2.3.1
+sphinx_rtd_theme==0.4.3
 watchdog==0.10.1
 twine==3.1.1
 

diff --git a/tests/test_report.py b/tests/test_report.py
@@ -15,7 +15,7 @@
 )
 ISSUES_SIMPLE = get_test_case("testdata/detected-issues-simple.txt", raw=True)
 ISSUES_TABLE = get_test_case("testdata/detected-issues-table.txt", raw=True)
-ISSUES_SONAR = get_test_case("testdata/detected-issues-sonar.json")
+# ISSUES_SONAR = get_test_case("testdata/detected-issues-sonar.json")
 
 
 def test_report_tabular():
@@ -95,82 +95,82 @@ def test_report_tabular_filter():
         assert result.exit_code == 0
 
 
-def test_report_sonar():
-    runner = CliRunner()
-    with mock_context():
-        result = runner.invoke(
-            cli,
-            [
-                "--format",
-                "sonar",
-                "analysis",
-                "report",
-                "ab9092f7-54d0-480f-9b63-1bb1508280e2",
-            ],
-        )
-
-        assert json.loads(result.output) == ISSUES_SONAR
-        assert result.exit_code == 0
-
-
-def test_report_sonar_blacklist():
-    runner = CliRunner()
-    with mock_context():
-        result = runner.invoke(
-            cli,
-            [
-                "--format",
-                "sonar",
-                "analysis",
-                "report",
-                "--swc-blacklist",
-                "SWC-110",
-                "ab9092f7-54d0-480f-9b63-1bb1508280e2",
-            ],
-        )
-
-        assert all(x["forRule"] != "SWC-110" for x in json.loads(result.output))
-        assert result.exit_code == 0
-
-
-def test_report_sonar_whitelist():
-    runner = CliRunner()
-    with mock_context():
-        result = runner.invoke(
-            cli,
-            [
-                "--format",
-                "sonar",
-                "analysis",
-                "report",
-                "--swc-whitelist",
-                "SWC-110",
-                "ab9092f7-54d0-480f-9b63-1bb1508280e2",
-            ],
-        )
-
-        assert all(x["forRule"] == "SWC-110" for x in json.loads(result.output))
-        assert result.exit_code == 0
-
-
-def test_report_sonar_filter():
-    runner = CliRunner()
-    with mock_context():
-        result = runner.invoke(
-            cli,
-            [
-                "--format",
-                "sonar",
-                "analysis",
-                "report",
-                "--min-severity",
-                "high",
-                "ab9092f7-54d0-480f-9b63-1bb1508280e2",
-            ],
-        )
-
-        assert all(x["forRule"] != "SWC-110" for x in json.loads(result.output))
-        assert result.exit_code == 0
+# def test_report_sonar():
+#     runner = CliRunner()
+#     with mock_context():
+#         result = runner.invoke(
+#             cli,
+#             [
+#                 "--format",
+#                 "sonar",
+#                 "analysis",
+#                 "report",
+#                 "ab9092f7-54d0-480f-9b63-1bb1508280e2",
+#             ],
+#         )
+#
+#         assert json.loads(result.output) == ISSUES_SONAR
+#         assert result.exit_code == 0
+#
+#
+# def test_report_sonar_blacklist():
+#     runner = CliRunner()
+#     with mock_context():
+#         result = runner.invoke(
+#             cli,
+#             [
+#                 "--format",
+#                 "sonar",
+#                 "analysis",
+#                 "report",
+#                 "--swc-blacklist",
+#                 "SWC-110",
+#                 "ab9092f7-54d0-480f-9b63-1bb1508280e2",
+#             ],
+#         )
+#
+#         assert all(x["forRule"] != "SWC-110" for x in json.loads(result.output))
+#         assert result.exit_code == 0
+#
+#
+# def test_report_sonar_whitelist():
+#     runner = CliRunner()
+#     with mock_context():
+#         result = runner.invoke(
+#             cli,
+#             [
+#                 "--format",
+#                 "sonar",
+#                 "analysis",
+#                 "report",
+#                 "--swc-whitelist",
+#                 "SWC-110",
+#                 "ab9092f7-54d0-480f-9b63-1bb1508280e2",
+#             ],
+#         )
+#
+#         assert all(x["forRule"] == "SWC-110" for x in json.loads(result.output))
+#         assert result.exit_code == 0
+#
+#
+# def test_report_sonar_filter():
+#     runner = CliRunner()
+#     with mock_context():
+#         result = runner.invoke(
+#             cli,
+#             [
+#                 "--format",
+#                 "sonar",
+#                 "analysis",
+#                 "report",
+#                 "--min-severity",
+#                 "high",
+#                 "ab9092f7-54d0-480f-9b63-1bb1508280e2",
+#             ],
+#         )
+#
+#         assert all(x["forRule"] != "SWC-110" for x in json.loads(result.output))
+#         assert result.exit_code == 0
 
 
 def test_report_json():