Merge remote branch 'origin/master' into edge

Author: automatic-merge

.gitlab-ci.plan

@@ -11,11 +11,18 @@ def test_als_(qualifier={}):
         anod_test("als")
 
 
+def test_als_cov_(qualifier={}):
+    with defaults(qualifier=qualifier | {"coverage": True}):
+        # We don't install 'als' because in coverage mode, 'als' can't be installed and
+        # has to be built instead.
+        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")
+        anod_test("vscode-extension", qualifier=qualifier | {"coverage": True})
 
 
 def build_test_gs_(qualifier={}):
@@ -39,6 +46,10 @@ def test_als_edge():
     test_als_(edge_qualifier)
 
 
+def test_als_cov_edge():
+    test_als_cov_(edge_qualifier)
+
+
 def test_vscode_extension_edge():
     test_vscode_extension_(edge_qualifier)
 

.gitlab-ci.yml

@@ -23,6 +23,18 @@ include:
       anod-args: run test_als_$ACI_TRACK
       image: systemgtk
 
+  # 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
+      image: systemgtk
+      # 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.
+      needs: []
+      stage: build
+
   # Testing of the VSCode extension
   - component: $CI_SERVER_FQDN/eng/gitlab-templates/test@~latest
     inputs:
@@ -57,3 +69,104 @@ include:
         - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
           when: manual
           allow_failure: true
+
+als-cov:
+  after_script:
+    # Source the env prepared by generic_anod_ci
+    - cat /tmp/ci_env.sh
+    - . /tmp/ci_env.sh
+
+    - ALS_BUILD_SPACE=$(anod info test als $ACI_TRACK_QUALIFIER -Q coverage --show working_dir)
+    - RESULTS_DIR=$ALS_BUILD_SPACE/results/new
+
+    # Include Anod logs
+    - cp -rv $ANOD_DEFAULT_SANDBOX_DIR/log $CI_PROJECT_DIR/anod-logs
+
+    # Include coverage report
+    - mkdir -v $CI_PROJECT_DIR/coverage
+
+      # save coverage results
+    - cp -v $RESULTS_DIR/coverage-cobertura/cobertura.xml $CI_PROJECT_DIR/coverage
+    - cp -vr $RESULTS_DIR/coverage-dhtml $CI_PROJECT_DIR/coverage/dhtml
+
+    # export to gitlab pages
+    - |
+      if [[ $CI_PIPELINE_SOURCE = "merge_request_event" ]]; then
+        target_subdir=MRs/$CI_MERGE_REQUEST_IID
+      else
+        target_subdir=$CI_COMMIT_BRANCH
+      fi
+
+    - target_subdir=$target_subdir/ada-coverage
+    - publish-pages $CI_PROJECT_DIR/coverage/dhtml/ --target-subdir $target_subdir --expires 30
+    - >
+      echo "Coverage report: https://pages.gitlab.adacore-it.com/$CI_PROJECT_PATH/$target_subdir/index.html"
+
+    # display coverage stats for global reporting
+    - echo_coverage_stats --coverage-file $RESULTS_DIR/coverage-xml/index.xml
+  coverage: '/^Stmt Coverage:\s+(\d+\.\d+\%) \(\d+ \/ \d+\)$/'
+  artifacts:
+    when: always #  Upload on errors too
+    reports:
+      junit: xunit-*.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/cobertura.xml
+    paths:
+      - anod-logs/
+      # Also archive the report file for debugging the CI integration
+      - coverage/cobertura.xml
+
+vscode-extension:
+  after_script:
+    # Source the env prepared by generic_anod_ci
+    - cat /tmp/ci_env.sh
+    - . /tmp/ci_env.sh
+
+    - VSCODE_BUILD_SPACE=$(anod info test vscode-extension -Q coverage $ACI_TRACK_QUALIFIER --show working_dir)
+
+    # Include Anod logs
+    - cp -rv $ANOD_DEFAULT_SANDBOX_DIR/log $CI_PROJECT_DIR/anod-logs
+
+    # Copy coverage reports
+    - cp -rv $VSCODE_BUILD_SPACE/test/integration/vscode/ada/coverage $CI_PROJECT_DIR
+
+    # export to gitlab pages
+    - |
+      if [[ $CI_PIPELINE_SOURCE = "merge_request_event" ]]; then
+        target_subdir=MRs/$CI_MERGE_REQUEST_IID
+      else
+        target_subdir=$CI_COMMIT_BRANCH
+      fi
+    - target_subdir=$target_subdir/ts-coverage
+    - publish-pages $CI_PROJECT_DIR/coverage/ --target-subdir $target_subdir --expires 30
+    - >
+      echo "Coverage report: https://pages.gitlab.adacore-it.com/$CI_PROJECT_PATH/$target_subdir/index.html"
+
+    # Compute coverage percentage
+    - line_rate=$(cat $CI_PROJECT_DIR/coverage/cobertura-coverage.xml | grep -o 'line-rate="\([^"]\+\)"' | head -1 | grep -o '[0-9.]\+')
+    - line_perc=$(python -c "print($line_rate * 100)")
+    - >
+      echo "Line Coverage: $line_perc"
+
+    # The Cobertura report coming from the VS Code test infra has a <source>
+    # element specifying the root path of all sources.
+    #
+    # This needs to be replaced with the CI_PROJECT_DIR in order for GitLab to
+    # understand it.
+    #
+    # In this sed command we use '|' instead of '/' as a separator for the 's'
+    # command to avoid interpreting path separators in the pattern and
+    # replacement.
+    - sed -e "s|$VSCODE_BUILD_SPACE/test|$CI_PROJECT_DIR|" -i $CI_PROJECT_DIR/coverage/cobertura-coverage.xml
+  coverage: '/^Line Coverage:\s+(\d+\.\d+)$/'
+  artifacts:
+    when: always #  Upload on errors too
+    reports:
+      junit: xunit-*.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/cobertura-coverage.xml
+    paths:
+      - anod-logs/
+      - coverage/cobertura-coverage.xml

