fix comments

Signed-off-by: Koichi Imai <koichi.imai.2@tier4.jp>
tier4 · Mar 4, 2025 · 3f2b1c2 · 3f2b1c2
1 parent 092c021
commit 3f2b1c2
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 11 deletions.
diff --git a/agnocast_kmod/agnocast_kunit/agnocast_kunit_publish_msg.c b/agnocast_kmod/agnocast_kunit/agnocast_kunit_publish_msg.c
@@ -50,10 +50,12 @@ static void setup_one_publisher(
 // Expect to fail at find_topic()
 void test_case_no_topic(struct kunit * test)
 {
-  // Act
+  // Arrange
   topic_local_id_t publisher_id = 0;
   uint64_t msg_virtual_address = 0x40000000000;
   union ioctl_publish_args ioctl_publish_ret;
+
+  // Act
   int ret = publish_msg(topic_name, publisher_id, msg_virtual_address, &ioctl_publish_ret);
 
   // Assert
@@ -67,10 +69,11 @@ void test_case_no_publisher(struct kunit * test)
   topic_local_id_t subscriber_id;
   setup_one_subscriber(test, &subscriber_id);
 
-  // Act
   topic_local_id_t publisher_id = 0;
   uint64_t msg_virtual_address = 0x40000000000;
   union ioctl_publish_args ioctl_publish_msg_ret;
+
+  // Act
   int ret = publish_msg(topic_name, publisher_id, msg_virtual_address, &ioctl_publish_msg_ret);
 
   // Assert
@@ -84,8 +87,9 @@ void test_case_simple_publish_without_any_release(struct kunit * test)
   uint64_t ret_addr;
   setup_one_publisher(test, &publisher_id, &ret_addr);
 
-  // Act
   union ioctl_publish_args ioctl_publish_msg_ret;
+
+  // Act
   int ret = publish_msg(topic_name, publisher_id, ret_addr, &ioctl_publish_msg_ret);
 
   // Assert
@@ -111,8 +115,9 @@ void test_case_different_publisher_no_release(struct kunit * test)
   KUNIT_ASSERT_EQ(test, ret1, 0);
   KUNIT_ASSERT_EQ(test, ret2, 0);
 
-  // Act
   union ioctl_publish_args ioctl_publish_msg_ret2;
+
+  // Act
   int ret3 = publish_msg(topic_name, publisher_id2, ret_addr2, &ioctl_publish_msg_ret2);
 
   // Assert
@@ -135,8 +140,9 @@ void test_case_referenced_node_not_released(struct kunit * test)
   int ret1 = publish_msg(topic_name, publisher_id, ret_addr, &ioctl_publish_msg_ret1);
   KUNIT_ASSERT_EQ(test, ret1, 0);
 
-  // Act
   union ioctl_publish_args ioctl_publish_msg_ret2;
+
+  // Act
   int ret2 = publish_msg(topic_name, publisher_id, ret_addr + 1, &ioctl_publish_msg_ret2);
 
   // Assert
@@ -162,8 +168,9 @@ void test_case_single_release_return(struct kunit * test)
   KUNIT_ASSERT_EQ(test, ret1, 0);
   KUNIT_ASSERT_EQ(test, ret2, 0);
 
-  // Act
   union ioctl_publish_args ioctl_publish_msg_ret2;
+
+  // Act
   int ret3 = publish_msg(topic_name, publisher_id, ret_addr + 1, &ioctl_publish_msg_ret2);
 
   // Assert
@@ -198,8 +205,9 @@ void test_case_excessive_release_count(struct kunit * test)
     KUNIT_ASSERT_EQ(test, ret, 0);
   }
 
-  // Act
   union ioctl_publish_args ioctl_publish_msg_ret;
+
+  // Act
   int ret = publish_msg(topic_name, publisher_id, ret_addr, &ioctl_publish_msg_ret);
 
   // Assert
@@ -217,8 +225,9 @@ void test_case_ret_one_subscriber(struct kunit * test)
   setup_one_publisher(test, &publisher_id, &ret_addr);
   setup_one_subscriber(test, &subscriber_id);
 
-  // Act
   union ioctl_publish_args ioctl_publish_msg_ret;
+
+  // Act
   int ret = publish_msg(topic_name, publisher_id, ret_addr, &ioctl_publish_msg_ret);
 
   // Assert
@@ -240,8 +249,9 @@ void test_case_ret_many_subscribers(struct kunit * test)
     setup_one_subscriber(test, &subscriber_id);
   }
 
-  // Act
   union ioctl_publish_args ioctl_publish_msg_ret;
+
+  // Act
   int ret = publish_msg(topic_name, publisher_id, ret_addr, &ioctl_publish_msg_ret);
 
   // Assert

diff --git a/agnocast_kmod/agnocast_kunit/agnocast_kunit_publish_msg.h b/agnocast_kmod/agnocast_kunit/agnocast_kunit_publish_msg.h
@@ -4,7 +4,6 @@
 #define TEST_CASES_PUBLISH_MSG                                                                  \
   KUNIT_CASE(test_case_no_topic), KUNIT_CASE(test_case_no_publisher),                           \
     KUNIT_CASE(test_case_simple_publish_without_any_release),                                   \
-    KUNIT_CASE(test_case_excessive_unreleased_entry_nodes),                                     \
     KUNIT_CASE(test_case_different_publisher_no_release),                                       \
     KUNIT_CASE(test_case_referenced_node_not_released),                                         \
     KUNIT_CASE(test_case_single_release_return), KUNIT_CASE(test_case_excessive_release_count), \
@@ -13,7 +12,6 @@
 void test_case_no_topic(struct kunit * test);
 void test_case_no_publisher(struct kunit * test);
 void test_case_simple_publish_without_any_release(struct kunit * test);
-void test_case_excessive_unreleased_entry_nodes(struct kunit * test);
 void test_case_different_publisher_no_release(struct kunit * test);
 void test_case_referenced_node_not_released(struct kunit * test);
 void test_case_single_release_return(struct kunit * test);