| 1 |
import pytest |
| 2 |
import responses |
| 3 |
from flask import Flask |
| 4 |
from urlobject import URLObject |
| 5 |
|
| 6 |
from flask_dance.consumer import OAuth2ConsumerBlueprint |
| 7 |
from flask_dance.consumer.storage import MemoryStorage |
| 8 |
from flask_dance.contrib.salesforce import make_salesforce_blueprint, salesforce |
| 9 |
|
| 10 |
|
| 11 |
@pytest.fixture |
| 12 |
def make_app(): |
| 13 |
"A callable to create a Flask app with the Salesforce provider" |
| 14 |
|
| 15 |
def _make_app(*args, **kwargs): |
| 16 |
app = Flask(__name__) |
| 17 |
app.secret_key = "whatever" |
| 18 |
blueprint = make_salesforce_blueprint(*args, **kwargs) |
| 19 |
app.register_blueprint(blueprint) |
| 20 |
return app |
| 21 |
|
| 22 |
return _make_app |
| 23 |
|
| 24 |
|
| 25 |
def test_blueprint_factory_default(): |
| 26 |
salesforce_bp = make_salesforce_blueprint( |
| 27 |
client_id="foo", |
| 28 |
client_secret="bar", |
| 29 |
scope="api", |
| 30 |
redirect_to="index", |
| 31 |
) |
| 32 |
assert isinstance(salesforce_bp, OAuth2ConsumerBlueprint) |
| 33 |
assert salesforce_bp.session.scope == "api" |
| 34 |
assert salesforce_bp.session.base_url == "https://login.salesforce.com/" |
| 35 |
assert salesforce_bp.session.client_id == "foo" |
| 36 |
assert salesforce_bp.client_secret == "bar" |
| 37 |
assert ( |
| 38 |
salesforce_bp.authorization_url |
| 39 |
== "https://login.salesforce.com/services/oauth2/authorize" |
| 40 |
) |
| 41 |
assert ( |
| 42 |
salesforce_bp.token_url == "https://login.salesforce.com/services/oauth2/token" |
| 43 |
) |
| 44 |
|
| 45 |
|
| 46 |
def test_blueprint_factory_sandbox(): |
| 47 |
salesforce_bp = make_salesforce_blueprint( |
| 48 |
client_id="foo", |
| 49 |
client_secret="bar", |
| 50 |
scope="api", |
| 51 |
redirect_to="index", |
| 52 |
is_sandbox=True, |
| 53 |
) |
| 54 |
assert isinstance(salesforce_bp, OAuth2ConsumerBlueprint) |
| 55 |
assert salesforce_bp.session.scope == "api" |
| 56 |
assert salesforce_bp.session.base_url == "https://test.salesforce.com/" |
| 57 |
assert salesforce_bp.session.client_id == "foo" |
| 58 |
assert salesforce_bp.client_secret == "bar" |
| 59 |
assert ( |
| 60 |
salesforce_bp.authorization_url |
| 61 |
== "https://test.salesforce.com/services/oauth2/authorize" |
| 62 |
) |
| 63 |
assert ( |
| 64 |
salesforce_bp.token_url == "https://test.salesforce.com/services/oauth2/token" |
| 65 |
) |
| 66 |
|
| 67 |
|
| 68 |
def test_blueprint_factory_custom(): |
| 69 |
salesforce_bp = make_salesforce_blueprint( |
| 70 |
client_id="foo", |
| 71 |
client_secret="bar", |
| 72 |
scope="api", |
| 73 |
redirect_to="index", |
| 74 |
hostname="example.my.salesforce.com", |
| 75 |
) |
| 76 |
assert isinstance(salesforce_bp, OAuth2ConsumerBlueprint) |
| 77 |
assert salesforce_bp.session.scope == "api" |
| 78 |
assert salesforce_bp.session.base_url == "https://example.my.salesforce.com/" |
| 79 |
assert salesforce_bp.session.client_id == "foo" |
| 80 |
assert salesforce_bp.client_secret == "bar" |
| 81 |
assert ( |
| 82 |
salesforce_bp.authorization_url |
| 83 |
== "https://example.my.salesforce.com/services/oauth2/authorize" |
| 84 |
) |
| 85 |
assert ( |
| 86 |
salesforce_bp.token_url |
| 87 |
== "https://example.my.salesforce.com/services/oauth2/token" |
| 88 |
) |
| 89 |
|
| 90 |
|
| 91 |
def test_load_from_config(make_app): |
| 92 |
app = make_app(redirect_to="index") |
| 93 |
app.config["SALESFORCE_OAUTH_CLIENT_ID"] = "foo" |
| 94 |
app.config["SALESFORCE_OAUTH_CLIENT_SECRET"] = "bar" |
| 95 |
|
| 96 |
resp = app.test_client().get("/salesforce") |
| 97 |
url = resp.headers["Location"] |
| 98 |
client_id = URLObject(url).query.dict.get("client_id") |
| 99 |
assert client_id == "foo" |
| 100 |
|
| 101 |
|
| 102 |
def test_blueprint_factory_scope(): |
| 103 |
salesforce_bp = make_salesforce_blueprint( |
| 104 |
client_id="foo", client_secret="bar", scope="customscope" |
| 105 |
) |
| 106 |
assert salesforce_bp.session.scope == "customscope" |
| 107 |
|
| 108 |
|
| 109 |
@responses.activate |
| 110 |
def test_context_local(make_app): |
| 111 |
responses.add(responses.GET, "https://salesforce.com") |
| 112 |
|
| 113 |
# set up two apps with two different set of auth tokens |
| 114 |
app1 = make_app( |
| 115 |
"foo1", |
| 116 |
"bar1", |
| 117 |
redirect_to="url1", |
| 118 |
storage=MemoryStorage({"access_token": "app1"}), |
| 119 |
) |
| 120 |
app2 = make_app( |
| 121 |
"foo2", |
| 122 |
"bar2", |
| 123 |
redirect_to="url2", |
| 124 |
storage=MemoryStorage({"access_token": "app2"}), |
| 125 |
) |
| 126 |
|
| 127 |
# outside of a request context, referencing functions on the `salesforce` |
| 128 |
# object will raise an exception |
| 129 |
with pytest.raises(RuntimeError): |
| 130 |
salesforce.get("https://salesforce.com") |
| 131 |
|
| 132 |
# inside of a request context, `salesforce` should be a proxy to the correct |
| 133 |
# blueprint session |
| 134 |
with app1.test_request_context("/"): |
| 135 |
app1.preprocess_request() |
| 136 |
salesforce.get("https://salesforce.com") |
| 137 |
request = responses.calls[0].request |
| 138 |
assert request.headers["Authorization"] == "Bearer app1" |
| 139 |
|
| 140 |
with app2.test_request_context("/"): |
| 141 |
app2.preprocess_request() |
| 142 |
salesforce.get("https://salesforce.com") |
| 143 |
request = responses.calls[1].request |
| 144 |
assert request.headers["Authorization"] == "Bearer app2" |
| 145 |
|
| 146 |
|
| 147 |
def app_redirect_location(app): |
| 148 |
with app.test_client() as client: |
| 149 |
resp = client.get( |
| 150 |
"/salesforce", base_url="https://a.b.c", follow_redirects=False |
| 151 |
) |
| 152 |
assert resp.status_code == 302 |
| 153 |
return URLObject(resp.headers["Location"]) |
| 154 |
|
| 155 |
|
| 156 |
def test_default_redirect_params(make_app): |
| 157 |
app = make_app("foo", "bar") |
| 158 |
query_dict = app_redirect_location(app).query_dict |
| 159 |
assert isinstance(query_dict.pop("state"), str) |
| 160 |
assert query_dict == { |
| 161 |
"client_id": "foo", |
| 162 |
"redirect_uri": "https://a.b.c/salesforce/authorized", |
| 163 |
"response_type": "code", |
| 164 |
} |
| 165 |
|
| 166 |
|
| 167 |
def test_consent(make_app): |
| 168 |
app = make_app("foo", "bar", reprompt_consent=True) |
| 169 |
assert app_redirect_location(app).query_dict["prompt"] == "consent" |