Merge pull request #344 from sot/scs107_hrc_off

[bugfix] Add commands to turn HRC off to SCS 107

Author: taldcroft

kadi/commands/command_sets.py

@@ -7,6 +7,7 @@
 from Quaternion import Quat
 from ska_helpers.utils import convert_to_int_float_str
 
+import kadi.commands
 from kadi.commands.core import CommandTable
 
 RTS_PATH = Path("FOT/configuration/products/rts")
@@ -90,17 +91,27 @@ def cmd_set_scs107(date=None):
     cmds = cmd_set_end_observing()
     cmds += (
         dict(type="COMMAND_SW", dur=1.025, tlmsid="OORMPDS"),
-        dict(
-            type="COMMAND_HW",
-            # dur=1.025,
-            tlmsid="AFIDP",
-            msid="AFLCRSET",
-        ),
+        dict(type="COMMAND_HW", tlmsid="AFIDP", msid="AFLCRSET"),
         dict(type="SIMTRANS", params=dict(POS=-99616), dur=65.66),
         dict(type="ACISPKT", tlmsid="AA00000000", dur=1.025),
         dict(type="ACISPKT", tlmsid="AA00000000", dur=10.25),
         dict(type="ACISPKT", tlmsid=pow_cmd),
     )
+    # Note that the following block to include HRC turn-off commands is wrapped in a
+    # config variable to make this conditional in support of regression testing. This is
+    # needed for tests of command generation vs. commands in the archive which did not
+    # include this HRC SCS-107 commanding (prior to #344).
+    if not kadi.commands.conf.disable_hrc_scs107_commanding:
+        cmds += (
+            dict(type="COMMAND_HW", tlmsid="215PCAOF", dur=1.205),
+            dict(type="COMMAND_HW", tlmsid="2IMHVOF", dur=1.025),
+            dict(type="COMMAND_HW", tlmsid="2SPHVOF", dur=1.025),
+            dict(type="COMMAND_HW", tlmsid="2S2STHV", dur=1.025),
+            dict(type="COMMAND_HW", tlmsid="2S1STHV", dur=1.025),
+            dict(type="COMMAND_HW", tlmsid="2S2HVOF", dur=1.025),
+            dict(type="COMMAND_HW", tlmsid="2S1HVOF", dur=1.025),
+        )
+
     return cmds
 
 

kadi/commands/tests/conftest.py

@@ -1,7 +1,14 @@
 import pytest
 import ska_sun
 
+import kadi.commands
+
 
 @pytest.fixture()
 def fast_sun_position_method(monkeypatch: pytest.MonkeyPatch):
     monkeypatch.setattr(ska_sun.conf, "sun_position_method_default", "fast")
+
+
+@pytest.fixture()
+def disable_hrc_scs107_commanding(monkeypatch: pytest.MonkeyPatch):
+    monkeypatch.setattr(kadi.commands.conf, "disable_hrc_scs107_commanding", True)

kadi/commands/tests/test_commands.py

@@ -236,7 +236,9 @@ def test_get_cmds_from_backstop_and_add_cmds():
 
 @pytest.mark.skipif("not HAS_MPDIR")
 @pytest.mark.skipif(not HAS_INTERNET, reason="No internet connection")
-def test_commands_create_archive_regress(tmpdir, fast_sun_position_method):
+def test_commands_create_archive_regress(
+    tmpdir, fast_sun_position_method, disable_hrc_scs107_commanding
+):
     """Create cmds archive from scratch and test that it matches flight
 
     This tests over an eventful month that includes IU reset/NSM, SCS-107
@@ -462,7 +464,7 @@ def test_get_cmds_v2_recent_only(stop_date_2020_12_03):  # noqa: ARG001
 
 
 @pytest.mark.skipif(not HAS_INTERNET, reason="No internet connection")
-def test_get_cmds_nsm_2021(stop_date_2021_10_24):  # noqa: ARG001
+def test_get_cmds_nsm_2021(stop_date_2021_10_24, disable_hrc_scs107_commanding):
     """NSM at ~2021:296:10:41. This tests non-load commands from cmd_events."""
     cmds = commands.get_cmds("2021:296:10:35:00")  # , '2021:298:01:58:00')
     cmds = cmds[cmds["tlmsid"] != "OBS"]
@@ -538,6 +540,7 @@ def test_get_cmds_nsm_2021(stop_date_2021_10_24):  # noqa: ARG001
         "2021:297:14:01:00.000 | LOAD_EVENT       | None       | OCT1821A | "
         "event_type=SCHEDULED_STOP_TIME, scs=0",
     ]
+
     assert cmds.pformat_like_backstop(max_params_width=200) == exp
     commands.clear_caches()
 
@@ -676,7 +679,14 @@ def test_command_set_bsh():
 2000:001:00:00:01.025 | SIMTRANS         | None       | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, pos=-99616, scs=0
 2000:001:00:01:06.685 | ACISPKT          | AA00000000 | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0
 2000:001:00:01:07.710 | ACISPKT          | AA00000000 | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0
-2000:001:00:01:17.960 | ACISPKT          | WSPOW00000 | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0"""
+2000:001:00:01:17.960 | ACISPKT          | WSPOW00000 | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:17.960 | COMMAND_HW       | 215PCAOF   | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:19.165 | COMMAND_HW       | 2IMHVOF    | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:20.190 | COMMAND_HW       | 2SPHVOF    | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:21.215 | COMMAND_HW       | 2S2STHV    | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:22.240 | COMMAND_HW       | 2S1STHV    | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:23.265 | COMMAND_HW       | 2S2HVOF    | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:24.290 | COMMAND_HW       | 2S1HVOF    | CMD_EVT  | event=Bright_star_hold, event_date=2000:001:00:00:00, scs=0"""
 
     assert cmds.pformat_like_backstop(max_params_width=None) == exp.splitlines()
     commands.clear_caches()
@@ -699,13 +709,22 @@ def test_command_set_safe_mode():
 2000:001:00:01:06.685 | ACISPKT          | AA00000000 | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
 2000:001:00:01:07.710 | ACISPKT          | AA00000000 | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
 2000:001:00:01:17.960 | ACISPKT          | WSPOW00000 | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
-2000:001:00:01:17.960 | COMMAND_SW       | AODSDITH   | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0"""
+2000:001:00:01:17.960 | COMMAND_HW       | 215PCAOF   | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:19.165 | COMMAND_HW       | 2IMHVOF    | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:20.190 | COMMAND_HW       | 2SPHVOF    | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:21.215 | COMMAND_HW       | 2S2STHV    | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:22.240 | COMMAND_HW       | 2S1STHV    | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:23.265 | COMMAND_HW       | 2S2HVOF    | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:24.290 | COMMAND_HW       | 2S1HVOF    | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0
+2000:001:00:01:25.315 | COMMAND_SW       | AODSDITH   | CMD_EVT  | event=Safe_mode, event_date=2000:001:00:00:00, scs=0"""
     assert cmds.pformat_like_backstop(max_params_width=None) == exp.splitlines()
     commands.clear_caches()
 
 
 @pytest.mark.skipif(not HAS_INTERNET, reason="No internet connection")
-def test_bright_star_hold_event(cmds_dir, stop_date_2020_12_03):  # noqa: ARG001
+def test_bright_star_hold_event(
+    cmds_dir, stop_date_2020_12_03, disable_hrc_scs107_commanding
+):
     """Make a scenario with a bright star hold event.
 
     Confirm that this inserts expected commands and interrupts all load commands.
