Fix deprecated volatile access in CanMsgRingbuffer + testcase

jboynes · jboynes · commit d8d0b6aa05d3 · 2023-09-07T13:48:45.000+01:00
diff --git a/api/CanMsgRingbuffer.cpp b/api/CanMsgRingbuffer.cpp
@@ -40,7 +40,7 @@ void CanMsgRingbuffer::enqueue(CanMsg const & msg)
 
   _buf[_head] = msg;
   _head = next(_head);
-  _num_elems++;
+  _num_elems = _num_elems + 1;
 }
 
 CanMsg CanMsgRingbuffer::dequeue()
@@ -50,7 +50,7 @@ CanMsg CanMsgRingbuffer::dequeue()
 
   CanMsg const msg = _buf[_tail];
   _tail = next(_tail);
-  _num_elems--;
+  _num_elems = _num_elems - 1;
 
   return msg;
 }
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -33,6 +33,7 @@ set(TEST_SRCS
   src/CanMsg/test_isStandardId.cpp
   src/CanMsg/test_operator_assignment.cpp
   src/CanMsg/test_printTo.cpp
+  src/CanMsgRingbuffer/test_available.cpp
   src/Common/test_makeWord.cpp
   src/Common/test_map.cpp
   src/Common/test_max.cpp
@@ -104,6 +105,7 @@ set(TEST_SRCS
 
 set(TEST_DUT_SRCS
   ../api/CanMsg.cpp
+  ../api/CanMsgRingbuffer.cpp
   ../api/Common.cpp
   ../api/IPAddress.cpp
   ../api/String.cpp
diff --git a/test/src/CanMsgRingbuffer/test_available.cpp b/test/src/CanMsgRingbuffer/test_available.cpp
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2020 Arduino.  All rights reserved.
+ */
+
+/**************************************************************************************
+ * INCLUDE
+ **************************************************************************************/
+
+#include <catch.hpp>
+
+#include <CanMsgRingbuffer.h>
+
+/**************************************************************************************
+ * TEST CODE
+ **************************************************************************************/
+
+TEST_CASE ("'available' should return 0 for empty CanMsg ring buffer", "[CanMsgRingbuffer-available-01]")
+{
+  arduino::CanMsgRingbuffer ringbuffer;
+  REQUIRE(ringbuffer.available() == 0);
+}
+
+TEST_CASE ("'available' should return number of elements in CanMsg ringbuffer", "[CanMsgRingbuffer-available-02]")
+{
+  arduino::CanMsgRingbuffer ringbuffer;
+  arduino::CanMsg msg;
+  ringbuffer.enqueue(msg);
+  REQUIRE(ringbuffer.available() == 1);
+  ringbuffer.enqueue(msg);
+  REQUIRE(ringbuffer.available() == 2);
+  ringbuffer.dequeue();
+  REQUIRE(ringbuffer.available() == 1);
+}

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ void CanMsgRingbuffer::enqueue(CanMsg const & msg)`
`40`	`40`
`41`	`41`	`_buf[_head] = msg;`
`42`	`42`	`_head = next(_head);`
`43`		`- _num_elems++;`
	`43`	`+ _num_elems = _num_elems + 1;`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`CanMsg CanMsgRingbuffer::dequeue()`
`@@ -50,7 +50,7 @@ CanMsg CanMsgRingbuffer::dequeue()`
`50`	`50`
`51`	`51`	`CanMsg const msg = _buf[_tail];`
`52`	`52`	`_tail = next(_tail);`
`53`		`- _num_elems--;`
	`53`	`+ _num_elems = _num_elems - 1;`
`54`	`54`
`55`	`55`	`return msg;`
`56`	`56`	`}`