[Reproducers] Improve reproducer API and add unit tests.

[JDevlieghere]

Summary

When I landed the initial reproducer framework I knew there were some things that needed improvement. Rather than bundling it with a patch that adds more functionality I split it off into this patch. I also think the API is stable enough to add unit testing, which is included in this patch as well.

Other improvements include:

• Refactor how we initialize the loader and generator.
• Improve naming consistency: capture and replay seems the least ambiguous.
• Index providers by name and make sure there's only one of each.
• Add convenience methods for creating and accessing providers.

[sgraenitz]

Looks pretty good to me, but added my 2¢ on minor things.

include/lldb/Utility/Reproducer.h

169

Are the default-value-cases necessary?

source/API/SBDebugger.cpp

1064

Will the error be passed up the stack soon? Otherwise maybe add FIXME comment?

source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp

303

In which case would GetOrCreate() fail?

3440

Brackets

unittests/Utility/ReproducerTest.cpp

37

It may be good to know what went wrong if this fails. And: are the other EXPECTs still relevant in the error-case?

If SetCapture() can fail in this particular situation, you may want to do something like:

if (error)
  FAIL() << llvm::toString(std::move(error));

Otherwise, if this was only to prepare the test and you wanted to indicate that it's not supposed to fail, then you could do:

llvm::cantFail(reproducer.SetCapture(true, FileSpec("/bogus/path"));

[JDevlieghere]

Address Stefan's review feedback.

[JDevlieghere]

Missed a comment; fixed now.

[JDevlieghere]

Simplify code a little, as per Stefan's (offline) suggestion.

[labath]

include/lldb/Utility/Reproducer.h

59–64

Could this be replaced by additional arguments to the constructor (avoiding two-stage initialization)?

107

Is the value of the NAME used anywhere? If not, you could just have each class define a char variable (like llvm::ErrorInfo subclasses do) and then use its address as a key, making everything faster.

(Even if name is useful (for printing to the user or whatever), it might be worth to switch to using the char-address for lookup and then just have getName method for other things.)

source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp

303

could GetOrCreate keep returning a reference (to avoid spurious guaranteed to be not null comments)?

source/Utility/Reproducer.cpp

140–142

Given these limitations, would it be possible to set the root once in the constructor and keep it immutable since then?

unittests/Utility/ReproducerTest.cpp

45–47

Shorter and with better error messages:
EXPECT_THAT_ERROR(reproducer.SetReplay(FileSpec("/bogus/path")), llvm::Succeeded());

80–82

EXPECT_THAT_ERROR(..., llvm::Failed());

[JDevlieghere]

Thanks Pavel, really useful feedback, I learned a few new things :-)

[JDevlieghere]

Does anybody want to have another look or can I land this?

[labath]

I haven't been following the reproducer work in detail, but this seems reasonable to me. Thanks for incorporating my drive-by suggestions.

include/lldb/Utility/Reproducer.h

93

You should still be able to use make_unique here.

122–126

Out of date comment.

[davide]

LGTM

include/lldb/Core/Debugger.h

public:
 
   llvm::StringRef GetPrompt() const;
 
   void SetPrompt(llvm::StringRef p);
   void SetPrompt(const char *) = delete;
 
   llvm::StringRef GetReproducerPath() const;
 
-  void SetReproducerPath(llvm::StringRef p);
-  void SetReproducerPath(const char *) = delete;
+  llvm::Error SetReproducerReplay(llvm::StringRef p);
+  llvm::Error SetReproducerReplay(const char *) = delete;
 
   llvm::Error SetReproducerCapture(bool b);
 
   bool GetUseExternalEditor() const;
 
   bool SetUseExternalEditor(bool use_external_editor_p);
 
   bool GetUseColor() const;

