Skip to content

Fixed unwanted execution and wrong database path for p10 analysis with CodeQL #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
federicozappone wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Fixed unwanted execution and wrong database path for p10 analysis with CodeQL #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
69e60d5
fixed unwanted execution and wrong database path for p10 analysis
federicozappone Jan 17, 2023
4d8ded1
added autosar analysis using codeql opensource coding standards
federicozappone Jan 21, 2023
5bad374
updated detailed configurations and templates for codeql
federicozappone Jan 21, 2023
990ae1e
added post processing and filtering for autosar_raw files
federicozappone Jan 21, 2023
d3652b1
Merge branch 'master' of https://github.com/federicozappone/scrub
federicozappone Jan 21, 2023
e0af1f6
added codeql cert checks, updated docs and template configs
federicozappone Jan 21, 2023
c1021eb
small fixes
federicozappone Jan 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/configuration-inputs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,13 @@ Each table below represents a portion of the complete `scrub.cfg` file.
| CODEQL_WARNINGS | True/False | Yes | Should CodeQL analysis be performed? | False |
| CODEQL_PATH | String | Optional | Absolute path to the directory of the CodeQL installation | Check `PATH` |
| CODEQL_QUERY_PATH | String | Yes | Absolute path to the CodeQL query files | N/A |
| CODEQL_CODING_STANDARDS_PATH | String | Yes | Absolute path to the CodeQL coding standard files | N/A |
| CODEQL_BUILD_DIR | String | Optional | Relative path (to `SOURCE_DIR`) to the build directory | `SOURCE_DIR` |
| CODEQL_BUILD_CMD | String | Optional | Command to build the source code for CodeQL analysis | N/A |
| CODEQL_CLEAN_CMD | String | Optional | Command to clean the source code for CodeQL analysis | N/A |
| CODEQL_BASELINE_ANALYSIS | True/False | Yes | Should baseline CodeQL analysis be performed? | True |
| CODEQL_P10_ANALYSIS | True/False | Yes | Should CodeQL P10 analysis be performed? | True |
| CODEQL_AUTOSAR_ANALYSIS | True/False | Yes | Should CodeQL AUTOSAR analysis be performed? | True |
| CODEQL_DATABASECREATE_FLAGS | String | Optional | Flags to be passed into 'codeql database create' command | '' |
| CODEQL_DATEBASEANALYZE_FLAGS | String | Optional | Flags to be passed into 'codeql database analyze' command | '' |

Expand Down Expand Up @@ -264,13 +266,15 @@ The configuration file provided below is a sample configuration file for a C pro
#
[CodeQL Variables]
CODEQL_WARNINGS: True
CODEQL_PATH: /opt/local/codeql/codeql-cli
CODEQL_QUERY_PATH: /opt/local/codeql/queries
CODEQL_BUILD_DIR: src
CODEQL_PATH: ~/codeql-home/codeql-cli
CODEQL_QUERY_PATH: ~/codeql-home/codeql-repo
CODEQL_CODING_STANDARDS_PATH: ~/codeql-home/codeql-coding-standards
CODEQL_BUILD_DIR: build
CODEQL_BUILD_CMD: make all
CODEQL_CLEAN_CMD: make clean
CODEQL_BASELINE_ANALYSIS: True
CODEQL_P10_ANALYSIS: False
CODEQL_P10_ANALYSIS: True
CODEQL_AUTOSAR_ANALYSIS: True
CODEQL_DATABASECREATE_FLAGS:
CODEQL_DATABASEANALYZE_FLAGS:

Expand Down
6 changes: 6 additions & 0 deletions scrub/scrub.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,23 +76,29 @@ PYLINT_FLAGS:
# CODEQL_WARNINGS Yes True/False
# CODEQL_PATH No String
# CODEQL_QUERY_PATH Yes String
# CODEQL_CODING_STANDARDS_PATH Yes String
# CODEQL_BUILD_DIR No String
# CODEQL_BUILD_CMD Yes String
# CODEQL_CLEAN_CMD Yes String
# CODEQL_BASELINE_ANALYSIS Yes True/False
# CODEQL_P10_ANALYSIS Yes True/False
# CODEQL_AUTOSAR_ANALYSIS Yes True/False
# CODEQL_CERT_ANALYSIS Yes True/False
# CODEQL_DATABASECREATE_FLAGS No String
# CODEQL_DATABASEANALYZE_FLAGS No String
#
[CodeQL Variables]
CODEQL_WARNINGS: False
CODEQL_PATH:
CODEQL_QUERY_PATH:
CODEQL_CODING_STANDARDS_PATH:
CODEQL_BUILD_DIR:
CODEQL_BUILD_CMD:
CODEQL_CLEAN_CMD:
CODEQL_BASELINE_ANALYSIS: True
CODEQL_P10_ANALYSIS: True
CODEQL_AUTOSAR_ANALYSIS: True
CODEQL_CERT_ANALYSIS: True
CODEQL_DATABASECREATE_FLAGS:
CODEQL_DATABASEANALYZE_FLAGS:

