Worker tests: use unique pointers when possible (#1421)

Co-authored-by: José Luis Millán <[email protected]>
versatica · Jul 6, 2024 · 8b46a2b · 8b46a2b
1 parent 2f30a84
commit 8b46a2b
Show file tree

Hide file tree

Showing 33 changed files with 244 additions and 392 deletions.
diff --git a/.github/workflows/mediasoup-worker.yaml b/.github/workflows/mediasoup-worker.yaml
@@ -97,12 +97,10 @@ jobs:
         # TODO: Maybe fix this one day.
         if: runner.os != 'Windows'
 
-      # TODO: Uncomment once https://github.com/versatica/mediasoup/issues/1417
-      # is fixed.
-      # - name: invoke -r worker test-asan-address
-      #   run: invoke -r worker test-asan-address
-      #   # Address Sanitizer only works on Linux.
-      #   if: runner.os == 'Linux'
+      - name: invoke -r worker test-asan-address
+        run: invoke -r worker test-asan-address
+        # Address Sanitizer only works on Linux.
+        if: runner.os == 'Linux'
 
       # TODO: Uncomment once https://github.com/versatica/mediasoup/issues/1417
       # is fixed.

diff --git a/worker/Dockerfile b/worker/Dockerfile
@@ -6,7 +6,7 @@ RUN set -x \
 	&& apt-get install --yes \
 		gcc g++ clang pkg-config bash-completion wget curl \
 		screen python3-pip python3-yaml pkg-config zlib1g-dev \
-		libgss-dev libssl-dev libxml2-dev
+		libgss-dev libssl-dev libxml2-dev gdb
 
 # Install node 20.
 RUN set -x \
@@ -21,6 +21,10 @@ RUN set -x \
 	&& apt-get update \
 	&& apt-get install nodejs --yes
 
+# Enable core dumps.
+RUN set -x \
+	&& echo "mkdir -p /tmp/cores && chmod 777 /tmp/cores && echo \"/tmp/cores/core.%e.sig%s.%p\" > /proc/sys/kernel/core_pattern && ulimit -c unlimited" >> ~/.bashrc
+
 # Make CC and CXX point to clang/clang++ installed above.
 ENV LANG="C.UTF-8"
 ENV CC="clang"

diff --git a/worker/test/src/RTC/Codecs/TestH264.cpp b/worker/test/src/RTC/Codecs/TestH264.cpp
@@ -21,10 +21,9 @@ SCENARIO("parse H264 payload descriptor", "[codecs][h264]")
 
 		std::memcpy(buffer, originalBuffer, sizeof(buffer));
 
-		const auto* payloadDescriptor = Codecs::H264::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<Codecs::H264::PayloadDescriptor> payloadDescriptor{ Codecs::H264::Parse(
+			buffer, sizeof(buffer)) };
 
 		REQUIRE(payloadDescriptor);
-
-		delete payloadDescriptor;
 	}
 }
diff --git a/worker/test/src/RTC/Codecs/TestH264_SVC.cpp b/worker/test/src/RTC/Codecs/TestH264_SVC.cpp
@@ -21,7 +21,9 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 
 		std::memcpy(buffer, originalBuffer, sizeof(buffer));
 
-		const auto* payloadDescriptor = Codecs::H264_SVC::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<RTC::Codecs::H264_SVC::PayloadDescriptor> payloadDescriptor{
+			Codecs::H264_SVC::Parse(buffer, sizeof(buffer))
+		};
 
 		REQUIRE(payloadDescriptor);
 
@@ -31,8 +33,6 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 		REQUIRE(payloadDescriptor->isKeyFrame == true);
 		REQUIRE(payloadDescriptor->hasTlIndex == false);
 		REQUIRE(payloadDescriptor->hasSlIndex == false);
-
-		delete payloadDescriptor;
 	}
 
 	SECTION("parse payload descriptor for NALU 8")
@@ -49,7 +49,9 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 
 		std::memcpy(buffer, originalBuffer, sizeof(buffer));
 
-		const auto* payloadDescriptor = Codecs::H264_SVC::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<RTC::Codecs::H264_SVC::PayloadDescriptor> payloadDescriptor{
+			Codecs::H264_SVC::Parse(buffer, sizeof(buffer))
+		};
 
 		REQUIRE(payloadDescriptor);
 
@@ -59,8 +61,6 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 		REQUIRE(payloadDescriptor->isKeyFrame == false);
 		REQUIRE(payloadDescriptor->hasTlIndex == false);
 		REQUIRE(payloadDescriptor->hasSlIndex == false);
