From 2664fd6f13e4c20284834c2f845fb548697444cb Mon Sep 17 00:00:00 2001
From: Malia Labor <99438964+MaliaLabor@users.noreply.github.com>
Date: Tue, 3 Dec 2024 11:02:17 -0700
Subject: [PATCH] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20Refactor=20tests=20(#47)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* :recylce: Refactor tests

* add missing ;

* update names of tests
---
 tests/as_bytes.test.cpp         |  3 +--
 tests/bit.test.cpp              |  3 +--
 tests/can.test.cpp              |  5 ++--
 tests/enum.test.cpp             |  3 +--
 tests/i2c.test.cpp              |  3 +--
 tests/input_pin.test.cpp        |  3 +--
 tests/interrupt_pin.test.cpp    |  3 +--
 tests/main.test.cpp             | 48 ---------------------------------
 tests/map.test.cpp              |  3 +--
 tests/math.test.cpp             |  3 +--
 tests/move_interceptor.test.cpp |  3 +--
 tests/output_pin.test.cpp       |  3 +--
 tests/overflow_counter.test.cpp |  3 +--
 tests/serial.test.cpp           |  3 +--
 tests/spi.test.cpp              |  3 +--
 tests/static_callable.test.cpp  |  3 +--
 tests/static_list.test.cpp      |  3 +--
 tests/steady_clock.test.cpp     |  3 +--
 tests/streams.test.cpp          | 15 ++++-------
 tests/timeout.test.cpp          |  3 +--
 tests/units.test.cpp            |  3 +--
 21 files changed, 25 insertions(+), 97 deletions(-)

diff --git a/tests/as_bytes.test.cpp b/tests/as_bytes.test.cpp
index 7b5ab34..0095674 100644
--- a/tests/as_bytes.test.cpp
+++ b/tests/as_bytes.test.cpp
@@ -20,8 +20,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void as_bytes_test()
-{
+boost::ut::suite<"as_bytes_test"> as_bytes_test = [] {
   using namespace boost::ut;
 
   "hal::as_bytes()"_test = []() {
diff --git a/tests/bit.test.cpp b/tests/bit.test.cpp
index ea6ec32..a0b3d3c 100644
--- a/tests/bit.test.cpp
+++ b/tests/bit.test.cpp
@@ -18,8 +18,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void bit_test()
-{
+boost::ut::suite<"bit_test"> bit_test = [] {
   using namespace boost::ut;
 
   "hal::bit_modify<template> compile time masks APIs"_test = []() {
diff --git a/tests/can.test.cpp b/tests/can.test.cpp
index 51a0f3b..b05b337 100644
--- a/tests/can.test.cpp
+++ b/tests/can.test.cpp
@@ -71,8 +71,7 @@ void check_validity(hal::hertz p_operating_frequency,
 }  // namespace
 
 namespace hal {
-void can_test()
-{
+boost::ut::suite<"can_test"> can_test = [] {
   using namespace boost::ut;
 
   "operator==(can::message, can::message) "_test = []() {
@@ -157,5 +156,5 @@ void can_test()
       expect(that % not fail2.has_value());
       expect(that % not fail4.has_value());
     };
-}
+};
 }  // namespace hal
diff --git a/tests/enum.test.cpp b/tests/enum.test.cpp
index ae49c7c..2b38d07 100644
--- a/tests/enum.test.cpp
+++ b/tests/enum.test.cpp
@@ -17,8 +17,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void enum_test()
-{
+boost::ut::suite<"enum_test"> enum_test = [] {
   using namespace boost::ut;
 
   "hal::value(enum)"_test = []() {
diff --git a/tests/i2c.test.cpp b/tests/i2c.test.cpp
index 002ab10..e58f5d1 100644
--- a/tests/i2c.test.cpp
+++ b/tests/i2c.test.cpp
@@ -22,8 +22,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void i2c_util_test()
-{
+boost::ut::suite<"i2c_test"> i2c_test = [] {
   using namespace boost::ut;
 
   static constexpr hal::byte successful_address{ 0x15 };
diff --git a/tests/input_pin.test.cpp b/tests/input_pin.test.cpp
index 6a890c1..de72eee 100644
--- a/tests/input_pin.test.cpp
+++ b/tests/input_pin.test.cpp
@@ -17,8 +17,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void input_pin_util_test()
-{
+boost::ut::suite<"input_pin_test"> input_pin_test = [] {
   using namespace boost::ut;
   "operator==(input_pin::settings)"_test = []() {
     input_pin::settings a{};
diff --git a/tests/interrupt_pin.test.cpp b/tests/interrupt_pin.test.cpp
index bd89150..c49257c 100644
--- a/tests/interrupt_pin.test.cpp
+++ b/tests/interrupt_pin.test.cpp
@@ -17,8 +17,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void interrupt_pin_util_test()
-{
+boost::ut::suite<"interrupt_pin_test"> interrupt_pin_test = [] {
   using namespace boost::ut;
   "operator==(interrupt_pin::settings)"_test = []() {
     interrupt_pin::settings a{};
diff --git a/tests/main.test.cpp b/tests/main.test.cpp
index 501a342..65e82cc 100644
--- a/tests/main.test.cpp
+++ b/tests/main.test.cpp
@@ -14,56 +14,8 @@
 
 namespace hal {
 // TODO(#45): Replace these with boost.ut named global test suites
-extern void as_bytes_test();
-extern void bit_test();
-extern void can_test();
-extern void enum_test();
-extern void i2c_util_test();
-extern void input_pin_util_test();
-extern void interrupt_pin_util_test();
-extern void map_test();
-extern void math_test();
-extern void move_interceptor_test();
-extern void output_pin_util_test();
-extern void overflow_counter_test();
-extern void serial_util_test();
-extern void spi_util_test();
-extern void static_callable_test();
-extern void static_list_test();
-extern void steady_clock_utility_test();
-extern void timeout_test();
-extern void units_test();
-extern void stream_terminated_test();
-extern void parse_stream_test();
-extern void find_stream_test();
-extern void fill_upto_stream_test();
-extern void multi_stream_test();
 }  // namespace hal
 
 int main()
 {
-  hal::as_bytes_test();
-  hal::bit_test();
-  hal::can_test();
-  hal::enum_test();
-  hal::i2c_util_test();
-  hal::input_pin_util_test();
-  hal::interrupt_pin_util_test();
-  hal::map_test();
-  hal::math_test();
-  hal::move_interceptor_test();
-  hal::output_pin_util_test();
-  hal::overflow_counter_test();
-  hal::serial_util_test();
-  hal::spi_util_test();
-  hal::static_callable_test();
-  hal::static_list_test();
-  hal::steady_clock_utility_test();
-  hal::timeout_test();
-  hal::units_test();
-  hal::stream_terminated_test();
-  hal::parse_stream_test();
-  hal::find_stream_test();
-  hal::fill_upto_stream_test();
-  hal::multi_stream_test();
 }
diff --git a/tests/map.test.cpp b/tests/map.test.cpp
index d71af02..ae86e3e 100644
--- a/tests/map.test.cpp
+++ b/tests/map.test.cpp
@@ -21,8 +21,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void map_test()
-{
+boost::ut::suite<"map_test"> map_test = [] {
   using namespace boost::ut;
 
   "hal::map<std::floating_point>()"_test = []() {
diff --git a/tests/math.test.cpp b/tests/math.test.cpp
index c24aa85..ad2e33e 100644
--- a/tests/math.test.cpp
+++ b/tests/math.test.cpp
@@ -17,8 +17,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void math_test()
-{
+boost::ut::suite<"math_test"> math_test = [] {
   using namespace boost::ut;
 
   "hal::multiply()"_test = []() {
diff --git a/tests/move_interceptor.test.cpp b/tests/move_interceptor.test.cpp
index 8ebec81..999240f 100644
--- a/tests/move_interceptor.test.cpp
+++ b/tests/move_interceptor.test.cpp
@@ -17,8 +17,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void move_interceptor_test()
-{
+boost::ut::suite<"move_interceptor_test"> move_interceptor_test = [] {
   using namespace boost::ut;
 
   "move_interceptor<mock>::intercept"_test = []() {
diff --git a/tests/output_pin.test.cpp b/tests/output_pin.test.cpp
index 705db6d..36d2c37 100644
--- a/tests/output_pin.test.cpp
+++ b/tests/output_pin.test.cpp
@@ -17,8 +17,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void output_pin_util_test()
-{
+boost::ut::suite<"output_pin_test"> output_pin_test = [] {
   using namespace boost::ut;
   "operator==(output_pin::settings)"_test = []() {
     output_pin::settings a{};
diff --git a/tests/overflow_counter.test.cpp b/tests/overflow_counter.test.cpp
index c8fef1a..9b3c2f8 100644
--- a/tests/overflow_counter.test.cpp
+++ b/tests/overflow_counter.test.cpp
@@ -17,8 +17,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void overflow_counter_test()
-{
+boost::ut::suite<"overflow_counter_test"> overflow_counter_test = [] {
   using namespace boost::ut;
 
   "overflow_counter::update() increment by 1"_test = []() {
diff --git a/tests/serial.test.cpp b/tests/serial.test.cpp
index f76b0da..d985542 100644
--- a/tests/serial.test.cpp
+++ b/tests/serial.test.cpp
@@ -24,8 +24,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void serial_util_test()
-{
+boost::ut::suite<"serial_test"> serial_test = [] {
   using namespace boost::ut;
 
   static constexpr hal::byte write_failure_byte{ 'C' };
diff --git a/tests/spi.test.cpp b/tests/spi.test.cpp
index 47d210b..18efe51 100644
--- a/tests/spi.test.cpp
+++ b/tests/spi.test.cpp
@@ -19,8 +19,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void spi_util_test()
-{
+boost::ut::suite<"spi_test"> spi_test = [] {
   using namespace boost::ut;
 
   static constexpr hal::byte success_filler{ 0xF5 };
diff --git a/tests/static_callable.test.cpp b/tests/static_callable.test.cpp
index 053d569..3e226ec 100644
--- a/tests/static_callable.test.cpp
+++ b/tests/static_callable.test.cpp
@@ -17,8 +17,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void static_callable_test()
-{
+boost::ut::suite<"static_callable_test"> static_callable_test = [] {
   using namespace boost::ut;
 
   // Setup
diff --git a/tests/static_list.test.cpp b/tests/static_list.test.cpp
index 44fad0d..6b3ecff 100644
--- a/tests/static_list.test.cpp
+++ b/tests/static_list.test.cpp
@@ -17,8 +17,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void static_list_test()
-{
+boost::ut::suite<"static_list_test"> static_list_test = [] {
   using namespace boost::ut;
 
   "static_list::ctor()"_test = []() {
diff --git a/tests/steady_clock.test.cpp b/tests/steady_clock.test.cpp
index 26b5c6a..5f03cb6 100644
--- a/tests/steady_clock.test.cpp
+++ b/tests/steady_clock.test.cpp
@@ -19,8 +19,7 @@
 // #include <libhal/testing.hpp>
 
 namespace hal {
-void steady_clock_utility_test()
-{
+boost::ut::suite<"steady_clock_test"> steady_clock_test = [] {
   using namespace boost::ut;
 
   // Make the frequency equal to inverse of the time duration period, giving you
diff --git a/tests/streams.test.cpp b/tests/streams.test.cpp
index 2377128..e0aea9a 100644
--- a/tests/streams.test.cpp
+++ b/tests/streams.test.cpp
@@ -39,8 +39,7 @@ std::span<hal::byte const> operator|(
 }
 }  // namespace
 
-void stream_terminated_test()
-{
+boost::ut::suite<"stream_terminated_test"> stream_terminated_test = [] {
   using namespace boost::ut;
   using namespace std::literals;
 
@@ -97,8 +96,7 @@ void stream_terminated_test()
 //                              |  parse<T> Stream  |
 //
 // =============================================================================
-void parse_stream_test()
-{
+boost::ut::suite<"parse_stream_test"> parse_stream_test = [] {
   using namespace boost::ut;
   using namespace std::literals;
 
@@ -264,8 +262,7 @@ void parse_stream_test()
 //                               |  Find Stream  |
 //
 // =============================================================================
-void find_stream_test()
-{
+boost::ut::suite<"find_stream_test"> find_stream_test = [] {
   // Setup
   using namespace boost::ut;
   using namespace std::literals;
@@ -375,8 +372,7 @@ void find_stream_test()
 //                             |  fill_upto Stream  |
 //
 // =============================================================================
-void fill_upto_stream_test()
-{
+boost::ut::suite<"fill_upto_stream_test"> fill_upto_stream_test = [] {
   // Setup
   using namespace boost::ut;
   using namespace std::literals;
@@ -448,8 +444,7 @@ void fill_upto_stream_test()
 //                               |  Multi Stream Test  |
 //
 // =============================================================================
-void multi_stream_test()
-{
+boost::ut::suite<"multi_stream_test"> multi_stream_test = [] {
   using namespace boost::ut;
   using namespace std::literals;
 
diff --git a/tests/timeout.test.cpp b/tests/timeout.test.cpp
index 06c816f..6863deb 100644
--- a/tests/timeout.test.cpp
+++ b/tests/timeout.test.cpp
@@ -19,8 +19,7 @@
 #include <boost/ut.hpp>
 
 namespace hal {
-void timeout_test()
-{
+boost::ut::suite<"timeout_test"> timeout_test = [] {
   using namespace boost::ut;
   "hal::try_until(callback, timeout)"_test = []() {
     // Setup
diff --git a/tests/units.test.cpp b/tests/units.test.cpp
index a256c83..3d9f959 100644
--- a/tests/units.test.cpp
+++ b/tests/units.test.cpp
@@ -29,8 +29,7 @@ std::ostream& operator<<(std::ostream& p_os,
 
 namespace hal {
 
-void units_test()
-{
+boost::ut::suite<"units_test"> units_test = [] {
   using namespace boost::ut;
   using namespace std::literals;