Merge branch 'topic/ci/formatting_check' into 'master'

Rework the sources format checking pipeline

Closes #485

See merge request eng/libadalang/langkit-query-language!499

Author: HugoGGuerrier

.gitlab-ci.yml

@@ -1,6 +1,52 @@
+include:
+  - component: $CI_SERVER_FQDN/eng/gitlab-templates/check-issue@~latest
+    inputs:
+      stage: checkstyle
+  - component: $CI_SERVER_FQDN/eng/gitlab-templates/pre-commit@~latest
+    inputs:
+      stage: checkstyle
+
 stages:
+  - checkstyle
   - test
 
+pre-commit:
+  services:
+    - image:pe-base
+    - cpu:8
+    - mem:32
+    - disk:50
+  before_script:
+    # Create a sandbox and install needed dependencies
+    - generic_anod_ci
+    - . /tmp/ci_env.sh
+    # Define working variables
+    - npm_cache=$PWD/npm_cache
+    - npm_cache_install=$npm_cache/spotless-prettier-node-modules-fbb3f0657a1374078dbfdc0a3df68734
+    - maven_local_repo=$(anod info maven-repo-pull -Qclient=lkql --show working_dir)/install
+    - npmrc_file=$PWD/.npmrc
+
+    # Echo vars to log information about the run
+    - echo $npm_cache
+    - echo $npm_cache_install
+    - echo $maven_local_repo
+
+    # Install all pre-commit dependencies
+    - anod install gnatformat
+    - anod build   java            -Q version=17,vendor=graalvm
+    - anod build   maven           -Q version=3.6.3
+    - anod build   nodejs          -Q version=16.19.1
+    - anod build   maven-repo-pull -Q client=lkql
+    - eval $(anod printenv gnatformat)
+    - eval $(anod printenv java       -Q version=17,vendor=graalvm)
+    - eval $(anod printenv maven      -Q version=3.6.3)
+    - eval $(anod printenv nodejs     -Q version=16.19.1)
+    - mkdir -p $npm_cache_install
+    - e3-cathod thirdparty prettier_java-npm_cache-20250203.tar.gz --install $npm_cache_install --delete
+    - ls $npm_cache_install
+    - echo "offline=true" > $npmrc_file
+    - export MAVEN_ARGS="-Dmaven.repo.local=$maven_local_repo -Dconfig.npmInstallCache=$npm_cache -Dconfig.npmrc=$npmrc_file"
+
 # Common part for all testing CIs
 .common-test-part: &common-test-part
   services:

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: local
+    hooks:
+      - id: gnatformat
+        name: Format GNATcheck sources
+        entry: gnatformat
+        language: system
+        files: "^lkql_checker/src/.*\\.ad(b|s)$"
+  - repo: local
+    hooks:
+      - id: maven-spotless
+        name: Format LKQL JIT sources
+        entry: python
+        args:
+          - utils/maven_wrapper.py
+          - spotless:apply
+        language: system
+        pass_filenames: false
+        require_serial: true
+        files: "^lkql_jit/.*\\.java$"

lkql_checker/src/gnatcheck-compiler.adb

@@ -1559,8 +1559,9 @@ package body Gnatcheck.Compiler is
       if Gnatcheck_Prj.Tree.Is_Defined
         and then Gnatcheck_Prj.Tree.Has_Explicit_Target
       then
-         return Ada.Strings.Unbounded."=" (Target, "codepeer") or else
-           Ada.Strings.Unbounded."=" (Target, "gnatsas");
+         return
+           Ada.Strings.Unbounded."=" (Target, "codepeer")
+           or else Ada.Strings.Unbounded."=" (Target, "gnatsas");
       end if;
 
       --  If we could find a regular gnatls, it means there is a native

lkql_jit/pom.xml

@@ -122,15 +122,6 @@
                 <artifactId>spotless-maven-plugin</artifactId>
                 <version>2.40.0</version>
 
-                <executions>
-                    <execution>
-                        <goals>
-                            <goal>check</goal>
-                        </goals>
-                        <phase>validate</phase>
-                    </execution>
-                </executions>
-
                 <configuration>
                     <java>
                         <includes>

utils/maven_wrapper.py

@@ -0,0 +1,51 @@
+"""
+This script is a wrapper around the Maven command, it is used by the pre-commit
+hooks configuration to simplify the process of running Maven on LKQL JIT
+sources.
+"""
+
+import os
+import subprocess
+import sys
+
+if __name__ == '__main__':
+    # Get the Maven executable
+    mvn = "mvn.cmd" if os.name == "nt" else "mvn"
+
+    # Get the path of the LKQL JIT "pom.xml" file
+    pom_xml = os.path.abspath(
+        os.path.join(
+            os.path.dirname(os.path.realpath(__file__)),
+            "..",
+            "lkql_jit",
+            "pom.xml",
+        )
+    )
+
+    # Forward script arguments to Maven and ensure 'MAVEN_ARGS' is taken into
+    # account.
+    maven_args = sys.argv[1:] + (
+        os.environ['MAVEN_ARGS'].split(" ")
+        if os.environ.get('MAVEN_ARGS') else
+        []
+    )
+
+    # Set maven to offline mode when running in a Gitlab CI
+    if "CI_JOB_NAME" in os.environ:
+        maven_args = [
+            "-o",
+            *maven_args,
+        ]
+
+    # Run Maven on LKQL JIT project with additional args of this script
+    try:
+        subprocess.check_output([
+            mvn,
+            "-f",
+            pom_xml,
+            "-q",
+            *maven_args
+        ])
+    except subprocess.CalledProcessError as e:
+        print(e.output.decode())
+        exit(e.returncode)