Skip to content

Commit bf9535a

Browse files
Merge pull request #34 from testcontainers/renaming
Rename the project to Testcontainers Native
2 parents c831838 + 5590b0d commit bf9535a

File tree

10 files changed

+22
-20
lines changed

10 files changed

+22
-20
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Testcontainers for C/C++ and other native languages
1+
# Testcontainers for C/C++/Swift and other native languages
22

33
<p align="center">
4-
<img width="512px" src="docs/images/logo/logo_testcontainers_c_wide.png" alt="Testcontainers for C/C++ Logo"/>
4+
<img width="512px" src="docs/images/logo/logo_testcontainers_native_wide.png" alt="Testcontainers Native Logo"/>
55
</p>
66

77
[![Slack: testcontainers-c on slack.testcontainers.org](https://img.shields.io/badge/Slack-%23testcontainers%E2%80%94c-brightgreen?style=flat&logo=slack)](http://slack.testcontainers.org/)
@@ -24,14 +24,14 @@ Also join the `#testcontainers-c` channel on the [Testcontainers Slack](http://s
2424

2525
## Key Features
2626

27+
- _Testcontainers for C/C++_ - a shared library and C-style headers that can be used in native projects
28+
- Support for [C](./docs/c/README.md), [C++](./docs/cpp/README.md), [Swift](./docs/swift/README.md) and other native projects.
2729
- Minimum viable Testcontainers API functionality:
2830
starting and terminating containers, passing files, exposing ports,
2931
accessing container logs, etc.
3032
- Minimum HTTP client wrapper to simplify requests and assertions
3133
- [Testcontainers for Go](https://golang.testcontainers.org/) under the hood, with all its reporting and resource management capabilities.
3234
Memory might leak a lot in the current versions, but we do not want containers to leak :)
33-
- Support for [C](./docs/c/README.md), [C++](./docs/cpp/README.md), [Swift](./docs/swift/README.md) and other native projects.
34-
- C-style header file for the library. A fancy C++ wrapper is coming soon
3535
- Support for [Testcontainers Modules](./modules/README.md)
3636

3737
This is what a very simple run without a test framework may look like.
@@ -66,7 +66,7 @@ See [the examples and demos](./demo/README.md) for more examples.
6666
### Using in other languages
6767

6868
TL;DR: You get the C header file, a shared library object or a DLL file from the
69-
[Testcontainers C](./docs/c/README.md) module,
69+
[Testcontainers for C](./docs/c/README.md) module,
7070
Then, you know the drill.
7171
Feel free to contribute examples or SDKs for the languages!
7272

ROADMAP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Testcontainers for C/C++. Roadmap
1+
# Testcontainers Native. Roadmap
22

33
A full public roadmap is coming soon.
44
See the [GitHub Issues](https://github.com/testcontainers/testcontainers-c/issues) and,
@@ -11,7 +11,7 @@ the pinned issues to learn about the key initiatives on the table.
1111
- Add a C++ binding library and class-based headers ([#12](https://github.com/testcontainers/testcontainers-c/issues/12))
1212
- Prototype and document support for other languages that
1313
leverage native libraries, in particular Swift
14-
- Make Testcontainers for C/C++ an official project
14+
- Make Testcontainers Native an official project
1515
listed on the [Testcontainers site](https://testcontainers.com/)
1616
- Publish the project to common C/C++ package managers
1717
([vcpkg](https://github.com/testcontainers/testcontainers-c/issues/2),

docs/SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ Please do **NOT** use public GitHub Issues for reporting vulnerabilities.
88

99
## Bug Bounty
1010

11-
The Testcontainers for C/C++ project is not a part of the official Testcontainers bug bounty program and,
11+
The Testcontainers Native project is not a part of the official Testcontainers bug bounty program and,
1212
as of now, of any other program.
1313
We will be happy to credit you in the public Security Advisory and on social media.

docs/SUPPORT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Support for Testcontainers for C/C++
1+
# Support for Testcontainers Native
22

33
[![Slack: testcontainers-c on slack.testcontainers.org](https://img.shields.io/badge/Slack-%23testcontainers%E2%80%94c-brightgreen?style=flat&logo=slack)](http://slack.testcontainers.org/)
44

@@ -29,7 +29,7 @@ Read More - [Security Policy](./SECURITY.md),
2929

3030
The creator of this project, Oleg Nenashev,
3131
is [available for consulting projects](https://oleg-nenashev.github.io/oleg-nenashev/consulting/) in the areas of developer tools,
32-
including Testcontainers for C/C++.
32+
including Testcontainers Native and adapters for C/C++.
3333
Development of this project will continue regardless of commercial contracts,
3434
but of course your support can help the project to move forward.
3535
[GitHub Sponsorships](https://github.com/sponsors/oleg-nenashev) will be appreciated too.

docs/getting-started.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Getting Started with Testcontainers for C/C++
22

3-
In this section, we will build a demo C application that uses Testcontainers for C/C++
3+
In this section, we will build a demo C application that uses Testcontainers
4+
in a simple C application
45
for deploying a [WireMock](https://wiremock.org/) API server,
56
sends a simple HTTP request to this service,
67
and verifies the response.
78
We will not be using any C/C++ test framework for that.
89

9-
For a test framework framework example, see the [demos](../demo/README.md).
10+
For test framework framework examples, see the [demos](../demo/README.md).
1011

1112
## Build the Project
1213

19.7 KB
Loading
37.1 KB
Loading

docs/swift/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Using Testcontainers in Swift
22

3-
The Testcontainers C/C++ library is compatible with native languages, and that includes Swift. To use the library in Swift, a few extra steps must be followed in order for it to be useable.
3+
The Testcontainers for C/C++ library is compatible with native languages, and that includes Swift. To use the library in Swift, a few extra steps must be followed in order for it to be useable.
44

55
## Using the generic Testcontainer C API
66

mkdocs.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
site_name: Testcontainers for C/C++
1+
site_name: Testcontainers Native
22
site_description: >-
3-
Testcontainers for C/C++ is not a standalone Testcontainers engine,
4-
but a C-style shared library adapter for C/C++, Swift, and other native projects.
3+
Testcontainers for C/C++/Swift and other native projects.
4+
It is not a standalone Testcontainers engine,
5+
but a shared bridge library and language-specific adapters.
56
The project is based on Testcontainers for Go which is one of the most powerful Testcontainers implementations.
67
copyright: >-
78
Copyright &copy; 2024 - Oleg Nenashev and all contributors.
8-
repo_url: https://github.com/testcontainers/testcontainers-c
9+
repo_url: https://github.com/testcontainers/testcontainers-native
910
repo_name: GitHub Repo
1011
edit_uri: edit/main/
11-
site_url: https://testcontainers.github.io/testcontainers-c
12+
site_url: https://testcontainers.github.io/testcontainers-native
1213

1314
# Build
1415
site_dir: _site

modules/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Testcontainers for C/C++. Modules
1+
# Testcontainers Native. Modules
22

3-
As for other Testcontainers implementations, Testcontainers for C/C++ allow writing
3+
As for other Testcontainers implementations, Testcontainers Native allows writing
44
extensions that extend the SDK and APIs to make usage of a particular service provider
55
easier.
66
The expectation is that the modules are implemented in a separate dynamic library

0 commit comments

Comments
 (0)