CodeQL documentation

Basic query for C# code

Learn to write and run a simple CodeQL query using LGTM.

About the query

The query we’re going to run performs a basic search of the code for if statements that are redundant, in the sense that they have an empty then branch. For example, code such as:

if (error) { }

Running the query

  1. In the main search box on LGTM.com, search for the project you want to query. For tips, see Searching.

  2. Click the project in the search results.

  3. Click Query this project.

    This opens the query console. (For information about using this, see Using the query console.)

    Note

    Alternatively, you can go straight to the query console by clicking Query console (at the top of any page), selecting C# from the Language drop-down list, then choosing one or more projects to query from those displayed in the Project drop-down list.

  4. Copy the following query into the text box in the query console:

    import csharp
    
    from IfStmt ifstmt, BlockStmt block
    where ifstmt.getThen() = block and
      block.isEmpty()
    select ifstmt, "This 'if' statement is redundant."
    

    LGTM checks whether your query compiles and, if all is well, the Run button changes to green to indicate that you can go ahead and run the query.

  5. Click Run.

    The name of the project you are querying, and the ID of the most recently analyzed commit to the project, are listed below the query box. To the right of this is an icon that indicates the progress of the query operation:

    ../../_images/query-progress.png

    Note

    Your query is always run against the most recently analyzed commit to the selected project.

    The query will take a few moments to return results. When the query completes, the results are displayed below the project name. The query results are listed in two columns, corresponding to the two expressions in the select clause of the query. The first column corresponds to the expression ifstmt and is linked to the location in the source code of the project where ifstmt occurs. The second column is the alert message.

    Example query results

    Note

    An ellipsis (…) at the bottom of the table indicates that the entire list is not displayed—click it to show more results.

  6. If any matching code is found, click a link in the ifstmt column to view the if statement in the code viewer.

    The matching if statement is highlighted with a yellow background in the code viewer. If any code in the file also matches a query from the standard query library for that language, you will see a red alert message at the appropriate point within the code.

About the query structure

After the initial import statement, this simple query comprises three parts that serve similar purposes to the FROM, WHERE, and SELECT parts of an SQL query.

Query part Purpose Details
import csharp Imports the standard CodeQL libraries for C#. Every query begins with one or more import statements.
from IfStmt ifstmt, BlockStmt block Defines the variables for the query. Declarations are of the form: <type> <variable name>

We use:

  • an IfStmt variable for if statements
  • a BlockStmt variable for the then block
where ifstmt.getThen() = block and block.isEmpty() Defines a condition on the variables.

ifstmt.getThen() = block relates the two variables. The block must be the then branch of the if statement.

block.isEmpty() states that the block must be empty (that is, it contains no statements).

select ifstmt, "This 'if' statement is redundant."

Defines what to report for each match.

select statements for queries that are used to find instances of poor coding practice are always in the form: select <program element>, "<alert message>"

Reports the resulting if statement with a string that explains the problem.

Extend the query

Query writing is an inherently iterative process. You write a simple query and then, when you run it, you discover examples that you had not previously considered, or opportunities for improvement.

Remove false positive results

Browsing the results of our basic query shows that it could be improved. Among the results you are likely to find examples of if statements with an else branch, where an empty then branch does serve a purpose. For example:

if (...)
{
    ...
}
else if (option == "-verbose")
{
    // nothing to do - handled earlier
}
else
{
    error("unrecognized option");
}

In this case, identifying the if statement with the empty then branch as redundant is a false positive. One solution to this is to modify the query to ignore empty then branches if the if statement has an else branch.

To exclude if statements that have an else branch:

  1. Add the following to the where clause:

    and not exists(ifstmt.getElse())
    

    The where clause is now:

    where ifstmt.getThen() = block and
      block.isEmpty() and
      not exists(ifstmt.getElse())
    
  2. Click Run.

    There are now fewer results because if statements with an else branch are no longer included.

See this in the query console