feat: Results Table Generator before sort

gcarreno · gcarreno · commit 53560e762089 · 2024-03-22T20:51:28.000Z
diff --git a/utilities/common/utilities.data.entries.pas b/utilities/common/utilities.data.entries.pas
@@ -34,15 +34,15 @@ interface
   TEntry = class(TObject)
   private
     FActive: Boolean;
-    FName: String;
-    FNotes: String;
-    FCompiler: String;
-    FEntryFolder: String;
-    FEntryBinary: String;
-    FLPI: String;
+    FName: TJSONStringType;
+    FNotes: TJSONStringType;
+    FCompiler: TJSONStringType;
+    FEntryFolder: TJSONStringType;
+    FEntryBinary: TJSONStringType;
+    FLPI: TJSONStringType;
     FHasRelease: Boolean;
     FThreads: Integer;
-    FRunParams: String;
+    FRunParams: TJSONStringType;
 
     //procedure setFromJSON(const AJSON: TJSONStringType);
     procedure setFromJSONData(const AJSONData: TJSONData);
@@ -58,22 +58,22 @@   TEntry = class(TObject)
     property Active: Boolean
       read FActive
       write FActive;
-    property Name: String
+    property Name: TJSONStringType
       read FName
       write FName;
-    property Notes: String
+    property Notes: TJSONStringType
       read FNotes
       write FNotes;
-    property Compiler: String
+    property Compiler: TJSONStringType
       read FCompiler
       write FCompiler;
-    property EntryFolder: String
+    property EntryFolder: TJSONStringType
       read FEntryFolder
       write FEntryFolder;
-    property EntryBinary: String
+    property EntryBinary: TJSONStringType
       read FEntryBinary
       write FEntryBinary;
-    property LPI: String
+    property LPI: TJSONStringType
       read FLPI
       write FLPI;
     property HasRelease: Boolean
@@ -82,7 +82,7 @@   TEntry = class(TObject)
     property Threads: Integer
       read FThreads
       write FThreads;
-    property RunParams: String
+    property RunParams: TJSONStringType
       read FRunParams
       write FRunParams;
   published
