The Surveys Building Block manages survey data for the Rokwire platform.
The service is based on clear hexagonal architecture. The hexagonal architecture divides the system into several loosely-coupled components, such as the application core and different adapters. We categorize the adapters in two categories - driver and driven.
This is the core component of the service. It keeps the data model and the logic of the service. It communicates with the outer world via adapters.
What the service provides - user interface, rest adapter, test agent etc.
What the service depends on - database, mock database, integration with other services etc.
The functionality provided by this application is documented in the Wiki.
The API documentation is available here: https://api-dev.rokwire.illinois.edu/surveys/doc/ui/index.html
MongoDB v4.4+
Go v1.22+
The following Environment variables are supported. The service will not start unless those marked as Required are supplied.
| Name | Format | Required | Description |
|---|---|---|---|
| SURVEYS_BASE_URL | < url > | yes | Base URL where this application is being hosted |
| SURVEYS_PORT | < int > | yes | Port to be used by this application |
| SURVEYS_MONGO_AUTH | <mongodb://USER:PASSWORD@HOST:PORT/DATABASE NAME> | yes | MongoDB authentication string. The user must have read/write privileges. |
| SURVEYS_MONGO_DATABASE | < string > | yes | MongoDB database name |
| SURVEYS_MONGO_TIMEOUT | < int > | no | MongoDB timeout in milliseconds. Defaults to 500. |
| SURVEYS_CORE_BB_BASE_URL | < url > | yes | Core BB base URL |
| SURVEYS_SERVICE_ACCOUNT_ID | < string > | yes | Service account ID |
| SURVEYS_PRIV_KEY | < PEM rsa private key > | yes | Private key for service account |
-
Clone the repo (outside GOPATH)
-
Open the terminal and go to the root folder
-
Make the project
$ make
...
▶ building executable(s)… 1.9.0 2020-08-13T10:00:00+0300
- Run the executable
$ ./bin/application
-
Clone the repo (outside GOPATH)
-
Open the terminal and go to the root folder
-
Create Docker image
docker build -t surveys .
- Run as Docker container
docker-compose up
$ make tests
$ make cover
$ make lint
$ make checkfmt
$ make fixfmt
$ make clean
$ make help
To run this command, you will need to install swagger-cli
$ make oapi-gen-docs
To run this command, you will need to install oapi-codegen
$ make make oapi-gen-types
Verify the service is running as calling the get version API.
curl -X GET -i https://api-dev.rokwire.illinois.edu/surveys/version
Response
0.1.2
If you would like to contribute to this project, please be sure to read the Contributing Guidelines, Code of Conduct, and Conventions before beginning.
This repository is configured with a pre-commit hook that runs Yelp's Detect Secrets. If you intend to contribute directly to this repository, you must install pre-commit on your local machine to ensure that no secrets are pushed accidentally.
# Install software
$ git pull # Pull in pre-commit configuration & baseline
$ pip install pre-commit
$ pre-commit install
If detect-secrets returns an error, ensure that the value it detected is not a secret, then run the following to update the secrets baseline file to match the current state of the codebase:
detect-secrets scan --baseline .secrets.baseline
All environment variables MUST be declared in the appropriate section of app-env.json. Declare all secret environment variables in the app_secret section and all others in the app_config section.
If the default value of a config is known and should be consistent across environments, provide the value directly in this file. Please note that this DOES NOT apply to secrets, as secret values MUST NOT be pushed to this repository. For other configs and all secrets, provide a hint for all required values and set all optional values to an empty string (ie. "").