Merge branch 'topic/edge-conflict' into 'edge'

Merge master into edge and address conflicts

See merge request eng/ide/ada_language_server!1733

Author: eliericha

.gitlab-ci.plan

@@ -0,0 +1,64 @@
+def build_(qualifier={}):
+    with defaults(qualifier=qualifier):
+        anod_build("als")
+        anod_build("vscode-extension")
+
+
+def test_als_(qualifier={}):
+    with defaults(qualifier=qualifier):
+        # Install the component built in the preceding CI build job
+        anod_install("als")
+        anod_test("als")
+
+
+def test_vscode_extension_(qualifier={}):
+    with defaults(qualifier=qualifier):
+        # Install the component built in the preceding CI build job
+        anod_install("vscode-extension")
+        anod_test("vscode-extension")
+
+
+def build_test_gs_(qualifier={}):
+    with defaults(qualifier=qualifier):
+        # Install the component built in the preceding CI build job
+        anod_install("als")
+        # Test gps. This will automatically rebuild gps based on the ALS changes
+        anod_test("gps")
+
+
+# Edge
+
+edge_qualifier = {"edge": True}
+
+
+def build_edge():
+    build_(edge_qualifier)
+
+
+def test_als_edge():
+    test_als_(edge_qualifier)
+
+
+def test_vscode_extension_edge():
+    test_vscode_extension_(edge_qualifier)
+
+
+def build_test_gs_edge():
+    build_test_gs_(edge_qualifier)
+
+
+# Integration testsuite (no edge version)
+
+
+def test_integration_testsuite():
+    # The two components below have been built by the build job of the CI
+    anod_install("als")
+    anod_install("vscode-extension")
+    # Install gps component to avoid it getting rebuilt. We are only interested in
+    # vscode tests in the integration-testsuite, not gps.
+    anod_install("gps")
+    # Run the subset of integration-testsuite that uses VS Code
+    anod_test(
+        "integration-testsuite",
+        qualifier={"run-tools": "vscode", "cleanup-mode": "none"},
+    )

.gitlab-ci.yml

@@ -1,188 +1,59 @@
 stages:
   - build
   - test
+  - optional
   - check
-  - run_downstream_ci
 
