added test case for generating CSC and updated README.md

Author: akaila-splunk

README.md

@@ -174,6 +174,27 @@ class CustomStreamingCommand(StreamingCommand):
                 record["odd_record"] = "true"
             yield record
 ```
+### Customization for Generating Custom Search Command
+* Generating Custom Search Command is used to generate events using SDK code.
+* Make sure to use ``gen_record()`` method from SearchCommand to add a new record and pass event data as a key=value pair separated by , (mentioned in below example).
+
+Do
+```python
+@Configuration()
+    class GeneratorTest(GeneratingCommand):
+        def generate(self):
+            yield self.gen_record(_time=time.time(), one=1)
+            yield self.gen_record(_time=time.time(), two=2)
+```
+
+Don't
+```python
+@Configuration()
+    class GeneratorTest(GeneratingCommand):
+        def generate(self):
+            yield {'_time': time.time(), 'one': 1}
+            yield {'_time': time.time(), 'two': 2}
+```
 
 ### Changelog
 

splunklib/searchcommands/generating_command.py

@@ -216,18 +216,17 @@ def _execute_chunk_v2(self, process, chunk):
         records = []
         for row in process:
             records.append(row)
-            count+=1
+            count += 1
             if count == self._record_writer._maxresultrows:
                 break
 
-        count = 0
         for row in records:
             self._record_writer.write_record(row)
-            count += 1
-            if count == self._record_writer._maxresultrows:
-                self._finished = False
-                return
-        self._finished = True
+
+        if count == self._record_writer._maxresultrows:
+            self._finished = False
+        else:
+            self._finished = True
 
     def process(self, argv=sys.argv, ifile=sys.stdin, ofile=sys.stdout, allow_empty_input=True):
         """ Process data.

tests/searchcommands/test_generator_command.py

@@ -40,7 +40,6 @@ def generate(self):
     assert expected.issubset(seen)
     assert finished_seen
 
-
 def test_allow_empty_input_for_generating_command():
     """
     Passing allow_empty_input for generating command will cause an error
@@ -59,3 +58,29 @@ def generate(self):
     except ValueError as error:
         assert str(error) == "allow_empty_input cannot be False for Generating Commands"
 
+def test_all_fieldnames_present_for_generated_records():
+    @Configuration()
+    class GeneratorTest(GeneratingCommand):
+        def generate(self):
+            yield self.gen_record(_time=time.time(), one=1)
+            yield self.gen_record(_time=time.time(), two=2)
+            yield self.gen_record(_time=time.time(), three=3)
+            yield self.gen_record(_time=time.time(), four=4)
+            yield self.gen_record(_time=time.time(), five=5)
+
+    generator = GeneratorTest()
+    in_stream = io.BytesIO()
+    in_stream.write(chunky.build_getinfo_chunk())
+    in_stream.write(chunky.build_chunk({'action': 'execute'}))
+    in_stream.seek(0)
+    out_stream = io.BytesIO()
+    generator._process_protocol_v2([], in_stream, out_stream)
+    out_stream.seek(0)
+
+    ds = chunky.ChunkedDataStream(out_stream)
+    fieldnames_expected = {'_time', 'one', 'two', 'three', 'four', 'five'}
+    fieldnames_actual = set()
+    for chunk in ds:
+        for row in chunk.data:
+            fieldnames_actual |= row.keys()
+    assert fieldnames_expected.issubset(fieldnames_actual)