ord: fix issue #7816 testing changes

The fix commit had linting errors, and the test placement was wrong.
Now the test runs in ctest and bazel test. Also, the test is more
verbose in output.

Signed-off-by: Ahmed R. Mohamed <[email protected]>

Author: Ahmed R. Mohamed

src/Main.cc

@@ -313,9 +313,8 @@ int main(int argc, char* argv[])
 #ifdef ENABLE_READLINE
 static int tclReadlineInit(Tcl_Interp* interp)
 {
-  std::array<const char*, 2> readline_cmds = {
-    "ord::setup_tclreadline",
-    "::tclreadline::Loop"};
+  std::array<const char*, 2> readline_cmds
+      = {"ord::setup_tclreadline", "::tclreadline::Loop"};
 
   for (auto cmd : readline_cmds) {
     if (TCL_ERROR == Tcl_Eval(interp, cmd)) {

src/OpenRoad.tcl

@@ -587,16 +587,16 @@ proc parse_list_args { cmd arg_var list_var lists_args } {
   }
 }
 
-proc cmd_args_completer {part start end line} {
-  if { $start == 0 || [catch {set cmd [::tclreadline::Lindex $line 0]} err] != 0 } {
-      utl::redirectStringBegin
-      set err [catch {::tclreadline::ScriptCompleter $part $start $end $line} ret]
-      utl::redirectStringEnd
-      if { $err == 0} {
-        return $ret
-      } else {
-        return ""
-      }
+proc cmd_args_completer { part start end line } {
+  if { $start == 0 || [catch { set cmd [::tclreadline::Lindex $line 0] } err] != 0 } {
+    utl::redirectStringBegin
+    set err [catch { ::tclreadline::ScriptCompleter $part $start $end $line } ret]
+    utl::redirectStringEnd
+    if { $err == 0 } {
+      return $ret
+    } else {
+      return ""
+    }
   }
   if { [info exists ::sta::cmd_args($cmd)] } {
     set metadata $::sta::cmd_args($cmd)
@@ -609,7 +609,7 @@ proc cmd_args_completer {part start end line} {
   set raw_files [glob -nocomplain -types {f d} -- "${part}*"]
   set files {}
   foreach f $raw_files {
-    if {[file isdirectory $f]} {
+    if { [file isdirectory $f] } {
       lappend files "${f}/"
     } else {
       lappend files $f
@@ -629,8 +629,8 @@ proc setup_tclreadline { } {
   ::tclreadline::readline builtincompleter false
   catch { ::tclreadline::ScriptCompleter "" 0 0 "" }
   ::tclreadline::readline customcompleter ::ord::cmd_args_completer
-  proc ::tclreadline::prompt1 {} { return "openroad> " }
-  proc ::tclreadline::prompt2 {} { return "...> " }
+  proc ::tclreadline::prompt1 { } { return "openroad> " }
+  proc ::tclreadline::prompt2 { } { return "...> " }
 }
 
 # namespace ord

test/BUILD

@@ -51,6 +51,7 @@ PASSFAIL_TESTS = [
 COMPULSORY_TESTS = [
     "error1",
     "get_core_die_areas",
+    "issue_7816",
     "place_inst",
     "upf_test",
     "upf_aes",

test/CMakeLists.txt

@@ -3,6 +3,7 @@ or_integration_tests(
   TESTS
     error1
     get_core_die_areas
+    issue_7816
     place_inst
     timing_api
     timing_api_2

test/issue_7816.tcl

@@ -1,32 +1,32 @@
 # Mock tclreadline
 namespace eval ::tclreadline {
-  proc Lindex {line index} {
-    return [lindex $line $index]
-  }
-  
-  proc ScriptCompleter {part start end line} {
-    # Simulate noisy output from ScriptCompleter to ensure it's suppressed
-    puts "ScriptCompleter: [ERROR] Should be suppressed"
-    error "ScriptCompleter Error"
-  }
+proc Lindex { line index } {
+  return [lindex $line $index]
+}
 
-  proc RemoveUsedOptions {line flags} {
-    # Default behavior: return flags as is
-    return $flags
-  }
+proc ScriptCompleter { part start end line } {
+  # Simulate noisy output from ScriptCompleter to ensure it's suppressed
+  puts "ScriptCompleter: [ERROR] Should be suppressed"
+  error "ScriptCompleter Error"
+}
 
-  proc CompleteFromList {part matches} {
-    set res {}
-    foreach m $matches {
-      if {[string match "${part}*" $m]} {
-        lappend res $m
-      }
+proc RemoveUsedOptions { line flags } {
+  # Default behavior: return flags as is
+  return $flags
+}
+
+proc CompleteFromList { part matches } {
+  set res {}
+  foreach m $matches {
+    if { [string match "${part}*" $m] } {
+      lappend res $m
     }
-    return $res
   }
+  return $res
+}
 }
 
-if {[info procs ::ord::cmd_args_completer] eq ""} {
+if { [info procs ::ord::cmd_args_completer] eq "" } {
   puts "Error: ::ord::cmd_args_completer not found."
   exit 1
 }
@@ -36,13 +36,13 @@ puts "Test 1: Command name completion 'read_db'"
 # We expect NO error to propagate (caught inside) and clean stdout (redirected).
 # Result should be "" (from catch block returning "")
 set result ""
-if { [catch {set result [::ord::cmd_args_completer "read_db" 0 7 "read_db"]} err] } {
+if { [catch { set result [::ord::cmd_args_completer "read_db" 0 7 "read_db"] } err] } {
   puts "FAIL: Test 1 threw error: $err"
 } else {
-  if {$result eq ""} {
+  if { $result eq "" } {
     puts "PASS: Test 1 returned empty (as expected for mock failure)"
   } else {
-    puts "PASS: Test 1 returned: $result"
+    puts "FAIL: Test 1 returned: $result"
   }
 }
 
@@ -52,21 +52,25 @@ puts "\nTest 2: Argument completion 'read_db '"
 # Since we didn't mock glob, it will use real glob.
 # 'read_db' takes a file. cmd_args_completer logic does `glob`.
 set result ""
-if { [catch {set result [::ord::cmd_args_completer "" 8 8 "read_db "]} err] } {
+if { [catch { set result [::ord::cmd_args_completer "" 8 8 "read_db "] } err] } {
   puts "FAIL: Test 2 threw error: $err"
 } else {
   # It should return a list of files/dirs
-  if {[llength $result] > 0} {
-     puts "PASS: Test 2 returned list of length > 0"
+  if { [llength $result] > 0 } {
+    puts "PASS: Test 2 returned list of length > 0"
+  } else {
+    puts "FAIL: Test 2 returned list of length 0"
   }
 }
 
 puts "\nTest 3: write_lef completion"
 # write_lef also takes filename.
-if { [catch {set result [::ord::cmd_args_completer "" 10 10 "write_lef "]} err] } {
+if { [catch { set result [::ord::cmd_args_completer "" 10 10 "write_lef "] } err] } {
   puts "FAIL: Test 3 threw error: $err"
 } else {
-  if {[llength $result] > 0} {
-     puts "PASS: Test 3 returned list of length > 0"
+  if { [llength $result] > 0 } {
+    puts "PASS: Test 3 returned list of length > 0"
+  } else {
+    puts "FAIL: Test 3 returned list of length 0"
   }
 }

test/regression_tests.tcl

@@ -24,5 +24,3 @@ record_flow_tests {
 record_test open_db $test_dir "compare_logfile" "-db gcd_sky130hd.odb"
 # For invalid DB, allow non-zero exit but require log to match ok
 record_test open_db_invalid $test_dir "compare_logfile_allow_error" "-db nonexistent_file.odb"
-
-record_test issue_7816 $test_dir "compare_logfile"