From 20b0ab26b1d26b3a50a50640197b9e3ea874dffb Mon Sep 17 00:00:00 2001
From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com>
Date: Fri, 16 May 2025 16:55:54 +1200
Subject: [PATCH] tests/bugpoint: More tests

More coverage.
---
 tests/bugpoint/.gitignore                 |  4 +-
 tests/bugpoint/failures.ys                | 29 ++++++++
 tests/bugpoint/mod_constraints.ys         | 83 +++++++++++++++++++++++
 tests/bugpoint/mods.il                    | 38 +++++++++++
 tests/bugpoint/proc_constraints.ys        | 49 +++++++++++++
 tests/bugpoint/procs.il                   | 42 ++++++++++++
 tests/bugpoint/{err.ys => raise_error.ys} |  8 +--
 7 files changed, 248 insertions(+), 5 deletions(-)
 create mode 100644 tests/bugpoint/failures.ys
 create mode 100644 tests/bugpoint/mod_constraints.ys
 create mode 100644 tests/bugpoint/mods.il
 create mode 100644 tests/bugpoint/proc_constraints.ys
 create mode 100644 tests/bugpoint/procs.il
 rename tests/bugpoint/{err.ys => raise_error.ys} (71%)

diff --git a/tests/bugpoint/.gitignore b/tests/bugpoint/.gitignore
index 818575593..1012c66cc 100644
--- a/tests/bugpoint/.gitignore
+++ b/tests/bugpoint/.gitignore
@@ -1,3 +1,5 @@
-*.il
+bugpoint-case.*
 *.log
 *.err