include/lldb/Utility/Reproducer.h

 /// its name and files to the index, before registering with the generator,
 /// i.e. in the constructor.
 ///
 /// Different components will implement different providers.
 class Provider {
 public:
   virtual ~Provider() = default;
 
-  const ProviderInfo &GetInfo() { return m_info; }
-  const FileSpec &GetDirectory() { return m_directory; }
+  const ProviderInfo &GetInfo() const { return m_info; }
+  const FileSpec &GetRoot() const { return m_root; }
 
   /// The Keep method is called when it is decided that we need to keep the
   /// data in order to provide a reproducer.
   virtual void Keep(){};
 
   /// The Discard method is called when it is decided that we do not need to
   /// keep any information and will not generate a reproducer.
   virtual void Discard(){};
 
 protected:
-  Provider(const FileSpec &directory) : m_directory(directory) {}
+  Provider(const FileSpec &root) : m_root(root) {}
+
+  void InitializeFileInfo(llvm::StringRef name,
+                          llvm::ArrayRef<std::string> files) {
+    m_info.name = name;
+    for (auto file : files)
+      m_info.files.push_back(file);
+  }
 
   /// Every provider keeps track of its own files.
   ProviderInfo m_info;
 
 private:
   /// Every provider knows where to dump its potential files.
-  FileSpec m_directory;
+  FileSpec m_root;
 };
 
 /// The generator is responsible for the logic needed to generate a
 /// reproducer. For doing so it relies on providers, who serialize data that
 /// is necessary for reproducing  a failure.
 class Generator final {
 public:
-  Generator();
+  Generator(const FileSpec &root);
   ~Generator();
 
   /// Method to indicate we want to keep the reproducer. If reproducer
   /// generation is disabled, this does nothing.
   void Keep();
 
   /// Method to indicate we do not want to keep the reproducer. This is
   /// unaffected by whether or not generation reproduction is enabled, as we
   /// might need to clean up files already written to disk.
   void Discard();
 
-  /// Providers are registered at creating time.
-  template <typename T> T &CreateProvider() {
-    std::unique_ptr<T> provider = llvm::make_unique<T>(m_directory);
-    return static_cast<T &>(Register(std::move(provider)));
+  /// Create and register a new provider.
+  template <typename T> T *Create() {
+    std::unique_ptr<T> provider = llvm::make_unique<T>(m_root);
+    return static_cast<T *>(Register(std::move(provider)));
+  }
+
+  /// Get an existing provider.
+  template <typename T> T *Get() {
+    auto it = m_providers.find(T::NAME);
+    if (it == m_providers.end())
+      return nullptr;
+    return static_cast<T *>(it->second.get());
   }
 
-  void ChangeDirectory(const FileSpec &directory);
-  const FileSpec &GetDirectory() const;
+  /// Get a provider if it exists, otherwise create it.
+  template <typename T> T *GetOrCreate() {
+    auto *provider = Get<T>();
+    if (provider)
+      return provider;
+    return Create<T>();
+  }
+
+  void ChangeRoot(const FileSpec &root);
+  const FileSpec &GetRoot() const;
 
 private:
   friend Reproducer;
 
   void SetEnabled(bool enabled) { m_enabled = enabled; }
-  Provider &Register(std::unique_ptr<Provider> provider);
-  void AddProviderToIndex(const ProviderInfo &provider_info);
+  Provider *Register(std::unique_ptr<Provider> provider);
 
-  std::vector<std::unique_ptr<Provider>> m_providers;
+  /// Builds and index with provider info.
+  void AddProvidersToIndex();
+
+  /// List of providers indexed by their name for easy access.
+  llvm::StringMap<std::unique_ptr<Provider>> m_providers;
   std::mutex m_providers_mutex;
 
   /// The reproducer root directory.
-  FileSpec m_directory;
+  FileSpec m_root;
 
   /// Flag for controlling whether we generate a reproducer when Keep is
   /// called.
   bool m_enabled;
 
   /// Flag to ensure that we never call both keep and discard.
   bool m_done;
 };
 
 class Loader final {
 public:
-  Loader();
+  Loader(const FileSpec &root);
 
   llvm::Optional<ProviderInfo> GetProviderInfo(llvm::StringRef name);
-  llvm::Error LoadIndex(const FileSpec &directory);
+  llvm::Error LoadIndex();
 
-  const FileSpec &GetDirectory() { return m_directory; }
+  const FileSpec &GetRoot() const { return m_root; }
 
 private:
   llvm::StringMap<ProviderInfo> m_provider_info;
-  FileSpec m_directory;
+  FileSpec m_root;
   bool m_loaded;
 };
 
 /// The reproducer enables clients to obtain access to the Generator and
 /// Loader.
 class Reproducer final {
 
 public:
   static Reproducer &Instance();
 
   Generator *GetGenerator();
   Loader *GetLoader();
 
   const Generator *GetGenerator() const;
   const Loader *GetLoader() const;
 
-  llvm::Error SetGenerateReproducer(bool value);
-  llvm::Error SetReplayReproducer(bool value);
+  llvm::Error SetCapture(bool value, FileSpec root = {});
+  llvm::Error SetReplay(bool value, FileSpec root = {});
 
-  llvm::Error SetReproducerPath(const FileSpec &path);
   FileSpec GetReproducerPath() const;
 
 private:
-  Generator m_generator;
-  Loader m_loader;
-
-  bool m_generate_reproducer = false;
-  bool m_replay_reproducer = false;
+  llvm::Optional<Generator> m_generator;
+  llvm::Optional<Loader> m_loader;
 
   mutable std::mutex m_mutex;
 };
 
 } // namespace repro
 } // namespace lldb_private
 
 LLVM_YAML_IS_DOCUMENT_LIST_VECTOR(lldb_private::repro::ProviderInfo)

