import pytest import responses from flask import Flask from urlobject import URLObject from flask_dance.consumer import OAuth2ConsumerBlueprint from flask_dance.consumer.storage import MemoryStorage from flask_dance.contrib.gitlab import gitlab, make_gitlab_blueprint @pytest.fixture def make_app(): "A callable to create a Flask app with the GitLab provider" def _make_app(*args, **kwargs): app = Flask(__name__) app.config["SERVER_NAME"] = "a.b.c" app.secret_key = "whatever" blueprint = make_gitlab_blueprint(*args, **kwargs) app.register_blueprint(blueprint) return app return _make_app def test_blueprint_factory_default(): # Test with gitlab.com glbp = make_gitlab_blueprint( client_id="foo", client_secret="bar", scope="read_user", redirect_to="index" ) assert isinstance(glbp, OAuth2ConsumerBlueprint) assert glbp.session.scope == "read_user" assert glbp.session.base_url == "https://gitlab.com/api/v4/" assert glbp.session.client_id == "foo" assert glbp.client_secret == "bar" assert glbp.authorization_url == "https://gitlab.com/oauth/authorize" assert glbp.token_url == "https://gitlab.com/oauth/token" def test_blueprint_factory_custom(): glbp = make_gitlab_blueprint( client_id="foo", client_secret="bar", scope="read_user", redirect_to="index", hostname="git.example.com", ) assert isinstance(glbp, OAuth2ConsumerBlueprint) assert glbp.session.scope == "read_user" assert glbp.session.base_url == "https://git.example.com/api/v4/" assert glbp.session.client_id == "foo" assert glbp.client_secret == "bar" assert glbp.authorization_url == "https://git.example.com/oauth/authorize" assert glbp.token_url == "https://git.example.com/oauth/token" def test_load_from_config(make_app): app = make_app() app.config["GITLAB_OAUTH_CLIENT_ID"] = "foo" app.config["GITLAB_OAUTH_CLIENT_SECRET"] = "bar" resp = app.test_client().get("/gitlab") url = resp.headers["Location"] client_id = URLObject(url).query.dict.get("client_id") assert client_id == "foo" @responses.activate def test_context_local(make_app): responses.add(responses.GET, "https://google.com") # set up two apps with two different set of auth tokens app1 = make_app( "foo1", "bar1", redirect_to="url1", storage=MemoryStorage({"access_token": "app1"}), ) app2 = make_app( "foo2", "bar2", redirect_to="url2", storage=MemoryStorage({"access_token": "app2"}), ) # outside of a request context, referencing functions on the `gitlab` object # will raise an exception with pytest.raises(RuntimeError): gitlab.get("https://google.com") # inside of a request context, `gitlab` should be a proxy to the correct # blueprint session with app1.test_request_context("/"): app1.preprocess_request() gitlab.get("https://google.com") request = responses.calls[0].request assert request.headers["Authorization"] == "Bearer app1" with app2.test_request_context("/"): app2.preprocess_request() gitlab.get("https://google.com") request = responses.calls[1].request assert request.headers["Authorization"] == "Bearer app2" def test_no_verify_token(make_app, mocker): app = make_app( "foo", "bar", hostname="my-insecure-gitlab.com", storage=MemoryStorage(), verify_tls_certificates=False, ) with responses.RequestsMock() as rsps: mock_on_request = mocker.patch.object( rsps, "_on_request", wraps=rsps._on_request ) rsps.add( responses.POST, "https://my-insecure-gitlab.com/oauth/token", body='{"access_token":"foobar","token_type":"bearer","scope":"admin"}', ) with app.test_client() as client: # reset the session before the request with client.session_transaction() as sess: sess["gitlab_oauth_state"] = "random-string" # make the request resp = client.get( "/gitlab/authorized?code=secret-code&state=random-string", base_url="https://a.b.c", ) # check that `verify=False` in the token request mock_on_request.assert_called() call_verify = mock_on_request.call_args[1].get("verify", True) assert call_verify is False def test_no_verify_api_call(make_app, mocker): app = make_app( "foo", "bar", hostname="my-insecure-gitlab.com", storage=MemoryStorage({"access_token": "fake-token"}), verify_tls_certificates=False, ) with responses.RequestsMock() as rsps: mock_on_request = mocker.patch.object( rsps, "_on_request", wraps=rsps._on_request ) rsps.add( method=responses.GET, url="https://my-insecure-gitlab.com", body="insecure but OK", ) with app.test_request_context("/"): app.preprocess_request() gitlab.get("https://my-insecure-gitlab.com") # check that `verify=False` in the API call mock_on_request.assert_called() call_verify = mock_on_request.call_args[1].get("verify", True) assert call_verify is False