RentalManagement provides the functionality for the capability Management of Rentals via API endpoints dedicated to individual use cases.
For the implementation of the business logic required for the use cases, RentalManagement orchestrates Car to access required data. Therefore, it depends on the Git repository cargotypes to provide mappings for the JSON responses. Further information on the usage of private Git repositories with go can be found there.
The provided API endpoints of RentalManagement are specified in the API specification.
⚠️ CORS Warning: The local setup mode of this microservice allows requests from all origins. In production, this is a security risk! For production deployments, use custom configuration values with an appropriate value forRM_ALLOW_ORIGINS.
To test RentalManagement locally, you can use the MongoDB Docker Compose setup provided in the dev folder.
To do so, execute the following commands:
cd dev
docker compose up -dThis will start a MongoDB instance on port 27032 (non-default port to avoid collisions with other databases) with a default user with admin privileges.
After that, start the Go server with the following environment variable set:
| Environment Variable | Value | Comment |
|---|---|---|
RM_LOCAL_SETUP |
true | Enables the local setup mode. |
You might want to set RM_LOCAL_SETUP in your IDE's default run configuration.
For example, in IntelliJ IDEA, you can do this as described here.
In the local setup mode, the microservice will use the configuration specified in environment/localSetup.env.
It contains the correct database connection information matching the docker compose file such that no further
configuration is required. This information will be embedded into the binary at build time.
However, you can still override the configuration by setting environment variables described in the "Deployment or Custom Setup" section manually.
The default configuration values of local setup mode can also be found in the table of the "Deployment or Custom Setup" section.
If the local setup mode is enabled, the integration tests (NOT the application itself) will try to detect if the correct docker compose stack is running and will print a warning if it is not.
After you have started the microservice in local setup mode, you can access it at http://localhost:8012.
Do not use the local setup mode in a deployment or a custom setup, i.e. do not set the RM_LOCAL_SETUP
environment variable. Instead, use the following environment variables to configure the microservice:
| Environment Variable | Local Setup Value | Required for Testing? | Comment |
|---|---|---|---|
MONGODB_CONNECTION_STRING |
mongodb://root:example@localhost:27032/ccsappvp2rentals | yes | Local setup uses a non-default port! |
MONGODB_DATABASE_NAME |
ccsappvp2rentals | yes | |
RM_EXPOSE_PORT |
8012 | no | Optional, defaults to 80. This is the port this microservice is exposing. The local setup exposes a non-default port! |
RM_COLLECTION_PREFIX |
localSetup- | no | Optional. A (unique) prefix that is prepended to every database collection of this service. |
RM_CAR_SERVER |
http://localhost:8001 |
no | The URL of the Car server of the domain layer. |
RM_REQUEST_TIMEOUT |
5s | no | Optional. The timeout for requests to the Car server (number with suffix). Defaults to 5s. |
RM_ALLOW_ORIGINS |
* | no | Optional. A comma-separated list of allowed origins for CORS requests. By default, no additional origins are allowed. |
The Unit Tests of RentalManagement depend on automatically generated Go mocks.
You need to install mockgen to generate them.
After the installation, execute go generate ./... in the src directory of this project.
To run the tests locally, choose the local setup mode, or use a custom setup as described above to configure database access for the integration tests.
Please note: The integration tests will ignore the
RM_COLLECTION_PREFIXenvironment variable and use dynamically generated collection names to avoid collisions with other tests.
After that, you can run the tests using go test ./... in the src directory.