taipy/tests/cli/test_cli.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.

import argparse
import re
from unittest.mock import patch

import pytest

from src.taipy._entrypoint import _entrypoint
from taipy._cli._base_cli import _CLI


def preprocess_stdout(stdout):
    stdout = stdout.replace("\n", " ").replace("\t", " ")
    return re.sub(" +", " ", stdout)


def remove_subparser(name: str):
    """Remove a subparser from the _CLI class."""
    _CLI._sub_taipyparsers.pop(name, None)

    if _CLI._subparser_action:
        _CLI._subparser_action._name_parser_map.pop(name, None)

        for action in _CLI._subparser_action._choices_actions:
            if action.dest == name:
                _CLI._subparser_action._choices_actions.remove(action)


@pytest.fixture(autouse=True, scope="function")
def clean_argparser():
    _CLI._parser = argparse.ArgumentParser(conflict_handler="resolve")
    _CLI._subparser_action = None
    _CLI._arg_groups = {}
    subcommands = list(_CLI._sub_taipyparsers.keys())
    for subcommand in subcommands:
        remove_subparser(subcommand)

    yield


expected_help = """{run,manage-versions,create,help} ...

positional arguments:
  {run,manage-versions,create,help}
    run                 Run a Taipy application.
    manage-versions     Taipy version control system.
    create              Create a new Taipy application.
    help                Show the Taipy help message.
"""


def test_taipy_command_alone_print_help(capsys):
    with patch("sys.argv", ["prog"]):
        _entrypoint()
        out, _ = capsys.readouterr()
        assert preprocess_stdout(expected_help) in preprocess_stdout(out)


def test_taipy_help_command(capsys):
    with patch("sys.argv", ["prog", "help"]):
        with pytest.raises(SystemExit):
            _entrypoint()
        out, _ = capsys.readouterr()
        assert preprocess_stdout(expected_help) in preprocess_stdout(out)


def test_help_non_existed_command(caplog):
    with patch("sys.argv", ["prog", "help", "non_existed_command"]):
        with pytest.raises(SystemExit):
            _entrypoint()
        assert "non_existed_command is not a valid command." in caplog.text


def test_taipy_create_help(capsys):
    expected_help = "create [-h] [--template"

    with patch("sys.argv", ["prog", "help", "create"]):
        with pytest.raises(SystemExit):
            _entrypoint()
        out, _ = capsys.readouterr()
        assert preprocess_stdout(expected_help) in preprocess_stdout(out)