from urllib.parse import parse_qs import pytest import requests_oauthlib 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.slack import make_slack_blueprint, slack @pytest.fixture def make_app(): "A callable to create a Flask app with the Slack provider" def _make_app(*args, **kwargs): app = Flask(__name__) app.secret_key = "whatever" blueprint = make_slack_blueprint(*args, **kwargs) app.register_blueprint(blueprint) return app return _make_app def test_blueprint_factory(): slack_bp = make_slack_blueprint( client_id="foo", client_secret="bar", scope=["identity", "im:write"], redirect_to="index", ) assert isinstance(slack_bp, OAuth2ConsumerBlueprint) assert slack_bp.session.scope == ["identity", "im:write"] assert slack_bp.session.base_url == "https://slack.com/api/" assert slack_bp.session.client_id == "foo" assert slack_bp.client_secret == "bar" assert slack_bp.authorization_url == "https://slack.com/oauth/authorize" assert slack_bp.token_url == "https://slack.com/api/oauth.access" def test_blueprint_factory_with_subdomain(): slack_bp = make_slack_blueprint( client_id="foo", client_secret="bar", scope=["identity", "im:write"], redirect_to="index", subdomain="my-team", ) assert slack_bp.authorization_url == "https://my-team.slack.com/oauth/authorize" assert slack_bp.token_url == "https://slack.com/api/oauth.access" def test_load_from_config(make_app): app = make_app() app.config["SLACK_OAUTH_CLIENT_ID"] = "foo" app.config["SLACK_OAUTH_CLIENT_SECRET"] = "bar" resp = app.test_client().get("/slack") 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://slack.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 `slack` object # will raise an exception with pytest.raises(RuntimeError): slack.get("https://slack.com") # inside of a request context, `slack` should be a proxy to the correct # blueprint session with app1.test_request_context("/"): app1.preprocess_request() slack.get("https://slack.com") request = responses.calls[0].request assert request.headers["Authorization"] == "Bearer app1" with app2.test_request_context("/"): app2.preprocess_request() slack.get("https://slack.com") request = responses.calls[1].request assert request.headers["Authorization"] == "Bearer app2" @responses.activate def test_auto_token_get(make_app): responses.add(responses.GET, "https://slack.com/api/chat.postMessage") app = make_app( client_id="foo", client_secret="bar", storage=MemoryStorage({"access_token": "abcde"}), ) with app.test_request_context("/"): app.preprocess_request() resp = slack.get( "chat.postMessage", data={"channel": "#general", "text": "ping", "icon_emoji": ":robot_face:"}, ) request_data = parse_qs(resp.request.body) assert request_data["channel"] == ["#general"] assert request_data["text"] == ["ping"] assert request_data["icon_emoji"] == [":robot_face:"] # the `token` parameter should have been automatically added assert request_data["token"] == ["abcde"] @responses.activate def test_auto_token_post(make_app): responses.add(responses.POST, "https://slack.com/api/chat.postMessage") app = make_app( client_id="foo", client_secret="bar", storage=MemoryStorage({"access_token": "abcde"}), ) with app.test_request_context("/"): app.preprocess_request() resp = slack.post( "chat.postMessage", data={"channel": "#general", "text": "ping", "icon_emoji": ":robot_face:"}, ) request_data = parse_qs(resp.request.body) assert request_data["channel"] == ["#general"] assert request_data["text"] == ["ping"] assert request_data["icon_emoji"] == [":robot_face:"] # the `token` parameter should have been automatically added assert request_data["token"] == ["abcde"] @responses.activate def test_auto_token_post_no_token(make_app): responses.add(responses.POST, "https://slack.com/api/chat.postMessage") app = make_app(client_id="foo", client_secret="bar") with app.test_request_context("/"): app.preprocess_request() resp = slack.post( "chat.postMessage", data={"channel": "#general", "text": "ping", "icon_emoji": ":robot_face:"}, ) request_data = parse_qs(resp.request.body) assert request_data["channel"] == ["#general"] assert request_data["text"] == ["ping"] assert request_data["icon_emoji"] == [":robot_face:"] assert "token" not in request_data url = URLObject(resp.request.url) assert "token" not in url.query_dict @responses.activate def test_override_token_get(make_app): responses.add(responses.GET, "https://slack.com/api/chat.postMessage") app = make_app( client_id="foo", client_secret="bar", storage=MemoryStorage({"access_token": "abcde"}), ) with app.test_request_context("/"): app.preprocess_request() resp = slack.get( "chat.postMessage", data={ "token": "xyz", "channel": "#general", "text": "ping", "icon_emoji": ":robot_face:", }, ) request_data = parse_qs(resp.request.body) assert request_data["token"] == ["xyz"] assert request_data["channel"] == ["#general"] assert request_data["text"] == ["ping"] assert request_data["icon_emoji"] == [":robot_face:"] # should not be present in URL url = URLObject(resp.request.url) assert "token" not in url.query_dict @responses.activate def test_override_token_post(make_app): responses.add(responses.POST, "https://slack.com/api/chat.postMessage") app = make_app( client_id="foo", client_secret="bar", storage=MemoryStorage({"access_token": "abcde"}), ) with app.test_request_context("/"): app.preprocess_request() resp = slack.post( "chat.postMessage", data={ "token": "xyz", "channel": "#general", "text": "ping", "icon_emoji": ":robot_face:", }, ) request_data = parse_qs(resp.request.body) assert request_data["token"] == ["xyz"] assert request_data["channel"] == ["#general"] assert request_data["text"] == ["ping"] assert request_data["icon_emoji"] == [":robot_face:"] # should not be present url = URLObject(resp.request.url) assert "token" not in url.query_dict