-issue-check:
-  services:
-    - image:e3
-  stage: check
-  needs: [] # Do not wait for the other stages to execute
-  interruptible: true  # Cancel job if the branch is pushed
-  variables: # do not checkout the git repository, not needed
-    GIT_STRATEGY: none
-  rules: # Launch only on merge requests
-    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
-  script:
-    - require_issue # launch the verification
-
-.basic-setup:
-  # Basic invocation of generic_anod_ci.
-  - generic_anod_ci
-  - cat /tmp/ci_env.sh
-  - . /tmp/ci_env.sh
-
-.basic-test-setup:
-  # Use of generic_anod_ci for the purposes of testing, assuming
-  # the presence of a package containing the build.
-
-  # Unpack the built package
-  - (cd /tmp && tar -xzf $CI_PROJECT_DIR/wave-build-export.tar.gz)
-  # Make sure to remove the package, lest it be considered source by anod
-  - rm $CI_PROJECT_DIR/wave-build-export.tar.gz
-
-  # Basic invocation of generic_anod_ci.
-  - generic_anod_ci
-  - cat /tmp/ci_env.sh
-  - . /tmp/ci_env.sh
-
-  # Use the packaged components in our sandbox
-  - anod-copy-components /tmp/wave-build-export $ANOD_DEFAULT_SANDBOX_DIR
-
-  # generic_anod_ci sets the resolver to "smart_resolver" - this conflicts
-  # with our intention to use the pre-build package(s): use the "minimal"
-  # resolver for this.
-  - anod tune --minimal --plan /tmp/plans
-
-
-# Build and test with ANOD
-# TODO: add a build and test based on Alire in parallel to this.
-build:
-  services:
-    - image:systemgtk
-    - cpu:8
-  stage: build
-  interruptible: true
-  rules:
-    - if: $CI_PIPELINE_SOURCE == 'push'
-      when: never
-    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
-    - if: $CI_PIPELINE_SOURCE == 'pipeline'
-  script:
-    - !reference [.basic-setup]
-
-    - echo -e "\e[0Ksection_start:`date +%s`:build_als[collapsed=true]\r\e[0Kanod build als"
-    - anod build als $ACI_TRACK_QUALIFIER
-    - echo -e "\e[0Ksection_end:`date +%s`:build_als\r\e[0K"
-
-    - echo -e "\e[0Ksection_start:`date +%s`:build_vscode[collapsed=true]\r\e[0Kanod build vscode-extension"
-    # We pass --latest here because the vscode-extension will try to download
-    # the Windows binary (it's a multi-platform extension), and this binary
-    # might not be available right away.
-    - anod build vscode-extension $ACI_TRACK_QUALIFIER --minimal --latest
-    - echo -e "\e[0Ksection_end:`date +%s`:build_vscode\r\e[0K"
-
-    # Export the components and make a package out of them
-    - anod-copy-components --standalone-export $ANOD_DEFAULT_SANDBOX_DIR /tmp/wave-build-export
-    - (cd /tmp/ && tar -czf $CI_PROJECT_DIR/wave-build-export.tar.gz wave-build-export)
-
-  artifacts:
-    when: on_success
-    paths:
-      - wave-build-export.tar.gz
-
-
-test-als:
-  services:
-    - image:systemgtk
-    - cpu:8
-  stage: test
-  interruptible: true
-  rules:
-    - if: $CI_PIPELINE_SOURCE == 'push'
-      when: never
-    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
-    - if: $CI_PIPELINE_SOURCE == 'pipeline'
-  script:
-    - !reference [.basic-test-setup]
-
-    - echo -e "\e[0Ksection_start:`date +%s`:test_als[collapsed=true]\r\e[0Kanod test als"
-    # Run ALS tests
-    - anod test als $ACI_TRACK_QUALIFIER
-
-    - ALS_BUILD_SPACE=$(anod info test als $ACI_TRACK_QUALIFIER --show working_dir)
-    - echo -e "\e[0Ksection_end:`date +%s`:test_als\r\e[0K"
-
-    # Job artifacts must be produced in the project directory, so we do it at
-    # the end of the job to avoid changing Anod checkouts halfway through the
-    # job and triggering useless rebuilds.
-    # Process the als test report
-    - e3-testsuite-report
-      --failure-exit-code 1
-      --xunit-output $CI_PROJECT_DIR/als_xunit_output.xml
-      $ALS_BUILD_SPACE/results/new/ || FAILED=true
-    # Include Anod logs
-    - cp -r $ANOD_DEFAULT_SANDBOX_DIR/log $CI_PROJECT_DIR/anod-logs
-
-    - if [ ! -z ${FAILED+x} ]; then echo "There was at least one testcase failure" && exit 1; fi
-
-  artifacts:
-    when: always #  Upload on errors too
-    reports:
-      junit: [als_xunit_output.xml]
-    paths:
-      - anod-logs/
-
-test-vscode-extension:
-  services:
-    - image:systemgtk
-    - cpu:8
-  stage: test
-  interruptible: true
-  rules:
-    - if: $CI_PIPELINE_SOURCE == 'push'
-      when: never
-    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
-    - if: $CI_PIPELINE_SOURCE == 'pipeline'
-  script:
-    - !reference [.basic-test-setup]
-
-    # Run VSCode extension tests
-    - echo -e "\e[0Ksection_start:`date +%s`:test_vscode[collapsed=true]\r\e[0Kanod test vscode-extension"
-    - anod test vscode-extension $ACI_TRACK_QUALIFIER --minimal
-
-    - VSCODE_BUILD_SPACE=$(anod info test vscode-extension $ACI_TRACK_QUALIFIER --show working_dir)
-    - echo -e "\e[0Ksection_end:`date +%s`:test_vscode\r\e[0K"
-
-    # Job artifacts must be produced in the project directory, so we do it at
-    # the end of the job to avoid changing Anod checkouts halfway through the
-    # job and triggering useless rebuilds.
-    # Process the vscode-extension test report
-    - e3-testsuite-report
-      --failure-exit-code 1
-      --xunit-output $CI_PROJECT_DIR/vscode_xunit_output.xml
-      $VSCODE_BUILD_SPACE/results/ || FAILED=true
-    # Include Anod logs
-    - cp -r $ANOD_DEFAULT_SANDBOX_DIR/log $CI_PROJECT_DIR/anod-logs
-
-    - if [ ! -z ${FAILED+x} ]; then echo "There was at least one testcase failure" && exit 1; fi
-
-  artifacts:
-    when: always #  Upload on errors too
-    reports:
-      junit: [vscode_xunit_output.xml]
-    paths:
-      - anod-logs/
-
-.run_ci_common: &run_ci_common
-  stage: run_downstream_ci
-  needs: ["test-als"]
-  rules:
-    - if: $CI_PIPELINE_SOURCE == 'push'
-      when: never
-    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
-      when: manual
-      allow_failure: true
-  trigger:
-    strategy: depend
-  inherit:
-    variables: false
-  variables:
-    ACI_UPSTREAM_PROJECT_ID: $CI_PROJECT_ID
-    ACI_UPSTREAM_MERGE_REQUEST_IID: $CI_MERGE_REQUEST_IID
-
-run_gs_ci:
-  <<: *run_ci_common
-  trigger:
-    project: eng/ide/gnatstudio
+include:
+  # Issue check
+  - component: $CI_SERVER_FQDN/eng/gitlab-templates/check-issue@~latest
+
+  # Build
+  - component: $CI_SERVER_FQDN/eng/gitlab-templates/build@~latest
+    inputs:
+      anod-args: run build_$ACI_TRACK
+      cpus: 16
+      image: systemgtk
+      save-component: true
+
+  # Testing of the ALS
+  - component: $CI_SERVER_FQDN/eng/gitlab-templates/test@~latest
+    inputs:
+      job-name: als
+      anod-args: run test_als_$ACI_TRACK
+      image: systemgtk
+
+  # Testing of the VSCode extension
+  - component: $CI_SERVER_FQDN/eng/gitlab-templates/test@~latest
+    inputs:
+      job-name: vscode-extension
+      anod-args: run test_vscode_extension_$ACI_TRACK
+      image: systemgtk
+
+  # Integration testsuite
+  - component: $CI_SERVER_FQDN/eng/gitlab-templates/test@~latest
+    inputs:
+      job-name: integration-testsuite
+      # Here we would like to use --latest as to reduce issues from unavailable
+      # components, but we can't because it breaks the transfer of built
+      # components between jobs using anod-copy-components.
+      #
+      # See https://gitlab.adacore-it.com/eng/ide/ada_language_server/-/merge_requests/1611#note_610445
+      anod-args: run test_integration_testsuite
+      image: systemgtk
+      cpus: 4
+      rules:
+        # Does not work on edge
+        - if: $CI_PIPELINE_SOURCE == 'merge_request_event' && $CI_TARGET_BRANCH_NAME != 'edge'
+
+  # Optional testing of GNAT Studio
+  - component: $CI_SERVER_FQDN/eng/gitlab-templates/test@~latest
+    inputs:
+      job-name: gs
+      anod-args: run build_test_gs_$ACI_TRACK
+      image: systemgtk
+      stage: optional
+      rules:
+        - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+          when: manual
+          allow_failure: true

