Don't set default values for SIGAN_MODULE, SIGAN_CLASS, or DEVICE_MOD…

…EL. Add check and raise exception if SIGAN_MODULE or SIGAN_CLASS are not set. Don't set sensor_sha512 if unable to generate hash. Add DEVICE_MODEL to readme and env.template.

README.md

@@ -328,6 +328,9 @@ settings in the environment file:
 - CALLBACK_TIMEOUT: The timeout for the posts sent to the callback URL when a scheduled
   action is completed.
 - DEBUG: Django debug mode. Set to False in production.
+- DEVICE_MODEL: Optional setting indicating the model of the signal analyzer. The
+  TekRSASigan class will use this value to determine which action configs to load.
+  See [scos-tekrsa](https://github.com/ntia/scos-tekrsa) for additional details.
 - DOCKER_TAG: Always set to “latest” to install newest version of docker containers.
 - DOMAINS: A space separated list of domain names. Used to generate [ALLOWED_HOSTS](
   <https://docs.djangoproject.com/en/3.0/ref/settings/#allowed-hosts>).

env.template

@@ -34,6 +34,8 @@ CALLBACK_TIMEOUT=2
 # Use either true or false
 DEBUG=true
 
+DEVICE_MODEL=RSA507A
+
 # Use latest as default for local development
 DOCKER_TAG=latest
 

src/initialization/capabilities_loader.py

@@ -54,8 +54,6 @@ def load_capabilities(sensor_definition_file: str) -> dict:
             ).hexdigest()
             capabilities["sensor"]["sensor_sha512"] = sensor_definition_hash
     except:
-        capabilities["sensor"]["sensor_sha512"] = "ERROR GENERATING HASH"
-        # sensor_sha512 is None, do not raise Exception, but log it
         logger.exception(f"Unable to generate sensor definition hash")
 
     return capabilities

src/initialization/sensor_loader.py

@@ -72,6 +72,7 @@ def load_sensor(sensor_capabilities: dict) -> Sensor:
     sigan = None
     try:
         if not settings.RUNNING_MIGRATIONS:
+            check_for_required_sigan_settings()
             sigan_module_setting = settings.SIGAN_MODULE
             sigan_module = importlib.import_module(sigan_module_setting)
             logger.info(
@@ -97,6 +98,19 @@ def load_sensor(sensor_capabilities: dict) -> Sensor:
     return sensor
 
 
+def check_for_required_sigan_settings():
+    error = ""
+    raise_exception = False
+    if settings.SIGAN_MODULE is None:
+        raise_exception = True
+        error = "SIGAN_MODULE environment variable must be set. "
+    if settings.SIGAN_CLASS is None:
+        raise_exception = True
+        error += "SIGAN_CLASS environment variable. "
+    if raise_exception:
+        raise Exception(error)
+
+
 def load_switches(switch_dir: Path) -> dict:
     logger.debug(f"Loading switches in {switch_dir}")
     switch_dict = {}

src/sensor/settings.py

@@ -345,9 +345,9 @@
             "PORT": "5432",
         }
     }
-    DEVICE_MODEL = env("DEVICE_MODEL", default="RSA507A")
-    SIGAN_MODULE = env.str("SIGAN_MDOULE", default="scos_tekrsa.hardware.tekrsa_sigan")
-    SIGAN_CLASS = env.str("SIGAN_CLASS", default="TekRSASigan")
+    DEVICE_MODEL = env("DEVICE_MODEL", default=None)
+    SIGAN_MODULE = env.str("SIGAN_MDOULE", default=None)
+    SIGAN_CLASS = env.str("SIGAN_CLASS", default=None)
 
 if not IN_DOCKER:
     DATABASES["default"]["HOST"] = "localhost"