Initial C++ library

CMakeLists.txt

@@ -10,6 +10,7 @@ include(CTest)
 
 add_subdirectory(testcontainers-bridge)
 add_subdirectory(testcontainers-c)
+add_subdirectory(testcontainers-cpp)
 add_subdirectory(modules)
 if(NOT DEFINED SKIP_DEMOS)
     add_subdirectory(demo)

CONTRIBUTING.md

@@ -38,7 +38,7 @@ cmake -DSKIP_DEMOS=true .
 ## Contributing to the Documentation
 
 The documentation is structured in the MkDocs format and uses Material for MkDocs.
-To develop the site in this repository, start it in the [Dev Containers](.devcontainer/README.md)
+To develop the site in this repository, start it in a [Dev Container](.devcontainer/README.md)
 and use the following commands:
 
 ```shell
@@ -57,4 +57,4 @@ mkdocs build
 - `tc_` is used as a prefix for all exported Testcontainers functions
 - When possible, we try to avoid special Golang types in public API and try to expose wrapper types
 - `const` is important for users, and please add it to your arguments when possible.
-  There is no Const in Golang, so some `typedef` injection is needed when importing CGo
+  There is no `const` in Golang, so some `typedef` injection is needed when importing CGo

README.md

@@ -8,10 +8,8 @@
 [![Stability: Experimental](https://masterminds.github.io/stability/experimental.svg)](https://masterminds.github.io/stability/experimental.html)
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/oleg-nenashev/testcontainers-c)](https://github.com/oleg-nenashev/testcontainers-c/releases)
 
-!!! warning
-    This is a prototype.
-    There is a lot to do before it can be distributed and used in production, see the GitHub Issues
-    and the [project roadmap](./ROADMAP.md)
+> [!WARNING]
+> This is a prototype. There is a lot to do before it can be distributed and used in production, see the GitHub Issues and the [project roadmap](./ROADMAP.md)
 
 This is not a standalone [Testcontainers](https://testcontainers.org/) engine,
 but a C-style shared library adapter for native languages like C/C++, D, Lua, Swift, etc.
@@ -88,9 +86,7 @@ describes how it can be done in principle.
 ## Credits
 
 Using a complex Golang framework from C/C++ is not trivial.
-Neither the CMake files are.
-This project would not succeed without many quality articles
-and help from the community.
+Neither are the CMake files. This project would not succeed without many quality articles and help from the community.
 
 Kudos to:
 
@@ -102,7 +98,7 @@ Kudos to:
    [An Adventure into CGO - Calling Go code with C](https://medium.com/@ben.mcclelland/an-adventure-into-cgo-calling-go-code-with-c-b20aa6637e75)
 - [Insu Jang](https://github.com/insujang) for
   [Implementing Kubernetes C++ Client Library using Go Client Library](https://insujang.github.io/2019-11-28/implementing-kubernetes-cpp-client-library)
-- Infinite number of StackOverflow contributors
+- An infinite number of StackOverflow contributors
 
 ## Discuss
 

demo/CMakeLists.txt

@@ -2,3 +2,4 @@
 add_subdirectory(generic-container)
 add_subdirectory(wiremock)
 add_subdirectory(google-test)
+add_subdirectory(google-test-cpp)

demo/google-test-cpp/CMakeLists.txt

@@ -0,0 +1,32 @@
+# Google Test demo
+# This is based on https://google.github.io/googletest/quickstart-cmake.html
+cmake_minimum_required (VERSION 3.26)
+project (google-test-cpp-demo
+    VERSION 0.1.0
+    DESCRIPTION "Demonstrates usage of Testcontainers C++ in Google Test"
+    LANGUAGES CXX
+)
+
+set(TARGET_OUT ${PROJECT_NAME}.out)
+
+# GoogleTest requires at least C++14
+set(CMAKE_CXX_STANDARD 23)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+include(FetchContent)
+FetchContent_Declare(
+    googletest
+    GIT_REPOSITORY https://github.com/google/googletest.git
+    GIT_TAG v1.17.0
+)
+set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+FetchContent_MakeAvailable(googletest)
+
+enable_testing()
+file(COPY test_data DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
+
+add_executable(${TARGET_OUT} test.cpp)
+target_link_libraries(${TARGET_OUT} PRIVATE testcontainers-cpp)
+target_link_libraries(${TARGET_OUT} PRIVATE GTest::gtest_main)
+
+include(GoogleTest)
+gtest_discover_tests(${TARGET_OUT})

demo/google-test-cpp/README.md

@@ -0,0 +1,13 @@
+# Using Testcontainers C++ in Google Test
+
+Demonstrates usage of Testcontainers C++ in [Google
+Test](https://github.com/google/googletest). See
+[test.cpp](./test.cpp) for the code.
+
+## Run the demo
+
+```bash
+cmake -S . -B /tmp/tc-native
+cmake --build /tmp/tc-native/
+ctest --output-on-failure -R Class
+```

demo/google-test-cpp/test.cpp

@@ -0,0 +1,54 @@
+#include <gtest/gtest.h>
+
+#include <iostream>
+#include <string>
+
+#include "testcontainers.hpp"
+
+using namespace testcontainers;
+
+class WireMockTestContainerClass : public ::testing::Test {
+    const char* WIREMOCK_IMAGE                  = "wiremock/wiremock:3.0.1-1";
+    const char* WIREMOCK_ADMIN_MAPPING_ENDPOINT = "/__admin/mappings";
+
+protected:
+    void SetUp() override {
+        using namespace std::literals;
+
+        builder.expose_port(TcpPort{8080}).wait_for_http(TcpPort{8080}, WIREMOCK_ADMIN_MAPPING_ENDPOINT);
+    }
+
+    Container::Builder builder = Container::Builder{WIREMOCK_IMAGE};
+};
+
+/// This test runs a "Hello World" example.
+TEST_F(WireMockTestContainerClass, HelloWorld) {
+    auto container = builder.with_file("test_data/hello.json", "/home/wiremock/mappings/hello.json").build();
+    ASSERT_TRUE(container.has_value()) << "Failed to run the container";
+
+    auto [code, response] = container->send_http(HttpMethod::Get, TcpPort{8080}, "/hello");
+    ASSERT_EQ(code, 200) << "Expected 200 OK. Received response: " << response;
+}
+
+/// This test responds to an HTTP request with response from a
+/// prepared file.
+TEST_F(WireMockTestContainerClass, HelloWorldFromResource) {
+    auto container = builder.with_file("test_data/hello_with_resource.json", "/home/wiremock/mappings/hello2.json")
+                         .with_file("test_data/response.xml", "/home/wiremock/__files/response.xml")
+                         .build();
+    ASSERT_TRUE(container.has_value()) << "Failed to run the container";
+
+    auto [code, response] = container->send_http(HttpMethod::Get, TcpPort{8080}, "/hello-from-resource");
+    ASSERT_EQ(code, 200) << "Expected 200 OK. Received response: " << response;
+}
+
+/// This test performs a request that is guaranteed to fail and
+/// return an HTTP-500.
+TEST_F(WireMockTestContainerClass, HelloWorldFromMissingResource) {
+    auto container =
+        builder.with_file("test_data/hello_with_missing_resource.json", "/home/wiremock/mappings/hello3.json").build();
+    ASSERT_TRUE(container.has_value()) << "Failed to run the container";
+
+    auto [code, response] = container->send_http(HttpMethod::Get, TcpPort{8080}, "/hello-from-missing-resource");
+    ASSERT_EQ(code, 500) << "Expected 500 Internal Server Error. Received response: " << response;
+}

demo/google-test-cpp/test_data/hello.json

@@ -0,0 +1,12 @@
+{
+    "request": {
+      "method": "GET",
+      "url": "/hello"
+    },
+
+    "response": {
+      "status": 200,
+      "body": "Hello, world!"
+    }
+  }
+

demo/google-test-cpp/test_data/hello_with_missing_resource.json

@@ -0,0 +1,10 @@
+{
+  "request": {
+    "method": "GET",
+    "url": "/hello-from-missing-resource"
+  },
+  "response": {
+    "status": 200,
+    "bodyFileName": "response_missing.xml"
+  }
+}

demo/google-test-cpp/test_data/hello_with_resource.json

@@ -0,0 +1,10 @@
+{
+  "request": {
+    "method": "GET",
+    "url": "/hello-from-resource"
+  },
+  "response": {
+    "status": 200,
+    "bodyFileName": "response.xml"
+  }
+}

demo/google-test-cpp/test_data/response.xml

@@ -0,0 +1,6 @@
+<note>
+  <to>you</to>
+  <from>WireMock</from>
+  <heading>Response</heading>
+  <body>Hello, world!</body>
+</note>

docs/SUPPORT.md

@@ -13,17 +13,13 @@ At the moment, this is single channel for all project matters.
 
 ## Raising Issues and Feature Requests
 
-Use [GitHub Issues](https://github.com/testcontainers/testcontainers-c/issues).
+Use [GitHub Issues](https://github.com/testcontainers/testcontainers-native/issues).
 Note that it may take some time to get a response, thanks for your patience.
 Contributions are always welcome, see the [Contributor Guide](../CONTRIBUTING.md).
 
 ## Reporting Security Issues
 
-You can submit any security issue or suspected vulnerability
-on [GitHub Security](https://github.com/testcontainers/testcontainers-c/security/advisories).
-Please do NOT use public GitHub Issues for reporting vulnerabilities.
-
-Read More - [Security Policy](./SECURITY.md).
+See the [Security Policy](./SECURITY.md).
 
 ## Commercial Support and Customization
 

docs/architecture/README.md

@@ -1,8 +1,7 @@
 # Architecture
 
-!!! note
-    This section is coming soon.
-    All contributions are welcome, just submit a pull request!
+> [!NOTE]
+> This section is coming soon. All contributions are welcome, just submit a pull request!
 
 ## Build Process
 

docs/c/README.md

@@ -3,9 +3,8 @@
 You can use the `testcontainers-c` library with common C
 unit testing frameworks and, soon, with package managers.
 
-!!! note
-    This section is coming soon.
-    All contributions are welcome, just submit a pull request!
+> [!NOTE]
+> This section is coming soon. All contributions are welcome, just submit a pull request!
 
 ## Installing the library
 
@@ -39,9 +38,8 @@ CPMAddPackage(
 
 ## Using the Library
 
-!!! note
-    More frameworks will be documented soon.
-    All contributions are welcome, just submit a pull request!
+> [!NOTE]
+> More frameworks will be documented soon. All contributions are welcome, just submit a pull request!
 
 ### CMake Tests (CTest)
 

docs/cpp/README.md

@@ -2,7 +2,7 @@
 
 At the moment, there is no dedicated C++ binding library/header,
 but it is on [our roadmap](../../ROADMAP.md).
-Tou can use the `testcontainers-c` library directly
+You can use the `testcontainers-c` library directly
 in all C++ testing frameworks.
 
 ## Google Test
@@ -29,10 +29,10 @@ protected:
         tc_with_exposed_tcp_port(requestId, 8080);
         tc_with_wait_for_http(requestId, 8080, WIREMOCK_ADMIN_MAPPING_ENDPOINT);
         tc_with_file(requestId, "test_data/hello.json", "/home/wiremock/mappings/hello.json");
-        
+
         struct tc_run_container_return ret = tc_run_container(requestId);
         containerId = ret.r0;
-        
+
         EXPECT_TRUE(ret.r1) << "Failed to run the container: " << ret.r2;
     };
 
@@ -51,10 +51,10 @@ Then, you can define new tests by referring to the container via `containerId`.
 TEST_F(WireMockTestContainer, HelloWorld) {
     std::cout << "Sending HTTP request to the container\n";
     struct tc_send_http_get_return response = tc_send_http_get(containerId, 8080, "/hello");
-    
+
     ASSERT_NE(response.r0, -1) << "Failed to send HTTP request: " << response.r2;
     ASSERT_EQ(response.r0, 200) << "Received wrong response code: " << response.r1 << response.r2;
- 
+
     std::cout << "Server Response: HTTP-" << response.r0 << '\n' << response.r1 << '\n';
 }
 ```

