Added unit test for StreamTee

[davide]

lg. You probably don't need pre-commit reviews for adding tests. This is obvious goodness.

lldb.xcodeproj/project.pbxproj

/* Begin PBXBuildFile section */
     2689000F13353DB600698AC0 /* StoppointLocation.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 26BC7E1710F1B83100F91463 /* StoppointLocation.cpp */; };
     26764C9E1E48F51E008D3573 /* Stream.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 26764C9D1E48F51E008D3573 /* Stream.cpp */; };
     9A4F35101368A51A00823F52 /* StreamAsynchronousIO.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 9A4F350F1368A51A00823F52 /* StreamAsynchronousIO.cpp */; };
     AFC2DCF61E6E316A00283714 /* StreamCallback.cpp in Sources */ = {isa = PBXBuildFile; fileRef = AFC2DCF51E6E316A00283714 /* StreamCallback.cpp */; };
     9A3D43EE1F3237F900EB767C /* StreamCallbackTest.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 9A3D43E11F3237D500EB767C /* StreamCallbackTest.cpp */; };
     2689004F13353E0400698AC0 /* StreamFile.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 26BC7E9210F1B85900F91463 /* StreamFile.cpp */; };
     AFC2DCF91E6E318000283714 /* StreamGDBRemote.cpp in Sources */ = {isa = PBXBuildFile; fileRef = AFC2DCF81E6E318000283714 /* StreamGDBRemote.cpp */; };
     26764CA21E48F547008D3573 /* StreamString.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 26764CA11E48F547008D3573 /* StreamString.cpp */; };