diff --git a/utilities/common/utilities.data.hyperfine.pas b/utilities/common/utilities.data.hyperfine.pas
@@ -0,0 +1,146 @@
+unit Utilities.Data.Hyperfine;
+
+{$mode ObjFPC}{$H+}
+
+interface
+
+uses
+  Classes
+, SysUtils
+, fpjson
+;
+
+const
+  cJSONHyperfineResult = 'results[0]';
+
+type
+{ EResultNotAJSONObject }
+  EResultNotAJSONObject = Exception;
+
+{ THyperfineResult }
+  TArrayOfTime = array of Double;
+  THyperfineResult = class(TObject)
+  private
+    FCommand: String;
+    FMean: Double;
+    FStandardDeviation: Double;
+    FMedian: Double;
+    FUser: Double;
+    FSystem: Double;
+    FMin: Double;
+    FMax: Double;
+    FTimes: TArrayOfTime;
+
+    procedure setFromJSONData(const AJSONData: TJSONData);
+    procedure setFromJSONObject(const AJSONObject: TJSONObject);
+  protected
+  public
+    constructor Create;
+    constructor Create(const AJSONData: TJSONData);
+
+    destructor Destroy; override;
+
+    property Command: String
+      read FCommand
+      write FCommand;
+    property Mean: Double
+      read fMean
+      write FMean;
+    property StandardDeviation: Double
+      read FStandardDeviation
+      write FStandardDeviation;
+    property Median: Double
+      read FMedian
+      write FMedian;
+    property User: Double
+      read FUser
+      write FUser;
+    property System: Double
+      read FSystem
+      write FSystem;
+    property Min: Double
+      read FMin
+      write FMin;
+    property Max: Double
+      read FMax
+      write FMax;
+    property Times: TArrayOfTime
+      read FTimes
+      write FTimes;
+  published
+  end;
+
+implementation
+
+const
+  cJSONCommand           = 'command';
+  cJSONMean              = 'mean';
+  cJSONStandardDeviation = 'stddev';
+  cJSONMedian            = 'median';
+  cJSONUser              = 'user';
+  cJSONSystem            = 'system';
+  cJSONMin               = 'min';
+  cJSONMax               = 'max';
+  cJSONTimes             = 'times';
+
+resourcestring
+  rsExceptionNotAJSONObject = 'JSON Data is not an object';
+
+{ THyperfineResult }
+
+constructor THyperfineResult.Create;
+begin
+  FCommand:= '';
+  FMean:= 0.0;
+  FStandardDeviation:= 0.0;
+  FMedian:= 0.0;
+  FUser:= 0.0;
+  FSystem:= 0.0;
+  FMin:= 0.0;
+  FMax:= 0.0;
+  SetLength(FTimes, 0);
+end;
+
+constructor THyperfineResult.Create(const AJSONData: TJSONData);
+begin
+  Create;
+  setFromJSONData(AJSONData);
+end;
+
+destructor THyperfineResult.Destroy;
+begin
+  inherited Destroy;
+end;
+
+procedure THyperfineResult.setFromJSONData(const AJSONData: TJSONData);
+begin
+  if aJSONData.JSONType <> jtObject then
+  begin
+    raise EResultNotAJSONObject.Create(rsExceptionNotAJSONObject);
+  end;
+  setFromJSONObject(aJSONData as TJSONObject);
+end;
+
+procedure THyperfineResult.setFromJSONObject(const AJSONObject: TJSONObject);
+var
+  timesObject: TJSONArray;
+  index: Integer;
+begin
+  FCommand:= AJSONObject.Get(cJSONCommand, FCommand);
+  FMean:= AJSONObject.Get(cJSONMean, FMean);
+  FStandardDeviation:= AJSONObject.Get(cJSONStandardDeviation, FStandardDeviation);
+  FMedian:= AJSONObject.Get(cJSONMedian, FMedian);
+  FUser:= AJSONObject.Get(cJSONUser, FUser);
+  FSystem:= AJSONObject.Get(cJSONSystem, FSystem);
+  FMin:= AJSONObject.Get(cJSONMin, FMin);
+  FMax:= AJSONObject.Get(cJSONMax, FMax);
+  timesObject:= AJSONObject.Arrays[cJSONTimes];
+  SetLength(FTimes, timesObject.Count);
+  for index:= 0 to Pred(timesObject.Count) do
+  begin
+    FTimes[index]:= timesObject[index].AsFloat;
+  end;
+end;
+
+end.
+
diff --git a/utilities/results_generator/Common/resultsgenerator.common.pas b/utilities/results_generator/Common/resultsgenerator.common.pas
@@ -11,52 +11,55 @@ interface
 , SysUtils
 , Utilities.Data.Config
 , Utilities.Data.Entries
+, Utilities.Data.Hyperfine
 ;
 
 type
 { TResults }
   TResults = class(TObject)
   private
     FConfig: TConfig;
+    FResult: THyperfineResult;
 
     function GenerateProgressBar(APBPosition, APBMax, APBWIdth: Integer): String;
   protected
   public
     constructor Create(AConfigFile: String);
     destructor Destroy; override;
 
-    {$IFDEF UNIX}
-    {$ELSE}
-    {$ENDIF}
+    procedure Generate;
   published
   end;
 
 implementation
 
 uses
-{$IFDEF FPC}
   fpjson
 , jsonparser
-{$ELSE}
-{$ENDIF}
 ;
 
 const
   lineBreak = #13;
 
+  cTableHeader =
+    '| # | Result (m:s.ms): SSD | Compiler | Submitter     | Notes     | Certificates |'#10 +
+    '|--:|---------------------:|:---------|:--------------|:----------|:-------------|'#10;
+
 { TResults }
 
 constructor TResults.Create(AConfigFile: String);
 var
   configStream: TFileStream;
   configJSONData: TJSONData;
 begin
