add string-in option

Author: jreiberkyle

planet/cli/data.py

@@ -221,6 +221,16 @@ def _func(obj):
         return [_func(v) for v in values]
 
 
+def string_in_to_filter(ctx, param, values) -> Union[dict, None]:
+
+    def _func(obj):
+        field, values = obj
+        return data_filter.string_in_filter(field_name=field, values=values)
+
+    if values:
+        return [_func(v) for v in values]
+
+
 @data.command()
 @click.pass_context
 @translate_exceptions
@@ -231,7 +241,7 @@ def _func(obj):
               callback=assets_to_filter,
               help="""Filter to items with one or more of specified assets.
     VALUE is a comma-separated list of entries.
-    When multiple entries are specified  an implicit 'or' logic is applied.""")
+    When multiple entries are specified, an implicit 'or' logic is applied.""")
 @click.option('--date-range',
               type=click.Tuple([FieldType(), ComparisonType(),
                                 DateTimeType()]),
@@ -253,7 +263,7 @@ def _func(obj):
               help="""Filter field by numeric in.
     FIELD is the name of the field to filter on.
     VALUE is a comma-separated list of entries.
-    When multiple entries are specified  an implicit 'or' logic is applied.""")
+    When multiple entries are specified, an implicit 'or' logic is applied.""")
 @click.option('--range',
               'nrange',
               type=click.Tuple([FieldType(), ComparisonType(), float]),
@@ -263,10 +273,14 @@ def _func(obj):
     FIELD is the name of the field to filter on.
     COMP can be lt, lte, gt, or gte.
     DATETIME can be an RFC3339 or ISO 8601 string.""")
-# @click.option('--string-in',
-#               type=RangeFilter(),
-#               multiple=True,
-#               help=RangeFilter.help)
+@click.option('--string-in',
+              type=click.Tuple([FieldType(), CommaSeparatedString()]),
+              multiple=True,
+              callback=string_in_to_filter,
+              help="""Filter field by numeric in.
+    FIELD is the name of the field to filter on.
+    VALUE is a comma-separated list of entries.
+    When multiple entries are specified, an implicit 'or' logic is applied.""")
 @click.option(
     '--update',
     type=click.Tuple([FieldType(), GTComparisonType(), DateTimeType()]),
@@ -287,6 +301,7 @@ def filter(ctx,
            geom,
            number_in,
            nrange,
+           string_in,
            update,
            permission,
            pretty):
@@ -305,6 +320,7 @@ def filter(ctx,
                       geom,
                       number_in,
                       nrange,
+                      string_in,
                       update,
                       permission)
 

tests/integration/test_data_cli.py

@@ -172,12 +172,9 @@ def test_data_filter_geom(geom_fixture,
     assert_and_filters_equal(json.loads(result.output), expected_filt)
 
 
-# @pytest.mark.skip
 @respx.mock
 @pytest.mark.asyncio
-def test_data_filter_number_in(
-                          invoke,
-                          assert_and_filters_equal):
+def test_data_filter_number_in(invoke, assert_and_filters_equal):
     runner = CliRunner()
 
     result = invoke(["filter"] + '--number-in field 1'.split() +
@@ -189,10 +186,8 @@ def test_data_filter_number_in(
         "type": "NumberInFilter", "field_name": "field", "config": [1.0]
     }
     number_in_filter2 = {
-        "type": "NumberInFilter",
-        "field_name": "field2",
-        "config": [2.0, 3.5]
-        }
+        "type": "NumberInFilter", "field_name": "field2", "config": [2.0, 3.5]
+    }
 
     expected_filt = {
         "type": "AndFilter",
@@ -235,6 +230,33 @@ def test_data_filter_range(invoke, assert_and_filters_equal):
     assert_and_filters_equal(json.loads(result.output), expected_filt)
 
 
+@respx.mock
+@pytest.mark.asyncio
+def test_data_filter_string_in(invoke, assert_and_filters_equal):
+    runner = CliRunner()
+
+    result = invoke(["filter"] + '--string-in field foo'.split() +
+                    '--string-in field2 foo,bar'.split(),
+                    runner=runner)
+    assert result.exit_code == 0
+
+    string_in_filter1 = {
+        "type": "StringInFilter", "field_name": "field", "config": ["foo"]
+    }
+    string_in_filter2 = {
+        "type": "StringInFilter",
+        "field_name": "field2",
+        "config": ["foo", "bar"]
+    }
+
+    expected_filt = {
+        "type": "AndFilter",
+        "config": [permission_filter, string_in_filter1, string_in_filter2]
+    }
+
+    assert_and_filters_equal(json.loads(result.output), expected_filt)
+
+
 @respx.mock
 @pytest.mark.asyncio
 def test_data_filter_update(invoke, assert_and_filters_equal):