+*.temp
+run-test.mk
diff --git a/tests/bugpoint/failures.ys b/tests/bugpoint/failures.ys
new file mode 100644
index 000000000..ce8daa8cc
--- /dev/null
+++ b/tests/bugpoint/failures.ys
@@ -0,0 +1,29 @@
+write_file fail.temp << EOF
+logger -expect error "Missing -script or -command option." 1
+bugpoint -suffix fail -yosys ../../yosys
+EOF
+exec -expect-return 0 -- ../../yosys -qq mods.il -s fail.temp
+
+write_file fail.temp << EOF
+logger -expect error "do not crash on this design" 1
+bugpoint -suffix fail -yosys ../../yosys -command "dump"
+EOF
+exec -expect-return 0 -- ../../yosys -qq mods.il -s fail.temp
+
+write_file fail.temp << EOF
+logger -expect error "returned value 3 instead of expected 7" 1
+bugpoint -suffix fail -yosys ../../yosys -command raise_error -expect-return 7
+EOF
+exec -expect-return 0 -- ../../yosys -qq mods.il -s fail.temp
+
+write_file fail.temp << EOF
+logger -expect error "not found in the log file!" 1
+bugpoint -suffix fail -yosys ../../yosys -command raise_error -grep "nope"
+EOF
+exec -expect-return 0 -- ../../yosys -qq mods.il -s fail.temp
+
+write_file fail.temp << EOF
+logger -expect error "not found in stderr log!" 1
+bugpoint -suffix fail -yosys ../../yosys -command raise_error -err-grep "nope"
+EOF
+exec -expect-return 0 -- ../../yosys -qq mods.il -s fail.temp
diff --git a/tests/bugpoint/mod_constraints.ys b/tests/bugpoint/mod_constraints.ys
new file mode 100644
index 000000000..f35095510
--- /dev/null
+++ b/tests/bugpoint/mod_constraints.ys
@@ -0,0 +1,83 @@
+read_rtlil mods.il
+select -assert-count 7 w:*
+select -assert-mod-count 3 =*
+select -assert-count 4 c:*
+design -stash base
+
+# everything is removed by default
+design -load base
+bugpoint -suffix mods -yosys ../../yosys -command raise_error -expect-return 3
+select -assert-count 1 w:*
+select -assert-mod-count 1 =*
+select -assert-none c:*
+
+# don't remove wires
+design -load base
+bugpoint -suffix mods -yosys ../../yosys -command raise_error -expect-return 3 -modules -cells
+select -assert-count 3 w:*
+select -assert-mod-count 1 =*
+select -assert-none c:*
+
+# don't remove cells or their connections
+design -load base
+bugpoint -suffix mods -yosys ../../yosys -command raise_error -expect-return 3 -wires -modules
+select -assert-count 5 w:*
+select -assert-mod-count 1 =*
+select -assert-count 4 c:*
+
+# don't remove cells but do remove their connections
+design -load base
+bugpoint -suffix mods -yosys ../../yosys -command raise_error -expect-return 3 -wires -modules -connections
+select -assert-count 1 w:*
+select -assert-mod-count 1 =*
+select -assert-count 4 c:*
+
+# don't remove modules
+design -load base
+bugpoint -suffix mods -yosys ../../yosys -command raise_error -expect-return 3 -wires -cells
+select -assert-count 1 w:*
+select -assert-mod-count 3 =*
+select -assert-none c:*
+
+# can keep wires
+design -load base
+setattr -set bugpoint_keep 1 w:w_b
+bugpoint -suffix mods -yosys ../../yosys -command raise_error -expect-return 3
+select -assert-count 2 w:*
+select -assert-mod-count 1 =*
+select -assert-none c:*
+
+# a wire with keep won't keep the cell/module containing it
+design -load base
+setattr -set bugpoint_keep 1 w:w_o
+bugpoint -suffix mods -yosys ../../yosys -command raise_error -expect-return 3
+select -assert-count 1 w:*
+select -assert-mod-count 1 =*
+select -assert-none c:*
+
+# can keep cells (and do it without the associated module)
+design -load base
+setattr -set bugpoint_keep 1 c:c_a
+bugpoint -suffix mods -yosys ../../yosys -command raise_error -expect-return 3
+select -assert-count 1 w:*
+select -assert-mod-count 1 =*
+select -assert-count 1 c:*
+
+# can keep modules
+design -load base
+setattr -mod -set bugpoint_keep 1 m_a
+bugpoint -suffix mods -yosys ../../yosys -command raise_error -expect-return 3
+select -assert-count 1 w:*
+select -assert-mod-count 2 =*
+select -assert-none c:*
+
+# minimize to just the path connecting w_a and w_c
+# which happens via w_b, w_i, w_o, m_a, c_a and c_b
+write_file script.temp << EOF
+select -assert-none w:w_a %co* w:w_c %ci* %i
+EOF
+design -load base
+bugpoint -suffix mods -yosys ../../yosys -script script.temp -grep "Assertion failed"
+select -assert-count 5 w:*
+select -assert-mod-count 2 =*
+select -assert-count 2 c:*
diff --git a/tests/bugpoint/mods.il b/tests/bugpoint/mods.il
new file mode 100644
index 000000000..fe3ce6522
--- /dev/null
+++ b/tests/bugpoint/mods.il
@@ -0,0 +1,38 @@
+module \m_a
+    wire input 1 \w_i
+    wire output 2 \w_o
+    connect \w_o \w_i
+end
+
+module \m_b
+    wire input 1 \w_i
+    wire output 2 \w_o
+end
+
+attribute \top 1
+module \top
+    attribute \raise_error 3
+    wire \w_a
+    wire \w_b
+    wire \w_c
+
+    cell \m_a \c_a
+        connect \w_i \w_a
+        connect \w_o \w_b
+    end
+
+    cell \m_a \c_b
+        connect \w_i \w_b
+        connect \w_o \w_c
+    end
+
+    cell \m_b \c_c
+        connect \w_i \w_c
+        connect \w_o \w_a
+    end
+
+    cell \m_b \c_d
+        connect \w_i 1'0
+        connect \w_o 1'1
+    end
+end
diff --git a/tests/bugpoint/proc_constraints.ys b/tests/bugpoint/proc_constraints.ys
new file mode 100644
index 000000000..22b8b3c60
--- /dev/null
+++ b/tests/bugpoint/proc_constraints.ys
@@ -0,0 +1,49 @@
+read_rtlil procs.il
+select -assert-count 2 p:*
+design -stash err_q
+
+# processes get removed by default
+design -load err_q
+bugpoint -suffix procs -yosys ../../yosys -command raise_error -expect-return 4
+select -assert-none p:*
+
+# individual processes can be kept
+design -load err_q
+setattr -set bugpoint_keep 1 p:proc_a
+bugpoint -suffix procs -yosys ../../yosys -command raise_error -expect-return 4
+select -assert-count 1 p:*
+
+# all processes can be kept
+design -load err_q
+bugpoint -suffix procs -yosys ../../yosys -command raise_error -expect-return 4 -wires
+select -assert-count 2 p:*
+
+# d and clock are connected after proc
+design -load err_q
+proc
+select -assert-count 3 w:d %co
+select -assert-count 3 w:clock %co
+
+# no assigns means no d
+design -load err_q
+bugpoint -suffix procs -yosys ../../yosys -command raise_error -expect-return 4 -assigns
+proc
+select -assert-count 1 w:d %co
+
+# no updates means no clock
+design -load err_q
+bugpoint -suffix procs -yosys ../../yosys -command raise_error -expect-return 4 -updates
+proc
+select -assert-count 1 w:clock %co
+
+# can remove ports
+design -load err_q
+select -assert-count 5 x:*
+bugpoint -suffix procs -yosys ../../yosys -command raise_error -expect-return 4 -ports
+select -assert-none x:*
+
+# can keep ports
+design -load err_q
+setattr -set bugpoint_keep 1 i:d o:q
+bugpoint -suffix procs -yosys ../../yosys -command raise_error -expect-return 4 -ports
+select -assert-count 2 x:*
diff --git a/tests/bugpoint/procs.il b/tests/bugpoint/procs.il
new file mode 100644
index 000000000..cb9f7c8dd
--- /dev/null
+++ b/tests/bugpoint/procs.il
@@ -0,0 +1,42 @@
+module \ff_with_en_and_sync_reset
+  wire $0\q[1:1]
+  wire $0\q[0:0]
+  attribute \raise_error 4
+  wire width 2 output 5 \q
+  wire width 2 input 4 \d
+  wire input 3 \enable
+  wire input 2 \reset
+  wire input 1 \clock
+
+  process \proc_a
+    assign $0\q[0:0] \q [0]
+    switch \reset
+      case 1'1
+        assign $0\q[0:0] 1'0
+      case 
+        switch \enable
+          case 1'1
+            assign $0\q[0:0] \d [0]
+          case 
+        end
+    end
+    sync posedge \clock
+      update \q [0] $0\q[0:0]
+  end
+
+  process \proc_b
+    assign $0\q[1:1] \q [1]
+    switch \reset
+      case 1'1
+        assign $0\q[1:1] 1'0
+      case 
+        switch \enable
+          case 1'1
+            assign $0\q[1:1] \d [1]
+          case 
+        end
+    end
+    sync posedge \clock
+      update \q [1] $0\q[1:1]
+  end
+end
diff --git a/tests/bugpoint/err.ys b/tests/bugpoint/raise_error.ys
similarity index 71%
rename from tests/bugpoint/err.ys
rename to tests/bugpoint/raise_error.ys
index 42e84241c..a0a03f447 100644
--- a/tests/bugpoint/err.ys
+++ b/tests/bugpoint/raise_error.ys
@@ -16,14 +16,14 @@ design -stash read
 
 # raise_error with int exits with status
 design -load read
