Merge remote branch 'origin/master' into edge

Author: automatic-merge

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+# This is intented for compatibility with Black. See
+# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8
+max-line-length = 80
+extend-select = B950
+extend-ignore = E203,E501,E701

.gitlab-ci.yml

@@ -8,11 +8,18 @@ include:
   # Issue check
   - component: $CI_SERVER_FQDN/eng/gitlab-templates/check-issue@~latest
 
+  # pre-commit
+  - component: $CI_SERVER_FQDN/eng/gitlab-templates/pre-commit@~latest
+    inputs:
+      on-diff: true
+      stage: check
+
   # Build
   - component: $CI_SERVER_FQDN/eng/gitlab-templates/build@~latest
     inputs:
       anod-args: run build_$ACI_TRACK
       cpus: 16
+      disk: 80
       image: systemgtk
       save-component: true
 
@@ -22,13 +29,15 @@ include:
       job-name: als
       anod-args: run test_als_$ACI_TRACK
       image: systemgtk
+      disk: 80
 
   # Testing of the ALS with coverage
   - component: $CI_SERVER_FQDN/eng/gitlab-templates/test@~latest
     inputs:
       job-name: als-cov
       anod-args: run test_als_cov_$ACI_TRACK --latest
       image: systemgtk
+      disk: 80
       # This job needs to rebuild ALS in coverage mode, so it doesn't need to
       # depend on the build job. The following will get it to run in parallel
       # with the build job.
@@ -52,6 +61,7 @@ include:
       anod-args: run test_integration_testsuite
       image: systemgtk
       cpus: 4
+      disk: 80
       rules:
         # Does not work on edge
         - if: $CI_PIPELINE_SOURCE == 'merge_request_event' && $CI_TARGET_BRANCH_NAME != 'edge'
@@ -63,6 +73,7 @@ include:
       job-name: gs
       anod-args: run build_test_gs_$ACI_TRACK
       image: systemgtk
+      disk: 80
       stage: optional
       rules:
         - if: $CI_PIPELINE_SOURCE == 'merge_request_event'

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+        types: [file]
+        files: \.(py|anod|plan)$
+        additional_dependencies:
+          - flake8-bugbear
+          - flake8-builtins
+          - flake8-comprehensions
+          # - flake8-docstrings
+          # - flake8-rst-docstrings
+  - repo: https://github.com/ambv/black
+    rev: 24.2.0
+    hooks:
+      - id: black
+        types_or: [file]
+        files: \.(py|plan)$
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        files: '\.py$'
+        # exclude: "^tests/.+$"
+        additional_dependencies:
+          - --extra-index-url
+          - https://gitlab.adacore-it.com/api/v4/projects/it%2Fpackage-registry/packages/pypi/simple
+          - pytest-lsp

.vscode/settings.json.tmpl