Expand Down
22 changes: 19 additions & 3 deletions scrub/tools/templates/codeql.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,27 @@ do
fi

# Perform P10 analysis, if desired
if [[ ${{CODEQL_P10_ANALYSIS}} && $language == "cpp" ]]; then
${{CODEQL_PATH}}/codeql database analyze --format=sarif-latest --output=${{TOOL_ANALYSIS_DIR}}/codeql_p10_raw.sarif ${{TOOL_ANALYSIS_DIR}}/codeql-database "${{CODEQL_QUERY_PATH}}/cpp/ql/src/Power of 10" "${{CODEQL_QUERY_PATH}}/cpp/ql/src/AlertSuppression.ql"
if [ ${{CODEQL_P10_ANALYSIS}} == true ] && [ $language == "cpp" ]; then
${{CODEQL_PATH}}/codeql database analyze --format=sarif-latest --output=${{TOOL_ANALYSIS_DIR}}/codeql_p10_raw.sarif $database "${{CODEQL_QUERY_PATH}}/cpp/ql/src/Power of 10" "$suppression_query"

# Parse the SARIF P10 results output file into SCRUB format
python3 -m scrub.tools.parsers.translate_results ${{TOOL_ANALYSIS_DIR}}/codeql_p10_raw.sarif ${{RAW_RESULTS_DIR}}/codeql_p10_raw.scrub ${{SOURCE_DIR}} scrub
fi

done
# Perform AUTOSAR analysis, if desired
if [ ${{CODEQL_AUTOSAR_ANALYSIS}} == true ] && [ $language == "cpp" ]; then
${{CODEQL_PATH}}/codeql database analyze --format=sarif-latest --output=${{TOOL_ANALYSIS_DIR}}/codeql_autosar_raw.sarif $database "${{CODEQL_CODING_STANDARDS_PATH}}/cpp/autosar/src/codeql-suites/autosar-default.qls" "$suppression_query"

# Parse the SARIF AUTOSAR results output file into SCRUB format
python3 -m scrub.tools.parsers.translate_results ${{TOOL_ANALYSIS_DIR}}/codeql_autosar_raw.sarif ${{RAW_RESULTS_DIR}}/codeql_autosar_raw.scrub ${{SOURCE_DIR}} scrub
fi

# Perform CERT analysis, if desired
if [ ${{CODEQL_CERT_ANALYSIS}} == true ] && [ $language == "cpp" ]; then
${{CODEQL_PATH}}/codeql database analyze --format=sarif-latest --output=${{TOOL_ANALYSIS_DIR}}/codeql_cert_raw.sarif $database "${{CODEQL_CODING_STANDARDS_PATH}}/cpp/cert/src/codeql-suites/cert-default.qls" "$suppression_query"

# Parse the SARIF cert results output file into SCRUB format
python3 -m scrub.tools.parsers.translate_results ${{TOOL_ANALYSIS_DIR}}/codeql_cert_raw.sarif ${{RAW_RESULTS_DIR}}/codeql_cert_raw.scrub ${{SOURCE_DIR}} scrub
fi

done
70 changes: 70 additions & 0 deletions scrub/utils/filtering/do_filtering.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,18 @@ def filter_scrub_results(scrub_conf_data):
# Sort the files into groups
raw_compiler_files = []
raw_p10_files = []
raw_autosar_files = []
raw_cert_files = []
raw_generic_files = []
for results_file in results_files:
if 'compiler_raw' in results_file.stem:
raw_compiler_files.append(results_file)
elif 'p10_raw' in results_file.stem:
raw_p10_files.append(results_file)
elif 'autosar_raw' in results_file.stem:
raw_autosar_files.append(results_file)
elif 'cert_raw' in results_file.stem:
raw_cert_files.append(results_file)
else:
raw_generic_files.append(results_file)

