Script and Settings updates for coverage handling

Author: JimLewis

OsvvmScriptsCore.tcl

@@ -440,18 +440,12 @@ proc LocalBuild {BuildName Path_Or_File args} {
   CallbackAfter_Build ${Path_Or_File}
 
   if {[info exists TestSuiteName]} {
-    # Finalize Test Suite
-    set RequirementsSourceDir   [file join ${::osvvm::ReportsDirectory} ${TestSuiteName}]
-    set RequirementsResultsFile [file join ${::osvvm::ReportsDirectory} ${BuildName} ${TestSuiteName}_req.yml]
-    MergeRequirements $RequirementsSourceDir $RequirementsResultsFile
-    Requirements2Html $RequirementsResultsFile "../"
-    
     FinalizeTestSuite $TestSuiteName
     FinishTestSuiteBuildYaml
     unset TestSuiteName
   }
 
-  # Finalize Build
+  # Merge Requirements for Build
   set RequirementsSourceDir   [file join ${::osvvm::ReportsDirectory} ${BuildName}]
   set RequirementsResultsFile [file join ${::osvvm::ReportsDirectory} ${BuildName}_req.yml]
   MergeRequirements $RequirementsSourceDir $RequirementsResultsFile
@@ -1312,8 +1306,15 @@ proc MergeCoverage {SuiteName MergeName} {
   vendor_MergeCodeCoverage $SuiteName ${::osvvm::CoverageDirectory} ${MergeName}
 }
 
+
 # -------------------------------------------------
 proc FinalizeTestSuite {SuiteName} {
+
+  # Merge Requirements for each test case into TestSuite Requirements
+  set RequirementsSourceDir   [file join ${::osvvm::ReportsDirectory} ${SuiteName}]
+  set RequirementsResultsFile [file join ${::osvvm::ReportsDirectory} ${::osvvm::BuildName} ${SuiteName}_req.yml]
+  MergeRequirements $RequirementsSourceDir $RequirementsResultsFile
+  Requirements2Html $RequirementsResultsFile "../"
 
   # Merge Code Coverage for the Test Suite if it exists
   if {$::osvvm::RanSimulationWithCoverage eq "true"} {
@@ -1326,16 +1327,22 @@ proc FinalizeTestSuite {SuiteName} {
 # -------------------------------------------------
 proc TestSuite {SuiteName} {
   variable TestSuiteName
-
+  
   puts "TestSuite $SuiteName"                     ; # EchoOsvvmCmd
 
-
   set FirstRun [expr ![info exists TestSuiteName]]
+  
   if {! $FirstRun} {
-    set RequirementsSourceDir   [file join ${::osvvm::ReportsDirectory} ${TestSuiteName}]
-    set RequirementsResultsFile [file join ${::osvvm::ReportsDirectory} ${::osvvm::BuildName} ${TestSuiteName}_req.yml]
-    MergeRequirements $RequirementsSourceDir $RequirementsResultsFile
-    Requirements2Html $RequirementsResultsFile "../"
+    if {$SuiteName eq $TestSuiteName} {
+      # Do nothing if test suite already set
+      puts "Warning:  Redundant TestSuite $SuiteName - name already set to $TestSuiteName - Command Ignored"
+      return ""
+    }
+# #!!    # Finalize previous Test Suite
+# #!!    set RequirementsSourceDir   [file join ${::osvvm::ReportsDirectory} ${TestSuiteName}]
+# #!!    set RequirementsResultsFile [file join ${::osvvm::ReportsDirectory} ${::osvvm::BuildName} ${TestSuiteName}_req.yml]
+# #!!    MergeRequirements $RequirementsSourceDir $RequirementsResultsFile
+# #!!    Requirements2Html $RequirementsResultsFile "../"
 
     # Finish previous test suite before ending current one
     FinalizeTestSuite $TestSuiteName

OsvvmSettingsDefault.tcl

@@ -116,6 +116,15 @@ namespace eval ::osvvm {
     variable TranscriptExtension      "html"     ;# Generate log and html transcripts
     variable CreateSimScripts         "false"    ;# Create a script with every simulator command run during this session
     variable CreateOsvvmOutput        "false"    ;# Text file with just OSVVM output
+    
+  #
+  #  Requirements Tracking settings
+  #
+  #    USE_SUM_OF_GOALS
+  #      when false, uses maximum goal - good when merging in specification which provides the maximum goal which is divided across teests
+  #      when true,  uses sum of goals - good when not merging the specification and need to sum up goals to get the total
+    variable USE_SUM_OF_GOALS         "false"    ;# when false, uses maximum  
+    #  variable USE_SUM_OF_GOALS         "true"     ;# when true uses sum of goals 
 
   #
   # VHDL Simulation Settings 
@@ -125,7 +134,7 @@ namespace eval ::osvvm {
     variable DefaultLibraryName     "DefaultLib"
 
   # 
-  # Default Coverage Options
+  # Default Code Coverage Options
   #
     variable CoverageEnable           "true"
     variable CoverageAnalyzeEnable    "false"

OsvvmSettingsLocal_example.tcl

@@ -139,6 +139,16 @@ namespace eval ::osvvm {
     #  variable CreateSimScripts         "true"    ;# Create a script with every simulator command run during this session
     #  variable CreateOsvvmOutput        "true"    ;# Text file with just OSVVM output
 
+  #
+  #  Requirements Tracking settings
+  #
+  #    USE_SUM_OF_GOALS
+  #      when false, uses maximum goal - good when merging in specification which provides the maximum goal which is divided across teests
+  #      when true,  uses sum of goals - good when not merging the specification and need to sum up goals to get the total
+    #  variable USE_SUM_OF_GOALS         "false"    ;# when false, uses maximum  
+    #  variable USE_SUM_OF_GOALS         "true"     ;# when true uses sum of goals 
+
+
   #
   # VHDL Simulation Settings 
   #
@@ -172,7 +182,8 @@ namespace eval ::osvvm {
     #  variable VerilogAnalyzeOptions     ""
     #  variable ExtendedAnalyzeOptions    ""
     #  variable ExtendedSimulateOptions   ""
-    #  if {$ToolVendor eq "Siemens"} {
+    # Remove some of the chatter from Siemens and Aldec simulators
+    #  if {($ToolVendor eq "Siemens") || ($ToolVendor eq "Aldec")} {
     #    variable ExtendedAnalyzeOptions   "-quiet"
     #    variable ExtendedSimulateOptions  "-quiet"
     #  } 

Requirements2Html.tcl

@@ -243,9 +243,13 @@ proc MergeTestCaseResults { TestCases } {
       set Status "FAILED"
     }
 # Goal handling = Maximum vs Sum of goals
-    set Goal                 [expr {$Goal > $CurGoal ? $Goal : $CurGoal}]
+    if {$::osvvm::USE_SUM_OF_GOALS} {
+      set Goal               [expr {$Goal + $CurGoal}]
+    } else {
+      set Goal               [expr {$Goal > $CurGoal ? $Goal : $CurGoal}]
+    }
     set Passed               [expr {$Passed  + $CurPassed}]
-    set PassedReq           [expr {$PassedReq  + $CurPassedReq}]
+    set PassedReq            [expr {$PassedReq  + $CurPassedReq}]
     set Errors               [expr {$Errors  + $CurErrors}]
     set Checked              [expr {$Checked + $CurChecked}]