cli: Add --field-json=JSONSTRING

crobinso · crobinso · commit f95ff31d7646 · 2024-02-13T14:38:09.000-05:00
This is similar to the `--field` option for interacting with custom bugzilla fields, but it takes a full JSON string as input. This lets users set complex values like arrays, dict mappings, that otherwise were not settable with plain `--field` Fixes: #163 Signed-off-by: Cole Robinson <crobinso@redhat.com>
diff --git a/bugzilla/_cli.py b/bugzilla/_cli.py
@@ -263,6 +263,10 @@ def _parser_add_bz_fields(rootp, command):
         "the raw name used by the bugzilla instance. For example, if your "
         "bugzilla instance has a custom field cf_my_field, do:\n"
         "  --field cf_my_field=VALUE")
+    p.add_argument('--field-json',
+        metavar="JSONSTRING", action="append", dest="field_jsons",
+        help="Specify --field data as a JSON string. Example: --field-json "
+             '\'{"cf_my_field": "VALUE", "cf_array_field": [1, 2]}\'')
 
     if not cmd_modify:
         _parser_add_output_options(rootp)
@@ -436,15 +440,28 @@ def setup_parser():
 # Command routines #
 ####################
 
-def _merge_field_opts(query, fields, parser):
+def _merge_field_opts(query, fields, field_jsons, parser):
+    values = {}
+
     # Add any custom fields if specified
-    for f in fields:
+    for f in (fields or []):
         try:
             f, v = f.split('=', 1)
-            query[f] = v
+            values[f] = v
         except Exception:
             parser.error("Invalid field argument provided: %s" % (f))
 
+    for j in (field_jsons or []):
+        try:
+            jvalues = json.loads(j)
+            values.update(jvalues)
+        except Exception as e:
+            parser.error("Invalid field-json value=%s: %s" % (j, e))
+
+    if values:
+        log.debug("parsed --field* values: %s", values)
+        query.update(values)
+
 
 def _do_query(bz, opt, parser):
     q = {}
@@ -599,8 +616,7 @@ def _do_query(bz, opt, parser):
         kwopts["tags"] = opt.tags
 
     built_query = bz.build_query(**kwopts)
-    if opt.fields:
-        _merge_field_opts(built_query, opt.fields, parser)
+    _merge_field_opts(built_query, opt.fields, opt.field_jsons, parser)
 
     built_query.update(q)
     q = built_query
@@ -907,8 +923,7 @@ def parse_multi(val):
         kwopts["comment_private"] = opt.private
 
     ret = bz.build_createbug(**kwopts)
-    if opt.fields:
-        _merge_field_opts(ret, opt.fields, parser)
+    _merge_field_opts(ret, opt.fields, opt.field_jsons, parser)
 
     b = bz.createbug(ret)
     b.refresh()
@@ -1049,8 +1064,7 @@ def _do_modify(bz, parser, opt):
         if not v[0] and not v[1]:
             del wbmap[k]
 
-    if opt.fields:
-        _merge_field_opts(update, opt.fields, parser)
+    _merge_field_opts(update, opt.fields, opt.field_jsons, parser)
 
     log.debug("update bug dict=%s", update)
     log.debug("update whiteboard dict=%s", wbmap)
diff --git a/man/bugzilla.rst b/man/bugzilla.rst
@@ -416,13 +416,22 @@ RHBZ 'Fixed in version' field
 ``--field``
 ^^^^^^^^^^^
 
-**Syntax:** ``--field`` FIELD`` VALUE
+**Syntax:** ``--field`` FIELD=VALUE
 
 Manually specify a bugzilla API field. FIELD is the raw name used
 by the bugzilla instance. For example if your bugzilla instance has a
 custom field cf_my_field, do: --field cf_my_field=VALUE
 
 
+``--field-json``
+^^^^^^^^^^^^^^^^
+
+**Syntax:** ``--field-json`` JSONSTRING
+
+Specify --field data as a JSON string. Example:
+--field-json '{"cf_my_field": "VALUE", "cf_array_field": [1, 2]}'
+
+
 
 Output options
 ==============
