# Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. import json import pickle from typing import Any, Dict from uuid import UUID import pytest from sqlalchemy.orm import Session from superset import db from superset.key_value.models import KeyValueEntry from superset.models.slice import Slice from tests.integration_tests.base_tests import login from tests.integration_tests.fixtures.client import client from tests.integration_tests.fixtures.world_bank_dashboard import ( load_world_bank_dashboard_with_slices, load_world_bank_data, ) from tests.integration_tests.test_app import app @pytest.fixture def chart(load_world_bank_dashboard_with_slices) -> Slice: with app.app_context() as ctx: session: Session = ctx.app.appbuilder.get_session chart = session.query(Slice).filter_by(slice_name="World's Population").one() return chart @pytest.fixture def form_data(chart) -> Dict[str, Any]: datasource = f"{chart.datasource.id}__{chart.datasource.type}" return { "chart_id": chart.id, "datasource": datasource, } def test_post(client, form_data): login(client, "admin") resp = client.post(f"api/v1/explore/permalink", json={"formData": form_data}) assert resp.status_code == 201 data = json.loads(resp.data.decode("utf-8")) key = data["key"] url = data["url"] assert key in url db.session.query(KeyValueEntry).filter_by(uuid=key).delete() db.session.commit() def test_post_access_denied(client, form_data): login(client, "gamma") resp = client.post(f"api/v1/explore/permalink", json={"formData": form_data}) assert resp.status_code == 404 def test_get_missing_chart(client, chart): from superset.key_value.models import KeyValueEntry key = 1234 uuid_key = "e2ea9d19-7988-4862-aa69-c3a1a7628cb9" entry = KeyValueEntry( id=int(key), uuid=UUID("e2ea9d19-7988-4862-aa69-c3a1a7628cb9"), resource="explore_permalink", value=pickle.dumps( { "chartId": key, "datasetId": chart.datasource.id, "formData": { "slice_id": key, "datasource": f"{chart.datasource.id}__{chart.datasource.type}", }, } ), ) db.session.add(entry) db.session.commit() login(client, "admin") resp = client.get(f"api/v1/explore/permalink/{uuid_key}") assert resp.status_code == 404 db.session.delete(entry) db.session.commit() def test_post_invalid_schema(client): login(client, "admin") resp = client.post(f"api/v1/explore/permalink", json={"abc": 123}) assert resp.status_code == 400 def test_get(client, form_data): login(client, "admin") resp = client.post(f"api/v1/explore/permalink", json={"formData": form_data}) data = json.loads(resp.data.decode("utf-8")) key = data["key"] resp = client.get(f"api/v1/explore/permalink/{key}") assert resp.status_code == 200 result = json.loads(resp.data.decode("utf-8")) assert result["state"]["formData"] == form_data db.session.query(KeyValueEntry).filter_by(uuid=key).delete() db.session.commit()