-
-		delete payloadDescriptor;
 	}
 
 	SECTION("parse payload descriptor for NALU 1")
@@ -77,7 +77,9 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 
 		std::memcpy(buffer, originalBuffer, sizeof(buffer));
 
-		const auto* payloadDescriptor = Codecs::H264_SVC::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<RTC::Codecs::H264_SVC::PayloadDescriptor> payloadDescriptor{
+			Codecs::H264_SVC::Parse(buffer, sizeof(buffer))
+		};
 
 		REQUIRE(payloadDescriptor);
 
@@ -87,8 +89,6 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 		REQUIRE(payloadDescriptor->isKeyFrame == false);
 		REQUIRE(payloadDescriptor->hasTlIndex == false);
 		REQUIRE(payloadDescriptor->hasSlIndex == false);
-
-		delete payloadDescriptor;
 	}
 
 	SECTION("parse payload descriptor for NALU 5")
@@ -105,7 +105,9 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 
 		std::memcpy(buffer, originalBuffer, sizeof(buffer));
 
-		const auto* payloadDescriptor = Codecs::H264_SVC::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<RTC::Codecs::H264_SVC::PayloadDescriptor> payloadDescriptor{
+			Codecs::H264_SVC::Parse(buffer, sizeof(buffer))
+		};
 
 		REQUIRE(payloadDescriptor);
 
@@ -115,8 +117,6 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 		REQUIRE(payloadDescriptor->isKeyFrame == true);
 		REQUIRE(payloadDescriptor->hasTlIndex == false);
 		REQUIRE(payloadDescriptor->hasSlIndex == false);
-
-		delete payloadDescriptor;
 	}
 
 	SECTION("parse payload descriptor for NALU 14")
@@ -133,7 +133,9 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 
 		std::memcpy(buffer, originalBuffer, sizeof(buffer));
 
-		const auto* payloadDescriptor = Codecs::H264_SVC::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<RTC::Codecs::H264_SVC::PayloadDescriptor> payloadDescriptor{
+			Codecs::H264_SVC::Parse(buffer, sizeof(buffer))
+		};
 
 		REQUIRE(payloadDescriptor);
 
@@ -145,8 +147,6 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 		REQUIRE(payloadDescriptor->isKeyFrame == false);
 		REQUIRE(payloadDescriptor->hasTlIndex == true);
 		REQUIRE(payloadDescriptor->hasSlIndex == true);
-
-		delete payloadDescriptor;
 	}
 
 	SECTION("parse payload descriptor for NALU 20")
@@ -163,7 +163,9 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 
 		std::memcpy(buffer, originalBuffer, sizeof(buffer));
 
-		const auto* payloadDescriptor = Codecs::H264_SVC::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<RTC::Codecs::H264_SVC::PayloadDescriptor> payloadDescriptor{
+			Codecs::H264_SVC::Parse(buffer, sizeof(buffer))
+		};
 
 		REQUIRE(payloadDescriptor);
 
@@ -175,7 +177,5 @@ SCENARIO("parse H264_SVC payload descriptor", "[codecs][h264_svc]")
 		REQUIRE(payloadDescriptor->isKeyFrame == false);
 		REQUIRE(payloadDescriptor->hasTlIndex == true);
 		REQUIRE(payloadDescriptor->hasSlIndex == true);
-
-		delete payloadDescriptor;
 	}
 }
diff --git a/worker/test/src/RTC/Codecs/TestVP8.cpp b/worker/test/src/RTC/Codecs/TestVP8.cpp
@@ -38,7 +38,8 @@ SCENARIO("parse VP8 payload descriptor", "[codecs][vp8]")
 
 		std::memcpy(buffer, originalBuffer, sizeof(buffer));
 
-		const auto* payloadDescriptor = Codecs::VP8::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<Codecs::VP8::PayloadDescriptor> payloadDescriptor{ Codecs::VP8::Parse(
+			buffer, sizeof(buffer)) };
 
 		REQUIRE(payloadDescriptor);
 
