Method test_get_completions

tests/test_pt_utils.py:266–314

Test get_completions with matches.

(self, mock_cmd_app: MockCmd, monkeypatch)

class TestCmd2Completer:
    def test_get_completions(self, mock_cmd_app: MockCmd, monkeypatch) -> None:
        """Test get_completions with matches."""
        mock_print = Mock()
        monkeypatch.setattr(pt_utils, "print_formatted_text", mock_print)

        completer = pt_utils.Cmd2Completer(cast(Any, mock_cmd_app))

        # Set up document
        line = ""
        document = Document(line, cursor_position=0)

        # Test plain and styled values for display and display_meta
        foo_text = "foo"
        foo_display = "Foo Display"
        foo_meta = "Foo Meta"

        bar_text = "bar"
        bar_display = stylize("Bar Display", Cmd2Style.SUCCESS)
        bar_meta = stylize("Bar Meta", Cmd2Style.WARNING)

        # Set up matches
        completion_items = [
            cmd2.CompletionItem(foo_text, display=foo_display, display_meta=foo_meta),
            cmd2.CompletionItem(bar_text, display=bar_display, display_meta=bar_meta),
        ]

        table = Table("Table Header")
        table.add_row("Table Data")
        cmd2_completions = cmd2.Completions(completion_items, table=table)
        mock_cmd_app.complete.return_value = cmd2_completions

        # Call get_completions
        completions = list(completer.get_completions(document, None))

        assert len(completions) == len(cmd2_completions)

        assert completions[0].text == bar_text
        assert to_formatted_text(completions[0].display) == to_formatted_text(ANSI(bar_display))
        assert to_formatted_text(completions[0].display_meta) == to_formatted_text(ANSI(bar_meta))

        assert completions[1].text == foo_text
        assert to_formatted_text(completions[1].display) == to_formatted_text(ANSI(foo_display))
        assert to_formatted_text(completions[1].display_meta) == to_formatted_text(ANSI(foo_meta))

        # Verify that only the completion table printed
        assert mock_print.call_count == 1
        args, _ = mock_print.call_args
        assert "Table Header" in str(args[0])
        assert "Table Data" in str(args[0])

    def test_get_completions_no_matches(self, mock_cmd_app: MockCmd, monkeypatch) -> None:
        """Test get_completions with no matches."""