Adding upstream version 0.1.25.upstream/0.1.25

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

5 files changed, 468 insertions, 0 deletions

diff --git a/tests/lsp_tests/__init__.py b/tests/lsp_tests/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/tests/lsp_tests/__init__.py
diff --git a/tests/lsp_tests/conftest.py b/tests/lsp_tests/conftest.py
new file mode 100644
index 0000000..8b42582
--- /dev/null
+++ b/tests/lsp_tests/conftest.py
@@ -0,0 +1,43 @@
+import pytest
+from debputy.plugin.api.feature_set import PluginProvidedFeatureSet
+
+try:
+    from pygls.server import LanguageServer
+    from lsprotocol.types import (
+        InitializeParams,
+        ClientCapabilities,
+        GeneralClientCapabilities,
+        PositionEncodingKind,
+        TextDocumentItem,
+        Position,
+        CompletionParams,
+        TextDocumentIdentifier,
+        HoverParams,
+        MarkupContent,
+    )
+    from debputy.lsp.lsp_features import lsp_set_plugin_features
+
+    HAS_PYGLS = True
+except ImportError:
+    HAS_PYGLS = False
+
+
+@pytest.fixture()
+def ls(debputy_plugin_feature_set: PluginProvidedFeatureSet) -> "LanguageServer":
+    if not HAS_PYGLS:
+        pytest.skip("Missing pygls")
+    ls = LanguageServer("debputy", "v<test>")
+    ls.lsp.lsp_initialize(
+        InitializeParams(
+            ClientCapabilities(
+                general=GeneralClientCapabilities(
+                    position_encodings=[PositionEncodingKind.Utf32],
+                )
+            )
+        )
+    )
+    lsp_set_plugin_features(debputy_plugin_feature_set)
+    try:
+        yield ls
+    finally:
+        lsp_set_plugin_features(None)
diff --git a/tests/lsp_tests/lsp_tutil.py b/tests/lsp_tests/lsp_tutil.py
new file mode 100644
index 0000000..1e509af
--- /dev/null
+++ b/tests/lsp_tests/lsp_tutil.py
@@ -0,0 +1,45 @@
+from typing import Tuple
+
+try:
+    from pygls.server import LanguageServer
+    from lsprotocol.types import (
+        TextDocumentItem,
+        Position,
+    )
+except ImportError:
+    pass
+
+
+def _locate_cursor(text: str) -> Tuple[str, "Position"]:
+    lines = text.splitlines(keepends=True)
+    for line_no in range(len(lines)):
+        line = lines[line_no]
+        try:
+            c = line.index("<CURSOR>")
+        except ValueError:
+            continue
+        line = line.replace("<CURSOR>", "")
+        lines[line_no] = line
+        pos = Position(line_no, c)
+        return "".join(lines), pos
+    raise ValueError('Missing "<CURSOR>" marker')
+
+
+def put_doc_with_cursor(
+    ls: "LanguageServer",
+    uri: str,
+    language_id: str,
+    content: str,
+    *,
+    doc_version: int = 1,
+) -> "Position":
+    cleaned_content, cursor_pos = _locate_cursor(content)
+    ls.workspace.put_text_document(
+        TextDocumentItem(
+            uri,
+            language_id,
+            doc_version,
+            cleaned_content,
+        )
+    )
+    return cursor_pos
diff --git a/tests/lsp_tests/test_lsp_dctrl.py b/tests/lsp_tests/test_lsp_dctrl.py
new file mode 100644
index 0000000..2a2466f
--- /dev/null
+++ b/tests/lsp_tests/test_lsp_dctrl.py
@@ -0,0 +1,72 @@
+import textwrap
+
+try:
+    from lsprotocol.types import (
+        CompletionParams,
+        TextDocumentIdentifier,
+        HoverParams,
+        MarkupContent,
+    )
+
+    from debputy.lsp.lsp_debian_control import (
+        _debian_control_completions,
+        _debian_control_hover,
+    )
+
+    from pygls.server import LanguageServer
+except ImportError:
+    pass
+from lsp_tests.lsp_tutil import put_doc_with_cursor
+
+
+def test_dctrl_complete_field(ls: "LanguageServer") -> None:
+    dctrl_uri = "file:///nowhere/debian/control"
+
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        dctrl_uri,
+        "debian/control",
+        textwrap.dedent(
+            """\
+        Source: foo
+
+        Package: foo
+        <CURSOR>
+"""
+        ),
+    )
+    matches = _debian_control_completions(
+        ls,
+        CompletionParams(TextDocumentIdentifier(dctrl_uri), cursor_pos),
+    )
+    assert matches
+    keywords = {m.label for m in matches}
+    assert "Multi-Arch" in keywords
+    assert "Architecture" in keywords
+    # Already present or wrong section
+    assert "Package" not in keywords
+    assert "Source" not in keywords
+
+
+def test_dctrl_hover_doc_field(ls: "LanguageServer") -> None:
+    dctrl_uri = "file:///nowhere/debian/control"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        dctrl_uri,
+        "debian/control",
+        textwrap.dedent(
+            """\
+        Source: foo
+
+        Package: foo
+        Arch<CURSOR>itecture: any
+"""
+        ),
+    )
+
+    hover_doc = _debian_control_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(dctrl_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert "Determines which architecture" in hover_doc.contents.value
diff --git a/tests/lsp_tests/test_lsp_debputy_manifest_hover.py b/tests/lsp_tests/test_lsp_debputy_manifest_hover.py
new file mode 100644
index 0000000..c66db80
--- /dev/null
+++ b/tests/lsp_tests/test_lsp_debputy_manifest_hover.py
@@ -0,0 +1,308 @@
+import textwrap
+
+import pytest
+
+from lsp_tests.lsp_tutil import put_doc_with_cursor
+
+try:
+    from pygls.server import LanguageServer
+    from lsprotocol.types import (
+        InitializeParams,
+        ClientCapabilities,
+        GeneralClientCapabilities,
+        PositionEncodingKind,
+        TextDocumentItem,
+        Position,
+        CompletionParams,
+        TextDocumentIdentifier,
+        HoverParams,
+        MarkupContent,
+    )
+    from debputy.lsp.lsp_debian_debputy_manifest import debputy_manifest_hover
+
+    HAS_PYGLS = True
+except ImportError:
+    HAS_PYGLS = False
+
+
+def test_basic_debputy_hover_tlk(ls: "LanguageServer") -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        install<CURSOR>ations:
+        - install-docs:
+            sources:
+            - GETTING-STARTED-WITH-dh-debputy.md
+            - MANIFEST-FORMAT.md
+            - MIGRATING-A-DH-PLUGIN.md
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert hover_doc.contents.value.startswith("Installations")
+
+
+def test_basic_debputy_hover_install_docs_key(ls: "LanguageServer") -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        installations:
+        - <CURSOR>install-docs:
+            sources:
+            - GETTING-STARTED-WITH-dh-debputy.md
+            - MANIFEST-FORMAT.md
+            - MIGRATING-A-DH-PLUGIN.md
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert hover_doc.contents.value.startswith("Install documentation (`install-docs`)")
+
+
+def test_basic_debputy_hover_install_docs_sources(ls: "LanguageServer") -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        installations:
+        - install-docs:
+            sources<CURSOR>:
+            - GETTING-STARTED-WITH-dh-debputy.md
+            - MANIFEST-FORMAT.md
+            - MIGRATING-A-DH-PLUGIN.md
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert hover_doc.contents.value.startswith("# Attribute `sources`")
+
+
+def test_basic_debputy_hover_install_docs_when(ls: "LanguageServer") -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        installations:
+        - install-docs:
+            sources:
+            - GETTING-STARTED-WITH-dh-debputy.md
+            - MANIFEST-FORMAT.md
+            - MIGRATING-A-DH-PLUGIN.md
+            when<CURSOR>:
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert hover_doc.contents.value.startswith("# Attribute `when`")
+
+
+def test_basic_debputy_hover_install_docs_str_cond(ls: "LanguageServer") -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        installations:
+        - install-docs:
+            sources:
+            - GETTING-STARTED-WITH-dh-debputy.md
+            - MANIFEST-FORMAT.md
+            - MIGRATING-A-DH-PLUGIN.md
+            when: cross-<CURSOR>compiling
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert hover_doc.contents.value.startswith(
+        "Cross-Compiling condition `cross-compiling`"
+    )
+
+
+def test_basic_debputy_hover_install_docs_mapping_cond_key(
+    ls: "LanguageServer",
+) -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        installations:
+        - install-docs:
+            sources:
+            - GETTING-STARTED-WITH-dh-debputy.md
+            - MANIFEST-FORMAT.md
+            - MIGRATING-A-DH-PLUGIN.md
+            when:
+             not<CURSOR>: cross-compiling
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert hover_doc.contents.value.startswith("Negated condition `not` (mapping)")
+
+
+@pytest.mark.xfail
+def test_basic_debputy_hover_install_docs_mapping_cond_str_value(
+    ls: "LanguageServer",
+) -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        installations:
+        - install-docs:
+            sources:
+            - GETTING-STARTED-WITH-dh-debputy.md
+            - MANIFEST-FORMAT.md
+            - MIGRATING-A-DH-PLUGIN.md
+            when:
+             not: cross<CURSOR>-compiling
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    # This should be showing `cross-compiling` docs, but we are showing `not` docs
+    assert hover_doc.contents.value.startswith(
+        "Cross-Compiling condition `cross-compiling`"
+    )
+
+
+def test_basic_debputy_hover_binary_version(ls: "LanguageServer") -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        packages:
+            foo:
+                binary-version<CURSOR>:
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert hover_doc.contents.value.startswith(
+        "Custom binary version (`binary-version`)"
+    )
+
+
+def test_basic_debputy_hover_services(ls: "LanguageServer") -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        packages:
+            foo:
+                services<CURSOR>:
+                - service: foo
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert hover_doc.contents.value.startswith(
+        "Define how services in the package will be handled (`services`)"
+    )
+
+
+def test_basic_debputy_hover_services_service(ls: "LanguageServer") -> None:
+    debputy_manifest_uri = "file:///nowhere/debian/debputy.manifest"
+    cursor_pos = put_doc_with_cursor(
+        ls,
+        debputy_manifest_uri,
+        "debian/debputy.manifest",
+        textwrap.dedent(
+            """\
+        manifest-version: '0.1'
+        packages:
+            foo:
+                services:
+                - servic<CURSOR>e: foo
+"""
+        ),
+    )
+
+    hover_doc = debputy_manifest_hover(
+        ls,
+        HoverParams(TextDocumentIdentifier(debputy_manifest_uri), cursor_pos),
+    )
+    assert hover_doc is not None and isinstance(hover_doc.contents, MarkupContent)
+    assert hover_doc.contents.value.startswith("# Attribute `service`")