** Run MRVA from command line
This commit is contained in:
Michael Hohn
committed by
=Michael Hohn
=Michael Hohn
parent
edb9714b37
commit
8b076cfd53
190
README.org
190
README.org
@@ -31,38 +31,38 @@
|
||||
#+END_SRC
|
||||
|
||||
** Use the codeql extension to run MRVA
|
||||
Following the [[https://codeql.github.com/docs/codeql-for-visual-studio-code/running-codeql-queries-at-scale-with-mrva/#controller-repository][instructions]] and running =./FlatBuffersFunc.ql=, the entry
|
||||
=google/flatbuffers= has one [[https://github.com/google/flatbuffers/blob/dbce69c63b0f3cee8f6d9521479fd3b087338314/src/binary_annotator.cpp#L25C21-L25C37][result]]. Others have none.
|
||||
Following the [[https://codeql.github.com/docs/codeql-for-visual-studio-code/running-codeql-queries-at-scale-with-mrva/#controller-repository][instructions]] and running =./FlatBuffersFunc.ql=, the entry
|
||||
=google/flatbuffers= has one [[https://github.com/google/flatbuffers/blob/dbce69c63b0f3cee8f6d9521479fd3b087338314/src/binary_annotator.cpp#L25C21-L25C37][result]]. Others have none.
|
||||
|
||||
** Action logs on Controller Repository
|
||||
The action logs are on the controller repository at
|
||||
https://github.com/hohn/mirva-controller/actions.
|
||||
The action logs are on the controller repository at
|
||||
https://github.com/hohn/mirva-controller/actions.
|
||||
|
||||
The =action>google flatbuffers= log references
|
||||
: github/codeql-variant-analysis-action
|
||||
#+BEGIN_SRC yaml
|
||||
Run actions/checkout@v4
|
||||
with:
|
||||
repository: github/codeql-variant-analysis-action
|
||||
ref: main
|
||||
token: ***
|
||||
ssh-strict: true
|
||||
persist-credentials: true
|
||||
clean: true
|
||||
sparse-checkout-cone-mode: true
|
||||
fetch-depth: 1
|
||||
fetch-tags: false
|
||||
show-progress: true
|
||||
lfs: false
|
||||
submodules: false
|
||||
set-safe-directory: true
|
||||
env:
|
||||
CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT: true
|
||||
#+END_SRC
|
||||
This is https://github.com/github/codeql-variant-analysis-action
|
||||
The =action>google flatbuffers= log references
|
||||
: github/codeql-variant-analysis-action
|
||||
#+BEGIN_SRC yaml
|
||||
Run actions/checkout@v4
|
||||
with:
|
||||
repository: github/codeql-variant-analysis-action
|
||||
ref: main
|
||||
token: ***
|
||||
ssh-strict: true
|
||||
persist-credentials: true
|
||||
clean: true
|
||||
sparse-checkout-cone-mode: true
|
||||
fetch-depth: 1
|
||||
fetch-tags: false
|
||||
show-progress: true
|
||||
lfs: false
|
||||
submodules: false
|
||||
set-safe-directory: true
|
||||
env:
|
||||
CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT: true
|
||||
#+END_SRC
|
||||
This is https://github.com/github/codeql-variant-analysis-action
|
||||
|
||||
The workflow producing the logs:
|
||||
https://github.com/github/codeql-variant-analysis-action/blob/main/variant-analysis-workflow.yml
|
||||
The workflow producing the logs:
|
||||
https://github.com/github/codeql-variant-analysis-action/blob/main/variant-analysis-workflow.yml
|
||||
|
||||
|
||||
|
||||
@@ -76,52 +76,92 @@
|
||||
It's saved in the workspace, but not in the current git repository.
|
||||
|
||||
Here are two snapshots for reference:
|
||||
#+begin_src javascript
|
||||
{
|
||||
"version": 1,
|
||||
"databases": {
|
||||
"variantAnalysis": {
|
||||
"repositoryLists": [
|
||||
{
|
||||
"name": "mirva-list",
|
||||
"repositories": [
|
||||
"google/flatbuffers"
|
||||
]
|
||||
}
|
||||
],
|
||||
"owners": [],
|
||||
"repositories": []
|
||||
}
|
||||
},
|
||||
"selected": {
|
||||
"kind": "variantAnalysisSystemDefinedList",
|
||||
"listName": "top_10"
|
||||
}
|
||||
}
|
||||
#+end_src
|
||||
or
|
||||
#+begin_src javascript
|
||||
{
|
||||
"version": 1,
|
||||
"databases": {
|
||||
"variantAnalysis": {
|
||||
"repositoryLists": [
|
||||
{
|
||||
"name": "mirva-list",
|
||||
"repositories": [
|
||||
"google/flatbuffers"
|
||||
]
|
||||
}
|
||||
],
|
||||
"owners": [],
|
||||
"repositories": []
|
||||
}
|
||||
},
|
||||
"selected": {
|
||||
"kind": "variantAnalysisUserDefinedList",
|
||||
"listName": "mirva-list"
|
||||
}
|
||||
}
|
||||
#+end_src
|
||||
#+begin_src javascript
|
||||
{
|
||||
"version": 1,
|
||||
"databases": {
|
||||
"variantAnalysis": {
|
||||
"repositoryLists": [
|
||||
{
|
||||
"name": "mirva-list",
|
||||
"repositories": [
|
||||
"google/flatbuffers"
|
||||
]
|
||||
}
|
||||
],
|
||||
"owners": [],
|
||||
"repositories": []
|
||||
}
|
||||
},
|
||||
"selected": {
|
||||
"kind": "variantAnalysisSystemDefinedList",
|
||||
"listName": "top_10"
|
||||
}
|
||||
}
|
||||
#+end_src
|
||||
or
|
||||
#+begin_src javascript
|
||||
{
|
||||
"version": 1,
|
||||
"databases": {
|
||||
"variantAnalysis": {
|
||||
"repositoryLists": [
|
||||
{
|
||||
"name": "mirva-list",
|
||||
"repositories": [
|
||||
"google/flatbuffers"
|
||||
]
|
||||
}
|
||||
],
|
||||
"owners": [],
|
||||
"repositories": []
|
||||
}
|
||||
},
|
||||
"selected": {
|
||||
"kind": "variantAnalysisUserDefinedList",
|
||||
"listName": "mirva-list"
|
||||
}
|
||||
}
|
||||
#+end_src
|
||||
|
||||
|
||||
|
||||
** Run MRVA from command line
|
||||
1. Set up the configuration
|
||||
#+BEGIN_SRC sh
|
||||
cd ~/local/gh-mrva
|
||||
|
||||
cat > ~/.config/gh-mrva/config.yml <<eof
|
||||
# The following options are supported
|
||||
# codeql_path: Path to CodeQL distribution (checkout of codeql repo)
|
||||
# controller: NWO of the MRVA controller to use
|
||||
# list_file: Path to the JSON file containing the target repos
|
||||
|
||||
# git checkout codeql-cli/v2.15.5
|
||||
codeql_path: /Users/hohn/local/codeql-lib
|
||||
controller: hohn/mirva-controller
|
||||
list_file: /Users/hohn/local/gh-mrva/databases.json
|
||||
|
||||
eof
|
||||
#+END_SRC
|
||||
|
||||
2. Submit the mrva job
|
||||
#+BEGIN_SRC sh
|
||||
gh mrva submit --help
|
||||
|
||||
gh mrva submit --language cpp --session mirva-session-1 \
|
||||
--list mirva-list \
|
||||
--query /Users/hohn/local/gh-mrva/FlatBuffersFunc.ql
|
||||
#+END_SRC
|
||||
|
||||
3. Check the status and download the sarif files
|
||||
#+BEGIN_SRC sh
|
||||
cd ~/local/gh-mrva
|
||||
|
||||
# Check the status
|
||||
gh mrva status --session mirva-session-1
|
||||
|
||||
# Download the sarif files when finished
|
||||
gh mrva download --session mirva-session-1 \
|
||||
--output-dir mirva-session-1-sarif
|
||||
#+END_SRC
|
||||
|
||||
Reference in New Issue
Block a user