Makefile

@@ -166,9 +166,15 @@ endif
 	@echo Now run:
 	@echo code --extensionDevelopmentPath=`pwd`/integration/vscode/ada/ `pwd`
 
+ifeq ($(COVERAGE),)
+  NPM_TEST_ARGS?=
+else
+  NPM_TEST_ARGS?=-- --coverage --coverage-reporter text-summary --coverage-reporter html --coverage-reporter cobertura --label 0
+endif
+
 vscode-test:
 	# Run the VS Code integration testsuite.
-	cd integration/vscode/ada; MOCHA_ALS_UPDATE=$(MOCHA_ALS_UPDATE) LD_LIBRARY_PATH= npm run test
+	cd integration/vscode/ada; MOCHA_ALS_UPDATE=$(MOCHA_ALS_UPDATE) LD_LIBRARY_PATH= npm run test $(NPM_TEST_ARGS)
 
 vscode-package:
 	cd integration/vscode/ada; LD_LIBRARY_PATH= $(VSCE) package

gnat/tester.gpr

@@ -27,7 +27,7 @@ project Tester is
    package Compiler renames LSP_Client.Compiler;
 
    package Binder is
-      for Switches ("ada") use ("-E");
+      for Switches ("ada") use ("-Es");
    end Binder;
 
 end Tester;

integration/vscode/ada/eslint.config.mjs

