Move UUID generation to streaminfo, add UUID format unit test

Author: tstenner

src/stream_info_impl.cpp

@@ -2,6 +2,8 @@
 #include "api_config.h"
 #include "cast.h"
 #include <algorithm>
+#include <boost/uuid/random_generator.hpp>
+#include <boost/uuid/uuid_io.hpp>
 #include <loguru.hpp>
 #include <sstream>
 #include <utility>
@@ -254,6 +256,12 @@ void stream_info_impl::uid(const std::string &v) {
 	doc_.child("info").child("uid").first_child().set_value(uid_.c_str());
 }
 
+const std::string& stream_info_impl::reset_uid()
+{
+	uid(lslboost::uuids::to_string(lslboost::uuids::random_generator()()));
+	return uid_;
+}
+
 void stream_info_impl::session_id(const std::string &v) {
 	session_id_ = v;
 	doc_.child("info").child("session_id").first_child().set_value(session_id_.c_str());

src/stream_info_impl.h

@@ -152,6 +152,9 @@ class stream_info_impl {
 	const std::string &uid() const { return uid_; }
 	void uid(const std::string &v);
 
+	/// Reset the UID to a randomly generated UUID4
+	const std::string &reset_uid();
+
 	/**
 	 * Get/Set the session id for the given stream.
 	 *

src/tcp_server.cpp

@@ -12,8 +12,6 @@
 #include <boost/asio/read_until.hpp>
 #include <boost/asio/streambuf.hpp>
 #include <boost/asio/write.hpp>
-#include <boost/uuid/random_generator.hpp>
-#include <boost/uuid/uuid_io.hpp>
 #include <loguru.hpp>
 #include <memory>
 #include <thread>
@@ -158,7 +156,7 @@ tcp_server::tcp_server(stream_info_impl_p info, io_context_p io, send_buffer_p s
 	// and assign connection-dependent fields
 	// (note: this may be assigned multiple times by multiple TCPs during setup but does not matter)
 	info_->session_id(api_config::get_instance()->session_id());
-	info_->uid(lslboost::uuids::to_string(lslboost::uuids::random_generator()()));
+	info_->reset_uid();
 	info_->created_at(lsl_clock());
 	info_->hostname(asio::ip::host_name());
 	if (protocol == tcp::v4())

testing/test_int_streaminfo.cpp

@@ -1,9 +1,32 @@
 #include "../src/api_config.h"
 #include "../src/stream_info_impl.h"
+#include <cctype>
 #include <loguru.hpp>
 
 #include <catch2/catch.hpp>
 
+template<typename T, const std::size_t N>
+bool contains(const T(&valid)[N], const T target) {
+	for(T e: valid)
+		if(e==target) return true;
+	return false;
+}
+
+TEST_CASE("uid", "[basic][streaminfo]") {
+	lsl::stream_info_impl info;
+	const std::string uid = info.reset_uid();
+	REQUIRE(uid.length() == 36);
+	for(auto i=0u; i<uid.size(); ++i)
+		if(i==8||i==13||i==18||i==23) REQUIRE(uid[i] == '-');
+		else REQUIRE(std::isxdigit(uid[i]));
+	const char version = uid[14];
+	REQUIRE(contains("1345", version));
+
+	const char variant = uid[19];
+	REQUIRE(contains("89abAB", variant));
+	REQUIRE(uid != info.reset_uid());
+}
+
 TEST_CASE("streaminfo matching via XPath", "[basic][streaminfo][xml]") {
 	lsl::stream_info_impl info(
 		"streamname", "streamtype", 8, 500, lsl_channel_format_t::cft_string, "sourceid");