feat(vpn): auto-disconnect VPN on project and organization switch #568
+245
−17
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -87,6 +87,18 @@ def get_tailscale_status() -> dict: | |
| return json.loads(output) | ||
|
|
||
|
|
||
| def should_disconnect_vpn(config: dict, keep_vpn: bool) -> bool: | ||
| """Returns True if VPN should be auto-disconnected on project/org switch. | ||
|
|
||
| When True, both the VPN tunnel and the /etc/hosts cleanup are performed. | ||
| Returns False (skipping both) if --keep-vpn flag is passed, or if the | ||
| user has set auto_disconnect_vpn: false in ~/.rio-cli/config.json. | ||
| """ | ||
| if keep_vpn: | ||
| return False | ||
| return config.get("auto_disconnect_vpn", True) | ||
|
Member
There was a problem hiding this comment. suggestion (blocking): Expose Every other user-overridable setting in the CLI is a class-level default plus a non-raising property on # riocli/config/config.py, next to DIFF_TOOL / MERGE_TOOL
AUTO_DISCONNECT_VPN = True
@property
def auto_disconnect_vpn(self: Configuration) -> bool:
return self.data.get("auto_disconnect_vpn", self.AUTO_DISCONNECT_VPN)Then Same for the guard in the comment on |
||
|
|
||
|
|
||
| def install_vpn_tools(force: bool = False) -> None: | ||
| if is_tailscale_installed(): | ||
| return | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| from unittest.mock import MagicMock, patch | ||
|
|
||
| from click.testing import CliRunner | ||
|
|
||
| from riocli.vpn.util import should_disconnect_vpn | ||
|
|
||
|
|
||
| class TestShouldDisconnectVpn: | ||
| def test_disconnects_by_default(self): | ||
| assert should_disconnect_vpn({}, keep_vpn=False) is True | ||
|
|
||
| def test_keep_vpn_flag_suppresses_disconnect(self): | ||
| assert should_disconnect_vpn({}, keep_vpn=True) is False | ||
|
|
||
| def test_config_opt_out_suppresses_disconnect(self): | ||
| assert ( | ||
| should_disconnect_vpn({"auto_disconnect_vpn": False}, keep_vpn=False) is False | ||
| ) | ||
|
|
||
| def test_config_opt_out_with_keep_vpn_flag(self): | ||
| assert ( | ||
| should_disconnect_vpn({"auto_disconnect_vpn": False}, keep_vpn=True) is False | ||
| ) | ||
|
|
||
| def test_config_explicitly_true_disconnects(self): | ||
| assert ( | ||
| should_disconnect_vpn({"auto_disconnect_vpn": True}, keep_vpn=False) is True | ||
| ) | ||
|
|
||
| def test_keep_vpn_flag_overrides_config_true(self): | ||
| assert ( | ||
| should_disconnect_vpn({"auto_disconnect_vpn": True}, keep_vpn=True) is False | ||
| ) | ||
|
|
||
|
|
||
| def _make_project_ctx(config_data=None): | ||
| obj = MagicMock() | ||
| obj.data = { | ||
| "project_id": "old-guid", | ||
| "project_name": "old-project", | ||
| "organization_id": "org-guid", | ||
| **(config_data or {}), | ||
| } | ||
| return obj | ||
|
|
||
|
|
||
| def _make_org_ctx(config_data=None): | ||
| obj = MagicMock() | ||
| obj.data = { | ||
| "organization_id": "different-org-guid", # different so "already in org" check passes | ||
| "organization_name": "old-org", | ||
| "organization_short_id": "old-short", | ||
| **(config_data or {}), | ||
| } | ||
| return obj | ||
|
|
||
|
|
||
| class TestProjectSelectVpnDisconnect: | ||
| def _invoke(self, args, ctx_obj): | ||
| from riocli.project.select import select_project | ||
|
|
||
| with ( | ||
| patch("riocli.project.util.new_v2_client"), | ||
| patch("riocli.project.util.find_project_guid", return_value="new-guid"), | ||
| patch("riocli.project.util.get_project_name", return_value="new-project"), | ||
| patch("riocli.project.select.get_root_context") as mock_get_ctx, | ||
| ): | ||
| mock_get_ctx.return_value.obj = ctx_obj | ||
| # Pass obj so click.get_current_context().obj works inside name_to_guid | ||
| return CliRunner().invoke(select_project, args, obj=ctx_obj), mock_get_ctx | ||
|
|
||
| @patch("riocli.project.select.is_tailscale_up", return_value=True) | ||
| @patch("riocli.project.select.stop_tailscale", return_value=True) | ||
| @patch("riocli.project.select.cleanup_hosts_file") | ||
| def test_disconnects_vpn_when_tailscale_up(self, mock_cleanup, mock_stop, mock_is_up): | ||
| result, _ = self._invoke(["new-project"], _make_project_ctx()) | ||
| assert result.exit_code == 0 | ||
| mock_stop.assert_called_once() | ||
| mock_cleanup.assert_called_once() | ||
|
|
||
| @patch("riocli.project.select.is_tailscale_up", return_value=False) | ||
| @patch("riocli.project.select.stop_tailscale") | ||
| @patch("riocli.project.select.cleanup_hosts_file") | ||
| def test_skips_stop_when_tailscale_not_up(self, mock_cleanup, mock_stop, mock_is_up): | ||
| result, _ = self._invoke(["new-project"], _make_project_ctx()) | ||
| assert result.exit_code == 0 | ||
| mock_stop.assert_not_called() | ||
| mock_cleanup.assert_called_once() | ||
|
|
||
| @patch("riocli.project.select.is_tailscale_up", return_value=True) | ||
| @patch("riocli.project.select.stop_tailscale") | ||
| @patch("riocli.project.select.cleanup_hosts_file") | ||
| def test_keep_vpn_flag_skips_disconnect_and_cleanup( | ||
| self, mock_cleanup, mock_stop, mock_is_up | ||
| ): | ||
| result, _ = self._invoke(["new-project", "--keep-vpn"], _make_project_ctx()) | ||
| assert result.exit_code == 0 | ||
| mock_stop.assert_not_called() | ||
| mock_cleanup.assert_not_called() | ||
|
|
||
| @patch("riocli.project.select.is_tailscale_up", return_value=True) | ||
| @patch("riocli.project.select.stop_tailscale") | ||
| @patch("riocli.project.select.cleanup_hosts_file") | ||
| def test_config_opt_out_skips_disconnect_and_cleanup( | ||
| self, mock_cleanup, mock_stop, mock_is_up | ||
| ): | ||
| result, _ = self._invoke( | ||
| ["new-project"], _make_project_ctx({"auto_disconnect_vpn": False}) | ||
| ) | ||
| assert result.exit_code == 0 | ||
| mock_stop.assert_not_called() | ||
| mock_cleanup.assert_not_called() | ||
|
|
||
| @patch("riocli.project.select.is_tailscale_up", return_value=True) | ||
| @patch("riocli.project.select.stop_tailscale", return_value=False) | ||
| @patch("riocli.project.select.cleanup_hosts_file") | ||
| def test_hosts_not_cleaned_when_stop_fails(self, mock_cleanup, mock_stop, mock_is_up): | ||
|
Member
There was a problem hiding this comment. praise: Good to see the failure path pinned — asserting |
||
| result, _ = self._invoke(["new-project"], _make_project_ctx()) | ||
| assert result.exit_code == 0 | ||
| mock_stop.assert_called_once() | ||
| mock_cleanup.assert_not_called() | ||
|
|
||
|
|
||
| class TestOrgSelectVpnDisconnect: | ||
| def _invoke(self, args, ctx_obj): | ||
| from riocli.organization.select import select_organization | ||
|
|
||
| with ( | ||
| patch("riocli.organization.util.new_v2_client"), | ||
| patch( | ||
| "riocli.organization.util.find_organization_guid", | ||
| return_value=("new-org-guid", "new-short"), | ||
| ), | ||
| patch("riocli.organization.select.get_root_context") as mock_get_ctx, | ||
| ): | ||
| mock_get_ctx.return_value.obj = ctx_obj | ||
| return CliRunner().invoke(select_organization, args), mock_get_ctx | ||
|
|
||
| @patch("riocli.organization.select.is_tailscale_up", return_value=True) | ||
| @patch("riocli.organization.select.stop_tailscale", return_value=True) | ||
| @patch("riocli.organization.select.cleanup_hosts_file") | ||
| def test_disconnects_vpn_when_tailscale_up(self, mock_cleanup, mock_stop, mock_is_up): | ||
| result, _ = self._invoke(["new-org", "--no-interactive"], _make_org_ctx()) | ||
| assert result.exit_code == 0 | ||
| mock_stop.assert_called_once() | ||
| mock_cleanup.assert_called_once() | ||
|
|
||
| @patch("riocli.organization.select.is_tailscale_up", return_value=True) | ||
| @patch("riocli.organization.select.stop_tailscale") | ||
| @patch("riocli.organization.select.cleanup_hosts_file") | ||
| def test_keep_vpn_flag_skips_disconnect_and_cleanup( | ||
| self, mock_cleanup, mock_stop, mock_is_up | ||
| ): | ||
| result, _ = self._invoke( | ||
| ["new-org", "--keep-vpn", "--no-interactive"], _make_org_ctx() | ||
| ) | ||
| assert result.exit_code == 0 | ||
| mock_stop.assert_not_called() | ||
| mock_cleanup.assert_not_called() | ||
|
|
||
| @patch("riocli.organization.select.is_tailscale_up", return_value=True) | ||
| @patch("riocli.organization.select.stop_tailscale") | ||
| @patch("riocli.organization.select.cleanup_hosts_file") | ||
| def test_config_opt_out_skips_disconnect_and_cleanup( | ||
| self, mock_cleanup, mock_stop, mock_is_up | ||
| ): | ||
| result, _ = self._invoke( | ||
| ["new-org", "--no-interactive"], _make_org_ctx({"auto_disconnect_vpn": False}) | ||
| ) | ||
| assert result.exit_code == 0 | ||
| mock_stop.assert_not_called() | ||
| mock_cleanup.assert_not_called() | ||
|
|
||
| @patch("riocli.organization.select.is_tailscale_up", return_value=True) | ||
| @patch("riocli.organization.select.stop_tailscale", return_value=False) | ||
| @patch("riocli.organization.select.cleanup_hosts_file") | ||
| def test_hosts_not_cleaned_when_stop_fails(self, mock_cleanup, mock_stop, mock_is_up): | ||
| result, _ = self._invoke(["new-org", "--no-interactive"], _make_org_ctx()) | ||
| assert result.exit_code == 0 | ||
| mock_stop.assert_called_once() | ||
| mock_cleanup.assert_not_called() | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (non-blocking): Extract this block — it is byte-identical to
riocli/project/select.py:67-89.A
disconnect_vpn_for_switch(config: Configuration, keep_vpn: bool) -> Noneinriocli/vpn/util.py, next toshould_disconnect_vpn, would leave one call site in each command and let the unit tests target the helper directly instead of driving both commands throughCliRunner. The drift risk is already visible:project/select.pydocuments the new behaviour in its docstring and this command does not.