Create docstrings for test_name_generator.py

Author: portela-simbiose

tests_and_examples/test_name_generator.py

@@ -1,8 +1,19 @@
+"""Automatically generate tests names.
+
+This script updates all tests stored JSON files in the examples/ directory by
+replacing the current test name by a new one, generated based on the structure
+of the tests. It takes into account field types, operators being used,
+parameters etc.
+"""
+
 import collections
 import json
 
 
 def generate_name(query_type, test):
+    """Generate the test name based on the test type (count entity, aggregation
+    etc) and its data.
+    """
     name = generate_start(query_type)
     name += ' '
 
@@ -28,6 +39,7 @@ def generate_name(query_type, test):
 
 
 def generate_start(query_type):
+    """Generate the first part of the test name."""
     query_name = query_type.upper()
     a_or_an = 'a'
 
@@ -39,6 +51,7 @@ def generate_start(query_type):
 
 
 def generate_fields(fields):
+    """Generate the fields being used in the test."""
     if len(fields) == 0:
         return 'using automatically created fields'
 
@@ -64,6 +77,7 @@ def generate_fields(fields):
 
 
 def generate_operators(query):
+    """Generate the operators being used in the test."""
     query_string = json.dumps(query)
     valid_operators = ['and', 'or', 'not', 'freqgroup']
     existing_operators = [operator for operator in valid_operators
@@ -94,6 +108,7 @@ def generate_operators(query):
 
 
 def generate_parameters(query):
+    """Generate the parameters being used in the test."""
     query_string = json.dumps(query)
     valid_parameters = [
         'equals', 'not-equals', 'range', 'gt', 'gte', 'lt', 'lte', 'between',
@@ -127,6 +142,7 @@ def generate_parameters(query):
 
 
 def generate_end(test):
+    """Generate the last part of the test name."""
     text = ''
 
     metric = generate_metric(test)
@@ -151,6 +167,7 @@ def generate_end(test):
 
 
 def generate_metric(test):
+    """Generate the metrics and histogram being used in the test."""
     text = ''
     query_string = json.dumps(test['query'])
 
@@ -179,6 +196,7 @@ def generate_metric(test):
 
 
 def generate_timezone(test):
+    """Generate the timezone being used in the test."""
     text = ''
     index_string = json.dumps(test['index'])
     query_string = json.dumps(test['query'])
@@ -205,6 +223,7 @@ def generate_timezone(test):
 
 
 def generate_relative_time(test):
+    """Generate the relative being used in the test."""
     text = []
     query_string = json.dumps(test['query'])
 
@@ -239,6 +258,7 @@ def generate_relative_time(test):
 
 
 def main():
+    """Generate tests names for all JSON files in the examples/ directory."""
     query_types = [
         'count_entity',
         'count_event',