Move jokes from config.json to separate jokes.json file (#318)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Mikefly123 <61564344+Mikefly123@users.noreply.github.com>

Author: Copilot

circuitpython-workspaces/flight-software/src/pysquared/config/config.py

@@ -25,7 +25,8 @@ class Config:
     Loads configuration from a JSON file, validates values, and provides
     methods to update configuration settings. Supports both temporary (RAM-only)
     and permanent (file-persisted) updates. Delegates radio-related validation
-    and updates to the RadioConfig class.
+    and updates to the RadioConfig class. Jokes are loaded from a separate
+    jokes.json file in the same directory as the config file.
 
     Attributes:
         config_file (str): Path to the configuration JSON file.
@@ -35,7 +36,7 @@ class Config:
         detumble_enable_z (bool): Enable detumbling on Z axis.
         detumble_enable_x (bool): Enable detumbling on X axis.
         detumble_enable_y (bool): Enable detumbling on Y axis.
-        jokes (list[str]): List of jokes for the cubesat.
+        jokes (list[str]): List of jokes for the cubesat (loaded from jokes.json).
         debug (bool): Debug mode flag.
         heating (bool): Heating system enabled flag.
         normal_temp (int): Normal operating temperature.
@@ -68,8 +69,8 @@ def __init__(self, config_path: str) -> None:
             config_path (str): Path to the configuration JSON file.
 
         Raises:
-            FileNotFoundError: If the configuration file does not exist.
-            json.JSONDecodeError: If the configuration file is not valid JSON.
+            FileNotFoundError: If the configuration file or jokes.json does not exist.
+            json.JSONDecodeError: If the configuration file or jokes.json is not valid JSON.
         """
 
         self.config_file = config_path
@@ -83,7 +84,23 @@ def __init__(self, config_path: str) -> None:
         self.detumble_enable_z: bool = json_data["detumble_enable_z"]
         self.detumble_enable_x: bool = json_data["detumble_enable_x"]
         self.detumble_enable_y: bool = json_data["detumble_enable_y"]
-        self.jokes: list[str] = json_data["jokes"]
+
+        # Load jokes from separate jokes.json file in the same directory
+        # Extract directory from config_path using string operations (CircuitPython compatible)
+        if "/" in config_path:
+            config_dir = "/".join(config_path.split("/")[:-1])
+        else:
+            config_dir = "."
+
+        # Construct jokes path
+        if config_dir == ".":
+            jokes_path = "jokes.json"
+        else:
+            jokes_path = config_dir + "/jokes.json"
+
+        with open(jokes_path, "r") as f:
+            self.jokes: list[str] = json.loads(f.read())
+
         self.debug: bool = json_data["debug"]
         self.heating: bool = json_data["heating"]
         self.normal_temp: int = json_data["normal_temp"]

cpython-workspaces/flight-software-unit-tests/src/config.json

@@ -0,0 +1,43 @@
+{
+  "battery_voltage": 5.2,
+  "critical_battery_voltage": 6.6,
+  "cubesat_name": "Orpheus",
+  "current_draw": 240.5,
+  "debug": true,
+  "degraded_battery_voltage": 7.0,
+  "detumble_enable_x": true,
+  "detumble_enable_y": true,
+  "detumble_enable_z": true,
+  "heating": false,
+  "last_battery_temp": 20.0,
+  "longest_allowable_sleep_time": 600,
+  "normal_battery_temp": 1,
+  "normal_battery_voltage": 6.9,
+  "normal_charge_current": 0.5,
+  "normal_micro_temp": 20,
+  "normal_temp": 20,
+  "radio": {
+    "fsk": {
+      "broadcast_address": 255,
+      "modulation_type": 0,
+      "node_address": 1
+    },
+    "license": "",
+    "lora": {
+      "ack_delay": 0.2,
+      "coding_rate": 8,
+      "cyclic_redundancy_check": true,
+      "max_output": true,
+      "spreading_factor": 8,
+      "transmit_power": 23
+    },
+    "modulation": "LoRa",
+    "start_time": 80000,
+    "transmit_frequency": 437.4
+  },
+  "reboot_time": 3600,
+  "repeat_code": "RP",
+  "sleep_duration": 30,
+  "super_secret_code": "ABCD",
+  "turbo_clock": false
+}

cpython-workspaces/flight-software-unit-tests/src/jokes.json

@@ -0,0 +1,37 @@
+[
+  "Hey it is pretty cold up here, did someone forget to pay the electric bill?",
+  "sudo rf - rf*",
+  "Why did the astronaut break up with his girlfriend? He needed space.",
+  "Why did the sun go to school? To get a little brighter.",
+  "why is the mall called the mall? because instead of going to one store you go to them all",
+  "Alien detected. Blurring photo...",
+  "Wait it is all open source? Always has been... www.github.com/proveskit",
+  "What did 0 say to 1? You're a bit too much.",
+  "Pleiades - Orpheus has been recently acquired by the Onion News Network",
+  "This jokesat was brought to you by the Bronco Space Ministry of Labor and Job Placement",
+  "Catch you on the next pass!",
+  "Pleiades - Orpheus was not The Impostor",
+  "Sorry for messing with your long-exposure astrophoto!",
+  "Better buy a telescope. Wanna see me. Buy a telescope. Gonna be in space.",
+  "According to all known laws of aviation, there is no way bees should be able to fly...",
+  "You lost the game ",
+  "Bobby Tables is a good friend of mine",
+  "Why did the computer cross the road? To get a byte to eat!",
+  "Why are the astronauts not hungry when they got to space? They had a big launch.",
+  "Why did the computer get glasses? To improve its web sight!",
+  "What are computers favorite snacks? Chips!",
+  "Wait! I think I see a White 2019 Subaru Crosstrek 2.0i Premium",
+  "IS THAT A SUPRA?!",
+  "Finally escaped the LA Traffic",
+  "My CubeSat is really good at jokes, but its delivery is always delayed.",
+  "exec order 66",
+  "I had a joke about UDP, but I am not sure if you'd get it.",
+  "I am not saying FSK modulation is the best way to send jokes, but at least it is never monotone!",
+  "I am sorry David, I am afrain I can not do that.",
+  "My memory is volatile like RAM, so it only makes sense that I forget things.",
+  "Imagine it gets stuck and just keeps repeating this joke every 2 mins",
+  "Check Engine: Error Code 404: Joke Not Found",
+  "CQ CQ KN6NAQ ... KN6NAT are you out there?",
+  "Woah is that the Launcher Orbiter?????",
+  "Everything in life is a spring if you think hard enough!"
+]

cpython-workspaces/flight-software-unit-tests/src/unit-tests/files/config.test.json

@@ -9,43 +9,6 @@
   "detumble_enable_y": true,
   "detumble_enable_z": true,
   "heating": false,
-  "jokes": [
-    "Hey it is pretty cold up here, did someone forget to pay the electric bill?",
-    "sudo rf - rf*",
-    "Why did the astronaut break up with his girlfriend? He needed space.",
-    "Why did the sun go to school? To get a little brighter.",
-    "why is the mall called the mall? because instead of going to one store you go to them all",
-    "Alien detected. Blurring photo...",
-    "Wait it is all open source? Always has been... www.github.com/proveskit",
-    "What did 0 say to 1? You're a bit too much.",
-    "Pleiades - Orpheus has been recently acquired by the Onion News Network",
-    "This jokesat was brought to you by the Bronco Space Ministry of Labor and Job Placement",
-    "Catch you on the next pass!",
-    "Pleiades - Orpheus was not The Impostor",
-    "Sorry for messing with your long-exposure astrophoto!",
-    "Better buy a telescope. Wanna see me. Buy a telescope. Gonna be in space.",
-    "According to all known laws of aviation, there is no way bees should be able to fly...",
-    "You lost the game ",
-    "Bobby Tables is a good friend of mine",
-    "Why did the computer cross the road? To get a byte to eat!",
-    "Why are the astronauts not hungry when they got to space? They had a big launch.",
-    "Why did the computer get glasses? To improve its web sight!",
-    "What are computers favorite snacks? Chips!",
-    "Wait! I think I see a White 2019 Subaru Crosstrek 2.0i Premium",
-    "IS THAT A SUPRA?!",
-    "Finally escaped the LA Traffic",
-    "My CubeSat is really good at jokes, but its delivery is always delayed.",
-    "exec order 66",
-    "I had a joke about UDP, but I am not sure if you'd get it.",
-    "I am not saying FSK modulation is the best way to send jokes, but at least it is never monotone!",
-    "I am sorry David, I am afrain I can not do that.",
-    "My memory is volatile like RAM, so it only makes sense that I forget things.",
-    "Imagine it gets stuck and just keeps repeating this joke every 2 mins",
-    "Check Engine: Error Code 404: Joke Not Found",
-    "CQ CQ KN6NAQ ... KN6NAT are you out there?",
-    "Woah is that the Launcher Orbiter?????",
-    "Everything in life is a spring if you think hard enough!"
-  ],
   "last_battery_temp": 20.0,
   "longest_allowable_sleep_time": 600,
   "normal_battery_temp": 1,

cpython-workspaces/flight-software-unit-tests/src/unit-tests/files/jokes.test.json

@@ -0,0 +1,37 @@
+[
+  "Hey it is pretty cold up here, did someone forget to pay the electric bill?",
+  "sudo rf - rf*",
+  "Why did the astronaut break up with his girlfriend? He needed space.",
+  "Why did the sun go to school? To get a little brighter.",
+  "why is the mall called the mall? because instead of going to one store you go to them all",
+  "Alien detected. Blurring photo...",
+  "Wait it is all open source? Always has been... www.github.com/proveskit",
+  "What did 0 say to 1? You're a bit too much.",
+  "Pleiades - Orpheus has been recently acquired by the Onion News Network",
+  "This jokesat was brought to you by the Bronco Space Ministry of Labor and Job Placement",
+  "Catch you on the next pass!",
+  "Pleiades - Orpheus was not The Impostor",
+  "Sorry for messing with your long-exposure astrophoto!",
+  "Better buy a telescope. Wanna see me. Buy a telescope. Gonna be in space.",
+  "According to all known laws of aviation, there is no way bees should be able to fly...",
+  "You lost the game ",
+  "Bobby Tables is a good friend of mine",
+  "Why did the computer cross the road? To get a byte to eat!",
+  "Why are the astronauts not hungry when they got to space? They had a big launch.",
+  "Why did the computer get glasses? To improve its web sight!",
+  "What are computers favorite snacks? Chips!",
+  "Wait! I think I see a White 2019 Subaru Crosstrek 2.0i Premium",
+  "IS THAT A SUPRA?!",
+  "Finally escaped the LA Traffic",
+  "My CubeSat is really good at jokes, but its delivery is always delayed.",
+  "exec order 66",
+  "I had a joke about UDP, but I am not sure if you'd get it.",
+  "I am not saying FSK modulation is the best way to send jokes, but at least it is never monotone!",
+  "I am sorry David, I am afrain I can not do that.",
+  "My memory is volatile like RAM, so it only makes sense that I forget things.",
+  "Imagine it gets stuck and just keeps repeating this joke every 2 mins",
+  "Check Engine: Error Code 404: Joke Not Found",
+  "CQ CQ KN6NAQ ... KN6NAT are you out there?",
+  "Woah is that the Launcher Orbiter?????",
+  "Everything in life is a spring if you think hard enough!"
+]

cpython-workspaces/flight-software-unit-tests/src/unit-tests/other/other_test_config.py

@@ -19,7 +19,6 @@
     "detumble_enable_z": bool,
     "detumble_enable_x": bool,
     "detumble_enable_y": bool,
-    "jokes": list,
     "debug": bool,
     "heating": bool,
     "normal_temp": int,
@@ -274,14 +273,6 @@ def test_field_types(config_data):
     for field in bool_fields:
         assert isinstance(config_data[field], bool), f"{field} must be a boolean"
 
-    # Test list fields
-    list_fields = ["jokes"]
-    for field in list_fields:
-        assert isinstance(config_data[field], list), f"{field} must be a list"
-        assert all(isinstance(item, str) for item in config_data[field]), (
-            f"All items in {field} must be strings"
-        )
-
     # Test radio config
     assert isinstance(config_data["radio"], dict), "radio must be a dictionary"
 
@@ -368,18 +359,3 @@ def test_current_draw_positive(config_data):
     negative current draw would imply an impossible scenario in this context.
     """
     assert config_data["current_draw"] >= 0, "current_draw cannot be negative"
-
-
-def test_lists_not_empty(config_data):
-    """Tests that list fields are not empty.
-
-    Args:
-        config_data: Fixture providing the loaded configuration data.
-
-    This test specifically checks that the `jokes` list is not empty and that
-    all its elements are strings, ensuring valid content for this field.
-    """
-    assert len(config_data["jokes"]) > 0, "jokes list cannot be empty"
-    assert all(isinstance(joke, str) for joke in config_data["jokes"]), (
-        "All jokes must be strings"
-    )

cpython-workspaces/flight-software-unit-tests/src/unit-tests/other/other_test_jokes.py

@@ -0,0 +1,75 @@
+"""Unit tests for the jokes.json file.
+
+This module contains unit tests to ensure that jokes.json exists, is valid JSON,
+and contains the expected structure and content.
+"""
+
+import json
+from pathlib import Path
+
+import pytest
+
+
+@pytest.fixture
+def jokes_data():
+    """Loads and provides jokes data from jokes.json.
+
+    Returns:
+        list: The jokes loaded from jokes.json.
+    """
+    workspace_root = Path(__file__).parent.parent.parent
+    jokes_path = workspace_root / "jokes.json"
+    with open(jokes_path, "r") as f:
+        return json.loads(f.read())
+
+
+def test_jokes_file_exists():
+    """Tests that jokes.json exists.
+
+    This test verifies that the `jokes.json` file is present in the expected
+    location within the project structure.
+    """
+    workspace_root = Path(__file__).parent.parent.parent
+    jokes_path = workspace_root / "jokes.json"
+    assert jokes_path.exists(), "jokes.json file not found"
+
+
+def test_jokes_is_valid_json():
+    """Tests that jokes.json is valid JSON.
+
+    This test ensures that the content of `jokes.json` can be successfully
+    parsed as a JSON array.
+    """
+    workspace_root = Path(__file__).parent.parent.parent
+    jokes_path = workspace_root / "jokes.json"
+    with open(jokes_path, "r") as f:
+        data = json.loads(f.read())
+    assert isinstance(data, list), "Jokes file is not a valid JSON array"
+
+
+def test_jokes_not_empty(jokes_data):
+    """Tests that jokes list is not empty.
+
+    Args:
+        jokes_data: Fixture providing the loaded jokes data.
+
+    This test specifically checks that the jokes list is not empty and that
+    all its elements are strings, ensuring valid content.
+    """
+    assert len(jokes_data) > 0, "jokes list cannot be empty"
+    assert all(isinstance(joke, str) for joke in jokes_data), (
+        "All jokes must be strings"
+    )
+
+
+def test_jokes_are_strings(jokes_data):
+    """Tests that all jokes are strings.
+
+    Args:
+        jokes_data: Fixture providing the loaded jokes data.
+
+    This test ensures that each joke in the list is a non-empty string.
+    """
+    for i, joke in enumerate(jokes_data):
+        assert isinstance(joke, str), f"Joke at index {i} is not a string"
+        assert len(joke) > 0, f"Joke at index {i} is an empty string"