Expand Down Expand Up @@ -113,6 +119,70 @@ def filter_scrub_results(scrub_conf_data):
# Print the exception traceback
logging.debug(traceback.format_exc())

# Filter AUTOSAR results
if raw_autosar_files:
try:
# Set the output file path
filtered_autosar_results = scrub_conf_data.get('scrub_analysis_dir').joinpath('autosar.scrub')

# Parse all of the input files
autosar_results = []
valid_warning_types = []
for results_file in raw_autosar_files:
# Append the results file
autosar_results = (autosar_results + translate_results.parse_scrub(results_file,
scrub_conf_data.get('source_dir')))

# Append to the valid warning types
valid_warning_types.append(results_file.stem.split('_')[0])

filter_results.filter_results(autosar_results, filtered_autosar_results,
scrub_conf_data.get('filtering_output_file'),
scrub_conf_data.get('query_filters'),
scrub_conf_data.get('source_dir'),
scrub_conf_data.get('enable_micro_filter'),
scrub_conf_data.get('enable_ext_warnings'),
valid_warning_types)

except: # lgtm [py/catch-base-exception]
# Print a status message
logging.warning("Could not generate output file %s", filtered_autosar_results)

# Print the exception traceback
logging.debug(traceback.format_exc())

# Filter CERT results
if raw_cert_files:
try:
# Set the output file path
filtered_cert_results = scrub_conf_data.get('scrub_analysis_dir').joinpath('cert.scrub')

# Parse all of the input files
cert_results = []
valid_warning_types = []
for results_file in raw_cert_files:
# Append the results file
cert_results = (cert_results + translate_results.parse_scrub(results_file,
scrub_conf_data.get('source_dir')))

# Append to the valid warning types
valid_warning_types.append(results_file.stem.split('_')[0])

filter_results.filter_results(cert_results, filtered_cert_results,
scrub_conf_data.get('filtering_output_file'),
scrub_conf_data.get('query_filters'),
scrub_conf_data.get('source_dir'),
scrub_conf_data.get('enable_micro_filter'),
scrub_conf_data.get('enable_ext_warnings'),
valid_warning_types)

except: # lgtm [py/catch-base-exception]
# Print a status message
logging.warning("Could not generate output file %s", filtered_cert_results)

# Print the exception traceback
logging.debug(traceback.format_exc())

# Filter everything else
if raw_generic_files:
for raw_generic_file in raw_generic_files:
Expand Down
8 changes: 7 additions & 1 deletion scrub/utils/scrub_defaults.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,23 +77,29 @@ PYLINT_FLAGS:
# CODEQL_WARNINGS Yes True/False
# CODEQL_PATH No String
# CODEQL_QUERY_PATH Yes String
# CODEQL_CODING_STANDARDS_PATH Yes String
# CODEQL_BUILD_DIR No String
# CODEQL_BUILD_CMD Yes String
# CODEQL_CLEAN_CMD Yes String
# CODEQL_BASELINE_ANALYSIS Yes True/False
# CODEQL_P10_ANALYSIS Yes True/False
# CODEQL_AUTOSAR_ANALYSIS Yes True/False
# CODEQL_CERT_ANALYSIS Yes True/False
# CODEQL_DATABASECREATE_FLAGS No String
# CODEQL_DATABASEANALYZE_FLAGS No String
#
[CodeQL Variables]
CODEQL_WARNINGS: False
CODEQL_PATH:
CODEQL_QUERY_PATH:
CODEQL_CODING_STANDARDS_PATH:
CODEQL_BUILD_DIR:
CODEQL_BUILD_CMD:
CODEQL_CLEAN_CMD:
CODEQL_BASELINE_ANALYSIS: True
CODEQL_P10_ANALYSIS: True
CODEQL_AUTOSAR_ANALYSIS: True
CODEQL_CERT_ANALYSIS: True
CODEQL_DATABASECREATE_FLAGS:
CODEQL_DATABASEANALYZE_FLAGS:

Expand Down Expand Up @@ -231,4 +237,4 @@ ENABLE_EXT_WARNINGS: False
ENABLE_MICRO_FILTER: True
CUSTOM_FILTER_CMD:
ANALYSIS_FILTERS:
QUERY_FILTERS:
QUERY_FILTERS: