Spruce up example app names etc.

Author: Ickerday

tests/system/test_apps/eventing_app/bin/eventingcsc.py

@@ -28,8 +28,8 @@
 @Configuration()
 class EventingCSC(EventingCommand):
     """
-    The eventingapp command filters records from the events stream returning only those for which the status is same
-    as search query.
+    The `eventingcsc` command filters records from the events stream
+    returning only those for which the status is same as search query.
 
     Example:
 

tests/system/test_apps/eventing_app/default/app.conf

@@ -7,10 +7,10 @@ is_configured = 0
 
 [ui]
 is_visible = 1
-label = Eventing App
+label = [EXAMPLE] Eventing CSC App
 
 [launcher]
-description = Eventing custom search commands example
+description = Example app for eventing Custom Search Commands
 version = 1.0.0
 author = Splunk
 

tests/system/test_apps/generating_app/bin/generatingcsc.py

@@ -30,7 +30,7 @@
 @Configuration()
 class GeneratingCSC(GeneratingCommand):
     """
-    The generatingapp command generates a specific number of records.
+    The `generatingcsc` command generates a specific number of records.
 
     Example:
 

tests/system/test_apps/generating_app/default/app.conf

@@ -7,10 +7,10 @@ is_configured = 0
 
 [ui]
 is_visible = 1
-label = Generating App
+label = [EXAMPLE] Generating CSC App
 
 [launcher]
-description = Generating custom search commands example
+description = Example app for generating Custom Search Commands
 version = 1.0.0
 author = Splunk
 

tests/system/test_apps/modularinput_app/bin/modularinput.py

@@ -21,6 +21,11 @@
 
 
 class ModularInput(Script):
+    """
+    This app provides an example of a modular input that 
+    can be used in Settings => Data inputs => Local inputs => modularinput
+    """
+
     endpoint_arg = "endpoint"
 
     def get_scheme(self):

tests/system/test_apps/modularinput_app/default/app.conf

@@ -1,14 +1,18 @@
+#
+# Splunk app configuration file
+#
+
 [install]
 is_configured = 0
 
 [ui]
 is_visible = 1
-label = Modular Input test app
+label = [EXAMPLE] Modular Input Test App
 
 [launcher]
-author=Splunk
-description=Modular input test app
-version = 1.0
+description = Example app for Modular Inputs
+version = 1.0.0
+author = Splunk
 
 [package]
 check_for_updates = false

tests/system/test_apps/reporting_app/bin/reportingcsc.py

@@ -29,13 +29,17 @@
 @Configuration(requires_preop=True)
 class ReportingCSC(ReportingCommand):
     """
-    The reportingapp command returns a count of students having higher total marks than cutoff marks.
+    The `reportingcsc` command returns a count of students
+    having higher total marks than cutoff marks.
 
     Example:
+    ```
+    | makeresults count=10
+    | eval math=random()%100, eng=random()%100, cs=random()%100
+    | reportingcsc cutoff=150 math eng cs
+    ```
 
-    ``| makeresults count=10 | eval math=random()%100, eng=random()%100, cs=random()%100 | reportingcsc cutoff=150 math eng cs``
-
-    returns a count of students out of 10 having a higher total marks than cutoff.
+    Returns a count of students out of 10 having a higher total marks than cutoff.
     """
 
     cutoff = Option(require=True, validate=validators.Integer(0))

tests/system/test_apps/reporting_app/default/app.conf

@@ -7,10 +7,10 @@ is_configured = 0
 
 [ui]
 is_visible = 1
-label = Reporting App
+label = [EXAMPLE] Reporting CSC App
 
 [launcher]
-description = Reporting custom search commands example
+description = Example app for reporting Custom Search Commands
 version = 1.0.0
 author = Splunk
 

tests/system/test_apps/streaming_app/default/app.conf

@@ -7,10 +7,10 @@ is_configured = 0
 
 [ui]
 is_visible = 1
-label = Streaming App
+label = [EXAMPLE] Streaming CSC App
 
 [launcher]
-description = Streaming custom search commands example
+description = Example app for streaming Custom Search Commands
 version = 1.0.0
 author = Splunk
 

tests/system/test_csc_apps.py

@@ -59,8 +59,8 @@ def test_metadata(self):
 
         self.assertEqual(content.author, "Splunk")
         self.assertEqual(content.configured, "0")
-        self.assertEqual(content.description, "Eventing custom search commands example")
-        self.assertEqual(content.label, "Eventing App")
+        self.assertEqual(content.label, "[EXAMPLE] Eventing CSC App")
+        self.assertEqual(content.description, "Example app for eventing Custom Search Commands")
         self.assertEqual(content.version, "1.0.0")
         self.assertEqual(content.visible, "1")
 
@@ -135,10 +135,10 @@ def test_metadata(self):
 
         self.assertEqual(content.author, "Splunk")
         self.assertEqual(content.configured, "0")
+        self.assertEqual(content.label, "[EXAMPLE] Generating CSC App")
         self.assertEqual(
-            content.description, "Generating custom search commands example"
+            content.description, "Example app for generating Custom Search Commands"
         )
-        self.assertEqual(content.label, "Generating App")
         self.assertEqual(content.version, "1.0.0")
         self.assertEqual(content.visible, "1")
 
@@ -189,10 +189,10 @@ def test_metadata(self):
 
         self.assertEqual(content.author, "Splunk")
         self.assertEqual(content.configured, "0")
+        self.assertEqual(content.label, "[EXAMPLE] Reporting CSC App")
         self.assertEqual(
-            content.description, "Reporting custom search commands example"
+            content.description, "Example app for reporting Custom Search Commands"
         )
-        self.assertEqual(content.label, "Reporting App")
         self.assertEqual(content.version, "1.0.0")
         self.assertEqual(content.visible, "1")
 
@@ -267,10 +267,10 @@ def test_metadata(self):
 
         self.assertEqual(content.author, "Splunk")
         self.assertEqual(content.configured, "0")
+        self.assertEqual(content.label, "[EXAMPLE] Streaming CSC App")
         self.assertEqual(
-            content.description, "Streaming custom search commands example"
+            content.description, "Example app for streaming Custom Search Commands"
         )
-        self.assertEqual(content.label, "Streaming App")
         self.assertEqual(content.version, "1.0.0")
         self.assertEqual(content.visible, "1")