1
0
mirror of synced 2025-12-19 18:10:59 -05:00
Files
docs/content/code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected.md
Ben Ahmady 5a6057c46a Fix links
2023-08-05 13:55:26 +00:00

3.5 KiB

title, shortTitle, intro, allowTitleToDifferFromFilename, product, versions
title shortTitle intro allowTitleToDifferFromFilename product versions
CodeQL scanned fewer lines than expected Fewer lines scanned than expected If {% data variables.product.prodname_codeql %} analyzed less code than than you expected, you may need to use a custom build command. true {% data reusables.gated-features.code-scanning %}
fpt ghes ghae ghec
* * * *

{% data reusables.code-scanning.beta %}

About analysis of compiled languages

For compiled languages like C/C++, C#, Go, and Java, {% data variables.product.prodname_codeql %} only scans files that are built during the analysis. Therefore the number of lines of code scanned will be lower than expected if some of the source code isn't compiled correctly. This can happen for several reasons:

  1. The {% data variables.product.prodname_codeql %} autobuild feature uses heuristics to build the code in a repository. However, sometimes this approach results in an incomplete analysis of a repository. For example, when multiple build.sh commands exist in a single repository, the analysis may not be complete since the autobuild step will only execute one of the commands, and therefore some source files may not be compiled.

  2. Some compilers do not work with {% data variables.product.prodname_codeql %} and can cause issues while analyzing the code. For example, most vendor-specific C compilers will not be recognized by {% data variables.product.prodname_codeql %}. C code will need to be compiled with a recognized compiler (for example GCC, Clang or MSVC) in order to be analyzed.

If your {% data variables.product.prodname_codeql %} analysis scans fewer lines of code than expected, you can try replacing the autobuild step, or inspecting the copy of the source files in the {% data variables.product.prodname_codeql %} database.

Replace the autobuild step

Replace the autobuild step with the same build commands you would use in production. This makes sure that {% data variables.product.prodname_codeql %} knows exactly how to compile all of the source files you want to scan. For more information, see "AUTOTITLE."

Inspect the copy of the source files in the {% data variables.product.prodname_codeql %} database

You may be able to understand why some source files haven't been analyzed by inspecting the copy of the source code included with the {% data variables.product.prodname_codeql %} database. To obtain the database from your Actions workflow, modify the init step of your {% data variables.product.prodname_codeql %} workflow file and set debug: true.

- name: Initialize CodeQL
  uses: {% data reusables.actions.action-codeql-action-init %}
  with:
    debug: true

This uploads the database as an actions artifact that you can download to your local machine. For more information, see "AUTOTITLE."

The artifact will contain an archived copy of the source files scanned by {% data variables.product.prodname_codeql %} called src.zip. If you compare the source code files in the repository and the files in src.zip, you can see which types of file are missing. Once you know what types of file are not being analyzed, it is easier to understand how you may need to change the workflow for {% data variables.product.prodname_codeql %} analysis.