taipy/tests/common/cli/test_help_cli.py

# Copyright 2021-2025 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 re
from unittest.mock import patch

import pytest

from taipy._entrypoint import _entrypoint


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


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

positional arguments:
  {run,manage-versions,create,migrate,help}
    run                 Run a Taipy application.
    manage-versions     Taipy version control system.
    create              Create a new Taipy application using pre-defined templates.
    migrate             Migrate entities created from old taipy versions to be compatible with the current taipy
    version. The entity migration should be performed only after updating taipy code to the current version.
    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] [--application"

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