wip: migrate hub

Author: justinmerrell

README.md

@@ -15,6 +15,7 @@
 ## Table of Contents
 
 - [What is OpenPod?](#what-is-openpod)
+- [Directory Structure](#directory-structure)
 
 
 ## What is OpenPod?
@@ -130,3 +131,13 @@ This file contains a JSON summary of the Pod for debugging purposes. The informa
 
 ]
 ```
+
+## Directory Structure
+
+```default
+.
+├── .github             # CI/CD using GitHub Actions and other functions.
+├── tests               # Contains unit testing files.
+└── openpod             # Contains OpenPod functionality.
+    └── modules         # Independent core functions.
+```

openpod/launcher.py

@@ -19,7 +19,7 @@
 #                              Check Requirements                              #
 # ---------------------------------------------------------------------------- #
 try:
-    import config
+    import config                                           # pylint: disable=W0611
 except ImportError :
     subprocess.call(['sudo', 'pip3', 'install', 'config'])
 
@@ -33,7 +33,7 @@
 
 if settings.Pi:
     try:
-        from modules import rec_xbee
+        from modules import rec_xbee                      # pylint: disable=C0412
     except ModuleNotFoundError as err:
         exception_log.error("%s", err)
 
@@ -108,7 +108,7 @@
 #                               Main HUB Program                               #
 # ---------------------------------------------------------------------------- #
 try:
-    import hub
+    import pod                                              # pylint: disable=W0611
 
 except RuntimeError as err:
     exception_log.error("Could not start hub.py with error: %s", err)

openpod/modules/rec_lookup.py

@@ -134,7 +134,7 @@ def get_group_details(access_group_id):
 # ---------------------------------------------------------------------------- #
 #                                Perform Search                                #
 # ---------------------------------------------------------------------------- #
-def access_request(requested_id, request_node):
+def access_request(requested_id, request_node):         # pylint: disable=R0911
     '''
     Processes access requests.
     request_id - User's ID that is making a request.

openpod/modules/rec_mqtt.py

@@ -12,7 +12,7 @@
 from modules import rec_api, rec_xbee, rec_lookup
 from modules.rec_log import mqtt_log, exception_log, zip_send
 import settings
-import hub_updater
+import updater
 
 # The callback for when the client receives a CONNACK response from the server.
 def on_connect(client, userdata, flags, return_code):
@@ -107,12 +107,12 @@ def mqtt_start_update():
     '''
     mqtt_log.info("UPDATE AVAILABLE - Triggered by the user.")
     try:
-        hub_updater.update_hub()
+        updater.update_hub()
     except RuntimeError as err:
         exception_log.error("Error while updating, atempting as subprocess. %s", err)
         with open('system.json', 'r+', encoding="UTF-8") as file:
             system_data = json.load(file)
-            update_location = f'/opt/RecursionHub/{system_data.CurrentVersion}/hub_updater.py'
+            update_location = f'/opt/RecursionHub/{system_data.CurrentVersion}/updater.py'
             with subprocess.Popen(['sudo', 'python3', f'{update_location}']) as script:
                 print(script)
 

openpod/pod.py

@@ -72,7 +72,7 @@ def incoming_xbee_data():
         file.seek(0)
         json.dump(data, file)
         file.truncate()
-except Exception as err:
+except Exception as err:                                # pylint: disable=W0703
     print(err)
 # ------------------------------- TEMP SOLUTION ------------------------------ #
 
@@ -104,10 +104,10 @@ def incoming_xbee_data():
     else:
         rec_log.publog("info", "Facility connection not found, no data to pull.")
         if settings.Pi:
-            rec_gpio.state(settings.LED_IO, 1, 1)    #Slow blink ready to pair to a facility.
+            rec_gpio.state(settings.LED_IO, 1, 1)       # Slow blink ready to pair to a facility.
 
     zip_send() # Send latest log files on boot.
-except Exception as err:
+except Exception as err:                                # pylint: disable=W0703
     rec_log.publog("error", f"Error occured when pulling data: {err}")
 
 

openpod/settings.py

@@ -3,16 +3,16 @@
 '''Settings file contains "constants" that are unlikely to be changed.'''
 
 DEBUG = True
-Pi = False
+PI = False
 
 
 if DEBUG is True:
-    RecursionURL = 'https://dev.recursion.space'
+    RECURSION_SPACE_URL = 'https://dev.recursion.space'
     RECURSION_DOMAIN = 'dev.recursion.space'
     RECURSION_API_URL = 'https://dev.api.recursion.space'
 
 else:
-    RecursionURL = 'https://recursion.space'
+    RECURSION_SPACE_URL = 'https://recursion.space'
     RECURSION_DOMAIN = 'recursion.space'
     RECURSION_API_URL = 'https://api.recursion.space'
 

tests/test_updater.py

@@ -9,7 +9,7 @@
 from io import StringIO
 from unittest.mock import patch, mock_open, Mock
 
-import hub_updater
+import updater # OpenPod Updater
 
 import sys
 sys.path.insert(0, "0_1_0/")
@@ -28,9 +28,9 @@ def test_get_current_versions(self):
                         "facility": "3b9fdc97-9649-4c80-8b48-10df647bd032"
                     }""")
 
-        with patch('hub_updater.open') as mock_open:
+        with patch('updater.open') as mock_open:
             mock_open.side_effect = [systemJSON, systemJSON]
-            hub_updater.current_hub_version()
+            updater.current_hub_version()
             # hub_updater.update_version_name()
             mock_open.assert_called()