Merge pull request #14 from vinitjames/feature/tests

Feature/tests

Author: vinitjames

circular_buffer.h

@@ -5,7 +5,6 @@
 #include <mutex>
 #include <memory>
 #include <iterator>
-#include <type_traits>
 #include <algorithm>
 #include <utility>
 
@@ -20,7 +19,7 @@ class CircularBuffer {
 	typedef const T& const_reference;
 	typedef size_t size_type;
 	typedef ptrdiff_t difference_type;
-	template <bool isConst> struct BufferIterator;
+    template <bool isConst> struct BufferIterator;
 
 
 public:
@@ -80,7 +79,7 @@ class CircularBuffer {
 		}
 		return *this;
 	}
-
+	
 	void push_back(const value_type& data);
 	void push_back(value_type&& data) noexcept;
 	void pop_front();
@@ -116,31 +115,33 @@ class CircularBuffer {
 	void _decrement_bufferstate();
 	mutable std::mutex _mtx;
 	std::unique_ptr<value_type[]> _buff;
-
 	size_type _head = 0;
 	size_type _tail = 0;
 	size_type _size = 0;
 	size_type _max_size = 0;
-		
+			
     template<bool isConst = false>
 	struct  BufferIterator{
 	public:
-		
-		typedef std::random_access_iterator_tag iterator_type;
+		friend class CircularBuffer<T>;
+		typedef std::random_access_iterator_tag iterator_category;
+		typedef ptrdiff_t difference_type;
+		typedef T value_type;
 		typedef typename std::conditional<isConst, const value_type&, value_type&>::type reference;
 		typedef typename std::conditional<isConst, const value_type*, value_type*>::type pointer;
 		typedef typename std::conditional<isConst, const CircularBuffer<value_type>*,
 										  CircularBuffer<value_type>*>::type cbuf_pointer;
-		
+	private:
 		cbuf_pointer _ptrToBuffer;
 		size_type _offset;
 		size_type _index;
 		bool _reverse;
-
+		
 		bool _comparable(const BufferIterator<isConst>& other) const{
 			return (_ptrToBuffer == other._ptrToBuffer)&&(_reverse == other._reverse);
 		}
 
+	public:
 		BufferIterator()
 			:_ptrToBuffer{nullptr}, _offset{0}, _index{0}, _reverse{false}{}
 
@@ -159,8 +160,9 @@ class CircularBuffer {
 		pointer  operator->() { return &(operator*()); }
 
 		reference operator[](size_type index){
-			this->_index += index;
-			return this->operator*();
+			BufferIterator iter = *this;
+			iter._index += index;
+			return *iter;
 		}
 
 		BufferIterator& operator++(){
@@ -206,6 +208,11 @@ class CircularBuffer {
 			return lhsiter;
 		}
 
+		friend difference_type operator-(const BufferIterator& lhsiter, const BufferIterator& rhsiter){
+			
+			return lhsiter._index - rhsiter._index;
+		}
+
 		BufferIterator& operator-=(difference_type n){
 			_index -= n;
 			return *this;
@@ -246,7 +253,6 @@ class CircularBuffer {
 				return false;
 			return ((_index + _offset)>=(other._index+other._offset));
 		}
-		
 	};
 };
 

tests/CMakeLists.txt

@@ -33,18 +33,23 @@ add_subdirectory(${CMAKE_CURRENT_BINARY_DIR}/googletest-src
                  ${CMAKE_CURRENT_BINARY_DIR}/googletest-build
 				 EXCLUDE_FROM_ALL)
 
-add_executable(int_buffer int_buffer.cpp)
-target_link_libraries(int_buffer
+add_executable(simple_int_test simple_int_test.cpp)
+target_link_libraries(simple_int_test
 					  circularbuffer
 					  gtest_main
 					  )
-add_test(NAME test_int_buffer COMMAND int_buffer)
+add_test(NAME simple_int_test COMMAND simple_int_test)
 
-add_executable(string_buffer string_buffer.cpp)
-target_link_libraries(string_buffer
+add_executable(member_func_test member_func_test.cpp)
+target_link_libraries(member_func_test
 					  circularbuffer
 					  gtest_main
 					  )
-add_test(NAME test_string_buffer COMMAND string_buffer)
-
+add_test(NAME member_func_test COMMAND member_func_test)
 
+add_executable(iterator_test iterator_test.cpp)
+target_link_libraries(iterator_test
+					  circularbuffer
+					  gtest_main
+					  )
+add_test(NAME iterator_test COMMAND iterator_test)

tests/iterator_test.cpp

@@ -0,0 +1,99 @@
+#include "circular_buffer.h"
+#include <algorithm>
+#include <iostream>
+#include <string.h>
+#include <utility>
+#include "gtest/gtest.h"
+
+#define TEST_BUFFER_SIZE 100
+#define REDUCE_SIZE 100
+
+class CircularBufferTest : public ::testing::Test{
+	
+protected:
+	
+	CircularBuffer<std::string> test_str_buff{TEST_BUFFER_SIZE};
+	CircularBuffer<int> test_int_buff{TEST_BUFFER_SIZE};
+};
+
+TEST_F(CircularBufferTest, IteratorBasedLoopTest){	
+	//create full buffer
+	for(int i=0; i<TEST_BUFFER_SIZE; i++)
+		test_str_buff.push_back("string" + std::to_string(i));
+    int i = 0;
+	for(auto it = test_str_buff.begin(); it!=test_str_buff.end(); it++)
+		EXPECT_EQ(*it, "string" + std::to_string(i++));
+	//partially fill buffers
+	test_str_buff.clear();
+	for(int i=0; i<TEST_BUFFER_SIZE/2; i++)
+		test_str_buff.push_back("string" + std::to_string(i));
+	//test begin and end on partially full buffer
+	i = 0;
+	for(auto it = test_str_buff.begin(); it!=test_str_buff.end(); it++)
+		EXPECT_EQ(*it, "string" + std::to_string(i++));
+	//test size with increment variable
+	EXPECT_EQ(i, TEST_BUFFER_SIZE/2);
+}
+
+TEST_F(CircularBufferTest, RangeBasedLoopTest){	
+	//create full buffer
+	for(int i=0; i<TEST_BUFFER_SIZE; i++)
+		test_str_buff.push_back("string" + std::to_string(i));
+	int i = 0;
+	//copied elements 
+    for(auto buff_elem : test_str_buff)
+		EXPECT_EQ(buff_elem, "string" + std::to_string(i++));
+	//auto reference
+	i = 0;
+    for(auto& buff_elem : test_str_buff)
+		EXPECT_EQ(buff_elem, "string" + std::to_string(i++));	
+	//auto const reference
+	i = 0;
+    for(const auto& buff_elem : test_str_buff)
+		EXPECT_EQ(buff_elem, "string" + std::to_string(i++));
+	//check iterators after modifications
+	for(int i = 0; i<REDUCE_SIZE; i++)
+		test_str_buff.pop_front();
+	i = 0;
+    for(const auto& buff_elem : test_str_buff)
+		EXPECT_EQ(buff_elem, "string" + std::to_string(i++));
+	EXPECT_EQ(i, TEST_BUFFER_SIZE - REDUCE_SIZE);
+}
+
+TEST_F(CircularBufferTest, FindTest){	
+	//create full buffer
+	for(int i=0; i<TEST_BUFFER_SIZE; i++)
+		test_str_buff.push_back("string" + std::to_string(i));
+	auto result = std::find(test_str_buff.cbegin(), test_str_buff.cend(), "string50");
+	EXPECT_EQ(*result, "string50");
+	result  = std::find(test_str_buff.cbegin(), test_str_buff.cend(), "string100");
+	EXPECT_EQ(result, test_str_buff.cend());
+	//partial buffer search
+	result  = std::find(test_str_buff.cbegin(), test_str_buff.cbegin() + 50, "string30");
+	EXPECT_EQ(*result, "string30");
+	result  = std::find(test_str_buff.cbegin(), test_str_buff.cbegin() + 50, "string51");
+	EXPECT_EQ(result, test_str_buff.cbegin() + 50);
+}
+
+TEST_F(CircularBufferTest, ForEachTest){	
+	//create full buffer
+	for(int i=0; i<TEST_BUFFER_SIZE; i++)
+		test_str_buff.push_back("string" + std::to_string(i));
+	std::for_each(test_str_buff.begin(), test_str_buff.end(), [](std::string& elem){ elem = elem + "modified";});
+	int i=0;
+	for(const auto& elem: test_str_buff)
+		EXPECT_EQ(elem, "string" + std::to_string(i++) + "modified");	
+}
+
+TEST_F(CircularBufferTest, SortTest){	
+	//create full buffer
+	for(int i=0; i<TEST_BUFFER_SIZE; i++)
+		test_int_buff.push_back(i);
+	std::sort(test_int_buff.begin(), test_int_buff.end(), std::greater<int>());
+	int i = 99;
+	for(const auto& elem: test_int_buff)
+		EXPECT_EQ(elem, i--);
+}
+
+
+

tests/string_buffer.cpp renamed to tests/member_func_test.cpp

@@ -242,7 +242,7 @@ TEST_F(CircularBufferTest, AtFunctionTest){
 }
 
 TEST_F(CircularBufferTest, AccessOperatorTest){
-	// push back & at access for  individual elements
+	// push back & [] access for  individual elements
 	test_buff.push_back("string1");
 	test_buff.push_back("string2");
 	EXPECT_EQ(test_buff.size(), 2);
@@ -389,51 +389,7 @@ TEST_F(CircularBufferTest, CendIteratorTest){
 }
 
 
-TEST_F(CircularBufferTest, IteratorBasedLoopTest){	
-	//create full buffer
-	for(int i=0; i<TEST_BUFFER_SIZE; i++)
-		test_buff.push_back("string" + std::to_string(i));
-    int i = 0;
-	for(auto it = test_buff.begin(); it!=test_buff.end(); it++)
-		EXPECT_EQ(*it, "string" + std::to_string(i++));
-	//partially fill buffers
-	test_buff.clear();
-	for(int i=0; i<TEST_BUFFER_SIZE/2; i++)
-		test_buff.push_back("string" + std::to_string(i));
-	//test begin and end on partially full buffer
-	i = 0;
-	for(auto it = test_buff.begin(); it!=test_buff.end(); it++)
-		EXPECT_EQ(*it, "string" + std::to_string(i++));
-	//test size with increment variable
-	EXPECT_EQ(i, TEST_BUFFER_SIZE/2);
-	
-
-}
 
-TEST_F(CircularBufferTest, RangeBasedLoopTest){	
-	//create full buffer
-	for(int i=0; i<TEST_BUFFER_SIZE; i++)
-		test_buff.push_back("string" + std::to_string(i));
-	int i = 0;
-	//copied elements 
-    for(auto buff_elem : test_buff)
-		EXPECT_EQ(buff_elem, "string" + std::to_string(i++));
-	//auto reference
-	i = 0;
-    for(auto& buff_elem : test_buff)
-		EXPECT_EQ(buff_elem, "string" + std::to_string(i++));	
-	//auto const reference
-	i = 0;
-    for(const auto& buff_elem : test_buff)
-		EXPECT_EQ(buff_elem, "string" + std::to_string(i++));
-	//check iterators after modifications
-	for(int i = 0; i<REDUCE_SIZE; i++)
-		test_buff.pop_front();
-	i = 0;
-    for(const auto& buff_elem : test_buff)
-		EXPECT_EQ(buff_elem, "string" + std::to_string(i++));
-	EXPECT_EQ(i, TEST_BUFFER_SIZE - REDUCE_SIZE);
-}