Add a few new fields to results.json (#2585)

(Tracked internally as 51323)

The new fields are:
  name
  environmentDescription
  completionTime
  uuid

The name and environmentDescription are configurable using these new
configuration parameters:
  results_name
  results_environment

The results_name parameter is treated as a date format string.

benchmark.cfg.example

@@ -25,4 +25,6 @@ test=None
 type=all
 verbose=True
 clean=False
-clean_all=False
+clean_all=False
+#results_name=My Benchmarking Run %%Y-%%m-%%d %%H:%%M:%%S
+#results_environment=My Server Environment

toolset/benchmark/benchmarker.py

@@ -8,6 +8,7 @@ from utils import gather_frameworks
 from utils import verify_database_connections
 
 import os
+import uuid
 import shutil
 import stat
 import json
@@ -143,6 +144,7 @@ class Benchmarker:
             self.__parse_results(all_tests)
 
 
+        self.__set_completion_time()
         self.__finish()
         return result
 
@@ -883,20 +885,20 @@ class Benchmarker:
     # End __count_commits
     ############################################################
 
-    ############################################################
-    # __write_intermediate_results
-    ############################################################
     def __write_intermediate_results(self,test_name,status_message):
+        self.results["completed"][test_name] = status_message
+        self.__write_results()
+
+    def __write_results(self):
         try:
-            self.results["completed"][test_name] = status_message
             with open(os.path.join(self.full_results_directory(), 'results.json'), 'w') as f:
                 f.write(json.dumps(self.results, indent=2))
         except (IOError):
             logging.error("Error writing results.json")
 
-    ############################################################
-    # End __write_intermediate_results
-    ############################################################
+    def __set_completion_time(self):
+        self.results['completionTime'] = int(round(time.time() * 1000))
+        self.__write_results()
 
     def __load_results(self):
         try:
@@ -1015,6 +1017,10 @@ class Benchmarker:
 
         if self.results == None:
             self.results = dict()
+            self.results['uuid'] = str(uuid.uuid4())
+            self.results['name'] = datetime.now().strftime(self.results_name)
+            self.results['environmentDescription'] = self.results_environment
+            self.results['completionTime'] = None
             self.results['concurrencyLevels'] = self.concurrency_levels
             self.results['queryIntervals'] = self.query_levels
             self.results['frameworks'] = [t.name for t in self.__gather_tests]

toolset/run-tests.py

@@ -1,7 +1,9 @@
 #!/usr/bin/env python
 import argparse
 import ConfigParser
+import socket
 import sys
+import time
 import os
 import platform
 import multiprocessing
@@ -154,6 +156,8 @@ def main(argv=None):
     parser.add_argument('--sleep', type=int, default=60, help='the amount of time to sleep after starting each test to allow the server to start up.')
 
     # Misc Options
+    parser.add_argument('--results-name', help='Gives a name to this set of results, formatted as a date', default='(unspecified, datetime = %Y-%m-%d %H:%M:%S)')
+    parser.add_argument('--results-environment', help='Describes the environment in which these results were gathered', default='(unspecified, hostname = %s)' % socket.gethostname())
     parser.add_argument('--parse', help='Parses the results of the given timestamp and merges that with the latest results')
     parser.add_argument('-v', '--verbose', action='store_true', default=False, help='Causes the configuration to print before any other commands are executed.')
     parser.add_argument('--clear-tmp', action='store_true', default=False, help='Clears files written to /tmp after each framework\'s tests complete.')