-  { #todo 99 -ogcarreno : Config file must be used here }
   configStream:= TFileStream.Create(AConfigFile, fmOpenRead);
   try
     configJSONData:= GetJSON(configStream);
-    FConfig:= TConfig.Create(configJSONData);
-    configJSONData.Free;
+    try
+      FConfig:= TConfig.Create(configJSONData);
+    finally
+      configJSONData.Free;
+    end;
   finally
     configStream.Free;
   end;
@@ -68,6 +71,85 @@ destructor TResults.Destroy;
   inherited Destroy;
 end;
 
+procedure TResults.Generate;
+type
+  TResult = record
+    Result: Double;
+    Count: Integer;
+    Compiler: String;
+  end;
+  TResultsArray = array of TResult;
+
+var
+  index, index1: Integer;
+  content, hyperfineFile: String;
+  results: TResultsArray;
+  hyperfineStream: TFileStream;
+  hyperfineJSON: TJSONData;
+begin
+  content:= '';
+  SetLength(results, FConfig.Entries.Count);
+
+  for index:= 0 to Pred(FConfig.Entries.Count) do
+  begin
+    Write(GenerateProgressBar(Succ(index), FConfig.Entries.Count, 50), lineBreak);
+    hyperfineFile:= ExpandFileName(
+        IncludeTrailingPathDelimiter(FConfig.ResultsFolder)+
+        FConfig.Entries[index].EntryBinary+
+        '-1_000_000_000-SSD.json'
+      );
+    if not FileExists(hyperfineFile) then continue;
+    hyperfineStream:= TFileStream.Create(
+      hyperfineFile,
+      fmOpenRead
+    );
+    try
+      hyperfineJSON:= GetJSON(hyperfineStream);
+      try
+        FResult:= THyperfineResult.Create(
+          hyperfineJSON.GetPath(cJSONHyperfineResult)
+        );
+        try
+          if FConfig.Entries[index].Compiler = 'fpc' then
+          begin
+            results[index].Compiler:= 'lazarus-3.0, fpc-3.2.2';
+          end;
+
+          results[index].Result:= 0.0;
+          results[index].Count:= 0;
+          for index1:= Low(FResult.Times) to High(FResult.Times) do
+          begin
+            if (time = FResult.Max) or (time = FResult.Max) then continue;
+            results[index].Result:= results[index].Result + FResult.Times[index1];
+            Inc(results[index].Count);
+          end;
+          results[index].Result:= results[index].Result / results[index].Count;
+          { #todo 99 -ogcarreno : needs to be done after sorting array by time }
+          content:= content + Format('| %d | %.2f | %s | %s | %s | |'+LineEnding, [
+            index,
+            results[index].Result,
+            results[index].Compiler,
+            FConfig.Entries[index].Name,
+            FConfig.Entries[index].Notes
+          ]);
+        finally
+          FResult.Free;
+        end;
+      finally
+        hyperfineJSON.Free;
+      end;
+    finally
+      hyperfineStream.Free;
+    end;
+  end;
+
+  WriteLn;
+  WriteLn;
+  Write(cTableHeader, content);
+  // The results
+  WriteLn;
+end;
+
 function TResults.GenerateProgressBar(APBPosition, APBMax, APBWIdth: Integer
   ): String;
 var
diff --git a/utilities/results_generator/Lazarus/src/resultsgenerator.lpi b/utilities/results_generator/Lazarus/src/resultsgenerator.lpi
@@ -85,7 +85,7 @@
     <RunParams>
       <FormatVersion Value="2"/>
     </RunParams>
-    <Units Count="5">
+    <Units Count="6">
       <Unit0>
         <Filename Value="resultsgenerator.lpr"/>
         <IsPartOfProject Value="True"/>
@@ -104,11 +104,18 @@
       <Unit3>
         <Filename Value="../../../common/utilities.data.config.pas"/>
         <IsPartOfProject Value="True"/>
+        <UnitName Value="Utilities.Data.Config"/>
       </Unit3>
       <Unit4>
         <Filename Value="../../../common/utilities.data.entries.pas"/>
         <IsPartOfProject Value="True"/>
+        <UnitName Value="Utilities.Data.Entries"/>
       </Unit4>
+      <Unit5>
+        <Filename Value="../../../common/utilities.data.hyperfine.pas"/>
+        <IsPartOfProject Value="True"/>
+        <UnitName Value="Utilities.Data.Hyperfine"/>
+      </Unit5>
     </Units>
   </ProjectOptions>
   <CompilerOptions>
diff --git a/utilities/results_generator/Lazarus/src/resultsgenerator.lpr b/utilities/results_generator/Lazarus/src/resultsgenerator.lpr
diff --git a/utilities/script_builder/Common/scriptbuilder.common.pas b/utilities/script_builder/Common/scriptbuilder.common.pas
