taipy/tests/rest/test_sequence.py

# Copyright 2023 Avaiga Private Limited
#
# Licensed 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.

from unittest import mock

import pytest
from flask import url_for

from src.taipy.rest.api.exceptions.exceptions import ScenarioIdMissingException, SequenceNameMissingException
from taipy.core.exceptions.exceptions import NonExistingScenario
from taipy.core.scenario._scenario_manager_factory import _ScenarioManagerFactory


def test_get_sequence(client, default_sequence):
    # test 404
    user_url = url_for("api.sequence_by_id", sequence_id="foo")
    rep = client.get(user_url)
    assert rep.status_code == 404

    with mock.patch("taipy.core.sequence._sequence_manager._SequenceManager._get") as manager_mock:
        manager_mock.return_value = default_sequence

        # test get_sequence
        rep = client.get(url_for("api.sequence_by_id", sequence_id="foo"))
        assert rep.status_code == 200


def test_delete_sequence(client):
    # test 404
    user_url = url_for("api.sequence_by_id", sequence_id="foo")
    rep = client.get(user_url)
    assert rep.status_code == 404

    with mock.patch("taipy.core.sequence._sequence_manager._SequenceManager._delete"), mock.patch(
        "taipy.core.sequence._sequence_manager._SequenceManager._get"
    ):
        # test get_sequence
        rep = client.delete(url_for("api.sequence_by_id", sequence_id="foo"))
        assert rep.status_code == 200


def test_create_sequence(client, default_scenario):
    sequences_url = url_for("api.sequences")
    rep = client.post(sequences_url, json={})
    assert rep.status_code == 400
    assert rep.json == {"message": "Scenario id is missing."}

    sequences_url = url_for("api.sequences")
    rep = client.post(sequences_url, json={"scenario_id": "SCENARIO_scenario_id"})
    assert rep.status_code == 400
    assert rep.json == {"message": "Sequence name is missing."}

    sequences_url = url_for("api.sequences")
    rep = client.post(sequences_url, json={"scenario_id": "SCENARIO_scenario_id", "sequence_name": "sequence"})
    assert rep.status_code == 404

    _ScenarioManagerFactory._build_manager()._set(default_scenario)
    with mock.patch("taipy.core.scenario._scenario_manager._ScenarioManager._get") as config_mock:
        config_mock.return_value = default_scenario
        sequences_url = url_for("api.sequences")
        rep = client.post(
            sequences_url, json={"scenario_id": default_scenario.id, "sequence_name": "sequence", "tasks": []}
        )
        assert rep.status_code == 201


def test_get_all_sequences(client, default_scenario_config_list):
    for ds in range(10):
        with mock.patch("src.taipy.rest.api.resources.scenario.ScenarioList.fetch_config") as config_mock:
            config_mock.return_value = default_scenario_config_list[ds]
            scenario_url = url_for("api.scenarios", config_id=config_mock.name)
            client.post(scenario_url)

    sequences_url = url_for("api.sequences")
    rep = client.get(sequences_url)
    assert rep.status_code == 200

    results = rep.get_json()
    assert len(results) == 10


@pytest.mark.xfail()
def test_execute_sequence(client, default_sequence):
    # test 404
    user_url = url_for("api.sequence_submit", sequence_id="foo")
    rep = client.post(user_url)
    assert rep.status_code == 404

    with mock.patch("taipy.core.sequence._sequence_manager._SequenceManager._get") as manager_mock:
        manager_mock.return_value = default_sequence

        # test get_sequence
        rep = client.post(url_for("api.sequence_submit", sequence_id="foo"))
        assert rep.status_code == 200