@@ -77,8 +78,6 @@ SCENARIO("parse VP8 payload descriptor", "[codecs][vp8]")
 				REQUIRE(std::memcmp(buffer, originalBuffer, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete payloadDescriptor;
 	}
 
 	SECTION("parse payload descriptor 2")
@@ -113,7 +112,8 @@ SCENARIO("parse VP8 payload descriptor", "[codecs][vp8]")
 		std::memcpy(buffer, originalBuffer, sizeof(buffer));
 
 		// Parse the buffer.
-		const auto* payloadDescriptor = Codecs::VP8::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<Codecs::VP8::PayloadDescriptor> payloadDescriptor{ Codecs::VP8::Parse(
+			buffer, sizeof(buffer)) };
 
 		REQUIRE(payloadDescriptor);
 
@@ -152,8 +152,6 @@ SCENARIO("parse VP8 payload descriptor", "[codecs][vp8]")
 				REQUIRE(std::memcmp(buffer, originalBuffer, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete payloadDescriptor;
 	};
 
 	SECTION("parse payload descriptor. I flag set but no space for pictureId")

diff --git a/worker/test/src/RTC/RTCP/TestBye.cpp b/worker/test/src/RTC/RTCP/TestBye.cpp
@@ -47,11 +47,11 @@ SCENARIO("RTCP BYE parsing", "[parser][rtcp][bye]")
 {
 	SECTION("parse BYE packet")
 	{
-		ByePacket* packet = ByePacket::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<ByePacket> packet{ ByePacket::Parse(buffer, sizeof(buffer)) };
 
 		REQUIRE(packet);
 
-		verify(packet);
+		verify(packet.get());
 
 		SECTION("serialize packet instance")
 		{
@@ -64,8 +64,6 @@ SCENARIO("RTCP BYE parsing", "[parser][rtcp][bye]")
 				REQUIRE(std::memcmp(buffer, serialized, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete packet;
 	}
 
 	SECTION("create ByePacket")

diff --git a/worker/test/src/RTC/RTCP/TestFeedbackPsAfb.cpp b/worker/test/src/RTC/RTCP/TestFeedbackPsAfb.cpp
@@ -39,11 +39,11 @@ SCENARIO("RTCP Feedback PS AFB parsing", "[parser][rtcp][feedback-ps][afb]")
 	{
 		using namespace TestFeedbackPsAfb;
 
-		FeedbackPsAfbPacket* packet = FeedbackPsAfbPacket::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<FeedbackPsAfbPacket> packet{ FeedbackPsAfbPacket::Parse(buffer, sizeof(buffer)) };
 
 		REQUIRE(packet);
 
-		verify(packet);
+		verify(packet.get());
 
 		SECTION("serialize packet instance")
 		{
@@ -56,7 +56,5 @@ SCENARIO("RTCP Feedback PS AFB parsing", "[parser][rtcp][feedback-ps][afb]")
 				REQUIRE(std::memcmp(buffer, serialized, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete packet;
 	}
 }
diff --git a/worker/test/src/RTC/RTCP/TestFeedbackPsFir.cpp b/worker/test/src/RTC/RTCP/TestFeedbackPsFir.cpp
@@ -44,11 +44,11 @@ SCENARIO("RTCP Feedback PS FIR parsing", "[parser][rtcp][feedback-ps][fir]")
 
 	SECTION("parse FeedbackPsFirPacket")
 	{
-		FeedbackPsFirPacket* packet = FeedbackPsFirPacket::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<FeedbackPsFirPacket> packet{ FeedbackPsFirPacket::Parse(buffer, sizeof(buffer)) };
 
 		REQUIRE(packet);
 
-		verify(packet);
+		verify(packet.get());
 
 		SECTION("serialize packet instance")
 		{
@@ -61,8 +61,6 @@ SCENARIO("RTCP Feedback PS FIR parsing", "[parser][rtcp][feedback-ps][fir]")
 				REQUIRE(std::memcmp(buffer, serialized, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete packet;
 	}
 
 	SECTION("create FeedbackPsFirPacket")

diff --git a/worker/test/src/RTC/RTCP/TestFeedbackPsLei.cpp b/worker/test/src/RTC/RTCP/TestFeedbackPsLei.cpp
@@ -41,11 +41,11 @@ SCENARIO("RTCP Feedback PS LEI parsing", "[parser][rtcp][feedback-ps][lei]")
 
 	SECTION("parse FeedbackPsLeiPacket")
 	{
-		FeedbackPsLeiPacket* packet = FeedbackPsLeiPacket::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<FeedbackPsLeiPacket> packet{ FeedbackPsLeiPacket::Parse(buffer, sizeof(buffer)) };
 
 		REQUIRE(packet);
 
-		verify(packet);
+		verify(packet.get());
 
 		SECTION("serialize packet instance")
 		{
@@ -58,8 +58,6 @@ SCENARIO("RTCP Feedback PS LEI parsing", "[parser][rtcp][feedback-ps][lei]")
 				REQUIRE(std::memcmp(buffer, serialized, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete packet;
 	}
 
 	SECTION("create FeedbackPsLeiPacket")

diff --git a/worker/test/src/RTC/RTCP/TestFeedbackPsPli.cpp b/worker/test/src/RTC/RTCP/TestFeedbackPsPli.cpp
@@ -35,11 +35,11 @@ SCENARIO("RTCP Feeback RTP PLI parsing", "[parser][rtcp][feedback-ps][pli]")
 
 	SECTION("parse FeedbackPsPliPacket")
 	{
-		FeedbackPsPliPacket* packet = FeedbackPsPliPacket::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<FeedbackPsPliPacket> packet{ FeedbackPsPliPacket::Parse(buffer, sizeof(buffer)) };
 
 		REQUIRE(packet);
 
-		verify(packet);
+		verify(packet.get());
 
 		SECTION("serialize packet instance")
 		{
@@ -52,8 +52,6 @@ SCENARIO("RTCP Feeback RTP PLI parsing", "[parser][rtcp][feedback-ps][pli]")
 				REQUIRE(std::memcmp(buffer, serialized, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete packet;
 	}
 
 	SECTION("create FeedbackPsPliPacket")

diff --git a/worker/test/src/RTC/RTCP/TestFeedbackPsRemb.cpp b/worker/test/src/RTC/RTCP/TestFeedbackPsRemb.cpp
@@ -43,11 +43,11 @@ SCENARIO("RTCP Feedback PS parsing", "[parser][rtcp][feedback-ps][remb]")
 
 	SECTION("parse FeedbackPsRembPacket")
 	{
-		FeedbackPsRembPacket* packet = FeedbackPsRembPacket::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<FeedbackPsRembPacket> packet{ FeedbackPsRembPacket::Parse(buffer, sizeof(buffer)) };
 
 		REQUIRE(packet);
 
-		verify(packet);
+		verify(packet.get());
 
 		SECTION("serialize packet instance")
 		{
@@ -60,8 +60,6 @@ SCENARIO("RTCP Feedback PS parsing", "[parser][rtcp][feedback-ps][remb]")
 				REQUIRE(std::memcmp(buffer, serialized, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete packet;
 	}
 
 	SECTION("create FeedbackPsRembPacket")

diff --git a/worker/test/src/RTC/RTCP/TestFeedbackPsRpsi.cpp b/worker/test/src/RTC/RTCP/TestFeedbackPsRpsi.cpp
@@ -49,11 +49,11 @@ SCENARIO("RTCP Feedback PS RPSI parsing", "[parser][rtcp][feedback-ps][rpsi]")
 
 	SECTION("parse FeedbackPsRpsiPacket")
 	{
-		FeedbackPsRpsiPacket* packet = FeedbackPsRpsiPacket::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<FeedbackPsRpsiPacket> packet{ FeedbackPsRpsiPacket::Parse(buffer, sizeof(buffer)) };
 
 		REQUIRE(packet);
 
-		verify(packet);
+		verify(packet.get());
 
 		SECTION("serialize packet instance")
 		{
@@ -66,7 +66,5 @@ SCENARIO("RTCP Feedback PS RPSI parsing", "[parser][rtcp][feedback-ps][rpsi]")
 				REQUIRE(std::memcmp(buffer, serialized, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete packet;
 	}
 }
diff --git a/worker/test/src/RTC/RTCP/TestFeedbackPsSli.cpp b/worker/test/src/RTC/RTCP/TestFeedbackPsSli.cpp
@@ -46,11 +46,11 @@ SCENARIO("RTCP Feedback PS SLI parsing", "[parser][rtcp][feedback-ps][sli]")
 
 	SECTION("parse FeedbackPsSliPacket")
 	{
-		FeedbackPsSliPacket* packet = FeedbackPsSliPacket::Parse(buffer, sizeof(buffer));
+		std::unique_ptr<FeedbackPsSliPacket> packet{ FeedbackPsSliPacket::Parse(buffer, sizeof(buffer)) };
 
 		REQUIRE(packet);
 
-		verify(packet);
+		verify(packet.get());
 
 		SECTION("serialize packet instance")
 		{
@@ -63,7 +63,5 @@ SCENARIO("RTCP Feedback PS SLI parsing", "[parser][rtcp][feedback-ps][sli]")
 				REQUIRE(std::memcmp(buffer, serialized, sizeof(buffer)) == 0);
 			}
 		}
-
-		delete packet;
 	}
 }