Improve database configuration handling

Author: GJFR

.gitignore

@@ -1,5 +1,6 @@
 test/resources/repositories
 browser/binaries/
+config/
 database/data/
 !**/.gitkeep
 **/node_modules

README.md

@@ -77,9 +77,9 @@ By default, BugHog uses a MongoDB container.
 you might want to prefer all data to be stored on your own MongoDB instance.
 If you prefer storing data in your own MongoDB instance, follow these steps:
 
-1. Create a `.env` file from `.env.example` in the BugHog root directory and fill in the missing values.
+1. Create a `.env` file from `.env.example` (both in the `config` folder) and fill in the missing values.
 
-2. Rebuild BugHog and run it.
+2. (Re)start BugHog.
 
 ### Stopping
 To stop BugHog, run the following command:

bci/configuration.py

@@ -36,11 +36,17 @@ def initialize_folders():
 
     @staticmethod
     def get_database_connection_params() -> DatabaseConnectionParameters:
-        if 'BCI_MONGO_HOST' not in os.environ or \
-                'BCI_MONGO_USERNAME' not in os.environ or \
-                'BCI_MONGO_DATABASE' not in os.environ or \
-                'BCI_MONGO_PASSWORD' not in os.environ:
-            logger.info('Could not find database environment variables, using database container...')
+        required_database_params = [
+            'BCI_MONGO_HOST',
+            'BCI_MONGO_USERNAME',
+            'BCI_MONGO_DATABASE',
+            'BCI_MONGO_PASSWORD'
+        ]
+        missing_database_params = [
+            param for param in required_database_params
+            if os.getenv(param) in ['', None]]
+        if missing_database_params:
+            logger.info(f'Could not find database parameters {missing_database_params}, using database container...')
             return container.run()
         else:
             database_params = DatabaseConnectionParameters(

bci/distribution/worker_manager.py

@@ -75,7 +75,7 @@ def start_container_thread():
                     labels=['bh_worker'],
                     command=command,
                     volumes=[
-                        os.path.join(os.getenv('host_pwd'), '.env') + ':/app/.env',
+                        os.path.join(os.getenv('host_pwd'), 'config') + ':/app/config',
                         os.path.join(os.getenv('host_pwd'), 'browser/binaries/chromium/artisanal') + ':/app/browser/binaries/chromium/artisanal',
                         os.path.join(os.getenv('host_pwd'), 'browser/binaries/firefox/artisanal') + ':/app/browser/binaries/firefox/artisanal',
                         os.path.join(os.getenv('host_pwd'), 'experiments') + ':/app/experiments',

bci/master.py

@@ -41,7 +41,7 @@ def __init__(self):
         self.firefox_build = None
         self.chromium_build = None
 
-        load_dotenv()
+        load_dotenv('/app/config/.env')
 
         Global.initialize_folders()
         self.db_connection_params = Global.get_database_connection_params()

docker-compose.yml

@@ -22,7 +22,7 @@ services:
     ports:
       - "5000:5000"
     volumes:
-      - .env:/app/.env:ro
+      - ./config:/app/config:ro
       - ./browser/binaries/chromium/artisanal:/app/browser/binaries/chromium/artisanal:rw
       - ./browser/binaries/firefox/artisanal:/app/browser/binaries/firefox/artisanal:rw
       - ./experiments:/app/experiments:ro