@@ -1265,7 +1284,7 @@ def test_get_cmds_from_event_case(par_str):
 
 
 @pytest.mark.parametrize("idx", range(len(cmd_events_all_exps)))
-def test_get_cmds_from_event_all(idx):
+def test_get_cmds_from_event_all(idx, disable_hrc_scs107_commanding):
     """Test getting commands from every event type in the Command Events sheet"""
     cevt = cmd_events_all[idx]
     exp = cmd_events_all_exps[idx]
@@ -1337,7 +1356,14 @@ def test_scenario_with_rts(monkeypatch, fast_sun_position_method):
 2021:296:10:43:03.685 | ACISPKT          | AA00000000 | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
 2021:296:10:43:04.710 | ACISPKT          | AA00000000 | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
 2021:296:10:43:14.960 | ACISPKT          | WSPOW0002A | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
-2021:296:10:43:14.960 | COMMAND_SW       | AODSDITH   | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
+2021:296:10:43:14.960 | COMMAND_HW       | 215PCAOF   | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
+2021:296:10:43:16.165 | COMMAND_HW       | 2IMHVOF    | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
+2021:296:10:43:17.190 | COMMAND_HW       | 2SPHVOF    | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
+2021:296:10:43:18.215 | COMMAND_HW       | 2S2STHV    | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
+2021:296:10:43:19.240 | COMMAND_HW       | 2S1STHV    | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
+2021:296:10:43:20.265 | COMMAND_HW       | 2S2HVOF    | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
+2021:296:10:43:21.290 | COMMAND_HW       | 2S1HVOF    | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
+2021:296:10:43:22.315 | COMMAND_SW       | AODSDITH   | CMD_EVT  | event=NSM, event_date=2021:296:10:41:57, scs=0
 2021:296:11:08:12.966 | LOAD_EVENT       | OBS        | CMD_EVT  | manvr_start=2021:296:10:41:57.000, prev_att=(0.594590732, 0.
 2021:297:01:41:01.000 | COMMAND_SW       | AONMMODE   | CMD_EVT  | event=Maneuver, event_date=2021:297:01:41:01, msid=AONMMODE,
 2021:297:01:41:01.256 | COMMAND_SW       | AONM2NPE   | CMD_EVT  | event=Maneuver, event_date=2021:297:01:41:01, msid=AONM2NPE,

kadi/commands/tests/test_validate.py

@@ -155,7 +155,13 @@ def get_one_validator_data(cls: type[Validate], stop, days, no_exclude):
 @pytest.mark.skipif(not HAS_INTERNET, reason="Command sheet not available")
 @pytest.mark.parametrize("cls", Validate.subclasses)
 @pytest.mark.parametrize("no_exclude", [False, True])
-def test_validate_regression(cls, no_exclude, fast_sun_position_method, regress_stop):
+def test_validate_regression(
+    cls,
+    no_exclude,
+    fast_sun_position_method,
+    regress_stop,
+    disable_hrc_scs107_commanding,
+):
     """Test that validator data matches regression data
 
     This is likely to be fragile. In the future we may need helper function to output

kadi/config.py

@@ -73,6 +73,12 @@ class Conf(ConfigNamespace):
         "Start date for using AGASC 1.8 catalog.",
     )
 
+    disable_hrc_scs107_commanding = ConfigItem(
+        False,
+        "Disable HRC SCS-107 commanding from #344, strictly for regression testing "
+        "of command generation prior to that patch.",
+    )
+
 
 # Create a configuration instance for the user
 conf = Conf()