source/ada/lsp-ada_documents.adb

@@ -118,6 +118,7 @@ package body LSP.Ada_Documents is
       Completions_Count        : Natural)
       return LSP.Structures.CompletionItem
    is
+      use Libadalang.Common;
 
       package Weight_Formatters renames VSS.Strings.Formatters.Integers;
 
@@ -307,9 +308,13 @@ package body LSP.Ada_Documents is
          Item.label.Append (" (invisible)");
          Item.filterText := Label;
 
-         --  If the corresponding setting is enabled, append a command to
+         --  If the corresponding setting is enabled, and if we
+         --  are not completing within a with-clause, append a command to
          --  insert the missing with-clause/qualifier.
-         if Handler.Get_Configuration.Insert_With_Clauses then
+         if Handler.Get_Configuration.Insert_With_Clauses
+           and then not (for some Parent of Node.Parents
+                         => Parent.Kind = Ada_With_Clause)
+         then
             Append_Auto_Import_Command;
          end if;
       end if;

source/ada/lsp-ada_driver.adb

@@ -226,13 +226,16 @@ procedure LSP.Ada_Driver is
            Command'Tag);
    end Register_Commands;
 
-   Server_Trace : constant Trace_Handle := Create ("ALS.MAIN", From_Config);
+   Server_Trace : constant LSP.GNATCOLL_Tracers.Tracer :=
+     LSP.GNATCOLL_Tracers.Create ("ALS.MAIN", From_Config);
    --  Main trace for the LSP.
 