diff --git a/tests/data/mockargs/test_modify5.txt b/tests/data/mockargs/test_modify5.txt
@@ -4,9 +4,11 @@
   'bar': 'foo',
   'blocks': {'add': ['1234'], 'remove': ['1235'], 'set': []},
   'cc': {'add': ['+bar@example.com'], 'remove': ['steve@example.com']},
+  'cf_blah': {'1': 2},
   'cf_devel_whiteboard': 'DEVBOARD',
   'cf_internal_whiteboard': 'INTBOARD',
   'cf_qa_whiteboard': 'QABOARD',
+  'cf_verified': ['Tested'],
   'comment_tags': ['FOOTAG'],
   'depends_on': {'add': ['2234'], 'remove': ['2235'], 'set': []},
   'groups': {'add': ['foogroup']},
diff --git a/tests/data/mockargs/test_new2.txt b/tests/data/mockargs/test_new2.txt
@@ -2,6 +2,8 @@
  'assigned_to': 'foo@example.com',
  'blocks': ['12345', '6789'],
  'cc': ['foo@example.com', 'bar@example.com'],
+ 'cf_blah': {'1': 2},
+ 'cf_verified': ['Tested'],
  'comment_is_private': True,
  'comment_tags': ['FOO'],
  'component': 'FOOCOMP',
diff --git a/tests/data/mockargs/test_query6.txt b/tests/data/mockargs/test_query6.txt
@@ -1,6 +1,8 @@
 {'BAR': 'WIBBLE',
  'FOO': '1',
  'bug_status': ['VERIFIED', 'RELEASE_PENDING', 'CLOSED'],
+ 'cf_blah': {'1': 2},
+ 'cf_verified': ['Tested'],
  'include_fields': ['assigned_to',
                     'blocks',
                     'component',
diff --git a/tests/test_cli_modify.py b/tests/test_cli_modify.py
@@ -85,6 +85,7 @@ def test_modify(run_cli):
     cmd += "--devel_whiteboard =DEVBOARD --internal_whiteboard =INTBOARD "
     cmd += "--qa_whiteboard =QABOARD "
     cmd += "--comment-tag FOOTAG --field bar=foo "
+    cmd += '--field-json \'{"cf_verified": ["Tested"], "cf_blah": {"1": 2}}\' '
     cmd += "--minor-update "
     fakebz = tests.mockbackend.make_bz(rhbz=True,
         bug_update_args="data/mockargs/test_modify5.txt",
diff --git a/tests/test_cli_new.py b/tests/test_cli_new.py
@@ -41,6 +41,7 @@ def test_new(run_cli):
     cmd += "--assignee foo@example.com --qa_contact qa@example.com "
     cmd += "--comment-tag FOO "
     cmd += "--field foo=bar "
+    cmd += '--field-json \'{"cf_verified": ["Tested"], "cf_blah": {"1": 2}}\' '
 
     fakebz = tests.mockbackend.make_bz(
         bug_create_args="data/mockargs/test_new2.txt",
diff --git a/tests/test_cli_query.py b/tests/test_cli_query.py
@@ -15,12 +15,18 @@
 #################################
 
 def test_query(run_cli):
-    # bad field option
+    # bad --field option
     fakebz = tests.mockbackend.make_bz()
     cmd = "bugzilla query --field FOO"
     out = run_cli(cmd, fakebz, expectfail=True)
     assert "Invalid field argument" in out
 
+    # bad --field-json option
+    fakebz = tests.mockbackend.make_bz()
+    cmd = "bugzilla query --field-json='{1: 2}'"
+    out = run_cli(cmd, fakebz, expectfail=True)
+    assert "Invalid field-json" in out
+
     # Simple query with some comma opts
     cmd = "bugzilla query "
     cmd += "--product foo --component foo,bar --bug_id 1234,2480"
@@ -104,6 +110,7 @@ def test_query(run_cli):
     # Test --status EOL and --oneline, and some --field usage
     cmd = "bugzilla query --status EOL --oneline "
     cmd += "--field FOO=1 --field=BAR=WIBBLE "
+    cmd += '--field-json \'{"cf_verified": ["Tested"], "cf_blah": {"1": 2}}\' '
     fakebz = tests.mockbackend.make_bz(
         bug_search_args="data/mockargs/test_query6.txt",
         bug_search_return="data/mockreturn/test_getbug_rhel.txt",
