diff --git a/swh/web/client/cli.py b/swh/web/client/cli.py index 868324c..48e6754 100644 --- a/swh/web/client/cli.py +++ b/swh/web/client/cli.py @@ -1,93 +1,96 @@ # Copyright (C) 2020 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information -from getpass import getpass - +# WARNING: do not import unnecessary things here to keep cli startup time under +# control import click from click.core import Context -from swh.web.client.auth import OpenIDConnectSession CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"]) @click.group(name="auth", context_settings=CONTEXT_SETTINGS) @click.option( "--oidc-server-url", "oidc_server_url", default="https://auth.softwareheritage.org/auth/", help=( "URL of OpenID Connect server (default to " '"https://auth.softwareheritage.org/auth/")' ), ) @click.option( "--realm-name", "realm_name", default="SoftwareHeritage", help=( "Name of the OpenID Connect authentication realm " '(default to "SoftwareHeritage")' ), ) @click.option( "--client-id", "client_id", default="swh-web", help=("OpenID Connect client identifier in the realm " '(default to "swh-web")'), ) @click.pass_context def auth(ctx: Context, oidc_server_url: str, realm_name: str, client_id: str): """ Authenticate Software Heritage users with OpenID Connect. This CLI tool eases the retrieval of a bearer token to authenticate a user querying the Software Heritage Web API. """ + from swh.web.client.auth import OpenIDConnectSession + ctx.ensure_object(dict) ctx.obj["oidc_session"] = OpenIDConnectSession( oidc_server_url, realm_name, client_id ) @auth.command("login") @click.argument("username") @click.pass_context def login(ctx: Context, username: str): """ Login and create new offline OpenID Connect session. Login with USERNAME, create a new OpenID Connect session and get bearer token. User will be prompted for his password and tokens will be printed to standard output. The created OpenID Connect session is an offline one so the provided token has a much longer expiration time than classical OIDC sessions (usually several dozens of days). """ + from getpass import getpass + password = getpass() oidc_info = ctx.obj["oidc_session"].login(username, password) if "refresh_token" in oidc_info: print(oidc_info["refresh_token"]) else: print(oidc_info) @auth.command("logout") @click.argument("token") @click.pass_context def logout(ctx: Context, token: str): """ Logout from an offline OpenID Connect session. Use TOKEN to logout from an offline OpenID Connect session. The token is definitely revoked after that operation. """ ctx.obj["oidc_session"].logout(token) print("Successfully logged out from OpenID Connect session") diff --git a/swh/web/client/tests/test_cli.py b/swh/web/client/tests/test_cli.py index 605a12d..f76af36 100644 --- a/swh/web/client/tests/test_cli.py +++ b/swh/web/client/tests/test_cli.py @@ -1,50 +1,50 @@ # Copyright (C) 2020 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information from click.testing import CliRunner from swh.web.client.cli import auth runner = CliRunner() oidc_profile = { "access_token": "some-access-token", "expires_in": 600, "refresh_expires_in": 0, "refresh_token": "some-refresh-token", "token_type": "bearer", "session_state": "some-state", "scope": "openid email profile offline_access", } def test_auth_login(mocker): - mock_getpass = mocker.patch("swh.web.client.cli.getpass") + mock_getpass = mocker.patch("getpass.getpass") mock_getpass.return_value = "password" - mock_oidc_session = mocker.patch("swh.web.client.cli.OpenIDConnectSession") + mock_oidc_session = mocker.patch("swh.web.client.auth.OpenIDConnectSession") mock_login = mock_oidc_session.return_value.login mock_login.return_value = oidc_profile result = runner.invoke(auth, ["login", "username"], input="password\n") assert result.exit_code == 0 assert result.output[:-1] == oidc_profile["refresh_token"] mock_login.side_effect = Exception("Auth error") result = runner.invoke(auth, ["login", "username"], input="password\n") assert result.exit_code == 1 def test_auth_logout(mocker): - mock_oidc_session = mocker.patch("swh.web.client.cli.OpenIDConnectSession") + mock_oidc_session = mocker.patch("swh.web.client.auth.OpenIDConnectSession") mock_logout = mock_oidc_session.return_value.logout result = runner.invoke(auth, ["logout", oidc_profile["refresh_token"]]) assert result.exit_code == 0 mock_logout.side_effect = Exception("Auth error") result = runner.invoke(auth, ["logout", oidc_profile["refresh_token"]]) assert result.exit_code == 1