Merge pull request #792 from netenglabs/path-query-str

Add query_str to path

Author: ddutt

suzieq/cli/sqcmds/PathCmd.py

@@ -25,6 +25,7 @@ def __init__(
         src: str = "",
         dest: str = "",
         vrf: str = "",
+        query_str: str = ' ',
     ) -> None:
         super().__init__(
             engine=engine,
@@ -34,6 +35,7 @@ def __init__(
             view=view,
             namespace=namespace,
             columns=columns,
+            query_str=query_str,
             format=format,
             sqobj=PathObj
         )

suzieq/engines/pandas/path.py

@@ -752,6 +752,7 @@ def get(self, **kwargs) -> pd.DataFrame:
         src = kwargs.get("src", None)
         dest = kwargs.get("dest", None)
         dvrf = kwargs.get("vrf", "")
+        query_str = kwargs.pop('query_str', "")
 
         if not src or not dest:
             raise AttributeError("Must specify trace source and dest")
@@ -1120,7 +1121,9 @@ def get(self, **kwargs) -> pd.DataFrame:
             # This occurs when a path traversal terminates due to an error such
             # as loop detected
             final_paths = paths
-        return self._path_cons_result(final_paths)
+        return self._handle_user_query_str(
+            self._path_cons_result(final_paths), query_str)\
+            .reset_index(drop=True)
 
     def _path_cons_result(self, paths):
         df_plist = []

tests/integration/sqcmds/cumulus-samples/badquery.yml

@@ -75,8 +75,9 @@ tests:
 - command: path show --src='172.16.1.101' --dest='172.16.3.202' --namespace='ospf-ibgp'
     --query-str='vendor == "Cisco" and mtu==1500' --format=json
   data-directory: tests/data/parquet/
+  error:
+    error: '[{"error": "ERROR: UserQueryError: name ''vendor'' is not defined"}]'
   marks: path show badquery cumulus
-  output: '[]'
 - command: topology show --query-str='vendor == "Cisco" and mtu==1500' --format=json
     --namespace='ospf-single dual-evpn ospf-ibgp'
   data-directory: tests/data/parquet/
@@ -158,8 +159,9 @@ tests:
 - command: path summarize --src='172.16.1.101' --dest='172.16.3.202' --namespace='ospf-ibgp'
     --query-str='vendor == "Cisco" and mtu==1500' --format=json
   data-directory: tests/data/parquet/
+  error:
+    error: '{"error": {"0": "ERROR: UserQueryError: name ''vendor'' is not defined"}}'
   marks: path summarize badquery cumulus
-  output: '[]'
 - command: topology summarize --query-str='vendor == "Cisco" and mtu==1500' --format=json
     --namespace='ospf-single dual-evpn ospf-ibgp' --columns='hostname'
   data-directory: tests/data/parquet/
@@ -241,8 +243,9 @@ tests:
 - command: path unique --src='172.16.1.101' --dest='172.16.3.202' --namespace='ospf-ibgp'
     --query-str='vendor == "Cisco" and mtu==1500' --format=json --columns='hostname'
   data-directory: tests/data/parquet/
+  error:
+    error: '[{"error": "ERROR: UserQueryError: name ''vendor'' is not defined"}]'
   marks: path unique badquery cumulus
-  output: '[]'
 - command: topology unique --query-str='vendor == "Cisco" and mtu==1500' --format=json
     --namespace='ospf-single dual-evpn ospf-ibgp' --columns='hostname'
   data-directory: tests/data/parquet/