Chris@50: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
Chris@50: // Licensed under the MIT License:
Chris@50: //
Chris@50: // Permission is hereby granted, free of charge, to any person obtaining a copy
Chris@50: // of this software and associated documentation files (the "Software"), to deal
Chris@50: // in the Software without restriction, including without limitation the rights
Chris@50: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Chris@50: // copies of the Software, and to permit persons to whom the Software is
Chris@50: // furnished to do so, subject to the following conditions:
Chris@50: //
Chris@50: // The above copyright notice and this permission notice shall be included in
Chris@50: // all copies or substantial portions of the Software.
Chris@50: //
Chris@50: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Chris@50: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Chris@50: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Chris@50: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Chris@50: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Chris@50: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Chris@50: // THE SOFTWARE.
Chris@50: 
Chris@50: #ifndef CAPNP_TEST_UTIL_H_
Chris@50: #define CAPNP_TEST_UTIL_H_
Chris@50: 
Chris@50: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS)
Chris@50: #pragma GCC system_header
Chris@50: #endif
Chris@50: 
Chris@50: #include <capnp/test.capnp.h>
Chris@50: #include <iostream>
Chris@50: #include "blob.h"
Chris@50: #include <kj/compat/gtest.h>
Chris@50: 
Chris@50: #if !CAPNP_LITE
Chris@50: #include "dynamic.h"
Chris@50: #endif  // !CAPNP_LITE
Chris@50: 
Chris@50: #if KJ_NO_EXCEPTIONS
Chris@50: #undef EXPECT_ANY_THROW
Chris@50: #define EXPECT_ANY_THROW(code) EXPECT_DEATH(code, ".")
Chris@50: #endif
Chris@50: 
Chris@50: #define EXPECT_NONFATAL_FAILURE(code) \
Chris@50:   EXPECT_TRUE(kj::runCatchingExceptions([&]() { code; }) != nullptr);
Chris@50: 
Chris@50: #ifdef KJ_DEBUG
Chris@50: #define EXPECT_DEBUG_ANY_THROW EXPECT_ANY_THROW
Chris@50: #else
Chris@50: #define EXPECT_DEBUG_ANY_THROW(EXP)
Chris@50: #endif
Chris@50: 
Chris@50: // TODO(cleanup): Auto-generate stringification functions for union discriminants.
Chris@50: namespace capnproto_test {
Chris@50: namespace capnp {
Chris@50: namespace test {
Chris@50: inline kj::String KJ_STRINGIFY(TestUnion::Union0::Which which) {
Chris@50:   return kj::str(static_cast<uint16_t>(which));
Chris@50: }
Chris@50: inline kj::String KJ_STRINGIFY(TestUnion::Union1::Which which) {
Chris@50:   return kj::str(static_cast<uint16_t>(which));
Chris@50: }
Chris@50: inline kj::String KJ_STRINGIFY(TestUnion::Union2::Which which) {
Chris@50:   return kj::str(static_cast<uint16_t>(which));
Chris@50: }
Chris@50: inline kj::String KJ_STRINGIFY(TestUnion::Union3::Which which) {
Chris@50:   return kj::str(static_cast<uint16_t>(which));
Chris@50: }
Chris@50: inline kj::String KJ_STRINGIFY(TestUnnamedUnion::Which which) {
Chris@50:   return kj::str(static_cast<uint16_t>(which));
Chris@50: }
Chris@50: inline kj::String KJ_STRINGIFY(TestGroups::Groups::Which which) {
Chris@50:   return kj::str(static_cast<uint16_t>(which));
Chris@50: }
Chris@50: inline kj::String KJ_STRINGIFY(TestInterleavedGroups::Group1::Which which) {
Chris@50:   return kj::str(static_cast<uint16_t>(which));
Chris@50: }
Chris@50: }  // namespace test
Chris@50: }  // namespace capnp
Chris@50: }  // namespace capnproto_test
Chris@50: 
Chris@50: namespace capnp {
Chris@50: namespace _ {  // private
Chris@50: 
Chris@50: inline Data::Reader data(const char* str) {
Chris@50:   return Data::Reader(reinterpret_cast<const byte*>(str), strlen(str));
Chris@50: }
Chris@50: 
Chris@50: namespace test = capnproto_test::capnp::test;
Chris@50: 
Chris@50: // We don't use "using namespace" to pull these in because then things would still compile
Chris@50: // correctly if they were generated in the global namespace.
Chris@50: using ::capnproto_test::capnp::test::TestAllTypes;
Chris@50: using ::capnproto_test::capnp::test::TestDefaults;
Chris@50: using ::capnproto_test::capnp::test::TestEnum;
Chris@50: using ::capnproto_test::capnp::test::TestUnion;
Chris@50: using ::capnproto_test::capnp::test::TestUnionDefaults;
Chris@50: using ::capnproto_test::capnp::test::TestNestedTypes;
Chris@50: using ::capnproto_test::capnp::test::TestUsing;
Chris@50: using ::capnproto_test::capnp::test::TestListDefaults;
Chris@50: 
Chris@50: void initTestMessage(TestAllTypes::Builder builder);
Chris@50: void initTestMessage(TestDefaults::Builder builder);
Chris@50: void initTestMessage(TestListDefaults::Builder builder);
Chris@50: 
Chris@50: void checkTestMessage(TestAllTypes::Builder builder);
Chris@50: void checkTestMessage(TestDefaults::Builder builder);
Chris@50: void checkTestMessage(TestListDefaults::Builder builder);
Chris@50: 
Chris@50: void checkTestMessage(TestAllTypes::Reader reader);
Chris@50: void checkTestMessage(TestDefaults::Reader reader);
Chris@50: void checkTestMessage(TestListDefaults::Reader reader);
Chris@50: 
Chris@50: void checkTestMessageAllZero(TestAllTypes::Builder builder);
Chris@50: void checkTestMessageAllZero(TestAllTypes::Reader reader);
Chris@50: 
Chris@50: #if !CAPNP_LITE
Chris@50: void initDynamicTestMessage(DynamicStruct::Builder builder);
Chris@50: void initDynamicTestLists(DynamicStruct::Builder builder);
Chris@50: void checkDynamicTestMessage(DynamicStruct::Builder builder);
Chris@50: void checkDynamicTestLists(DynamicStruct::Builder builder);
Chris@50: void checkDynamicTestMessage(DynamicStruct::Reader reader);
Chris@50: void checkDynamicTestLists(DynamicStruct::Reader reader);
Chris@50: void checkDynamicTestMessageAllZero(DynamicStruct::Builder builder);
Chris@50: void checkDynamicTestMessageAllZero(DynamicStruct::Reader reader);
Chris@50: #endif  // !CAPNP_LITE
Chris@50: 
Chris@50: template <typename T>
Chris@50: inline void checkElement(T a, T b) {
Chris@50:   EXPECT_EQ(a, b);
Chris@50: }
Chris@50: 
Chris@50: template <>
Chris@50: inline void checkElement<float>(float a, float b) {
Chris@50:   EXPECT_FLOAT_EQ(a, b);
Chris@50: }
Chris@50: 
Chris@50: template <>
Chris@50: inline void checkElement<double>(double a, double b) {
Chris@50:   EXPECT_DOUBLE_EQ(a, b);
Chris@50: }
Chris@50: 
Chris@50: template <typename T, typename L = typename T::Reads>
Chris@50: void checkList(T reader, std::initializer_list<decltype(reader[0])> expected) {
Chris@50:   ASSERT_EQ(expected.size(), reader.size());
Chris@50:   for (uint i = 0; i < expected.size(); i++) {
Chris@50:     checkElement<decltype(reader[0])>(expected.begin()[i], reader[i]);
Chris@50:   }
Chris@50: }
Chris@50: 
Chris@50: template <typename T, typename L = typename T::Builds, bool = false>
Chris@50: void checkList(T reader, std::initializer_list<decltype(typename L::Reader()[0])> expected) {
Chris@50:   ASSERT_EQ(expected.size(), reader.size());
Chris@50:   for (uint i = 0; i < expected.size(); i++) {
Chris@50:     checkElement<decltype(typename L::Reader()[0])>(expected.begin()[i], reader[i]);
Chris@50:   }
Chris@50: }
Chris@50: 
Chris@50: inline void checkList(List<test::TestOldVersion>::Reader reader,
Chris@50:                       std::initializer_list<int64_t> expectedData,
Chris@50:                       std::initializer_list<Text::Reader> expectedPointers) {
Chris@50:   ASSERT_EQ(expectedData.size(), reader.size());
Chris@50:   for (uint i = 0; i < expectedData.size(); i++) {
Chris@50:     EXPECT_EQ(expectedData.begin()[i], reader[i].getOld1());
Chris@50:     EXPECT_EQ(expectedPointers.begin()[i], reader[i].getOld2());
Chris@50:   }
Chris@50: }
Chris@50: 
Chris@50: // Hack because as<>() is a template-parameter-dependent lookup everywhere below...
Chris@50: #define as template as
Chris@50: 
Chris@50: template <typename T> void expectPrimitiveEq(T a, T b) { EXPECT_EQ(a, b); }
Chris@50: inline void expectPrimitiveEq(float a, float b) { EXPECT_FLOAT_EQ(a, b); }
Chris@50: inline void expectPrimitiveEq(double a, double b) { EXPECT_DOUBLE_EQ(a, b); }
Chris@50: inline void expectPrimitiveEq(Text::Reader a, Text::Builder b) { EXPECT_EQ(a, b); }
Chris@50: inline void expectPrimitiveEq(Data::Reader a, Data::Builder b) { EXPECT_EQ(a, b); }
Chris@50: 
Chris@50: #if !CAPNP_LITE
Chris@50: template <typename Element, typename T>
Chris@50: void checkList(T reader, std::initializer_list<ReaderFor<Element>> expected) {
Chris@50:   auto list = reader.as<DynamicList>();
Chris@50:   ASSERT_EQ(expected.size(), list.size());
Chris@50:   for (uint i = 0; i < expected.size(); i++) {
Chris@50:     expectPrimitiveEq(expected.begin()[i], list[i].as<Element>());
Chris@50:   }
Chris@50: 
Chris@50:   auto typed = reader.as<List<Element>>();
Chris@50:   ASSERT_EQ(expected.size(), typed.size());
Chris@50:   for (uint i = 0; i < expected.size(); i++) {
Chris@50:     expectPrimitiveEq(expected.begin()[i], typed[i]);
Chris@50:   }
Chris@50: }
Chris@50: #endif  // !CAPNP_LITE
Chris@50: 
Chris@50: #undef as
Chris@50: 
Chris@50: // =======================================================================================
Chris@50: // Interface implementations.
Chris@50: 
Chris@50: #if !CAPNP_LITE
Chris@50: 
Chris@50: class TestInterfaceImpl final: public test::TestInterface::Server {
Chris@50: public:
Chris@50:   TestInterfaceImpl(int& callCount);
Chris@50: 
Chris@50:   kj::Promise<void> foo(FooContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> baz(BazContext context) override;
Chris@50: 
Chris@50: private:
Chris@50:   int& callCount;
Chris@50: };
Chris@50: 
Chris@50: class TestExtendsImpl final: public test::TestExtends2::Server {
Chris@50: public:
Chris@50:   TestExtendsImpl(int& callCount);
Chris@50: 
Chris@50:   kj::Promise<void> foo(FooContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> grault(GraultContext context) override;
Chris@50: 
Chris@50: private:
Chris@50:   int& callCount;
Chris@50: };
Chris@50: 
Chris@50: class TestPipelineImpl final: public test::TestPipeline::Server {
Chris@50: public:
Chris@50:   TestPipelineImpl(int& callCount);
Chris@50: 
Chris@50:   kj::Promise<void> getCap(GetCapContext context) override;
Chris@50: 
Chris@50: private:
Chris@50:   int& callCount;
Chris@50: };
Chris@50: 
Chris@50: class TestCallOrderImpl final: public test::TestCallOrder::Server {
Chris@50: public:
Chris@50:   kj::Promise<void> getCallSequence(GetCallSequenceContext context) override;
Chris@50: 
Chris@50: private:
Chris@50:   uint count = 0;
Chris@50: };
Chris@50: 
Chris@50: class TestTailCallerImpl final: public test::TestTailCaller::Server {
Chris@50: public:
Chris@50:   TestTailCallerImpl(int& callCount);
Chris@50: 
Chris@50:   kj::Promise<void> foo(FooContext context) override;
Chris@50: 
Chris@50: private:
Chris@50:   int& callCount;
Chris@50: };
Chris@50: 
Chris@50: class TestTailCalleeImpl final: public test::TestTailCallee::Server {
Chris@50: public:
Chris@50:   TestTailCalleeImpl(int& callCount);
Chris@50: 
Chris@50:   kj::Promise<void> foo(FooContext context) override;
Chris@50: 
Chris@50: private:
Chris@50:   int& callCount;
Chris@50: };
Chris@50: 
Chris@50: class TestMoreStuffImpl final: public test::TestMoreStuff::Server {
Chris@50: public:
Chris@50:   TestMoreStuffImpl(int& callCount, int& handleCount);
Chris@50: 
Chris@50:   kj::Promise<void> getCallSequence(GetCallSequenceContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> callFoo(CallFooContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> callFooWhenResolved(CallFooWhenResolvedContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> neverReturn(NeverReturnContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> hold(HoldContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> callHeld(CallHeldContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> getHeld(GetHeldContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> echo(EchoContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> expectCancel(ExpectCancelContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> getHandle(GetHandleContext context) override;
Chris@50: 
Chris@50:   kj::Promise<void> getNull(GetNullContext context) override;
Chris@50: 
Chris@50: private:
Chris@50:   int& callCount;
Chris@50:   int& handleCount;
Chris@50:   test::TestInterface::Client clientToHold = nullptr;
Chris@50: 
Chris@50:   kj::Promise<void> loop(uint depth, test::TestInterface::Client cap, ExpectCancelContext context);
Chris@50: };
Chris@50: 
Chris@50: class TestCapDestructor final: public test::TestInterface::Server {
Chris@50:   // Implementation of TestInterface that notifies when it is destroyed.
Chris@50: 
Chris@50: public:
Chris@50:   TestCapDestructor(kj::Own<kj::PromiseFulfiller<void>>&& fulfiller)
Chris@50:       : fulfiller(kj::mv(fulfiller)), impl(dummy) {}
Chris@50: 
Chris@50:   ~TestCapDestructor() {
Chris@50:     fulfiller->fulfill();
Chris@50:   }
Chris@50: 
Chris@50:   kj::Promise<void> foo(FooContext context) {
Chris@50:     return impl.foo(context);
Chris@50:   }
Chris@50: 
Chris@50: private:
Chris@50:   kj::Own<kj::PromiseFulfiller<void>> fulfiller;
Chris@50:   int dummy = 0;
Chris@50:   TestInterfaceImpl impl;
Chris@50: };
Chris@50: 
Chris@50: #endif  // !CAPNP_LITE
Chris@50: 
Chris@50: }  // namespace _ (private)
Chris@50: }  // namespace capnp
Chris@50: 
Chris@50: #endif  // TEST_UTIL_H_