docs/getting-started.md

@@ -1,13 +1,12 @@
 # Getting Started with Testcontainers for C/C++
 
-In this section, we will build a demo C application that uses Testcontainers
-in a simple C application
-for deploying a [WireMock](https://wiremock.org/) API server,
-sends a simple HTTP request to this service,
+In this section, we will build a simple demo C application that uses Testcontainers
+for deploying a [WireMock](https://wiremock.org/) API server.
+It sends a simple HTTP request to this service,
 and verifies the response.
-We will not be using any C/C++ test framework for that.
+We will not be using any test framework for that.
 
-For test framework framework examples, see the [demos](../demo/README.md).
+For test framework examples, see the [demos](../demo/README.md).
 
 ## Build the Project
 

flake.nix

@@ -0,0 +1,24 @@
+{
+  description = "Testcontainers Native";
+
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
+  };
+
+  outputs = { self, nixpkgs }: let
+    system = "x86_64-linux";
+    pkgs = import nixpkgs { inherit system; };
+  in {
+    devShells.${system}.default = pkgs.mkShell {
+        packages = with pkgs; [
+            clang-tools
+            cmake
+            gcc15
+            gdb
+            go
+            ninja
+            pre-commit
+        ];
+    };
+  };
+}

testcontainers-cpp/CMakeLists.txt

@@ -0,0 +1,23 @@
+set(TARGET testcontainers-cpp)
+set(TARGET_NAME ${TARGET})
+set(TARGET_DESCRIPTION "Testcontainer library for C++")
+set(TARGET_VERSION ${PROJECT_VERSION})
+
+add_library(${TARGET} INTERFACE)
+
+set(CMAKE_CXX_STANDARD 23)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+target_sources(${TARGET}
+    PUBLIC FILE_SET HEADERS
+    BASE_DIRS .
+    FILES testcontainers.hpp
+)
+
+target_link_libraries(${TARGET} INTERFACE testcontainers-c)
+
+configure_file(cmake.pc.in ${TARGET}.pc @ONLY)
+install(TARGETS ${TARGET}
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+install(FILES ${CMAKE_BINARY_DIR}/${TARGET}.pc DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/pkgconfig)