From 071b019942366375884eb0301cc37289e6101849 Mon Sep 17 00:00:00 2001
From: William Deegan <bill@baddogconsulting.com>
Date: Sun, 4 Jun 2023 16:36:45 -0700
Subject: Added build info to json, added --debug=json to docs

---
 SCons/Script/Main.py |  2 +-
 SCons/Util/stats.py  | 39 +++++++++++++++++++++++++++++++++------
 doc/man/scons.xml    | 13 +++++++++++++
 3 files changed, 47 insertions(+), 7 deletions(-)

diff --git a/SCons/Script/Main.py b/SCons/Script/Main.py
index 572a2e7..46b6e6a 100644
--- a/SCons/Script/Main.py
+++ b/SCons/Script/Main.py
@@ -208,7 +208,7 @@ class BuildTask(SCons.Taskmaster.OutOfDateTask):
                     "Command execution end timestamp: %s: %f\n"
                     % (str(self.node), finish_time)
                 )
-            TIME_STATS.add_command(str(self.node), (finish_time - start_time))
+            TIME_STATS.add_command(str(self.node), start_time, finish_time)
             sys.stdout.write(
                 "Command execution time: %s: %f seconds\n"
                 % (str(self.node), (finish_time - start_time))
diff --git a/SCons/Util/stats.py b/SCons/Util/stats.py
index 177f363..5a05f1c 100644
--- a/SCons/Util/stats.py
+++ b/SCons/Util/stats.py
@@ -33,13 +33,16 @@ There are basically two types of stats.
    though it might be useful to query during a run.
 
 """
+import os
 import json
+import sys
+from datetime import datetime
 
 import SCons.Debug
 
 ALL_STATS = {}
 ENABLE_JSON = False
-
+JSON_OUTPUT_FILE = 'scons_stats.json'
 
 def AddStatType(name, stat_object):
     """
@@ -135,10 +138,12 @@ class TimeStats(Stats):
             'command_exec_time': command_exec_time
         }
 
-    def add_command(self, command, command_time):
+    def add_command(self, command, start_time, finish_time):
         if command in self.commands:
             print("Duplicate command %s" % command)
-        self.commands[command] = command_time
+        self.commands[command] = {'start': start_time,
+                                  'end' : finish_time,
+                                  'duration': finish_time - start_time}
 
 
 COUNT_STATS = CountStats()
@@ -148,8 +153,12 @@ TIME_STATS = TimeStats()
 
 def WriteJsonFile():
     """
-
+    Actually write the JSON file with debug information.
+    Depending which of : count, time, action-timestamps,memory their information will be written.
     """
+
+    from SCons.Script import BUILD_TARGETS, COMMAND_LINE_TARGETS, ARGUMENTS, ARGLIST
+
     print("DUMPING JSON FILE")
     json_structure = {}
     if COUNT_STATS.enabled:
@@ -172,8 +181,26 @@ def WriteJsonFile():
         json_structure['Time'] = {'Commands': TIME_STATS.commands,
                                   'Totals': TIME_STATS.totals}
 
-    with open("scons_stats.json", 'w') as sf:
-        sf.write(json.dumps(json_structure))
+    # Now add information about this build to the JSON file
+    json_structure['Build_Info'] = {
+        'BUILD_TARGETS' : [str(t) for t in BUILD_TARGETS],
+        'ARGUMENTS' : [str(a) for a in ARGUMENTS],
+        'ARGLIST' : [ str(al) for al in ARGLIST],
+        'COMMAND_LINE_TARGETS' : [ str(clt) for clt in COMMAND_LINE_TARGETS],
+        'ARGV' : sys.argv,
+        'TIME' : datetime.now().isoformat(),
+        'HOST' : os.uname().nodename,
+        'PYTHON_VERSION' : {
+            'major' : sys.version_info.major,
+            'minor' : sys.version_info.minor,
+            'micro' : sys.version_info.micro,
+            'releaselevel' : sys.version_info.releaselevel,
+            'serial' : sys.version_info.serial,
+        }
+    }
+
+    with open(JSON_OUTPUT_FILE, 'w') as sf:
+        sf.write(json.dumps(json_structure, indent=4))
 
 # Local Variables:
 # tab-width:4
diff --git a/doc/man/scons.xml b/doc/man/scons.xml
index e79a267..0625efa 100644
--- a/doc/man/scons.xml
+++ b/doc/man/scons.xml
@@ -929,6 +929,19 @@ $ <userinput>scons --debug=includes foo.o</userinput>
   </listitem>
   </varlistentry>
 
+<varlistentry>
+  <term><emphasis role="bold">json</emphasis></term>
+  <listitem>
+<para>Write info for any of the following debug options if they are enabled: <emphasis role="bold">memory</emphasis>,
+    <emphasis>count</emphasis>, <emphasis>time</emphasis>, <emphasis>action-timestamps</emphasis> </para>
+
+<screen>
+$ <userinput>scons --debug=memory,json foo.o</userinput>
+</screen>
+
+  </listitem>
+  </varlistentry>
+
   <varlistentry>
   <term><emphasis role="bold">memoizer</emphasis></term>
   <listitem>
-- 
cgit v0.12