@@ -22,7 +22,9 @@
    "flake8.args": ["--max-line-length", "88"],
    "[python]": {
       // Use the same line length as black and flake8
-      "vim.textwidth": 88
+      "vim.textwidth": 88,
+      "editor.defaultFormatter": "ms-python.black-formatter",
+      "editor.formatOnSave": true
    },
    "[yaml]": {
       "editor.defaultFormatter": "esbenp.prettier-vscode"

testsuite/ada_lsp/called_by_dispatching/test.py

@@ -1,32 +1,37 @@
 """test that callHierarchy/incomingCalls works for dispatching calls"""
 
-import os
-
-from drivers.lsp_ada_requests import (
-    didOpen_from_disk,
-    incomingCalls,
-    prepareCallHierarchy,
+from drivers.pylsp import (
+    URI,
+    ALSLanguageClient,
+    assertLocationsList,
+    callHierarchyIncomingCallsParams,
+    callHierarchyPrepareParams,
+    didOpenTextDocumentParams,
+    test,
 )
-from drivers.lsp_python_driver import simple_test
 
 
-@simple_test
-def test_called_by(lsp, wd):
+@test()
+async def test_called_by(lsp: ALSLanguageClient):
     # Send a didOpen for main.adb
-    main_adb = os.path.join(wd, "main.adb")
-    root_ads = os.path.join(wd, "root.ads")
-    p_adb = os.path.join(wd, "p.adb")
-
-    lsp.send(didOpen_from_disk(main_adb))
+    open_params, main_adb_uri = didOpenTextDocumentParams("main.adb")
+    root_ads_uri = URI("root.ads")
+    lsp.text_document_did_open(open_params)
 
     # Send a textDocument/prepareCallHierarchy request
-    response = lsp.send(prepareCallHierarchy(main_adb, 7, 4))
+    result1 = await lsp.text_document_prepare_call_hierarchy_async(
+        callHierarchyPrepareParams(main_adb_uri, 7, 4)
+    )
+    assert result1
 
     # Expect these locations
-    response.assertLocationsList([("root.ads", 5)])
+    assertLocationsList(result1, [("root.ads", 5)])
 
     # Now send the callHierarchy/incomingCalls request
-    response = lsp.send(incomingCalls(root_ads, 5, 14))
+    result2 = await lsp.call_hierarchy_incoming_calls_async(
+        callHierarchyIncomingCallsParams(root_ads_uri, 5, 14)
+    )
+    assert result2
 
     # Expect these locations
-    response.assertLocationsList([("main.adb", 3)])
+    assertLocationsList(result2, [("main.adb", 3)])

testsuite/ada_lsp/called_by_dispatching/test.yaml

@@ -1,2 +1,3 @@
-title: 'called_by_dispatching'
-driver: python
+# If the title is the same as the directory name, it can be ommited.
+# title: 'called_by_dispatching'
+driver: pylsp

testsuite/drivers/__init__.py

@@ -14,6 +14,16 @@
 class ALSTestDriver(ClassicTestDriver):
     """Abstract class to share some common facilities."""
 
+    @property
+    def working_dir_cleanup_enabled(self):
+        # By default cleanup of the working dir is performed for successful tests
+        # because there is no need to investigate them. We inhibit that in verbose mode
+        # to allow investigating successful tests.
+        if self.env.main_options.verbose > 0 or self.env.main_options.debug:
+            return False
+        else:
+            return super().working_dir_cleanup_enabled
+
     @property
     def test_control_creator(self) -> TestControlCreator:
         eval_env = {

testsuite/drivers/lsp_python_driver.py

@@ -128,18 +128,18 @@ def __init__(
         self.license_to_kill = None
 
         # The queue receiving the messages from the reading task
-        self.queue = queue.Queue()
+        self.queue: queue.Queue[LSPResponse] = queue.Queue()
 
         # Launch a task that will receive messages from the LSP server
         # and store them in a queue
         self.task = threading.Thread(target=self.receive_task)
         self.k_task = threading.Thread(target=self.kill_task)
 
         # Error messages encountered
-        self.errors = []
+        self.errors: list[str] = []
 
         # A list of bytes containing everything we sent to the server
-        self.replay = []
+        self.replay: list[bytes] = []
 
         # Start the tasks after all the attributes have been declared
         self.task.start()
@@ -207,6 +207,7 @@ def send(self, message: LSPMessage, expect_response=True) -> LSPResponse | None:
         encoded = message.encode()
         self.replay.append(encoded)
 
+        assert self.process.stdin
         self.process.stdin.write(encoded)
         self.process.stdin.flush()
 
@@ -229,6 +230,8 @@ def send(self, message: LSPMessage, expect_response=True) -> LSPResponse | None:
                 }
             )
 
+        return None
+
     def error(self, message):
         """Log an error message."""
         self.errors.append(message)
@@ -301,7 +304,8 @@ def run_simple_test(test_function, working_dir) -> list[str]:
             lsp.errors.append(traceback.format_exc())
     finally:
         lsp.shutdown()
-        return lsp.errors
+
+    return lsp.errors
 
 
 # Make run_simple_test available as a decorator

testsuite/drivers/lsp_types.py

@@ -1,6 +1,5 @@
 """Describes some types used in the LSP testing."""
 
-from typing import Any
 import json
 import os
 
@@ -11,6 +10,7 @@
 
 class ResponseAssertionError(Exception):
     """An exception that we manage - to avoid printing long traceback."""
+
     pass
 
 
@@ -121,7 +121,7 @@ def _line_info(self) -> str:
         message = f"At {dir_and_file}:{line_number} in {fn_name}:\n"
         return message
 
-    def assertLocationsList(self, expected: list[(str, int)]):
+    def assertLocationsList(self, expected: list[tuple[str, int]]):
         """Compare the response to an expected list of locations.
         The expected list is a list of tuples (file base name, line number),
         with line_number being 1-based.

testsuite/drivers/pylsp-runner.py

@@ -0,0 +1,10 @@
+"""This is a Python main entry point that calls drivers.pylsp.main().
+
+We create this entry point here instead of in pylsp.py to avoid the pylsp.py module
+getting imported twice: once as "__main__" and once as "drivers.pylsp".
+"""
+
+from drivers.pylsp import main
+
+if __name__ == "__main__":
+    main()