Add TestMetadata struct

emil-e · Oct 24, 2015 · 47bafd8 · 47bafd8
1 parent 3c12977
commit 47bafd8
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 0 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -39,6 +39,7 @@ add_library(rapidcheck
   src/detail/PropertyContext.cpp
   src/detail/Results.cpp
   src/detail/Serialization.cpp
+  src/detail/TestMetadata.cpp
   src/detail/TestParams.cpp
   src/detail/Testing.cpp
   src/gen/Numeric.cpp

diff --git a/include/rapidcheck/detail/TestMetadata.h b/include/rapidcheck/detail/TestMetadata.h
@@ -0,0 +1,22 @@
+#pragma once
+
+#include <string>
+#include <iostream>
+
+namespace rc {
+namespace detail {
+
+/// Describes a property.
+struct TestMetadata {
+  /// A unique identifier for the test.
+  std::string id;
+  /// A description of the test.
+  std::string description;
+};
+
+std::ostream &operator<<(std::ostream &os, const TestMetadata &info);
+bool operator==(const TestMetadata &lhs, const TestMetadata &rhs);
+bool operator!=(const TestMetadata &lhs, const TestMetadata &rhs);
+
+} // namespace detail
+} // namespace rc
diff --git a/src/detail/TestMetadata.cpp b/src/detail/TestMetadata.cpp
@@ -0,0 +1,20 @@
+#include "rapidcheck/detail/TestMetadata.h"
+
+namespace rc {
+namespace detail {
+
+std::ostream &operator<<(std::ostream &os, const TestMetadata &info) {
+  os << "id='" << info.id << "', description='" << info.description << "'";
+  return os;
+}
+
+bool operator==(const TestMetadata &lhs, const TestMetadata &rhs) {
+  return (lhs.id == rhs.id) && (lhs.description == rhs.description);
+}
+
+bool operator!=(const TestMetadata &lhs, const TestMetadata &rhs) {
+  return !(lhs == rhs);
+}
+
+} // namespace detail
+} // namespace rc
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -33,6 +33,7 @@ add_executable(rapidcheck_tests
   detail/ResultsTests.cpp
   detail/SerializationTests.cpp
   detail/ShowTypeTests.cpp
+  detail/TestMetadataTests.cpp
   detail/TestParamsTests.cpp
   detail/TestingTests.cpp
   detail/VariantTests.cpp

diff --git a/test/detail/TestMetadataTests.cpp b/test/detail/TestMetadataTests.cpp
@@ -0,0 +1,20 @@
+#include <catch.hpp>
+#include <rapidcheck/catch.h>
+
+#include "rapidcheck/detail/TestMetadata.h"
+
+#include "util/TemplateProps.h"
+#include "util/Generators.h"
+
+using namespace rc;
+using namespace rc::detail;
+
+TEST_CASE("TestMetadata") {
+  SECTION("operator==/operator!=") {
+    propConformsToEquals<TestMetadata>();
+    PROP_REPLACE_MEMBER_INEQUAL(TestMetadata, id);
+    PROP_REPLACE_MEMBER_INEQUAL(TestMetadata, description);
+  }
+
+  SECTION("operator<<") { propConformsToOutputOperator<TestMetadata>(); }
+}
diff --git a/test/util/Generators.h b/test/util/Generators.h
@@ -6,6 +6,7 @@
 #include "rapidcheck/shrinkable/Create.h"
 #include "rapidcheck/Maybe.h"
 #include "rapidcheck/seq/Create.h"
+#include "rapidcheck/detail/TestMetadata.h"
 
 #include "util/ArbitraryRandom.h"
 
@@ -117,6 +118,15 @@ struct Arbitrary<detail::CaseDescription> {
   }
 };
 
+template <>
+struct Arbitrary<detail::TestMetadata> {
+  static Gen<detail::TestMetadata> arbitrary() {
+    return gen::build<detail::TestMetadata>(
+        gen::set(&detail::TestMetadata::id),
+        gen::set(&detail::TestMetadata::description));
+  }
+};
+
 template <typename T>
 struct Arbitrary<Seq<T>> {
   static Gen<Seq<T>> arbitrary() {