Update Ruby workflows

Author: aibaars

.github/workflows/qhelp.yml .github/workflows/qhelp-pr-preview.yml.github/workflows/qhelp.yml renamed to .github/workflows/qhelp-pr-preview.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
     branches: [main]
     paths:
-      - "**/*.qhelp"
+      - "ruby/**/*.qhelp"
 
 jobs:
   qhelp:
@@ -30,7 +30,7 @@ jobs:
           for path in ${{ steps.changes.outputs.qhelp_files }} ; do
             echo "<details> <summary>${path}</summary>"
             echo
-            codeql/codeql generate query-help --format=markdown ${path}
+            codeql generate query-help --format=markdown ${path}
             echo "</details>"
           done) | gh pr comment "${{ github.event.pull_request.number }}" -F -
         env:

.github/workflows/qltest.yml

@@ -1,10 +1,18 @@
-name: Build / Release
+name: "Ruby: Build"
 
 on:
   push:
-    branches: [main]
+    paths:
+      - 'ruby/**'
+    branches:
+      - main
+      - 'rc/*'
   pull_request:
-    branches: [main]
+    paths:
+      - 'ruby/**'
+    branches:
+      - main
+      - 'rc/*'
   workflow_dispatch:
     inputs:
       tag:
@@ -14,6 +22,10 @@ on:
 env:
   CARGO_TERM_COLOR: always
 
+defaults:
+  run:
+    working-directory: ruby
+
 jobs:
   build:
     strategy:
@@ -35,7 +47,7 @@ jobs:
           path: |
             ~/.cargo/registry
             ~/.cargo/git
-            target
+            ruby/target
           key: ${{ runner.os }}-rust-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Check formatting
         run: cargo fmt --all -- --check
@@ -52,20 +64,20 @@ jobs:
         if: ${{ matrix.os == 'ubuntu-latest' }}
         with:
           name: ruby.dbscheme
-          path: ql/lib/ruby.dbscheme
+          path: ruby/ql/lib/ruby.dbscheme
       - uses: actions/upload-artifact@v2
         if: ${{ matrix.os == 'ubuntu-latest' }}
         with:
           name: TreeSitter.qll
-          path: ql/lib/codeql/ruby/ast/internal/TreeSitter.qll
+          path: ruby/ql/lib/codeql/ruby/ast/internal/TreeSitter.qll
       - uses: actions/upload-artifact@v2
         with:
           name: extractor-${{ matrix.os }}
           path: |
-            target/release/ruby-autobuilder
-            target/release/ruby-autobuilder.exe
-            target/release/ruby-extractor
-            target/release/ruby-extractor.exe
+            ruby/target/release/ruby-autobuilder
+            ruby/target/release/ruby-autobuilder.exe
+            ruby/target/release/ruby-extractor
+            ruby/target/release/ruby-extractor.exe
           retention-days: 1
   compile-queries:
     runs-on: ubuntu-latest
@@ -102,7 +114,7 @@ jobs:
         with:
           name: codeql-ruby-queries
           path: |