-bugpoint -yosys ../../yosys -command raise_error -expect-return 7
+bugpoint -suffix error -yosys ../../yosys -command raise_error -expect-return 7
 select -assert-mod-count 1 =*
 select -assert-mod-count 1 top
 
 # raise_error with string prints message and exits with 1
 design -load read
 rename top abc
-bugpoint -yosys ../../yosys -command raise_error -grep "help me" -expect-return 1
+bugpoint -suffix error -yosys ../../yosys -command raise_error -grep "help me" -expect-return 1
 select -assert-mod-count 1 =*
 select -assert-mod-count 1 other
 
@@ -31,13 +31,13 @@ select -assert-mod-count 1 other
 design -load read
 rename def zzy
 delete other
-bugpoint -yosys ../../yosys -command raise_error -expect-return 1
+bugpoint -suffix error -yosys ../../yosys -command raise_error -expect-return 1
 select -assert-mod-count 1 =*
 select -assert-mod-count 1 zzy
 
 # raise_error -stderr prints to stderr and exits with 1
 design -load read
 rename top abc
-bugpoint -yosys ../../yosys -command "raise_error -stderr" -err-grep "help me" -expect-return 1
+bugpoint -suffix error -yosys ../../yosys -command "raise_error -stderr" -err-grep "help me" -expect-return 1
 select -assert-mod-count 1 =*
 select -assert-mod-count 1 other