[core][feat] Improve the display name of the property (#2073)

Author: aquamatthias

fixcore/fixcore/cli/command.py

@@ -55,8 +55,16 @@
 from detect_secrets.core import scan, plugins
 from detect_secrets.core.potential_secret import PotentialSecret
 from detect_secrets.settings import configure_settings_from_baseline, default_settings
-from parsy import Parser, string, ParseError
 from fixclient.models import Model as RCModel, Kind as RCKind
+from fixdatalink import EngineConfig
+from fixdatalink.batch_stream import BatchStream
+from fixdatalink.collect_plugins import update_sql
+from parsy import Parser, string, ParseError
+from rich.padding import Padding
+from rich.panel import Panel
+from rich.table import Table
+from rich.text import Text
+
 from fixcore import version
 from fixcore.async_extensions import run_async
 from fixcore.cli import (
@@ -170,9 +178,6 @@
     respond_cytoscape,
 )
 from fixcore.worker_task_queue import WorkerTask, WorkerTaskName
-from fixdatalink import EngineConfig
-from fixdatalink.batch_stream import BatchStream
-from fixdatalink.collect_plugins import update_sql
 from fixlib.core import CLIEnvelope
 from fixlib.durations import parse_duration
 from fixlib.parse_util import (
@@ -188,10 +193,6 @@
 )
 from fixlib.utils import safe_members_in_tarfile, get_local_tzinfo
 from fixlib.x509 import write_cert_to_file, write_key_to_file
-from rich.padding import Padding
-from rich.panel import Panel
-from rich.table import Table
-from rich.text import Text
 
 if TYPE_CHECKING:
     from fixcore.dependencies import TenantDependencies
@@ -2638,7 +2639,11 @@ def parse(self, arg: Optional[str] = None, ctx: CLIContext = EmptyContext, **kwa
         is_aggregate: bool = ctx.query is not None and ctx.query.aggregate is not None
 
         def display(name: str) -> str:
-            return " ".join(word.capitalize() for word in name.split("_"))
+            return " \u279E ".join(
+                " ".join((word[0].upper() + word[1:]).strip("`") for word in part.replace("_", " ").split(" ") if word)
+                for part in PropertyPath.from_string(name).path
+                if part is not None and part not in Section.content
+            )
 
         def default_props_to_show(
             props_setting: Tuple[List[PropToShow], List[PropToShow], List[PropToShow], List[PropToShow]]
@@ -2725,7 +2730,7 @@ def parse_props_to_show(props_arg: str) -> List[PropToShow]:
             for prop, as_name in list_arg_parse.parse(props_arg):
                 path = adjust_path(prop)
                 as_name = path[-1] if prop == as_name or as_name is None else as_name
-                props.append(PropToShow(path, as_name, display(as_name), prop))
+                props.append(PropToShow(path, as_name, display(prop), prop))
             return props
 
         def create_unique_names(all_props: List[PropToShow]) -> List[PropToShow]:

fixcore/tests/fixcore/cli/command_test.py

@@ -611,7 +611,7 @@ async def test_list_command(cli: CLI) -> None:
                 {"display": "Name", "kind": "string", "name": "name", "path": "/name"},
                 {"display": "Some Int", "kind": "int32", "name": "some_int", "path": "/some_int"},
                 {
-                    "display": "Foo․bla․bar.test.rest.best.",
+                    "display": "Tags ➞ foo․bla․bar.test.rest.best.",
                     "kind": "string",
                     "name": "foo․bla․bar.test.rest.best.",
                     "path": "/tags.`foo․bla․bar.test.rest.best.`",
@@ -649,6 +649,37 @@ async def test_list_command(cli: CLI) -> None:
     result = await cli.execute_cli_command("search is (foo) | aggregate kind: sum(1) as count | list", list_sink)
     assert result[0][0] == "kind=foo, count=10"
 
+    # properties to display are rendered correctly
+    result = await cli.execute_cli_command(
+        'search all {account_setting: <-- } account_setting.reported.bucket_public_access_block_configuration.{block_public_acls != true or ignore_public_acls != true or block_public_policy != true or restrict_public_buckets != true} and bucket_public_access_block_configuration.{block_public_acls != true or ignore_public_acls != true or block_public_policy != true or restrict_public_buckets != true} and (bucket_acl.grants[*].{permission in ["READ","READ_ACP","WRITE","WRITE_ACP","FULL_CONTROL"] and grantee.uri = "http://acs.amazonaws.com/groups/global/AllUsers"} or bucket_policy.Statement[*].{Effect = "Allow" and (Principal = "*" or Principal.AWS = "*" or Principal.CanonicalUser = "*") and (Action in ["s3:GetObject","s3:PutObject","s3:Get*","s3:Put*","s3:*","*"] or Action[*] in ["s3:GetObject","s3:PutObject","s3:Get*","s3:Put*","s3:*","*"])}) | list --json-table',  # noqa
+        list_sink,
+    )
+    assert [a["display"] for a in result[0][0]["columns"]] == [
+        "Kind",
+        "Id",
+        "Name",
+        "Bucket Acl ➞ Grants[] ➞ Permission",
+        "Bucket Acl ➞ Grants[] ➞ Grantee ➞ Uri",
+        "Bucket Policy ➞ Statement[] ➞ Effect",
+        "Bucket Policy ➞ Statement[] ➞ Principal",
+        "Bucket Policy ➞ Statement[] ➞ Principal ➞ AWS",
+        "Bucket Policy ➞ Statement[] ➞ Principal ➞ CanonicalUser",
+        "Bucket Policy ➞ Statement[] ➞ Action",
+        "Bucket Policy ➞ Statement[] ➞ Action[]",
+        "Bucket Public Access Block Configuration ➞ Block Public Acls",
+        "Bucket Public Access Block Configuration ➞ Ignore Public Acls",
+        "Bucket Public Access Block Configuration ➞ Block Public Policy",
+        "Bucket Public Access Block Configuration ➞ Restrict Public Buckets",
+        "Account Setting ➞ Bucket Public Access Block Configuration ➞ Block Public Acls",
+        "Account Setting ➞ Bucket Public Access Block Configuration ➞ Ignore Public Acls",
+        "Account Setting ➞ Bucket Public Access Block Configuration ➞ Block Public Policy",
+        "Account Setting ➞ Bucket Public Access Block Configuration ➞ Restrict Public Buckets",
+        "Age",
+        "Cloud",
+        "Account",
+        "Region / Zone",
+    ]
+
 
 @pytest.mark.asyncio
 async def test_jq_command(cli: CLI) -> None: