JavaScript: Add CI configuration for software tests and Dependabot

Author: amotl

.github/dependabot.yml

@@ -1,3 +1,8 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
 version: 2
 
 updates:
@@ -7,6 +12,11 @@ updates:
     schedule:
       interval: "weekly"
 
+  - package-ecosystem: "npm"
+    directory: "/cratedb_sqlparse_js"
+    schedule:
+      interval: "weekly"
+
   - package-ecosystem: "pip"
     directory: "/cratedb_sqlparse_py"
     schedule:

.github/workflows/javascript.yml

@@ -0,0 +1,82 @@
+---
+name: JavaScript Tests
+
+on:
+  pull_request: ~
+  push:
+    branches: [ main ]
+
+  # Allow job to be triggered manually.
+  workflow_dispatch:
+
+  # Run job each night after CrateDB nightly has been published.
+  schedule:
+    - cron: '0 3 * * *'
+
+# Cancel in-progress jobs when pushing to the same branch.
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+
+# Select JavaScript grammar.
+defaults:
+  run:
+    working-directory: cratedb_sqlparse_js
+
+jobs:
+
+  tests:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest"]
+        node-version: ["18", "20", "22"]
+
+    env:
+      OS: ${{ matrix.os }}
+      NODEJS: ${{ matrix.node-version }}
+
+    # https://docs.github.com/en/actions/using-containerized-services/about-service-containers
+    services:
+      cratedb:
+        image: crate/crate:nightly
+        ports:
+          - 4200:4200
+          - 5432:5432
+        env:
+          CRATE_HEAP_SIZE: 4g
+
+    name: JavaScript ${{ matrix.node-version }} on OS ${{ matrix.os }}
+    steps:
+
+    - name: Acquire sources
+      uses: actions/checkout@v4
+
+    # https://github.com/actions/setup-python
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+        architecture: x64
+
+    # https://github.com/actions/setup-node
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+        cache-dependency-path: 'package-lock.json'
+
+    - name: Generate runtime grammar
+      run: |
+        cd ..
+        pip install --requirement requirements.txt
+        python setup_grammar.py javascript
+
+    - name: Set up project
+      run: npm install
+
+    - name: Run linter and software tests
+      run: npm test

.github/workflows/main.yml .github/workflows/python.yml.github/workflows/main.yml renamed to .github/workflows/python.yml

@@ -62,7 +62,7 @@ jobs:
         cache: 'pip'
         cache-dependency-path: 'pyproject.toml'
 
-    - name: Setup project
+    - name: Set up project
       run: |
 
         # `setuptools 0.64.0` adds support for editable install hooks (PEP 660).

cratedb_sqlparse_js/package-lock.json

@@ -25,7 +25,7 @@
     "sql-dialect"
   ],
   "scripts": {
-    "test": "vitest",
+    "test": "vitest run",
     "build": "vite build"
   },
   "devDependencies": {

cratedb_sqlparse_js/package.json

@@ -19,7 +19,7 @@ def generate():
         # Test module for availability.
         find_spec("cratedb_sqlparse.generated_parser.SqlBaseParser")
     except ImportError:
-        subprocess.check_call([sys.executable, SETUP_GRAMMAR], cwd=HERE.parent.parent)  # noqa: S603
+        subprocess.check_call([sys.executable, SETUP_GRAMMAR, "python"], cwd=HERE.parent.parent)  # noqa: S603
 
     try:
         # Test module for availability.

cratedb_sqlparse_py/tests/conftest.py

@@ -1,5 +1,6 @@
 [tool.poe.tasks]
 
 generate = [
-  { cmd = "python setup_grammar.py" },
+  { cmd = "python setup_grammar.py python" },
+  { cmd = "python setup_grammar.py javascript" },
 ]

pyproject.toml

@@ -143,10 +143,21 @@ def set_version(target: Antlr4Target, version: str):
 
 
 if __name__ == '__main__':
+    """
+    Invoke the grammar compiler / generator.
+
+    TODO: Converge `version` into command-line argument?
+    TODO: Improve efficiency by generating runtime parser for all implemented languages at once.
+    """
     setup_logging()
-    # TODO: Converge into command-line argument?
+    input_target = sys.argv[1]
     version = '5.6.4'
-    target = Antlr4Target.python
+    if input_target.startswith("py"):
+        target = Antlr4Target.python
+    elif input_target.startswith("js") or input_target.startswith("java"):
+        target = Antlr4Target.js
+    else:
+        raise NotImplementedError(f"Parser generator for target {input_target} not implemented")
     download_cratedb_grammar(version)
     compile_grammar(target)
     patch_lexer(target)