Skip to content

Commit

Permalink
docs: [#1] Explain purpose of this project
Browse files Browse the repository at this point in the history
  • Loading branch information
sbp-bvanb committed Nov 21, 2024
1 parent ca1ac9e commit 120f3f0
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# mcvs-integrationtest-services

This repository, "mcvs-integrationtest-services" provides a versatile Docker
image designed to mimic multiple services, including Okta, AWS, and others. The
primary purpose of this Docker image is to facilitate comprehensive testing
environments where developers can simulate real-world scenarios involving
various services without needing to interact with the actual external services.
This approach is especially beneficial in integration, component and
end-to-end (e2e) testing, ensuring that all aspects of the application's
interaction with these services are thoroughly vetted.

In conjunction with the [dockertest](https://github.com/ory/dockertest) library,
this image allows developers to write robust and extensive tests that cover a
wide range of scenarios. Dockertest is a Go package essential for running Docker
containers as part of the testing process. By integrating these simulated
services, developers can streamline their testing process, detect potential
issues early, and maintain the stability and reliability of the system. This
repository thus plays a crucial role in enhancing the overall quality and
security of the application by ensuring that it performs as expected in various
integrated environments.

Note: This image can be used with other programming languages as well, as long
as they have a framework similar to go-dockertest

## Build

```zsh
Expand Down

0 comments on commit 120f3f0

Please sign in to comment.