merge upstream

Author: mike-hunhoff

CHANGELOG.md

@@ -26,6 +26,7 @@
 -
 
 ### Bug Fixes
+- fix: freeze: omit null description fields from freeze JSON @SkxOverKill #3100
 - fix lots of linter errors identified by pyright @williballenthin #3052
 - fix: render_default always returns empty string @williballenthin #3012
 - fix: elf.py vdso_guess exception handler clobbers symtab_guess @williballenthin #3013

capa/features/freeze/__init__.py

@@ -467,7 +467,7 @@ def dumps_static(extractor: StaticFeatureExtractor, reproducible: bool = False)
     )
     # type checkers are unable to recognise `base_address` as an argument due to alias
 
-    return freeze.model_dump_json()
+    return freeze.model_dump_json(exclude_none=True)
 
 
 def dumps_dynamic(extractor: DynamicFeatureExtractor, reproducible: bool = False) -> str:
@@ -586,7 +586,7 @@ def dumps_dynamic(extractor: DynamicFeatureExtractor, reproducible: bool = False
     )
     # type checkers are unable to recognise `base_address` as an argument due to alias
 
-    return freeze.model_dump_json()
+    return freeze.model_dump_json(exclude_none=True)
 
 
 def loads_static(s: str) -> StaticFeatureExtractor:

tests/data

@@ -153,6 +153,12 @@ def test_freeze_bytes_roundtrip():
     compare_extractors(EXTRACTOR, reanimated)
 
 
+def test_freeze_dump_omits_absent_description():
+    # features without a description must not serialize as "description": null
+    # see: https://github.com/mandiant/capa/issues/3100
+    assert '"description":null' not in capa.features.freeze.dumps_dynamic(EXTRACTOR)
+
+
 def test_freeze_load_sample(tmpdir):
     o = tmpdir.mkdir("capa").join("test.frz")
 

tests/test_freeze_dynamic.py

@@ -163,6 +163,12 @@ def test_freeze_bytes_roundtrip():
     compare_extractors(EXTRACTOR, reanimated)
 
 
+def test_freeze_dump_omits_absent_description():
+    # features without a description must not serialize as "description": null
+    # see: https://github.com/mandiant/capa/issues/3100
+    assert '"description":null' not in capa.features.freeze.dumps_static(EXTRACTOR)
+
+
 def roundtrip_feature(feature):
     assert feature == capa.features.freeze.features.feature_from_capa(feature).to_capa()