filter command should always use quotes

Author: sdimitro

sdb/commands/filter.py

@@ -30,19 +30,19 @@ class Filter(sdb.SingleInputCommand):
     EXAMPLES
         Print addresses greater than or equal to 4
 
-            sdb> addr 0 1 2 3 4 5 6 | filter obj >= 4
+            sdb> addr 0 1 2 3 4 5 6 | filter "obj >= 4"
             (void *)0x4
             (void *)0x5
             (void *)0x6
 
         Find the SPA object of the ZFS pool named "jax" and print its 'spa_name'
 
-            sdb> spa | filter obj.spa_name == "jax" | member spa_name
+            sdb> spa | filter 'obj.spa_name == "jax"' | member spa_name
             (char [256])"jax"
 
         Print the number of level 3 log statements in the kernel log buffer
 
-            sdb> dmesg | filter obj.level == 3 | count
+            sdb> dmesg | filter 'obj.level == 3' | count
             (unsigned long long)24
     """
     # pylint: disable=eval-used
@@ -52,7 +52,7 @@ class Filter(sdb.SingleInputCommand):
     @classmethod
     def _init_parser(cls, name: str) -> argparse.ArgumentParser:
         parser = super()._init_parser(name)
-        parser.add_argument("expr", nargs=argparse.REMAINDER)
+        parser.add_argument("expr", nargs=1)
         return parser
 
     @staticmethod
@@ -63,17 +63,7 @@ def __init__(self,
                  args: Optional[List[str]] = None,
                  name: str = "_") -> None:
         super().__init__(args, name)
-        if not self.args.expr:
-            self.parser.error("no expression specified")
-
-        #
-        # This is a stop-gap solution until we figure out
-        # exactly how we want the filter command to behave.
-        #
-        if len(self.args.expr) == 1:
-            self.expr = self.args.expr[0].split()
-        else:
-            self.expr = self.args.expr
+        self.expr = self.args.expr[0].split()
 
         index = None
         operators = ["==", "!=", ">", "<", ">=", "<="]

tests/integration/data/regression_output/core/spa rpool | filter 'obj.bogus == 1624'

@@ -0,0 +1 @@
+sdb: filter: 'spa_t' has no member 'bogus'

tests/integration/data/regression_output/core/zfs_dbgmsg | filter 'obj'spa rpool | filter 'obj.bogus == 1624' renamed to tests/integration/data/regression_output/core/zfs_dbgmsg | filter 'obj'

@@ -160,7 +160,7 @@
     # filter - no left-hand side
     "zfs_dbgmsg | filter  '== obj'",
     # filter - no operator
-    "zfs_dbgmsg | filter 'obj'"
+    "zfs_dbgmsg | filter 'obj'",
     # filter - bogus member
     "spa rpool | filter 'obj.bogus == 1624'",
     # filter - bogus op

tests/integration/test_core_generic.py

@@ -30,29 +30,43 @@ def test_no_arg() -> None:
         invoke(MOCK_PROGRAM, [], line)
 
 
+def test_no_quotes_0() -> None:
+    line = 'filter obj'
+
+    with pytest.raises(sdb.CommandInvalidInputError):
+        invoke(MOCK_PROGRAM, [], line)
+
+
+def test_no_quotes_1() -> None:
+    line = 'filter obj == 1'
+
+    with pytest.raises(sdb.CommandArgumentsError):
+        invoke(MOCK_PROGRAM, [], line)
+
+
 def test_no_rhs() -> None:
-    line = 'filter obj =='
+    line = 'filter "obj =="'
 
     with pytest.raises(sdb.CommandInvalidInputError):
         invoke(MOCK_PROGRAM, [], line)
 
 
 def test_no_lhs() -> None:
-    line = 'filter == obj'
+    line = 'filter "== obj"'
 
     with pytest.raises(sdb.CommandInvalidInputError):
         invoke(MOCK_PROGRAM, [], line)
 
 
 def test_no_operator() -> None:
-    line = 'filter obj'
+    line = 'filter "obj"'
 
     with pytest.raises(sdb.CommandInvalidInputError):
         invoke(MOCK_PROGRAM, [], line)
 
 
 def test_single_void_ptr_input_lhs_not_object() -> None:
-    line = 'filter 0 == obj'
+    line = 'filter "0 == obj"'
     objs = [drgn.Object(MOCK_PROGRAM, 'void *', value=0)]
 
     with pytest.raises(sdb.CommandInvalidInputError):
@@ -77,23 +91,23 @@ def test_multi_void_ptr_input_value_match_ne() -> None:
 
 
 def test_char_array_input_object_match() -> None:
-    line = 'filter obj == obj'
+    line = 'filter "obj == obj"'
     objs = [drgn.Object(MOCK_PROGRAM, 'char [4]', value=b"foo")]
 
     with pytest.raises(sdb.CommandError):
         invoke(MOCK_PROGRAM, objs, line)
 
 
 def test_struct_input_invalid_syntax() -> None:
-    line = 'filter obj->ts_int == 1'
+    line = 'filter "obj->ts_int == 1"'
     objs = [MOCK_PROGRAM["global_struct"]]
 
     with pytest.raises(sdb.CommandEvalSyntaxError):
         invoke(MOCK_PROGRAM, objs, line)
 
 
 def test_struct_input_bogus_member() -> None:
-    line = 'filter obj.ts_bogus == 1'
+    line = 'filter "obj.ts_bogus == 1"'
     objs = [MOCK_PROGRAM["global_struct"]]
 
     with pytest.raises(sdb.CommandError):