|
| 1 | +"""Tests for --enable-schedule / --no-enable-schedule CLI flag.""" |
| 2 | + |
| 3 | +import pytest |
| 4 | +from unittest.mock import patch |
| 5 | + |
| 6 | + |
| 7 | +class TestIsScheduleDisabledArgo: |
| 8 | + """Test _is_schedule_disabled in argo_workflows_cli.""" |
| 9 | + |
| 10 | + def _get_fn(self): |
| 11 | + from metaflow.plugins.argo.argo_workflows_cli import _is_schedule_disabled |
| 12 | + |
| 13 | + return _is_schedule_disabled |
| 14 | + |
| 15 | + def test_cli_flag_enable_overrides_env(self): |
| 16 | + fn = self._get_fn() |
| 17 | + with patch("metaflow.plugins.argo.argo_workflows_cli.SCHEDULE_DISABLED", True): |
| 18 | + # --enable-schedule should override env var |
| 19 | + assert fn(True) is False |
| 20 | + |
| 21 | + def test_cli_flag_disable_overrides_env(self): |
| 22 | + fn = self._get_fn() |
| 23 | + with patch("metaflow.plugins.argo.argo_workflows_cli.SCHEDULE_DISABLED", False): |
| 24 | + # --no-enable-schedule should override env var |
| 25 | + assert fn(False) is True |
| 26 | + |
| 27 | + def test_env_var_disabled(self): |
| 28 | + fn = self._get_fn() |
| 29 | + with patch("metaflow.plugins.argo.argo_workflows_cli.SCHEDULE_DISABLED", True): |
| 30 | + # No CLI flag, env var says disabled |
| 31 | + assert fn(None) is True |
| 32 | + |
| 33 | + def test_env_var_enabled(self): |
| 34 | + fn = self._get_fn() |
| 35 | + with patch("metaflow.plugins.argo.argo_workflows_cli.SCHEDULE_DISABLED", False): |
| 36 | + # No CLI flag, env var says enabled (default) |
| 37 | + assert fn(None) is False |
| 38 | + |
| 39 | + |
| 40 | +class TestIsScheduleDisabledSFN: |
| 41 | + """Test _is_schedule_disabled in step_functions_cli.""" |
| 42 | + |
| 43 | + def _get_fn(self): |
| 44 | + from metaflow.plugins.aws.step_functions.step_functions_cli import ( |
| 45 | + _is_schedule_disabled, |
| 46 | + ) |
| 47 | + |
| 48 | + return _is_schedule_disabled |
| 49 | + |
| 50 | + def test_cli_flag_enable_overrides_env(self): |
| 51 | + fn = self._get_fn() |
| 52 | + with patch( |
| 53 | + "metaflow.plugins.aws.step_functions.step_functions_cli.SCHEDULE_DISABLED", |
| 54 | + True, |
| 55 | + ): |
| 56 | + assert fn(True) is False |
| 57 | + |
| 58 | + def test_cli_flag_disable_overrides_env(self): |
| 59 | + fn = self._get_fn() |
| 60 | + with patch( |
| 61 | + "metaflow.plugins.aws.step_functions.step_functions_cli.SCHEDULE_DISABLED", |
| 62 | + False, |
| 63 | + ): |
| 64 | + assert fn(False) is True |
| 65 | + |
| 66 | + def test_env_var_disabled(self): |
| 67 | + fn = self._get_fn() |
| 68 | + with patch( |
| 69 | + "metaflow.plugins.aws.step_functions.step_functions_cli.SCHEDULE_DISABLED", |
| 70 | + True, |
| 71 | + ): |
| 72 | + assert fn(None) is True |
| 73 | + |
| 74 | + def test_env_var_enabled(self): |
| 75 | + fn = self._get_fn() |
| 76 | + with patch( |
| 77 | + "metaflow.plugins.aws.step_functions.step_functions_cli.SCHEDULE_DISABLED", |
| 78 | + False, |
| 79 | + ): |
| 80 | + assert fn(None) is False |
| 81 | + |
| 82 | + |
| 83 | +class TestArgoScheduleDisabled: |
| 84 | + """Test that ArgoWorkflows.schedule() respects schedule_disabled.""" |
| 85 | + |
| 86 | + def test_schedule_passes_none_when_disabled(self): |
| 87 | + """When schedule_disabled=True, schedule and timezone should be None.""" |
| 88 | + from unittest.mock import MagicMock |
| 89 | + |
| 90 | + from metaflow.plugins.argo.argo_workflows import ArgoWorkflows |
| 91 | + |
| 92 | + aw = object.__new__(ArgoWorkflows) |
| 93 | + aw.name = "test-workflow" |
| 94 | + aw._schedule = "0 * * * *" |
| 95 | + aw._timezone = "UTC" |
| 96 | + aw._sensor = None |
| 97 | + |
| 98 | + mock_client = MagicMock() |
| 99 | + with patch( |
| 100 | + "metaflow.plugins.argo.argo_workflows.ArgoClient", |
| 101 | + return_value=mock_client, |
| 102 | + ): |
| 103 | + aw.schedule(schedule_disabled=True) |
| 104 | + |
| 105 | + mock_client.schedule_workflow_template.assert_called_once_with( |
| 106 | + "test-workflow", None, None |
| 107 | + ) |
| 108 | + |
| 109 | + def test_schedule_passes_values_when_enabled(self): |
| 110 | + """When schedule_disabled=False, schedule and timezone should pass through.""" |
| 111 | + from unittest.mock import MagicMock |
| 112 | + |
| 113 | + from metaflow.plugins.argo.argo_workflows import ArgoWorkflows |
| 114 | + |
| 115 | + aw = object.__new__(ArgoWorkflows) |
| 116 | + aw.name = "test-workflow" |
| 117 | + aw._schedule = "0 * * * *" |
| 118 | + aw._timezone = "UTC" |
| 119 | + aw._sensor = None |
| 120 | + |
| 121 | + mock_client = MagicMock() |
| 122 | + with patch( |
| 123 | + "metaflow.plugins.argo.argo_workflows.ArgoClient", |
| 124 | + return_value=mock_client, |
| 125 | + ): |
| 126 | + aw.schedule(schedule_disabled=False) |
| 127 | + |
| 128 | + mock_client.schedule_workflow_template.assert_called_once_with( |
| 129 | + "test-workflow", "0 * * * *", "UTC" |
| 130 | + ) |
| 131 | + |
| 132 | + |
| 133 | +class TestSFNScheduleDisabled: |
| 134 | + """Test that StepFunctions.schedule() respects schedule_disabled.""" |
| 135 | + |
| 136 | + def test_schedule_skipped_when_disabled(self): |
| 137 | + """When schedule_disabled=True, EventBridge schedule should not be created.""" |
| 138 | + from unittest.mock import MagicMock |
| 139 | + |
| 140 | + from metaflow.plugins.aws.step_functions.step_functions import StepFunctions |
| 141 | + |
| 142 | + sf = object.__new__(StepFunctions) |
| 143 | + sf.name = "test-state-machine" |
| 144 | + sf._cron = "0 * * * ? *" |
| 145 | + |
| 146 | + with patch( |
| 147 | + "metaflow.plugins.aws.step_functions.step_functions.EventBridgeClient" |
| 148 | + ) as mock_eb: |
| 149 | + sf.schedule(schedule_disabled=True) |
| 150 | + |
| 151 | + # EventBridgeClient should not be called at all |
| 152 | + mock_eb.assert_not_called() |
| 153 | + |
| 154 | + def test_schedule_created_when_enabled(self): |
| 155 | + """When schedule_disabled=False, EventBridge schedule should be created normally.""" |
| 156 | + from unittest.mock import MagicMock |
| 157 | + |
| 158 | + from metaflow.plugins.aws.step_functions.step_functions import StepFunctions |
| 159 | + |
| 160 | + sf = object.__new__(StepFunctions) |
| 161 | + sf.name = "test-state-machine" |
| 162 | + sf._cron = "0 * * * ? *" |
| 163 | + sf._state_machine_arn = "arn:aws:states:us-east-1:123:stateMachine:test" |
| 164 | + |
| 165 | + mock_eb_instance = MagicMock() |
| 166 | + mock_eb_instance.cron.return_value = mock_eb_instance |
| 167 | + mock_eb_instance.role_arn.return_value = mock_eb_instance |
| 168 | + mock_eb_instance.state_machine_arn.return_value = mock_eb_instance |
| 169 | + mock_eb_instance.schedule.return_value = "test-state-machine" |
| 170 | + |
| 171 | + with patch( |
| 172 | + "metaflow.plugins.aws.step_functions.step_functions.EventBridgeClient", |
| 173 | + return_value=mock_eb_instance, |
| 174 | + ), patch( |
| 175 | + "metaflow.plugins.aws.step_functions.step_functions.EVENTS_SFN_ACCESS_IAM_ROLE", |
| 176 | + "arn:aws:iam::123:role/test", |
| 177 | + ): |
| 178 | + sf.schedule(schedule_disabled=False) |
| 179 | + |
| 180 | + mock_eb_instance.cron.assert_called_once_with("0 * * * ? *") |
0 commit comments