source/API/SBDebugger.cpp

 
 const char *SBDebugger::GetReproducerPath() const {
   return (m_opaque_sp
               ? ConstString(m_opaque_sp->GetReproducerPath()).GetCString()
               : nullptr);
 }
 
 void SBDebugger::SetReproducerPath(const char *p) {
-  if (m_opaque_sp)
-    m_opaque_sp->SetReproducerPath(llvm::StringRef::withNullAsEmpty(p));
+  if (m_opaque_sp) {
+    auto error =
+        m_opaque_sp->SetReproducerReplay(llvm::StringRef::withNullAsEmpty(p));
+    llvm::consumeError(std::move(error));
+  }
 }
 
 ScriptLanguage SBDebugger::GetScriptLanguage() const {
   return (m_opaque_sp ? m_opaque_sp->GetScriptLanguage() : eScriptLanguageNone);
 }
 
 void SBDebugger::SetScriptLanguage(ScriptLanguage script_lang) {
   if (m_opaque_sp) {

source/Commands/CommandObjectReproducer.cpp

if (command.empty()) {
       result.AppendErrorWithFormat(
           "'%s' takes a single argument: the reproducer path",
           m_cmd_name.c_str());
       return false;
     }
 
     auto &r = repro::Reproducer::Instance();
 
-    if (auto e = r.SetReplayReproducer(true)) {
-      std::string error_str = llvm::toString(std::move(e));
-      result.AppendErrorWithFormat("%s", error_str.c_str());
-      return false;
-    }
-
-    if (auto loader = r.GetLoader()) {
-      const char *repro_path = command.GetArgumentAtIndex(0);
-      if (auto e = loader->LoadIndex(FileSpec(repro_path))) {
-        std::string error_str = llvm::toString(std::move(e));
-        result.AppendErrorWithFormat("Unable to load reproducer: %s",
-                                     error_str.c_str());
-        return false;
-      }
-    } else {
-      result.AppendErrorWithFormat("Unable to get the reproducer loader");
+    if (auto e = r.SetReplay(true, FileSpec(repro_path))) {
+      result.AppendErrorWithFormat("%s", error_str.c_str());
       return false;
     }
 
     result.SetStatus(eReturnStatusSuccessFinishNoResult);
     return result.Succeeded();
   }
 };
 

source/Core/Debugger.cpp

void Debugger::SetPrompt(llvm::StringRef p) {
   GetCommandInterpreter().UpdatePrompt(new_prompt);
 }
 
 llvm::StringRef Debugger::GetReproducerPath() const {
   auto &r = repro::Reproducer::Instance();
   return r.GetReproducerPath().GetCString();
 }
 
-void Debugger::SetReproducerPath(llvm::StringRef p) {
+llvm::Error Debugger::SetReproducerReplay(llvm::StringRef p) {
   auto &r = repro::Reproducer::Instance();
-  if (auto e = r.SetReproducerPath(FileSpec(p)))
-    llvm::consumeError(std::move(e));
+  if (auto e = r.SetReplay(true, FileSpec(p)))
+    return e;
+  return llvm::Error::success();
 }
 
 llvm::Error Debugger::SetReproducerCapture(bool b) {
   auto &r = repro::Reproducer::Instance();
-  if (auto e = r.SetGenerateReproducer(b))
+  auto root = HostInfo::GetReproducerTempDir();
+  if (auto e = r.SetCapture(b, root))
     return e;
   return llvm::Error::success();
 }
 
 const FormatEntity::Entry *Debugger::GetThreadFormat() const {
   const uint32_t idx = ePropertyThreadFormat;
   return m_collection_sp->GetPropertyAtIndexAsFormatEntity(nullptr, idx);
 }

source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp

static const ProcessKDPPropertiesSP &GetGlobalPluginProperties() {
   static ProcessKDPPropertiesSP g_settings_sp;
   if (!g_settings_sp)
     g_settings_sp.reset(new PluginProperties());
   return g_settings_sp;
 }
 
 class ProcessGDBRemoteProvider : public repro::Provider {
 public:
+  static constexpr const char *NAME = "gdb-remote";
+
   ProcessGDBRemoteProvider(const FileSpec &directory) : Provider(directory) {
-    m_info.name = "gdb-remote";
-    m_info.files.push_back("gdb-remote.yaml");
+    InitializeFileInfo(NAME, {"gdb-remote.yaml"});
   }
 
   raw_ostream *GetHistoryStream() {
     FileSpec history_file =
-        GetDirectory().CopyByAppendingPathComponent("gdb-remote.yaml");
+        GetRoot().CopyByAppendingPathComponent("gdb-remote.yaml");
 
     std::error_code EC;
     m_stream_up = llvm::make_unique<raw_fd_ostream>(history_file.GetPath(), EC,
                                                     sys::fs::OpenFlags::F_None);
     return m_stream_up.get();
   }
 
   void SetCallback(std::function<void()> callback) {
: Process(target_sp, listener_sp),
       m_allow_flash_writes(false), m_erased_flash_ranges() {
   m_async_broadcaster.SetEventName(eBroadcastBitAsyncThreadShouldExit,
                                    "async thread should exit");
   m_async_broadcaster.SetEventName(eBroadcastBitAsyncContinue,
                                    "async thread continue");
   m_async_broadcaster.SetEventName(eBroadcastBitAsyncThreadDidExit,
                                    "async thread did exit");
 
-  repro::Generator *generator = repro::Reproducer::Instance().GetGenerator();
-  if (generator) {
-    ProcessGDBRemoteProvider &provider =
-        generator->CreateProvider<ProcessGDBRemoteProvider>();
+  if (repro::Generator *g = repro::Reproducer::Instance().GetGenerator()) {
+    if (ProcessGDBRemoteProvider *provider =
+            g->GetOrCreate<ProcessGDBRemoteProvider>()) {
       // Set the history stream to the stream owned by the provider.
-    m_gdb_comm.SetHistoryStream(provider.GetHistoryStream());
+      m_gdb_comm.SetHistoryStream(provider->GetHistoryStream());
       // Make sure to clear the stream again when we're finished.
-    provider.SetCallback([&]() { m_gdb_comm.SetHistoryStream(nullptr); });
+      provider->SetCallback([&]() { m_gdb_comm.SetHistoryStream(nullptr); });
+    }
   }
 
   Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_ASYNC));
 
   const uint32_t async_event_mask =
       eBroadcastBitAsyncContinue | eBroadcastBitAsyncThreadShouldExit;
 
   if (m_async_listener_sp->StartListeningForEvents(
Status ProcessGDBRemote::ConnectToReplayServer(repro::Loader *loader) {
   auto provider_info = loader->GetProviderInfo("gdb-remote");
   if (!provider_info)
     return Status("No provider for gdb-remote.");
 
   if (provider_info->files.empty())
     return Status("Provider for  gdb-remote contains no files.");
 
   // Construct replay history path.
-  FileSpec history_file(loader->GetDirectory());
+  FileSpec history_file = (loader->GetRoot());
   history_file.AppendPathComponent(provider_info->files.front());
 
   // Enable replay mode.
   m_replay_mode = true;
 
   // Load replay history.
   if (auto error = m_gdb_replay_server.LoadReplayHistory(history_file))
     return Status("Unable to load replay history");

source/Utility/Reproducer.cpp

 //===-- Reproducer.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/Reproducer.h"
-#include "lldb/Host/HostInfo.h"
 
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/Threading.h"
 #include "llvm/Support/raw_ostream.h"
 
 using namespace lldb_private;
 using namespace lldb_private::repro;
 using namespace llvm;
 using namespace llvm::yaml;
 
 Reproducer &Reproducer::Instance() {
   static Reproducer g_reproducer;
   return g_reproducer;
 }
 
 const Generator *Reproducer::GetGenerator() const {
   std::lock_guard<std::mutex> guard(m_mutex);
-  if (m_generate_reproducer)
-    return &m_generator;
+  if (m_generator)
+    return &(*m_generator);
   return nullptr;
 }
 
 const Loader *Reproducer::GetLoader() const {
   std::lock_guard<std::mutex> guard(m_mutex);
-  if (m_replay_reproducer)
-    return &m_loader;
+  if (m_loader)
+    return &(*m_loader);
   return nullptr;
 }
 
 Generator *Reproducer::GetGenerator() {
   std::lock_guard<std::mutex> guard(m_mutex);
-  if (m_generate_reproducer)
-    return &m_generator;
+  if (m_generator)
+    return &(*m_generator);
   return nullptr;
 }
 
 Loader *Reproducer::GetLoader() {
   std::lock_guard<std::mutex> guard(m_mutex);
-  if (m_replay_reproducer)
-    return &m_loader;
+  if (m_loader)
+    return &(*m_loader);
   return nullptr;
 }
 
-llvm::Error Reproducer::SetGenerateReproducer(bool value) {
+llvm::Error Reproducer::SetCapture(bool value, FileSpec root) {
   std::lock_guard<std::mutex> guard(m_mutex);
 
-  if (value && m_replay_reproducer)
+  if (value && m_loader)
     return make_error<StringError>(
         "cannot generate a reproducer when replay one",
         inconvertibleErrorCode());
 
-  m_generate_reproducer = value;
-  m_generator.SetEnabled(value);
+  if (value) {
+    m_generator.emplace(root);
+    m_generator->SetEnabled(value);
+  } else {
+    m_generator.reset();
+  }
 
   return Error::success();
 }
 
-llvm::Error Reproducer::SetReplayReproducer(bool value) {
+llvm::Error Reproducer::SetReplay(bool value, FileSpec root) {
   std::lock_guard<std::mutex> guard(m_mutex);
 
-  if (value && m_generate_reproducer)
+  if (value && m_generator)
     return make_error<StringError>(
         "cannot replay a reproducer when generating one",
         inconvertibleErrorCode());
 
-  m_replay_reproducer = value;
-
-  return Error::success();
-}
-
-llvm::Error Reproducer::SetReproducerPath(const FileSpec &path) {
-  // Setting the path implies using the reproducer.
-  if (auto e = SetReplayReproducer(true))
-    return e;
-
-  // Tell the reproducer to load the index form the given path.
-  if (auto loader = GetLoader()) {
-    if (auto e = loader->LoadIndex(path))
+  if (value) {
+    m_loader.emplace(root);
+    if (auto e = m_loader->LoadIndex())
       return e;
+  } else {
+    m_loader.reset();
   }
 
-  return make_error<StringError>("unable to get loader",
-                                 inconvertibleErrorCode());
+  return Error::success();
 }
 
 FileSpec Reproducer::GetReproducerPath() const {
   if (auto g = GetGenerator())
-    return g->GetDirectory();
+    return g->GetRoot();
+  if (auto l = GetLoader())
+    return l->GetRoot();
   return {};
 }
 
-Generator::Generator() : m_enabled(false), m_done(false) {
-  m_directory = HostInfo::GetReproducerTempDir();
-}
+Generator::Generator(const FileSpec &root)
+    : m_root(root), m_enabled(false), m_done(false) {}
 
 Generator::~Generator() {}
 
-Provider &Generator::Register(std::unique_ptr<Provider> provider) {
+Provider *Generator::Register(std::unique_ptr<Provider> provider) {
   std::lock_guard<std::mutex> lock(m_providers_mutex);
-
-  AddProviderToIndex(provider->GetInfo());
-
-  m_providers.push_back(std::move(provider));
-  return *m_providers.back();
+  std::string provider_name = provider->GetInfo().name;
+  std::pair<StringRef, std::unique_ptr<Provider>> key_value(
+      provider_name, std::move(provider));
+  auto e = m_providers.insert(std::move(key_value));
+  return e.first->getValue().get();
 }
 
 void Generator::Keep() {
   assert(!m_done);
   m_done = true;
 
   if (!m_enabled)
     return;
 
   for (auto &provider : m_providers)
-    provider->Keep();
+    provider.second->Keep();
+
+  AddProvidersToIndex();
 }
 
 void Generator::Discard() {
   assert(!m_done);
   m_done = true;
 
   if (!m_enabled)
     return;
 
   for (auto &provider : m_providers)
-    provider->Discard();
+    provider.second->Discard();
 
-  llvm::sys::fs::remove_directories(m_directory.GetPath());
+  llvm::sys::fs::remove_directories(m_root.GetPath());
 }
 
-void Generator::ChangeDirectory(const FileSpec &directory) {
-  assert(m_providers.empty() && "Changing the directory after providers have "
-                                "been registered would invalidate the index.");
-  m_directory = directory;
+void Generator::ChangeRoot(const FileSpec &root) {
+  assert(m_providers.empty() &&
+         "Changing the root directory after providers have "
+  m_root = root;
 }
 
-const FileSpec &Generator::GetDirectory() const { return m_directory; }
+const FileSpec &Generator::GetRoot() const { return m_root; }
 
-void Generator::AddProviderToIndex(const ProviderInfo &provider_info) {
-  FileSpec index = m_directory;
+void Generator::AddProvidersToIndex() {
+  FileSpec index = m_root;
   index.AppendPathComponent("index.yaml");
 
   std::error_code EC;
   auto strm = llvm::make_unique<raw_fd_ostream>(index.GetPath(), EC,
                                                 sys::fs::OpenFlags::F_None);
   yaml::Output yout(*strm);
+
+  for (auto &provider : m_providers) {
+    auto &provider_info = provider.second->GetInfo();
     yout << const_cast<ProviderInfo &>(provider_info);
   }
+}
 
-Loader::Loader() : m_loaded(false) {}
+Loader::Loader(const FileSpec &root) : m_root(root), m_loaded(false) {}
 
-llvm::Error Loader::LoadIndex(const FileSpec &directory) {
+llvm::Error Loader::LoadIndex() {
   if (m_loaded)
     return llvm::Error::success();
 
-  FileSpec index = directory.CopyByAppendingPathComponent("index.yaml");
+  FileSpec index = m_root.CopyByAppendingPathComponent("index.yaml");
 
   auto error_or_file = MemoryBuffer::getFile(index.GetPath());
   if (auto err = error_or_file.getError())
     return errorCodeToError(err);
 
   std::vector<ProviderInfo> provider_info;
   yaml::Input yin((*error_or_file)->getBuffer());
   yin >> provider_info;
 
   if (auto err = yin.error())
     return errorCodeToError(err);
 
   for (auto &info : provider_info)
     m_provider_info[info.name] = info;
 
-  m_directory = directory;
   m_loaded = true;
 
   return llvm::Error::success();
 }
 
 llvm::Optional<ProviderInfo> Loader::GetProviderInfo(StringRef name) {
   assert(m_loaded);
 
   auto it = m_provider_info.find(name);
   if (it == m_provider_info.end())
     return llvm::None;
 
   return it->second;
 }

unittests/Utility/CMakeLists.txt

add_lldb_unittest(UtilityTests
   EnvironmentTest.cpp
   FileSpecTest.cpp
   FlagsTest.cpp
   JSONTest.cpp
   LogTest.cpp
   NameMatchesTest.cpp
   PredicateTest.cpp
   RegisterValueTest.cpp
+  ReproducerTest.cpp
   ScalarTest.cpp
   StateTest.cpp
   StatusTest.cpp
   StreamTeeTest.cpp
   StreamTest.cpp
   StringExtractorTest.cpp
   StringLexerTest.cpp
   StringListTest.cpp

unittests/Utility/ReproducerTest.cpp

+//===-- ReproducerTest.cpp --------------------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "gtest/gtest.h"
+
+#include "lldb/Utility/FileSpec.h"
+#include "lldb/Utility/Reproducer.h"
+
+using namespace lldb_private;
+using namespace lldb_private::repro;
+
+class DummyProvider : public repro::Provider {
+public:
+  static constexpr const char *NAME = "dummy";
+
+  DummyProvider(const FileSpec &directory) : Provider(directory) {
+    InitializeFileInfo(NAME, {"dummy.yaml"});
+  }
+};
+
+TEST(ReproducerTest, SetCapture) {
+  Reproducer reproducer;
+
+  // Initially both generator and loader are unset.
+  EXPECT_EQ(nullptr, reproducer.GetGenerator());
+  EXPECT_EQ(nullptr, reproducer.GetLoader());
+
+  // Enable capture and check that means we have a generator.
+  {
+    auto error = reproducer.SetCapture(true, FileSpec("/bogus/path"));
+    EXPECT_FALSE(static_cast<bool>(error));
+    EXPECT_NE(nullptr, reproducer.GetGenerator());
+
+    // Make sure the bogus path is correctly set.
+    EXPECT_EQ(FileSpec("/bogus/path"), reproducer.GetGenerator()->GetRoot());
+    EXPECT_EQ(FileSpec("/bogus/path"), reproducer.GetReproducerPath());
+  }
+
+  // Ensure that we cannot enable replay.
+  {
+    auto error = reproducer.SetReplay(true);
+    EXPECT_TRUE(static_cast<bool>(error));
+    llvm::consumeError(std::move(error));
+    EXPECT_EQ(nullptr, reproducer.GetLoader());
+  }
+}
+
+TEST(ReproducerTest, SetReplay) {
+  Reproducer reproducer;
+
+  // Initially both generator and loader are unset.
+  EXPECT_EQ(nullptr, reproducer.GetGenerator());
+  EXPECT_EQ(nullptr, reproducer.GetLoader());
+
+  // Enable capture and check that means we have a generator.
+  {
+    auto error = reproducer.SetReplay(true, FileSpec("/bogus/path"));
+    // Expected to fail because we can't load the index.
+    EXPECT_TRUE(static_cast<bool>(error));
+    llvm::consumeError(std::move(error));
+    // However the loader should still be set, which we check here.
+    EXPECT_NE(nullptr, reproducer.GetLoader());
+
+    // Make sure the bogus path is correctly set.
+    EXPECT_EQ(FileSpec("/bogus/path"), reproducer.GetLoader()->GetRoot());
+    EXPECT_EQ(FileSpec("/bogus/path"), reproducer.GetReproducerPath());
+  }
+
+  // Ensure that we cannot enable replay.
+  {
+    auto error = reproducer.SetCapture(true);
+    EXPECT_TRUE(static_cast<bool>(error));
+    llvm::consumeError(std::move(error));
+    EXPECT_EQ(nullptr, reproducer.GetGenerator());
+  }
+}
+
+TEST(GeneratorTest, ChangeRoot) {
+  Reproducer reproducer;
+
+  auto error = reproducer.SetCapture(true, FileSpec("/bogus/path"));
+  EXPECT_FALSE(static_cast<bool>(error));
+  auto &generator = *reproducer.GetGenerator();
+
+  // As long as we haven't registered any providers this should work.
+  generator.ChangeRoot(FileSpec("/other/bogus/path"));
+
+  EXPECT_EQ(FileSpec("/other/bogus/path"),
+            reproducer.GetGenerator()->GetRoot());
+  EXPECT_EQ(FileSpec("/other/bogus/path"), reproducer.GetReproducerPath());
+}
+
+TEST(GeneratorTest, Create) {
+  Reproducer reproducer;
+
+  auto error = reproducer.SetCapture(true, FileSpec("/bogus/path"));
+  EXPECT_FALSE(static_cast<bool>(error));
+  auto &generator = *reproducer.GetGenerator();
+
+  auto *provider = generator.Create<DummyProvider>();
+  EXPECT_NE(nullptr, provider);
+  EXPECT_EQ(FileSpec("/bogus/path"), provider->GetRoot());
+  EXPECT_EQ(std::string("dummy"), provider->GetInfo().name);
+  EXPECT_EQ((size_t)1, provider->GetInfo().files.size());
+  EXPECT_EQ(std::string("dummy.yaml"), provider->GetInfo().files.front());
+}
+
+TEST(GeneratorTest, Get) {
+  Reproducer reproducer;
+
+  auto error = reproducer.SetCapture(true, FileSpec("/bogus/path"));
+  EXPECT_FALSE(static_cast<bool>(error));
+  auto &generator = *reproducer.GetGenerator();
+
+  auto *provider = generator.Create<DummyProvider>();
+  EXPECT_NE(nullptr, provider);
+
+  auto *provider_alt = generator.Get<DummyProvider>();
+  EXPECT_EQ(provider, provider_alt);
+}
+
+TEST(GeneratorTest, GetOrCreate) {
+  Reproducer reproducer;
+
+  auto error = reproducer.SetCapture(true, FileSpec("/bogus/path"));
+  EXPECT_FALSE(static_cast<bool>(error));
+  auto &generator = *reproducer.GetGenerator();
+
+  auto *provider = generator.GetOrCreate<DummyProvider>();
+  EXPECT_NE(nullptr, provider);
+  EXPECT_EQ(FileSpec("/bogus/path"), provider->GetRoot());
+  EXPECT_EQ(std::string("dummy"), provider->GetInfo().name);
+  EXPECT_EQ((size_t)1, provider->GetInfo().files.size());
+  EXPECT_EQ(std::string("dummy.yaml"), provider->GetInfo().files.front());
+
+  auto *provider_alt = generator.GetOrCreate<DummyProvider>();
+  EXPECT_EQ(provider, provider_alt);
+}