coguard-cli 0.2.44__tar.gz → 0.2.45__tar.gz

{coguard_cli-0.2.44/src/coguard_cli.egg-info → coguard_cli-0.2.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: coguard-cli
-Version: 0.2.44
+Version: 0.2.45
 Summary: A command line interface for scanning configuration files with CoGuard
 Home-page: https://github.com/coguardio/coguard-cli
 Author: Heinle Solutions Inc.

{coguard_cli-0.2.44 → coguard_cli-0.2.45}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = coguard-cli
-version = 0.2.44
+version = 0.2.45
 author = Heinle Solutions Inc.
 author_email = albert@coguard.io
 description = A command line interface for scanning configuration files with CoGuard

{coguard_cli-0.2.44 → coguard_cli-0.2.45}/src/coguard_cli/__init__.py

@@ -31,62 +31,37 @@ from coguard_cli.util import convert_posix_path_to_os_path
 from coguard_cli.output_generators.output_generator_sarif import \
     translate_result_to_sarif
 
-def extract_reference_string(entry_dict: Dict, manifest_dict: Dict):
+def extract_reference_string(entry_dict: Dict):
     """
     This is a helper function to extract the respective file in the manifest
     corresponding to an entry in the failed rules.
     """
-    machines_dict = manifest_dict.get("machines", {})
-    reference = ""
-    for machine in machines_dict.values():
-        services_dict = machine.get("services", {})
-        if entry_dict.get("service") in services_dict:
-            config_file_list_of_container = \
-                [
-                    os.path.join(
-                        convert_posix_path_to_os_path(entry["subPath"]),
-                        entry["fileName"]
-                    ) + \
-                    " for service " + entry_dict.get("service")
-                    for entry in services_dict.get(
-                            entry_dict.get("service")
-                    ).get("configFileList", [])
-                ]
-            if config_file_list_of_container:
-                reference = f" (affected files: {', '.join(config_file_list_of_container)})"
-                break
-    if not reference:
-        # Could be in cluster services
-        services_dict = manifest_dict.get("clusterServices", {})
-        if entry_dict.get("service") in services_dict:
-            config_file_list_of_container = \
-                [
-                    os.path.join(
-                        convert_posix_path_to_os_path(entry["subPath"]),
-                        entry["fileName"]
-                    ) + \
-                    " for service " + entry_dict.get("service")
-                    for entry in services_dict.get(
-                            entry_dict.get("service")
-                    ).get("configFileList", [])
-                ]
-            if config_file_list_of_container:
-                reference = f" (affected files: {', '.join(config_file_list_of_container)})"
-    return reference
+    config_file_in_entry = entry_dict.get("config_file", {})
+    from_line = entry_dict.get("fromLine", None)
+    to_line = entry_dict.get("toLine", None)
+    if (from_line is not None and to_line is not None) and (from_line != 0 and to_line != 1):
+        from_to_line = f", {from_line}-{to_line}"
+    else:
+        from_to_line = ""
+    if not config_file_in_entry:
+        return ""
+    reference_path = pathlib.Path(
+        config_file_in_entry.get("subPath", ".")
+    ).joinpath(
+        config_file_in_entry.get("fileName", ".")
+    )
+    return f" (affected files: {reference_path}{from_to_line})"
 
 def print_failed_check(color: str,
                        entry: Dict,
-                       manifest_dict: Dict,
                        fixable_checks: List[str]):
     """
     This is the function to print a failed check entry, given a color.
 
     :param color: The color to use. see e.g. :const:`COLOR_RED`
     :param entry: The entry as returned by the CoGuard API.
-    :param manifest_dict: The manifest dictionary containing information about the included
-                          configuration files
     """
-    reference = extract_reference_string(entry, manifest_dict)
+    reference = extract_reference_string(entry)
     fix_icon = "🔧 " if entry["rule"]["name"] in fixable_checks else ""
     print(
         f'{fix_icon}{color} X Severity {entry["rule"]["severity"]}: '
@@ -131,7 +106,6 @@ def print_failed_check(color: str,
 
 def output_result_json_from_coguard(
         result_json: Dict,
-        manifest_dict: Dict,
         token: Token,
         coguard_api_url: str,
         user_name: Optional[str],
@@ -140,8 +114,6 @@ def output_result_json_from_coguard(
     The function which outputs the result json in a pretty format to the screen.
 
     :param result_json: The output from the API call to CoGuard.
-    :param manifest_dict: The manifest dictionary containing information about the included
-                          configuration files
     """
     high_checks = [entry for entry in result_json.get("failed", []) \
                    if entry["rule"]["severity"] > 3]
@@ -166,11 +138,11 @@ def output_result_json_from_coguard(
                f"(🔧 {len(fixable_checks)} candidates for auto-remediation)")
     print(summary)
     for entry in high_checks:
-        print_failed_check(COLOR_RED, entry, manifest_dict, fixable_check_list)
+        print_failed_check(COLOR_RED, entry, fixable_check_list)
     for entry in medium_checks:
-        print_failed_check(COLOR_YELLOW, entry, manifest_dict, fixable_check_list)
+        print_failed_check(COLOR_YELLOW, entry, fixable_check_list)
     for entry in low_checks:
-        print_failed_check(COLOR_GRAY, entry, manifest_dict, fixable_check_list)
+        print_failed_check(COLOR_GRAY, entry, fixable_check_list)
     print(summary)
 
 class SubParserNames(Enum):
@@ -233,7 +205,7 @@ def upload_and_evaluate_zip_candidate(
             f"{COLOR_YELLOW}Unable to identify any known configuration files.{COLOR_TERMINATION}"
         )
         return
-    zip_file, manifest_dict = zip_candidate
+    zip_file, _ = zip_candidate
     result = api_connection.send_zip_file_for_scanning(
         zip_file,
         auth_config.get_username(),
@@ -257,7 +229,6 @@ def upload_and_evaluate_zip_candidate(
     if output_format == 'formatted':
         output_result_json_from_coguard(
             result or {},
-            manifest_dict,
             token,
             coguard_api_url,
             auth_config.get_username(),

{coguard_cli-0.2.44 → coguard_cli-0.2.45}/src/coguard_cli/output_generators/output_generator_sarif.py

@@ -55,8 +55,8 @@ def translate_result_to_sarif(
         Remediation: {remediation}
         Sources: {sources}
         """.strip()
-        file_uri = pathlib.Path(failed_rule.get("config_file", {}).get("subPath")).joinpath(
-            failed_rule.get("config_file", {}).get("fileName")
+        file_uri = pathlib.Path(failed_rule.get("config_file", {}).get("subPath", ".")).joinpath(
+            failed_rule.get("config_file", {}).get("fileName", "")
         )
         location = {
             "physicalLocation": {

{coguard_cli-0.2.44 → coguard_cli-0.2.45}/src/coguard_cli/tests/common_functions_test.py

@@ -13,24 +13,36 @@ class TestCommonFunctions(unittest.TestCase):
     The class to test the functions in coguard_cli.__init__
     """
 
-    def print_failed_check_test(self):
+    def test_print_failed_check(self):
         """
         Prints a failed check entry.
         """
         new_stdout = StringIO()
+        # Comment: we seem to also need to patch logging.debug
+        #          since it seems to interfere with our mock on
+        #          sys.stdout. Strange python behavior, and we might
+        #          want to examine if this is a python bug.
         with unittest.mock.patch(
                 'sys.stdout',
-                new_callable=lambda: new_stdout):
+                new_callable=lambda: new_stdout), \
+            unittest.mock.patch(
+                'logging.debug',
+                new_callable=unittest.mock.MagicMock()
+            ):
             coguard_cli.print_failed_check(coguard_cli.COLOR_RED, {
                 "rule": {
                     "name": "foo_bar_baz",
                     "severity": 5,
-                    "documentation": "Let's not even talk about it"
+                    "documentation": {
+                        "documentation": "Let's not even talk about it",
+                        "remediation": "foo",
+                        "sources": []
+                    }
                 }
             }, {})
             self.assertIn("not even talk", new_stdout.getvalue())
 
-    def print_output_result_json_from_coguard_test(self):
+    def test_print_output_result_json_from_coguard(self):
         """
         Prints a failed check entry.
         """
@@ -95,13 +107,22 @@ class TestCommonFunctions(unittest.TestCase):
         }
         with unittest.mock.patch(
                 'sys.stdout',
-                new_callable=lambda: new_stdout):
-            coguard_cli.output_result_json_from_coguard(result_json, {})
+                new_callable=lambda: new_stdout), \
+             unittest.mock.patch(
+                'coguard_cli.api_connection.get_fixable_rule_list',
+                 new_callable=lambda: lambda token, coguard_api_url, user_name, organization: []):
+            coguard_cli.output_result_json_from_coguard(
+                result_json,
+                "foo",
+                "bar",
+                "baz",
+                "boo"
+            )
             self.assertIn("1 High", new_stdout.getvalue())
             self.assertIn("1 Medium", new_stdout.getvalue())
             self.assertIn("4 Low", new_stdout.getvalue())
 
-    def auth_token_retrieval_auth_config_not_none_test(self):
+    def test_auth_token_retrieval_auth_config_not_none(self):
         """
         tests for the auth_token_retrieval.
         """
@@ -116,7 +137,7 @@ class TestCommonFunctions(unittest.TestCase):
             token = coguard_cli.auth_token_retrieval("foo", "bar")
             self.assertIsNotNone(token)
 
-    def auth_token_retrieval_auth_config_none_test(self):
+    def test_auth_token_retrieval_auth_config_none(self):
         """
         tests for the auth_token_retrieval.
         """
@@ -135,7 +156,7 @@ class TestCommonFunctions(unittest.TestCase):
             token = coguard_cli.auth_token_retrieval("foo", "bar")
             self.assertIsNotNone(token)
 
-    def upload_and_evaluate_zip_candidate_zip_candidate_none_test(self):
+    def test_upload_and_evaluate_zip_candidate_zip_candidate_none(self):
         """
         Testing zip candidate None
         """
@@ -152,24 +173,31 @@ class TestCommonFunctions(unittest.TestCase):
                 "foo",
                 None,
                 1,
-                "foo"
+                "foo",
+                "iso"
             )
             self.assertIn("Unable to identify any known configuration files.", new_stdout.getvalue())
 
-    def upload_and_evaluate_zip_candidate_test(self):
+    def test_upload_and_evaluate_zip_candidate(self):
         """
         Testing zip candidate None
         """
         new_stdout = StringIO()
         with unittest.mock.patch(
                 'coguard_cli.api_connection.send_zip_file_for_scanning',
-                new_callable=lambda: lambda a, b, c, d, e, f: {"failed": []}), \
+                new_callable=lambda: lambda a, b, c, d, e, f, g: {"failed": []}), \
                 unittest.mock.patch(
                     'sys.stdout',
                     new_callable=lambda: new_stdout), \
                 unittest.mock.patch(
                 'os.remove',
-                new_callable=lambda: lambda a: None):
+                new_callable=lambda: lambda a: None), \
+                unittest.mock.patch(
+                'coguard_cli.api_connection.get_fixable_rule_list',
+                 new_callable=lambda: lambda token, coguard_api_url, user_name, organization: []), \
+                unittest.mock.patch(
+                'logging.debug',
+                new_callable=unittest.mock.MagicMock()):
             auth_config = unittest.mock.MagicMock()
             auth_config.get_username = unittest.mock.Mock(return_value = "foo")
             coguard_cli.upload_and_evaluate_zip_candidate(
@@ -181,9 +209,10 @@ class TestCommonFunctions(unittest.TestCase):
                 "foo",
                 "formatted",
                 1,
-                "foo"
+                "foo",
+                "iso"
             )
-            self.assertIn("Scan result_jsons", new_stdout.getvalue())
+            self.assertIn("SCANNING OF", new_stdout.getvalue())
 
     def upload_and_evaluate_zip_candidate_json_formatted_test(self):
         """
@@ -210,7 +239,8 @@ class TestCommonFunctions(unittest.TestCase):
                 "foo",
                 "json",
                 1,
-                "foo"
+                "foo",
+                "iso"
             )
             self.assertIn('{"failed": []}', new_stdout.getvalue())
 
@@ -219,7 +249,7 @@ class TestCommonFunctions(unittest.TestCase):
         A test of the extract reference string function.
         """
         self.assertEqual(coguard_cli.extract_reference_string(
-            {}, {}
+            {}
         ), "")
 
     def extract_reference_string_test_non_trivial_dicts(self):
@@ -227,42 +257,30 @@ class TestCommonFunctions(unittest.TestCase):
         A test of the extract reference string function.
         """
         self.assertEqual(coguard_cli.extract_reference_string(
-            {"service": "foo"}, {
-                "machines": {
-                    "machine": {
-                        "services": {
-                            "foo": {
-                                "configFileList": [
-                                    {
-                                        "subPath": "bar",
-                                        "fileName": "foo.txt"
-                                    }
-                                ]
-                            }
-                        }
-                    }
-                }
-            }
-        ), " (affected files: bar/foo.txt for service foo)")
+            {"service": "foo",
+             "fromLine": 0,
+             "toLine": 1,
+             "config_file": {
+                 "fileName": "krb5.conf",
+                 "subPath": ".",
+                 "configFileType": "krb"
+             }}
+        ), " (affected files: ./krb5.conf)")
 
-    def extract_reference_string_test_cluster_services_dicts(self):
+    def extract_reference_string_test_non_trivial_dicts_and_lines(self):
         """
         A test of the extract reference string function.
         """
         self.assertEqual(coguard_cli.extract_reference_string(
-            {"service": "foo"}, {
-                "clusterServices": {
-                    "foo": {
-                        "configFileList": [
-                            {
-                                "subPath": "bar",
-                                "fileName": "foo.txt"
-                            }
-                        ]
-                    }
-                }
-            }
-        ), " (affected files: bar/foo.txt for service foo)")
+            {"service": "foo",
+             "fromLine": 2,
+             "toLine": 5,
+             "config_file": {
+                 "fileName": "krb5.conf",
+                 "subPath": ".",
+                 "configFileType": "krb"
+             }}
+        ), " (affected files: ./krb5.conf, 2-5)")
 
     def test_apply_fixes_to_folder(self):
         """

{coguard_cli-0.2.44 → coguard_cli-0.2.45/src/coguard_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: coguard-cli
-Version: 0.2.44
+Version: 0.2.45
 Summary: A command line interface for scanning configuration files with CoGuard
 Home-page: https://github.com/coguardio/coguard-cli
 Author: Heinle Solutions Inc.

{coguard_cli-0.2.44 → coguard_cli-0.2.45}/src/coguard_cli/discovery/config_file_finders/config_file_finder_ansible.py

@@ -8,10 +8,10 @@ import re
 import logging
 from typing import Dict, List, Optional, Tuple
 import yaml
+from flatten_dict import unflatten
 from coguard_cli.discovery.config_file_finder_abc import ConfigFileFinder
 import coguard_cli.discovery.config_file_finders as cff_util
 from coguard_cli.print_colors import COLOR_CYAN, COLOR_TERMINATION
-from flatten_dict import unflatten
 
 
 class ConfigFileFinderAnsible(ConfigFileFinder):