-   In_Trace  : constant Trace_Handle := Create ("ALS.IN", Off);
-   Out_Trace : constant Trace_Handle := Create ("ALS.OUT", Off);
+   In_Trace  : constant LSP.GNATCOLL_Tracers.Tracer :=
+     LSP.GNATCOLL_Tracers.Create ("ALS.IN", Off);
+   Out_Trace : constant LSP.GNATCOLL_Tracers.Tracer :=
+     LSP.GNATCOLL_Tracers.Create ("ALS.OUT", Off);
    --  Traces that logs all input & output. For debugging purposes.
-   Tracer    : aliased LSP.GNATCOLL_Tracers.Tracer;
+   Tracer    : aliased LSP.GNATCOLL_Tracers.Server_Tracer;
 
    In_Stream  : aliased LSP.GNATCOLL_Trace_Streams.Output_Text_Stream;
    --  Output stream for logging input messages into the trace
@@ -496,8 +499,8 @@ begin
       end;
    end if;
 
-   In_Stream.Initialize (Server_Trace);
-   Out_Stream.Initialize (Server_Trace);
+   In_Stream.Initialize (Trace_Handle (Server_Trace));
+   Out_Stream.Initialize (Trace_Handle (Server_Trace));
 
    Tracer.Initialize (Server_Trace, In_Trace, Out_Trace);
    Tracer.Trace ("ALS version: " & $VERSION & " (" & $BUILD_DATE & ")");
@@ -558,7 +561,7 @@ begin
 
          --  Load predefined completion items
          LSP.Predefined_Completion.Load_Predefined_Completion_Db
-           (Server_Trace);
+           (Trace_Handle (Server_Trace));
 
          Ada_Fence_Message_Handler.Initialize
            (Handler  => Ada_Handler'Unchecked_Access,

source/ada/lsp-ada_handlers-project_diagnostics.adb

@@ -15,8 +15,15 @@
 -- of the license.                                                          --
 ------------------------------------------------------------------------------
 
+with LSP.GNATCOLL_Tracers;
 package body LSP.Ada_Handlers.Project_Diagnostics is
 
+   Tracer : constant LSP.GNATCOLL_Tracers.Tracer :=
+      LSP.GNATCOLL_Tracers.Create ("ALS.PROJECT.DIAGNOSTICS");
+   --  We do not activate this trace by default because it is too noisy to
+   --  repeat the information every time diagnostics are published for every
+   --  file.
+
    --------------------
    -- Get_Diagnostic --
    --------------------
@@ -29,7 +36,8 @@ package body LSP.Ada_Handlers.Project_Diagnostics is
       if Self.Handler.Configuration.Project_Diagnostics_Enabled then
          Self.Last_Status := Self.Handler.Project_Status;
 
-         Self.Handler.Tracer.Trace ("Diag: " & Self.Last_Status'Image);
+         Tracer.Trace ("Project loading status: " & Self.Last_Status'Image);
+
          --  If we have a valid project return immediately: we want to display
          --  diagnostics only if there is an issue to solve or a potential
          --  enhancement.