Use CodeQL CLI Test Runner instead of RSpec

.codeqlmanifest.json

@@ -1,6 +1,7 @@
 {
   "provide": [
     "ql/src/qlpack.yml",
+    "ql/test/qlpack.yml",
     "extractor/codeql-extractor.yml"
   ],
   "ignore": [

.github/workflows/continuous-integration.yml

@@ -87,6 +87,12 @@ jobs:
         run: |
           bundle exec rake spec:ci
 
+      - name: Run CodeQL Tests
+        working-directory: ./codeql-ruby
+        run: |
+          bundle exec rake install
+          $GITHUB_WORKSPACE/codeql/codeql test run -vvvvv ql/test
+
       # - name: Setup tmate session
       #   uses: mxschmitt/action-tmate@v2
 

.gitignore

@@ -11,6 +11,9 @@
 # rspec failure tracking
 .rspec_status
 
+# CodeQL test runner databases
+*.testproj
+
 .cache/
 
 TODOS.md

extractor/codeql-extractor.yml

@@ -8,4 +8,4 @@ file_types:
     display_name: Ruby
     extensions:
       - .rb
-legacy_qltest_extraction: false
+legacy_qltest_extraction: true

extractor/tools/index.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+####################################################################################
+#
+# Required for running `codeql test run my/test/dir`
+# when legacy_qltest_extraction is set to true in ruby/codeql-extractor.yml
+#
+#
+# FIXME: figure out what "non-legacy" test extraction looks like and how it works
+#
+####################################################################################
+
+set -eu
+
+codeql_ruby $@

ql/test/base_unsafe_script/example.expected

@@ -0,0 +1,3 @@
+| 1 | This is a leaf node. |
+| ARGV | This is a leaf node. |
+| eval | This is a leaf node. |

ql/test/leaf_node_location/example.expected

@@ -0,0 +1,4 @@
+| leaf_node_location.rb:1:0:1:4 | LeafNode | puts | leaf_node_location.rb:1 |
+| leaf_node_location.rb:1:0:1:4 | LeafNode | puts | leaf_node_location.rb:1 |
+| leaf_node_location.rb:1:6:1:40 | LeafNode | this file contains some leaf nodes | leaf_node_location.rb:1 |
+| leaf_node_location.rb:1:6:1:40 | LeafNode | this file contains some leaf nodes | leaf_node_location.rb:1 |

ql/test/qlpack.yml

@@ -0,0 +1,5 @@
+name: codeql-ruby-tests
+version: 0.0.0
+libraryPathDependencies:
+  - codeql-ruby
+extractor: ruby

ql/test/script_with_require/example.expected

@@ -0,0 +1,14 @@
+| . | This is a leaf node. |
+| ./required_file | This is a leaf node. |
+| @fullpath | This is a leaf node. |
+| File | This is a leaf node. |
+| RequiredFile | This is a leaf node. |
+| __FILE__ | This is a leaf node. |
+| attr_reader | This is a leaf node. |
+| expand_path | This is a leaf node. |
+| fullpath | This is a leaf node. |
+| initialize | This is a leaf node. |
+| new | This is a leaf node. |
+| puts | This is a leaf node. |
+| require_relative | This is a leaf node. |
+| rf | This is a leaf node. |

spec/codeql_ruby_spec.rb

@@ -5,32 +5,11 @@
     expect(CodeqlRuby::VERSION).not_to be nil
   end
 
-  it "extracts a db, runs a query, and generates JSON results" do
-    results = CodeqlRunner.results_for_db('base_unsafe_script')
-    tuples = results.dig('#select', 'tuples')
-
-    expect(tuples).to include(['eval', 'This is a leaf node.'])
-  end
-
-  it "extracts a directory as a db and queries it" do
-    results = CodeqlRunner.results_for_db('script_with_require')
-    tuples = results.dig('#select', 'tuples')
-
-    expect(tuples).to include(['RequiredFile', 'This is a leaf node.'])
-  end
-
   it "extracts a file to relevant trap structures" do
-    filepath = File.expand_path(File.join(File.dirname(__FILE__), 'script_with_require', 'script_with_require.rb'))
+    filepath = File.expand_path(File.join(File.dirname(__FILE__), '..', 'ql', 'test', 'script_with_require', 'script_with_require.rb'))
     ef = CodeqlRuby::ExtractorFile.new(filepath)
     results = ef.to_trap
 
     expect(results).to be_a(String)
   end
-
-  it "extracts Location info from LeafNodes" do
-    results = CodeqlRunner.results_for_db('leaf_node_location')
-    tuples = results.dig('#select', 'tuples')
-
-    expect(tuples).to include([{'label'=>'LeafNode'}, 'puts', 'leaf_node_location.rb:1'])
-  end
 end