Server launch script

.github/workflows/ci.yml

@@ -31,32 +31,38 @@ jobs:
   ci:
     name: Run the integration tests
     runs-on: "ubuntu-latest"
-    strategy:
-      fail-fast: false
-      matrix:
-        python_version: ["3.11", "3.12"]
+    container:
+      image: registry.opensuse.org/opensuse/tumbleweed
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python_version }}
 
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pypoetry/virtualenvs
           key: poetry-${{ hashFiles('poetry.lock') }}
 
-      - run: pip install --upgrade poetry
+      - run: zypper -n ref
+        # python3 required for sqlite3 module
+      - run: zypper -n in python3-pipx python3-rpm python3
+
+      - run: pipx install poetry
+        env:
+          PIPX_BIN_DIR: /usr/bin
+
+      - run: poetry install
+      - run: poetry run pytest -vv
 
       - run: |
-          poetry install
-          poetry run pytest -vv
+          poetry run coverage run -m pytest -vv
+          poetry run coverage combine || :
+          poetry run coverage report -m
+          poetry run coverage xml
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:
-          fail_ci_if_error: true
+          fail_ci_if_error: false
 
   build:
     name: Build the package

README.rst

@@ -8,6 +8,14 @@ Requirements
 - `poetry <https://python-poetry.org/>`_
 
 
+Running the server
+------------------
+
+- Install the dependencies via :command:`poetry install`
+- Launch the server in tcp mode (binds to ``127.0.0.1:2087`` by default) via
+  :command:`poetry run server --tcp`
+
+
 Clients
 =======
 

pyproject.toml

@@ -17,6 +17,10 @@ pytest = ">=7.3"
 black = ">=23.3"
 mypy = ">=1.3"
 Sphinx = ">=7"
+coverage = ">=7.3"
+
+[tool.poetry.scripts]
+server = "rpm_spec_language_server.main:main"
 
 [build-system]
 requires = ["poetry-core"]

rpm_spec_language_server/document_symbols.py

@@ -0,0 +1,49 @@
+from lsprotocol.types import DocumentSymbol, Position, Range, SymbolKind
+from specfile.specfile import Specfile
+
+
+def spec_to_document_symbols(spec_path: str) -> list[DocumentSymbol]:
+    symbols = []
+    spec = Specfile(spec_path)
+    with spec.sections() as sections:
+        current_line = 0
+
+        for section in sections:
+            name = section.name
+
+            if opt := str(section.options).strip():
+                if not opt.startswith("-"):
+                    name = f"{name} {spec.name}-{opt.split()[0]}"
+
+                if "-n" in opt:
+                    name = f"{name} {(o := opt.split())[o.index('-n') + 1]}"
+
+            section_length = len(section.data)
+
+            if name != "package":
+                section_length += 1
+
+            symbols.append(
+                DocumentSymbol(
+                    name=name,
+                    kind=SymbolKind.Namespace,
+                    range=(
+                        section_range := Range(
+                            start=Position(line=current_line, character=0),
+                            end=Position(
+                                line=current_line + section_length, character=0
+                            ),
+                        )
+                    ),
+                    selection_range=section_range
+                    if name == "package"
+                    else Range(
+                        start=Position(line=current_line, character=0),
+                        end=Position(line=current_line + 1, character=0),
+                    ),
+                )
+            )
+
+            current_line += section_length
+
+    return symbols

rpm_spec_language_server/main.py

@@ -0,0 +1,23 @@
+from rpm_spec_language_server.server import create_rpm_lang_server
+
+
+def main() -> None:
+    import argparse
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--tcp", action="store_true", help="Use TCP server instead of stdio"
+    )
+    parser.add_argument(
+        "--host", type=str, default="127.0.0.1", help="Bind to this address"
+    )
+    parser.add_argument("--port", type=int, default=2087, help="Bind to this port")
+
+    args = parser.parse_args()
+
+    server = create_rpm_lang_server()
+
+    if args.tcp:
+        server.start_tcp(args.host, args.port)
+    else:
+        server.start_io()

rpm_spec_language_server/server.py

@@ -1,28 +1,48 @@
+from urllib.parse import urlparse
 from specfile.macros import Macros
 from lsprotocol.types import (
     TEXT_DOCUMENT_COMPLETION,
+    TEXT_DOCUMENT_DOCUMENT_SYMBOL,
     CompletionItem,
     CompletionList,
     CompletionOptions,
     CompletionParams,
+    DocumentSymbol,
+    DocumentSymbolParams,
+    SymbolInformation,
 )
 from pygls.server import LanguageServer
 
+from rpm_spec_language_server.document_symbols import spec_to_document_symbols
+
 
 class RpmSpecLanguageServer(LanguageServer):
     pass
 
 
-rpm_spec_server = RpmSpecLanguageServer("rpm-spec-server", "0.0.1")
-
-_MACROS = Macros.dump()
+def create_rpm_lang_server() -> RpmSpecLanguageServer:
+    rpm_spec_server = RpmSpecLanguageServer("rpm-spec-server", "0.0.1")
 
+    _MACROS = Macros.dump()
 
-@rpm_spec_server.feature(
-    TEXT_DOCUMENT_COMPLETION, CompletionOptions(trigger_characters=["%"])
-)
-def complete_macro_name(params: CompletionParams | None) -> CompletionList:
-    return CompletionList(
-        is_incomplete=False,
-        items=[CompletionItem(label=macro.name) for macro in _MACROS],
+    @rpm_spec_server.feature(
+        TEXT_DOCUMENT_COMPLETION, CompletionOptions(trigger_characters=["%"])
     )
+    def complete_macro_name(params: CompletionParams | None) -> CompletionList:
+        return CompletionList(
+            is_incomplete=False,
+            items=[CompletionItem(label=macro.name) for macro in _MACROS],
+        )
+
+    @rpm_spec_server.feature(TEXT_DOCUMENT_DOCUMENT_SYMBOL)
+    def spec_symbols(
+        param: DocumentSymbolParams,
+    ) -> list[DocumentSymbol] | list[SymbolInformation] | None:
+        url = urlparse(param.text_document.uri)
+
+        if url.scheme != "file" or not url.path.endswith(".spec"):
+            return None
+
+        return spec_to_document_symbols(url.path)
+
+    return rpm_spec_server