-            target/packs/*
+            ruby/target/packs/*
           retention-days: 1
 
   package:
@@ -113,19 +125,19 @@ jobs:
       - uses: actions/download-artifact@v2
         with:
           name: ruby.dbscheme
-          path: ruby
+          path: ruby/ruby
       - uses: actions/download-artifact@v2
         with:
           name: extractor-ubuntu-latest
-          path: linux64
+          path: ruby/linux64
       - uses: actions/download-artifact@v2
         with:
           name: extractor-windows-latest
-          path: win64
+          path: ruby/win64
       - uses: actions/download-artifact@v2
         with:
           name: extractor-macos-latest
-          path: osx64
+          path: ruby/osx64
       - run: |
           mkdir -p ruby
           cp -r codeql-extractor.yml tools ql/lib/ruby.dbscheme.stats ruby/
@@ -141,12 +153,12 @@ jobs:
       - uses: actions/upload-artifact@v2
         with:
           name: codeql-ruby-pack
-          path: codeql-ruby.zip
+          path: ruby/codeql-ruby.zip
           retention-days: 1
       - uses: actions/download-artifact@v2
         with:
           name: codeql-ruby-queries
-          path: qlpacks
+          path: ruby/qlpacks
       - run: |
           echo '{
             "provide": [
@@ -158,18 +170,13 @@ jobs:
       - uses: actions/upload-artifact@v2
         with:
           name: codeql-ruby-bundle
-          path: codeql-ruby-bundle.zip
+          path: ruby/codeql-ruby-bundle.zip
           retention-days: 1
-      - if: ${{ github.event.inputs.tag }}
-        run: |
-          gh release create --prerelease \
-             --title "CodeQL Ruby (${{ github.event.inputs.tag }})" \
-             --target "${{ github.sha }}" \
-             "${{ github.event.inputs.tag }}" \
-             codeql-ruby-bundle.zip
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   test:
+    defaults:
+      run:
+        working-directory: ${{ github.workspace }}
     strategy:
       fail-fast: false
       matrix:

.github/workflows/build.yml .github/workflows/ruby-build.yml.github/workflows/build.yml renamed to .github/workflows/ruby-build.yml

@@ -1,14 +1,14 @@
-name: Collect database stats
+name: "Ruby: Collect database stats"
 
 on:
   push:
     branches: [main]
     paths:
-      - ql/lib/ruby.dbscheme
+      - ruby/ql/lib/ruby.dbscheme
   pull_request:
     branches: [main]
     paths:
-      - ql/lib/ruby.dbscheme
+      - ruby/ql/lib/ruby.dbscheme
   workflow_dispatch:
 
 jobs:
@@ -34,15 +34,15 @@ jobs:
           path: ${{ github.workspace }}/repo
       - name: Create database
         run: |
-          codeql/codeql database create \
-            --search-path "${{ github.workspace }}" \
+          codeql database create \
+            --search-path "${{ github.workspace }}/ruby" \
             --threads 4 \
             --language ruby --source-root "${{ github.workspace }}/repo" \
             "${{ runner.temp }}/database"
       - name: Measure database
         run: |
           mkdir -p "stats/${{ matrix.repo }}"
-          codeql/codeql dataset measure --threads 4 --output "stats/${{ matrix.repo }}/stats.xml" "${{ runner.temp }}/database/db-ruby"
+          codeql dataset measure --threads 4 --output "stats/${{ matrix.repo }}/stats.xml" "${{ runner.temp }}/database/db-ruby"
       - uses: actions/upload-artifact@v2
         with:
           name: measurements
@@ -60,8 +60,8 @@ jobs:
           path: stats
       - run: |
           python -m pip install --user lxml
-          find stats -name 'stats.xml' | sort | xargs python scripts/merge_stats.py --output ql/lib/ruby.dbscheme.stats --normalise ruby_tokeninfo
+          find stats -name 'stats.xml' | sort | xargs python ruby/scripts/merge_stats.py --output ruby/ql/lib/ruby.dbscheme.stats --normalise ruby_tokeninfo
       - uses: actions/upload-artifact@v2
         with:
           name: ruby.dbscheme.stats
-          path: ql/lib/ruby.dbscheme.stats
+          path: ruby/ql/lib/ruby.dbscheme.stats

.github/workflows/dataset_measure.yml …ithub/workflows/ruby-dataset-measure.yml.github/workflows/dataset_measure.yml renamed to .github/workflows/ruby-dataset-measure.yml .github/workflows/dataset_measure.yml renamed to .github/workflows/ruby-dataset-measure.yml

@@ -0,0 +1,50 @@
+name: "Ruby: Run QL Tests"
+
+on:
+  push:
+    paths:
+      - 'ruby/**'
+    branches:
+      - main
+      - 'rc/*'
+  pull_request:
+    paths:
+      - 'ruby/**'
+    branches:
+      - main
+      - 'rc/*'
+
+env:
+  CARGO_TERM_COLOR: always
+
+defaults:
+  run:
+    working-directory: ruby
+
+jobs:
+  qltest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: ./.github/actions/fetch-codeql
+      - uses: ./ruby/actions/create-extractor-pack
+      - name: Run QL tests
+        run: |
+          codeql test run --check-databases --check-unused-labels --check-repeated-labels --check-redefined-labels --check-use-before-definition --search-path "${{ github.workspace }}/ruby" --additional-packs "${{ github.workspace }}/ruby/codeql"  --consistency-queries ql/consistency-queries ql/test
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+      - name: Check QL formatting
+        run: find ql "(" -name "*.ql" -or -name "*.qll" ")" -print0 | xargs -0 codeql query format --check-only
+      - name: Check QL compilation
+        run: |
+          codeql query compile --check-only --threads=4 --warnings=error --search-path "${{ github.workspace }}/ruby" --additional-packs "${{ github.workspace }}/ruby/codeql" "ql/src" "ql/examples"
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+      - name: Check DB upgrade scripts
+        run: |
+          echo >empty.trap
+          codeql dataset import -S ql/lib/upgrades/initial/ruby.dbscheme testdb empty.trap
+          codeql dataset upgrade testdb --additional-packs ql/lib/upgrades
+          diff -q testdb/ruby.dbscheme ql/lib/ruby.dbscheme

.github/workflows/ruby-qltest.yml

@@ -14,4 +14,4 @@ jobs:
         with:
           submodules: true
       - name: Check synchronized files
-        run: scripts/sync-identical-files.py
+        run: ruby/scripts/sync-identical-files.py