+    58EAC73F2106A07B0029571E /* StreamTeeTest.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 58EAC73D2106A0740029571E /* StreamTeeTest.cpp */; };
     33E5E8471A674FB60024ED68 /* StringConvert.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 33E5E8411A672A240024ED68 /* StringConvert.cpp */; };
     2689011113353E8200698AC0 /* StringExtractor.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 2660D9F611922A1300958FBD /* StringExtractor.cpp */; };
     2689011213353E8200698AC0 /* StringExtractorGDBRemote.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 2676A093119C93C8008A98EF /* StringExtractorGDBRemote.cpp */; };
     23CB15411D66DA9300EDDDE1 /* StringExtractorTest.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 2321F9441BDD346100BA9A93 /* StringExtractorTest.cpp */; };
     94380B8219940B0A00BFE4A8 /* StringLexer.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 94380B8119940B0A00BFE4A8 /* StringLexer.cpp */; };
     2689005113353E0400698AC0 /* StringList.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 9A35765F116E76B900E8ED2F /* StringList.cpp */; };
     94F48F251A01C687005C0EC6 /* StringPrinter.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 94F48F241A01C687005C0EC6 /* StringPrinter.cpp */; };
     AFEC3362194A8ABA00FF05C6 /* StructuredData.cpp in Sources */ = {isa = PBXBuildFile; fileRef = AFEC3361194A8ABA00FF05C6 /* StructuredData.cpp */; };

     9A3D43E11F3237D500EB767C /* StreamCallbackTest.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = StreamCallbackTest.cpp; sourceTree = "<group>"; };
     26BC7E9210F1B85900F91463 /* StreamFile.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = StreamFile.cpp; path = source/Core/StreamFile.cpp; sourceTree = "<group>"; };
     26BC7D7A10F1B77400F91463 /* StreamFile.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = StreamFile.h; path = include/lldb/Core/StreamFile.h; sourceTree = "<group>"; };
     AFC2DCF81E6E318000283714 /* StreamGDBRemote.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = StreamGDBRemote.cpp; path = source/Utility/StreamGDBRemote.cpp; sourceTree = "<group>"; };
     AFC2DCFA1E6E318600283714 /* StreamGDBRemote.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = StreamGDBRemote.h; path = include/lldb/Utility/StreamGDBRemote.h; sourceTree = "<group>"; };
     26764CA11E48F547008D3573 /* StreamString.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = StreamString.cpp; path = source/Utility/StreamString.cpp; sourceTree = "<group>"; };
     26764CA31E48F550008D3573 /* StreamString.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = StreamString.h; path = include/lldb/Utility/StreamString.h; sourceTree = "<group>"; };
     26764CA41E48F566008D3573 /* StreamTee.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = StreamTee.h; path = include/lldb/Utility/StreamTee.h; sourceTree = "<group>"; };
+    58EAC73D2106A0740029571E /* StreamTeeTest.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = StreamTeeTest.cpp; sourceTree = "<group>"; };
     33E5E8411A672A240024ED68 /* StringConvert.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = StringConvert.cpp; sourceTree = "<group>"; };
     33E5E8451A6736D30024ED68 /* StringConvert.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = StringConvert.h; path = include/lldb/Host/StringConvert.h; sourceTree = SOURCE_ROOT; };
     2660D9F611922A1300958FBD /* StringExtractor.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = StringExtractor.cpp; path = source/Utility/StringExtractor.cpp; sourceTree = "<group>"; };
     26A375831D59486000D6CBDB /* StringExtractor.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = StringExtractor.h; path = include/lldb/Utility/StringExtractor.h; sourceTree = "<group>"; };
     2676A093119C93C8008A98EF /* StringExtractorGDBRemote.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = StringExtractorGDBRemote.cpp; path = source/Utility/StringExtractorGDBRemote.cpp; sourceTree = "<group>"; };
     2676A094119C93C8008A98EF /* StringExtractorGDBRemote.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = StringExtractorGDBRemote.h; path = source/Utility/StringExtractorGDBRemote.h; sourceTree = "<group>"; };
     2321F9441BDD346100BA9A93 /* StringExtractorTest.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = StringExtractorTest.cpp; sourceTree = "<group>"; };
     94380B8119940B0A00BFE4A8 /* StringLexer.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = StringLexer.cpp; path = source/Utility/StringLexer.cpp; sourceTree = "<group>"; };
2321F93F1BDD33D800BA9A93 /* ScriptInterpreter */ = {
         2321F94B1BDD35D500BA9A93 /* Python */,
       );
       path = ScriptInterpreter;
       sourceTree = "<group>";
     };
     2321F9421BDD343A00BA9A93 /* Utility */ = {
       isa = PBXGroup;
       children = (
+        58EAC73D2106A0740029571E /* StreamTeeTest.cpp */,
         7F94D7172040A13A006EE3EA /* CleanUpTest.cpp */,
         23E2E5161D903689006F38BB /* ArchSpecTest.cpp */,
         9A3D43C81F3150D200EB767C /* ConstStringTest.cpp */,
         23CB14FD1D66CD2400EDDDE1 /* FileSpecTest.cpp */,
         9A3D43C71F3150D200EB767C /* LogTest.cpp */,
         9A3D43CB1F3150D200EB767C /* NameMatchesTest.cpp */,
         9A3D43C61F3150D200EB767C /* StatusTest.cpp */,
         9A3D43CA1F3150D200EB767C /* StructuredDataTest.cpp */,
23CB15321D66DA9300EDDDE1 /* Sources */ = {
         23CB15361D66DA9300EDDDE1 /* FileSpecTest.cpp in Sources */,
         23E2E5251D90373D006F38BB /* ArchSpecTest.cpp in Sources */,
         9A2057081F3B819100F6C293 /* MemoryRegionInfoTest.cpp in Sources */,
         9A20572D1F3B8E6600F6C293 /* TestCompletion.cpp in Sources */,
         4C719399207D23E300FDF430 /* TestOptionArgParser.cpp in Sources */,
         23CB15371D66DA9300EDDDE1 /* PythonTestSuite.cpp in Sources */,
         23E2E5321D903832006F38BB /* BreakpointIDTest.cpp in Sources */,
         4CEC86A7204738EB009B37B1 /* TestPPC64InstEmulation.cpp in Sources */,
+        58EAC73F2106A07B0029571E /* StreamTeeTest.cpp in Sources */,
         23CB15381D66DA9300EDDDE1 /* PythonExceptionStateTests.cpp in Sources */,
         9A3D43D81F3151C400EB767C /* NameMatchesTest.cpp in Sources */,
         23CB15391D66DA9300EDDDE1 /* DataExtractorTest.cpp in Sources */,
         4CEC86A4204738C5009B37B1 /* TestArm64InstEmulation.cpp in Sources */,
         9A3D43ED1F3237F900EB767C /* StateTest.cpp in Sources */,
         23CB153A1D66DA9300EDDDE1 /* GDBRemoteClientBaseTest.cpp in Sources */,
         23CB153B1D66DA9300EDDDE1 /* SocketTest.cpp in Sources */,
         23CB153C1D66DA9300EDDDE1 /* ArgsTest.cpp in Sources */,

unittests/Utility/CMakeLists.txt

 add_lldb_unittest(UtilityTests
   AnsiTerminalTest.cpp
   ArgsTest.cpp
   OptionsWithRawTest.cpp
   ArchSpecTest.cpp
   CleanUpTest.cpp
   ConstStringTest.cpp
   CompletionRequestTest.cpp
   EnvironmentTest.cpp
   FileSpecTest.cpp
   FlagsTest.cpp
   JSONTest.cpp
   LogTest.cpp
   NameMatchesTest.cpp
   StatusTest.cpp
+  StreamTeeTest.cpp
   StringExtractorTest.cpp
   StructuredDataTest.cpp
   TildeExpressionResolverTest.cpp
   TimeoutTest.cpp
   TimerTest.cpp
   UriParserTest.cpp
   UUIDTest.cpp
   VASprintfTest.cpp

unittests/Utility/StreamTeeTest.cpp

+//===-- StreamTeeTest.cpp ---------------------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "lldb/Utility/StreamTee.h"
+#include "lldb/Utility/StreamString.h"
+#include "gtest/gtest.h"
+
+using namespace lldb_private;
+
+TEST(StreamTeeTest, DefaultConstructor) {
+  // Test the default constructor.
+  StreamTee tee;
+  ASSERT_EQ(0U, tee.GetNumStreams());
+}
+
+TEST(StreamTeeTest, Constructor1Stream) {
+  // Test the constructor for a single stream.
+  lldb::StreamSP s1(std::make_shared<StreamString>());
+  StreamTee tee(s1);
+
+  ASSERT_EQ(1U, tee.GetNumStreams());
+  EXPECT_EQ(s1, tee.GetStreamAtIndex(0U));
+}
+
+TEST(StreamTeeTest, Constructor2Streams) {
+  // Test the constructor for two streams.
+  lldb::StreamSP s1(std::make_shared<StreamString>());
+  lldb::StreamSP s2(std::make_shared<StreamString>());
+  StreamTee tee(s1, s2);
+
+  ASSERT_EQ(2U, tee.GetNumStreams());
+  EXPECT_EQ(s1, tee.GetStreamAtIndex(0U));
+  EXPECT_EQ(s2, tee.GetStreamAtIndex(1U));
+}
+
+TEST(StreamTeeTest, CopyConstructor) {
+  // Test the copy constructor.
+  lldb::StreamSP s1(std::make_shared<StreamString>());
+  lldb::StreamSP s2(std::make_shared<StreamString>());
+  StreamTee tee1(s1, s2);
+  StreamTee tee2(tee1);
+
+  ASSERT_EQ(2U, tee2.GetNumStreams());
+  EXPECT_EQ(s1, tee2.GetStreamAtIndex(0U));
+  EXPECT_EQ(s2, tee2.GetStreamAtIndex(1U));
+}
+
+TEST(StreamTeeTest, Assignment) {
+  // Test the assignment of StreamTee.
+  lldb::StreamSP s1(std::make_shared<StreamString>());
+  lldb::StreamSP s2(std::make_shared<StreamString>());
+  StreamTee tee1(s1, s2);
+  StreamTee tee2 = tee1;
+
+  ASSERT_EQ(2U, tee2.GetNumStreams());
+  EXPECT_EQ(s1, tee2.GetStreamAtIndex(0U));
+  EXPECT_EQ(s2, tee2.GetStreamAtIndex(1U));
+}
+
+TEST(StreamTeeTest, Write) {
+  // Test that write is sent out to all children.
+  auto ss1 = new StreamString();
+  auto ss2 = new StreamString();
+  lldb::StreamSP s1(ss1);
+  lldb::StreamSP s2(ss2);
+  StreamTee tee(s1, s2);
+
+  tee << "foo";
+  tee.Flush();
+
+  ASSERT_EQ(2U, tee.GetNumStreams());
+  EXPECT_EQ("foo", ss1->GetString().str());
+  EXPECT_EQ("foo", ss2->GetString().str());
+
+  tee << "bar";
+  tee.Flush();
+  EXPECT_EQ("foobar", ss1->GetString().str());
+  EXPECT_EQ("foobar", ss2->GetString().str());
+}
+
+namespace {
+  struct FlushTestStream : public Stream {
+    unsigned m_flush_count = false;
+    void Flush() override {
+      ++m_flush_count;
+    }
+    size_t Write(const void *src, size_t src_len) override { return src_len; }
+  };
+}
+
+TEST(StreamTeeTest, Flush) {
+  // Check that Flush is distributed to all streams.
+  auto fs1 = new FlushTestStream();
+  auto fs2 = new FlushTestStream();
+  lldb::StreamSP s1(fs1);
+  lldb::StreamSP s2(fs2);
+  StreamTee tee(s1, s2);
+
+  tee << "foo";
+  tee.Flush();
+
+  ASSERT_EQ(2U, tee.GetNumStreams());
+  EXPECT_EQ(1U, fs1->m_flush_count);
+  EXPECT_EQ(1U, fs2->m_flush_count);
+
+  tee << "bar";
+  tee.Flush();
+  EXPECT_EQ(2U, fs1->m_flush_count);
+  EXPECT_EQ(2U, fs2->m_flush_count);
+}
+
+TEST(StreamTeeTest, AppendStream) {
+  // Append new streams to our StreamTee.
+  auto ss1 = new StreamString();
+  auto ss2 = new StreamString();
+  lldb::StreamSP s1(ss1);
+  lldb::StreamSP s2(ss2);
+
+  StreamTee tee;
+
+  ASSERT_EQ(0U, tee.GetNumStreams());
+
+  tee.AppendStream(s1);
+  ASSERT_EQ(1U, tee.GetNumStreams());
+  EXPECT_EQ(s1, tee.GetStreamAtIndex(0U));
+
+  tee.AppendStream(s2);
+  ASSERT_EQ(2U, tee.GetNumStreams());
+  EXPECT_EQ(s1, tee.GetStreamAtIndex(0U));
+  EXPECT_EQ(s2, tee.GetStreamAtIndex(1U));
+}
+
+TEST(StreamTeeTest, GetStreamAtIndexOutOfBounds) {
+  // The index we check for is not in the bounds of the StreamTee.
+  lldb::StreamSP s1(std::make_shared<StreamString>());
+  StreamTee tee(s1);
+
+  ASSERT_EQ(1U, tee.GetNumStreams());
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(1));
+}
+
+TEST(StreamTeeTest, GetStreamAtIndexOutOfBoundsEmpty) {
+  // Same as above, but with an empty StreamTee.
+  StreamTee tee;
+  ASSERT_EQ(0U, tee.GetNumStreams());
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(0U));
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(1U));
+}
+
+TEST(StreamTeeTest, SetStreamAtIndexOverwrite) {
+  // We overwrite an existing stream at a given index.
+  lldb::StreamSP s1(std::make_shared<StreamString>());
+  StreamTee tee(s1);
+
+  ASSERT_EQ(1U, tee.GetNumStreams());
+  EXPECT_EQ(s1, tee.GetStreamAtIndex(0U));
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(1U));
+
+  lldb::StreamSP s2(std::make_shared<StreamString>());
+  tee.SetStreamAtIndex(0U, s2);
+  EXPECT_EQ(1U, tee.GetNumStreams());
+  EXPECT_EQ(s2, tee.GetStreamAtIndex(0U));
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(1));
+}
+
+TEST(StreamTeeTest, SetStreamAtIndexOutOfBounds) {
+  // We place a new stream out of the bounds of the current StreamTee.
+  lldb::StreamSP s1(std::make_shared<StreamString>());
+  StreamTee tee(s1);
+
+  ASSERT_EQ(1U, tee.GetNumStreams());
+  EXPECT_EQ(s1, tee.GetStreamAtIndex(0U));
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(1U));
+
+  // Place a new stream out of bounds of the current array. The StreamTee should
+  // resize itself until it can contain this index.
+  lldb::StreamSP s2(std::make_shared<StreamString>());
+  tee.SetStreamAtIndex(4U, s2);
+  // Check that the vector has been resized.
+  EXPECT_EQ(5U, tee.GetNumStreams());
+  // Is our stream at the right place?
+  EXPECT_EQ(s2, tee.GetStreamAtIndex(4U));
+
+  // Existing stream should still be there.
+  EXPECT_EQ(s1, tee.GetStreamAtIndex(0U));
+  // Other elements are all invalid StreamSPs.
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(1U));
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(2U));
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(3U));
+  EXPECT_EQ(lldb::StreamSP(), tee.GetStreamAtIndex(5U));
+}