From f55e758d478bb067c4a59ace0e2aae7572b7708d Mon Sep 17 00:00:00 2001
From: William Ballenthin <william.ballenthin@fireeye.com>
Date: Tue, 24 Aug 2021 11:45:24 -0600
Subject: [PATCH] tests: rules: demonstrate substring with description

---
 tests/test_rules.py | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/tests/test_rules.py b/tests/test_rules.py
index 8cf5246b..adc87378 100644
--- a/tests/test_rules.py
+++ b/tests/test_rules.py
@@ -766,6 +766,23 @@ def test_substring_feature():
     assert (Substring("abc") in children) == True
     assert (Substring("def") in children) == True
     assert (Substring("gh\ni") in children) == True
+ 
+
+def test_substring_description():
+    rule = textwrap.dedent(
+        """
+        rule:
+            meta:
+                name: test rule
+            features:
+                - or:
+                    - substring: abc
+                      description: the start of the alphabet
+        """
+    )
+    r = capa.rules.Rule.from_yaml(rule)
+    children = list(r.statement.get_children())
+    assert (Substring("abc") in children) == True
 
 
 def test_regex_values_always_string():