@@ -0,0 +1,61 @@
+import typescriptEslintEslintPlugin from "@typescript-eslint/eslint-plugin";
+import tsdoc from "eslint-plugin-tsdoc";
+import globals from "globals";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default [{
+    ignores: ["**/out", "**/*.d.ts"],
+}, ...compat.extends(
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:prettier/recommended",
+), {
+    plugins: {
+        "@typescript-eslint": typescriptEslintEslintPlugin,
+        tsdoc,
+    },
+
+    languageOptions: {
+        globals: {
+            ...Object.fromEntries(Object.entries(globals.browser).map(([key]) => [key, "off"])),
+            ...globals.node,
+            ...globals.commonjs,
+        },
+
+        parser: tsParser,
+        ecmaVersion: 5,
+        sourceType: "commonjs",
+
+        parserOptions: {
+            ecmaFeatures: {
+                jsx: true,
+            },
+
+            project: "tsconfig.json",
+        },
+    },
+
+    rules: {
+        "tsdoc/syntax": "warn",
+
+        "max-len": ["warn", {
+            code: 100,
+            ignoreUrls: true,
+        }],
+
+        "@typescript-eslint/switch-exhaustiveness-check": "error",
+    },
+}];

integration/vscode/ada/package-lock.json

@@ -997,6 +997,8 @@
         ]
     },
     "devDependencies": {
+        "@eslint/eslintrc": "^3.1.0",
+        "@eslint/js": "^9.10.0",
         "@types/command-exists": "1.2.3",
         "@types/mocha": "10.0.7",
         "@types/node": "16.18.16",
@@ -1014,6 +1016,7 @@
         "eslint-plugin-prettier": "5.2.1",
         "eslint-plugin-tsdoc": "0.3.0",
         "glob": "11.0.0",
+        "globals": "^15.9.0",
         "mocha": "10.7.3",
         "mocha-junit-reporter": "^2.2.1",
         "npm-check-updates": "^17.1.0",
@@ -1024,7 +1027,7 @@
         "vscode-tmgrammar-test": "0.1.3"
     },
     "scripts": {
-        "check-licenses": "npx license-checker-rseidelsohn --summary --onlyAllow \"0BSD;Apache-2.0;BSD-2-Clause;BSD-3-Clause;BlueOak-1.0.0;CC0-1.0;GPL-3.0;GPL-3.0-or-later;ISC;MIT;Python-2.0;Zlib;EPL-2.0\" --excludePackages \"@vscode/vsce-sign-linux-x64;@vscode/vsce-sign\"",
+        "check-licenses": "npx license-checker-rseidelsohn --summary --onlyAllow \"0BSD;Apache-2.0;BSD-2-Clause;BSD-3-Clause;BlueOak-1.0.0;CC0-1.0;GPL-3.0;GPL-3.0-or-later;ISC;MIT;Python-2.0;Zlib;EPL-2.0\" --excludePackages \"@vscode/vsce-sign-linux-x64;@vscode/vsce-sign-win32-x64;@vscode/vsce-sign\"",
         "vscode:prepublish": "npm run esbuild-base -- --minify --sourcemap",
         "esbuild-base": "esbuild ./src/extension.ts --bundle --outfile=out/src/extension.js --external:vscode --format=cjs --platform=node",
         "compile": "node ./node_modules/typescript/bin/tsc",

integration/vscode/ada/package.json

@@ -18,11 +18,11 @@ export class AdaCodeLensProvider implements CodeLensProvider {
     onDidChangeCodeLenses?: Event<void> | undefined;
     provideCodeLenses(
         document: TextDocument,
-        token?: CancellationToken
+        token?: CancellationToken,
     ): ProviderResult<CodeLens[]> {
         const symbols = commands.executeCommand<DocumentSymbol[]>(
             'vscode.executeDocumentSymbolProvider',
-            document.uri
+            document.uri,
         );
 
         /**
@@ -34,7 +34,7 @@ export class AdaCodeLensProvider implements CodeLensProvider {
                     (m) =>
                         // Here we go through the Uri class to benefit from the normalization
                         // of path casing on Windows. See Uri.fsPath documentation.
-                        Uri.file(m).fsPath == document.uri.fsPath
+                        Uri.file(m).fsPath == document.uri.fsPath,
                 )
             ) {
                 // It's a main file, so let's offer Run and Debug actions on the main subprogram