SeqTests.cpp

#include <catch2/catch.hpp>
#include <rapidcheck/catch.h>

#include "rapidcheck/Seq.h"

#include "util/Generators.h"
#include "util/TemplateProps.h"
#include "util/Logger.h"

using namespace rc;
using namespace rc::test;

namespace {

class LoggingSeqImpl : public Logger {
public:
  LoggingSeqImpl(std::string theId)
      : Logger(std::move(theId)) {}

  Maybe<std::pair<std::string, std::vector<std::string>>> operator()() {
    return {{id, log}};
  }
};

using LoggingSeq = Seq<std::pair<std::string, std::vector<std::string>>>;
}

TEST_CASE("Seq") {
  SECTION("default constructed Seq is empty") {
    REQUIRE_FALSE(Seq<int>().next());
  }

  SECTION("Nothing constructed Seq is empty") {
    REQUIRE_FALSE(Seq<int>(Nothing).next());
  }

  SECTION("calls operator()() of the implementation object") {
    bool nextCalled = false;
    Seq<int> seq = Seq<int>([&] {
      nextCalled = true;
      return Maybe<int>(1337);
    });

    REQUIRE(*seq.next() == 1337);
    REQUIRE(nextCalled);
  }

  SECTION("self assignment leaves value unchanged") {
    const auto seq = seq::just(1, 2);
    auto x = seq;
    auto &ref = x;
    x = ref;

    REQUIRE(x == seq);
  }

  SECTION("copies implementation if constructed from lvalue") {
    LoggingSeqImpl impl("foobar");
    LoggingSeq seq(impl);

    const auto value = seq.next();
    std::vector<std::string> expectedLog{"constructed as foobar",
                                         "copy constructed"};
    REQUIRE(value->first == "foobar");
    REQUIRE(value->second == expectedLog);
  }

  SECTION("moves implementation if constructed from rvalue") {
    LoggingSeq seq(LoggingSeqImpl("foobar"));
    const auto value = seq.next();

    std::vector<std::string> expectedLog{"constructed as foobar",
                                         "move constructed"};
    REQUIRE(value->first == "foobar");
    REQUIRE(value->second == expectedLog);
  }

  SECTION("copy construction copies the implementation object") {
    LoggingSeq original(LoggingSeqImpl("foobar"));
    auto copy(original);

    const auto value = copy.next();
    std::vector<std::string> expectedLog{
        "constructed as foobar", "move constructed", "copy constructed"};
    REQUIRE(value->first == "foobar");
    REQUIRE(value->second == expectedLog);
  }

  SECTION("copy assignment copies the implementation object") {
    LoggingSeq original(LoggingSeqImpl("foobar"));
    LoggingSeq copy;
    copy = original;

    const auto value = copy.next();
    std::vector<std::string> expectedLog{
        "constructed as foobar", "move constructed", "copy constructed"};
    REQUIRE(value->first == "foobar");
    REQUIRE(value->second == expectedLog);
  }

  SECTION("move construction neither moves nor copies") {
    LoggingSeq original(LoggingSeqImpl("foobar"));
    LoggingSeq moved(std::move(original));

    const auto value = moved.next();
    std::vector<std::string> expectedLog{"constructed as foobar",
                                         "move constructed"};
    REQUIRE(value->first == "foobar");
    REQUIRE(value->second == expectedLog);
  }

  SECTION("move assignment neither moves nor copies") {
    LoggingSeq original(LoggingSeqImpl("foobar"));
    LoggingSeq moved;
    moved = std::move(original);

    const auto value = moved.next();
    std::vector<std::string> expectedLog{"constructed as foobar",
                                         "move constructed"};
    REQUIRE(value->first == "foobar");
    REQUIRE(value->second == expectedLog);
  }

  SECTION("if exception is throw on next(), Seq ends immediately") {
    auto x = 0;
    const auto seq = Seq<int>([x]() mutable -> Maybe<int> {
      if (x == 3) {
        throw std::string("foobar");
      }
      return ++x;
    });

    REQUIRE(seq == seq::just(1, 2, 3));
  }

  SECTION("operator==/operator!=") {
    propConformsToEquals<Seq<std::string>>();

    SECTION("empty sequences are equal") { REQUIRE(Seq<int>() == Seq<int>()); }

    SECTION("an exhausted sequence equals an originally empty sequence") {
      auto seq = seq::just(1, 2, 3);
      seq.next();
      seq.next();
      seq.next();
      REQUIRE(seq == Seq<int>());
    }

    prop("sequences with different implementation classes can be equal",
         [](const std::string &a, const std::string &b, const std::string &c) {
           auto seqJust = seq::just(a, b, c);
           std::vector<std::string> vec{a, b, c};
           auto seqContainer = seq::fromContainer(vec);
           RC_ASSERT(seqJust == seqContainer);
         });

    prop("changing a single element leads to inequal sequences",
         [] {
           const auto elements1 = *gen::nonEmpty<std::vector<std::string>>();
           auto elements2 = elements1;
           const auto i = *gen::inRange<std::size_t>(0, elements2.size());
           elements2[i] = *gen::distinctFrom(elements2[i]);
           RC_ASSERT(seq::fromContainer(elements1) !=
                     seq::fromContainer(elements2));
         });
  }

  SECTION("makeSeq") {
    SECTION("constructs implementation object in place") {
      auto seq = makeSeq<LoggingSeqImpl>("foobar");
      const auto value = seq.next();
      REQUIRE(value->first == "foobar");
      std::vector<std::string> expectedLog{"constructed as foobar"};
      REQUIRE(value->second == expectedLog);
    }
  }
}