chore: validate presence of necessary files and some config

Author: Holf

weduc_timetable_extractor/__main__.py

@@ -1,10 +1,13 @@
+import sys
+
 from playwright.sync_api import sync_playwright
 
 from weduc_timetable_extractor import get_command_line_args
 from weduc_timetable_extractor.config_management import (
     get_chromium_path,
     get_student_configs,
     get_weduc_credentials,
+    validate_chromium_path,
 )
 from weduc_timetable_extractor.google_calendar_management import (
     push_timetable_to_google_calendar,
@@ -20,14 +23,24 @@
 )
 
 
+def validate_at_least_one_student_config(student_configs):
+    count = len(student_configs)
+
+    if count > 0:
+        return count
+
+    sys.exit("Error: there are no student configs in config.ini")
+
+
 def main():
     args = get_command_line_args()
     weduc_credentials = get_weduc_credentials()
     use_headless = weduc_credentials["credentials_present"]
 
     student_configs = get_student_configs()
+    count = validate_at_least_one_student_config(student_configs)
 
-    print(f"Found {len(student_configs)} student config(s)")
+    print(f"Found {count} student config(s)")
 
     with sync_playwright() as p:
         print(
@@ -39,14 +52,15 @@ def main():
         print("Launching browser ...")
 
         chromium_path = get_chromium_path()
-        print("path", chromium_path)
+        validate_chromium_path(chromium_path)
+        print("Using browser located at:", chromium_path)
+
         browser = p.chromium.launch(
             executable_path=chromium_path, headless=use_headless
         )
         page = browser.new_page()
 
         page.goto("https://app.weduc.co.uk/")
-
         login_to_weduc(page, weduc_credentials)
 
         schools = extract_schools_data_from_weduc(page)

weduc_timetable_extractor/config_management.py

@@ -21,6 +21,7 @@ def get_config():
             project_root = Path(__file__).resolve().parent.parent
 
         config_file_path = project_root / "config.ini"
+        validate_config_ini_path(config_file_path)
 
         config = configparser.ConfigParser()
         config.read(config_file_path)
@@ -69,6 +70,18 @@ def get_chromium_path():
     return os_map.get(platform.system())
 
 
+def validate_config_ini_path(config_ini_file_path):
+    if not config_ini_file_path.is_file():
+        sys.exit(
+            f"Error: unable to find a config.ini file at path '{config_ini_file_path}'"
+        )
+
+
+def validate_chromium_path(chromium_path):
+    if not Path(chromium_path).is_file():
+        sys.exit(f"Error: unable to find a browser at path '{chromium_path}'")
+
+
 def get_student_configs():
     section_names = get_config().sections()
     student_section_names = [

weduc_timetable_extractor/google_calendar_management/get_google_calendar_service.py

@@ -30,6 +30,7 @@ def get_credentials():
 
     token_file_path = project_root / "token.json"
     credentials_file_path = project_root / "credentials.json"
+    validate_credentials_path(credentials_file_path)
 
     # Check if token.json exists, which stores the user's access and refresh tokens.
     if os.path.exists(token_file_path):
@@ -47,3 +48,11 @@ def get_credentials():
         with open(token_file_path, "w") as token:
             token.write(creds.to_json())
     return creds
+
+
+def validate_credentials_path(credentials_file_path):
+    if not credentials_file_path.is_file():
+        sys.exit(
+            f"""Error: there is no Google Calendar API 'credentials.json' file present in the same folder as the executable.
+See the project documentation for info on setting this up: https://github.com/Holf/weduc-timetable-extractor/blob/main/README.md"""
+        )