Read settings from .env file (fixes #53) (#131)

* Add python-dotenv dependency

* Read settings from .env file (fixes #53)

* Move local dev example to .env.example

* Run detect-secrets scan --baseline .secrets.baseline

* Run tests using .env.example

Author: leplatrem

config/local_dev.env renamed to .env.example

@@ -127,6 +127,3 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
-
-# Don't check in your own Env
-/config/local_dev.env

.gitignore

@@ -100,31 +100,31 @@
     }
   ],
   "results": {
-    "README.md": [
-      {
-        "type": "Hex High Entropy String",
-        "filename": "README.md",
-        "hashed_secret": "04e78d6e804f2b59e6cb282cb9ed2c7bfd8a9737",
-        "is_verified": false,
-        "line_number": 184
-      }
-    ],
-    "config/local_dev.env": [
+    ".env.example": [
       {
         "type": "Secret Keyword",
-        "filename": "config/local_dev.env",
+        "filename": ".env.example",
         "hashed_secret": "4b9a4ce92b6a01a4cd6ee1672d31c043f2ae79ab",
         "is_verified": false,
         "line_number": 7
       },
       {
         "type": "Secret Keyword",
-        "filename": "config/local_dev.env",
+        "filename": ".env.example",
         "hashed_secret": "77ea6398f252999314d609a708842a49fc43e055",
         "is_verified": false,
         "line_number": 10
       }
+    ],
+    "README.md": [
+      {
+        "type": "Hex High Entropy String",
+        "filename": "README.md",
+        "hashed_secret": "04e78d6e804f2b59e6cb282cb9ed2c7bfd8a9737",
+        "is_verified": false,
+        "line_number": 194
+      }
     ]
   },
-  "generated_at": "2022-07-21T07:58:50Z"
+  "generated_at": "2022-07-21T13:06:53Z"
 }

.secrets.baseline

@@ -6,6 +6,7 @@ _GID ?= 10001
 
 VENV := $(shell echo $${VIRTUAL_ENV-.venv})
 INSTALL_STAMP = $(VENV)/.install.stamp
+DOTENV_FILE = ".env"
 POETRY_VIRTUALENVS_IN_PROJECT = true
 
 .PHONY: help
@@ -48,15 +49,18 @@ lint: $(INSTALL_STAMP)
 	bin/lint.sh
 
 .PHONY: start
-start:
+start: $(INSTALL_STAMP) $(DOTENV_FILE)
 	poetry run python -m src.app.api
 
+$(DOTENV_FILE):
+	cp -n .env.example $(DOTENV_FILE)
+
 .PHONY: docker-shell
-docker-shell:
+docker-shell: $(DOTENV_FILE)
 	docker-compose run --rm web /bin/sh
 
 .PHONY: docker-start
-docker-start:
+docker-start: $(DOTENV_FILE)
 	docker-compose up
 
 .PHONY: test

Makefile

@@ -5,7 +5,7 @@
 # Jira Bugzilla Integration (JBI)
 System to sync Bugzilla bugs to Jira issues.
 
-### Caveats
+## Caveats
 - The system accepts webhook events from Bugzilla
 - Bugs' `whiteboard` tags are used to determine if they should be synchronized or ignored
 - The events are transformed into Jira issues
@@ -91,7 +91,7 @@ features on top of the default.
 
 It will attempt to assign the Jira issue the same person as the bug is assigned to. This relies on
 the user using the same email address in both Bugzilla and Jira. If the user does not exist in Jira
-then the assignee is cleared from the Jira issue. The Jira account that JBI uses requires the "Browse 
+then the assignee is cleared from the Jira issue. The Jira account that JBI uses requires the "Browse
 users and groups" global permission in order to set the assignee.
 
 If configured, the action supports setting the Jira issues's status when the Bugzilla status and resolution change.
@@ -145,6 +145,16 @@ graph TD
     end
 ```
 
+## Development
+
+- `make start`: run the application locally (http://localhost:8000)
+- `make test`: run the unit tests suites
+- `make lint`: static analysis of the code base
+
+You may consider:
+
+* Tweaking the application settings in the `.env` file (See `src/app/environment.py` for details)
+* Installing a pre-commit hook to lint your changes with `pre-commit install`
 
 ## Deployment
 

README.md

@@ -4,7 +4,7 @@ services:
     build: .
     command: python -m src.app.api
     env_file:
-      - config/local_dev.env
+      - .env
     # Let the init system handle signals for us.
     # among other things this helps shutdown be fast
     init: true

docker-compose.yaml

@@ -8,7 +8,7 @@ license = "MPL"
 [tool.poetry.dependencies]
 python = ">=3.8, <3.11"
 fastapi = "^0.73.0"
-pydantic = {version = "^1.9.1", extras = ["email"]}
+pydantic = {version = "^1.9.1", extras = ["dotenv", "email"]}
 uvicorn = {extras = ["standard"], version = "^0.18.2"}
 gunicorn = "^20.1.0"
 prometheus-client = "^0.14.1"
@@ -44,7 +44,7 @@ testpaths = [
 ]
 env_override_existing_values = true
 env_files = [
-    "config/local_dev.env"
+    ".env.example"
 ]
 
 [tool.pylint]

poetry.lock

@@ -36,6 +36,12 @@ class Settings(BaseSettings):
     # Sentry
     sentry_dsn: Optional[SentryDsn]
 
+    class Config:
+        """Pydantic configuration"""
+
+        env_file = ".env"
+        env_file_encoding = "utf-8"
+
 
 @lru_cache()
 def get_settings() -> Settings: