Skip to content

LGTM deprecation: Update basic queries to use VS Code #11468

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

Merged
felicitymay merged 11 commits into from
Dec 2, 2022
Merged

LGTM deprecation: Update basic queries to use VS Code #11468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
97db2c9
First draft update basic query to use VS Code
felicitymay Nov 24, 2022
229c3e6
Update for James' review comments
felicitymay Nov 28, 2022
1dc6640
Remove superfluous content
felicitymay Nov 28, 2022
c66569b
Generalize cpp changes and apply to csharp
felicitymay Nov 29, 2022
0def31a
Update Go article
felicitymay Nov 29, 2022
1142b77
Update articles for other languages
felicitymay Nov 29, 2022
0d7b27d
A few fixes
felicitymay Nov 29, 2022
6dee013
Merge branch 'rc/3.8' into felicitymay-8441-basic-query-2
felicitymay Nov 30, 2022
38b8cf4
Update docs/codeql/codeql-language-guides/basic-query-for-java-code.rst
felicitymay Dec 1, 2022
42a438c
Apply suggestions from code review
felicitymay Dec 2, 2022
7aca35d
Apply suggestions from code review
felicitymay Dec 2, 2022
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
75 changes: 29 additions & 46 deletions docs/codeql/codeql-language-guides/basic-query-for-cpp-code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
Basic query for C and C++ code
==============================

Learn to write and run a simple CodeQL query using LGTM.
Learn to write and run a simple CodeQL query using Visual Studio Code with the CodeQL extension.

.. include:: ../reusables/vs-code-basic-instructions/setup-to-run-queries.rst

About the query
---------------
Expand All @@ -14,62 +16,33 @@ The query we're going to run performs a basic search of the code for ``if`` stat

if (error) { }

Running the query
-----------------

#. In the main search box on LGTM.com, search for the project you want to query. For tips, see `Searching <https://lgtm.com/help/lgtm/searching>`__.

#. Click the project in the search results.

#. Click **Query this project**.

This opens the query console. (For information about using this, see `Using the query console <https://lgtm.com/help/lgtm/using-query-console>`__.)

.. pull-quote::
.. include:: ../reusables/vs-code-basic-instructions/find-database.rst

Note
Running a quick query
---------------------

Alternatively, you can go straight to the query console by clicking **Query console** (at the top of any page), selecting **C/C++** from the **Language** drop-down list, then choosing one or more projects to query from those displayed in the **Project** drop-down list.
.. include:: ../reusables/vs-code-basic-instructions/run-quick-query-1.rst

#. Copy the following query into the text box in the query console:
#. In the quick query tab, delete ``select ""`` and paste the following query beneath the import statement ``import cpp``.

.. code-block:: ql

import cpp

from IfStmt ifstmt, BlockStmt block
where ifstmt.getThen() = block and
block.getNumStmt() = 0
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.

#. 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:

.. image:: ../images/query-progress.png
:align: center

.. pull-quote::

Note
.. include:: ../reusables/vs-code-basic-instructions/run-quick-query-2.rst

Your query is always run against the most recently analyzed commit to the selected project.
.. image:: ../images/codeql-for-visual-studio-code/basic-cpp-query-results-1.png
:align: center

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.
If any matching code is found, click a link in the ``ifstmt`` column to open the file and highlight the matching ``if`` statement.

➤ `Example query results <https://lgtm.com/query/4242591143131494898/>`__
.. image:: ../images/codeql-for-visual-studio-code/basic-cpp-query-results-2.png
:align: center

.. pull-quote::

Note

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

#. 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.
.. include:: ../reusables/vs-code-basic-instructions/note-store-quick-query.rst

About the query structure
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -120,7 +93,7 @@ In this case, identifying the ``if`` statement with the empty ``then`` branch as

To exclude ``if`` statements that have an ``else`` branch:

#. Extend the ``where`` clause to include the following extra condition:
#. Edit your query and extend the ``where`` clause to include the following extra condition:

.. code-block:: ql

Expand All @@ -134,14 +107,24 @@ To exclude ``if`` statements that have an ``else`` branch:
block.getNumStmt() = 0 and
not ifstmt.hasElse()

#. Click **Run**.
#. Re-run the query.

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

➤ `See this in the query console <https://lgtm.com/query/1899933116489579248/>`__

Further reading
---------------

.. include:: ../reusables/cpp-further-reading.rst
.. include:: ../reusables/codeql-ref-tools-further-reading.rst

.. Article-specific substitutions for the reusables used in docs/codeql/reusables/vs-code-basic-instructions

.. |language-text| replace:: C/C++

.. |language-code| replace:: ``cpp``

.. |example-url| replace:: https://github.com/protocolbuffers/protobuf

.. |image-quick-query| image:: ../images/codeql-for-visual-studio-code/quick-query-tab-cpp.png

.. |result-col-1| replace:: The first column corresponds to the expression ``ifstmt`` and is linked to the location in the source code of the project where ``ifstmt`` occurs.
72 changes: 27 additions & 45 deletions docs/codeql/codeql-language-guides/basic-query-for-csharp-code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
Basic query for C# code
=======================

Learn to write and run a simple CodeQL query using LGTM.
Learn to write and run a simple CodeQL query using Visual Studio Code with the CodeQL extension.

.. include:: ../reusables/vs-code-basic-instructions/setup-to-run-queries.rst

About the query
---------------
Expand All @@ -14,62 +16,33 @@ The query we're going to run performs a basic search of the code for ``if`` stat

if (error) { }

Running the query
-----------------

#. In the main search box on LGTM.com, search for the project you want to query. For tips, see `Searching <https://lgtm.com/help/lgtm/searching>`__.

#. Click the project in the search results.

#. Click **Query this project**.

This opens the query console. (For information about using this, see `Using the query console <https://lgtm.com/help/lgtm/using-query-console>`__.)

.. pull-quote::
.. include:: ../reusables/vs-code-basic-instructions/find-database.rst

Note
Running a quick query
---------------------

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.
.. include:: ../reusables/vs-code-basic-instructions/run-quick-query-1.rst

#. Copy the following query into the text box in the query console:
#. In the quick query tab, delete ``select ""`` and paste the following query beneath the import statement ``import csharp``.

.. code-block:: ql

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.

#. 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:

.. image:: ../images/query-progress.png
:align: center

.. pull-quote::
.. include:: ../reusables/vs-code-basic-instructions/run-quick-query-2.rst

Note
.. image:: ../images/codeql-for-visual-studio-code/basic-csharp-query-results-1.png
:align: center

Your query is always run against the most recently analyzed commit to the selected project.
If any matching code is found, click a link in the ``ifstmt`` column to open the file and highlight the matching ``if`` statement.

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.
.. image:: ../images/codeql-for-visual-studio-code/basic-csharp-query-results-2.png
:align: center

➤ `Example query results <https://lgtm.com/query/1214010107827821393/>`__

.. pull-quote::

Note

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

#. 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.
.. include:: ../reusables/vs-code-basic-instructions/note-store-quick-query.rst

About the query structure
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -139,14 +112,23 @@ To exclude ``if`` statements that have an ``else`` branch:
block.isEmpty() and
not exists(ifstmt.getElse())

#. Click **Run**.
#. Re-run the query.

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

➤ `See this in the query console <https://lgtm.com/query/6233102733683510530/>`__

Further reading
---------------

.. include:: ../reusables/csharp-further-reading.rst
.. include:: ../reusables/codeql-ref-tools-further-reading.rst

.. Article-specific substitutions for the reusables used in docs/codeql/reusables/vs-code-basic-instructions
.. |language-text| replace:: C#

.. |language-code| replace:: ``csharp``

.. |example-url| replace:: https://github.com/PowerShell/PowerShell

.. |image-quick-query| image:: ../images/codeql-for-visual-studio-code/quick-query-tab-csharp.png

.. |result-col-1| replace:: The first column corresponds to the expression ``ifstmt`` and is linked to the location in the source code of the project where ``ifstmt`` occurs.
73 changes: 28 additions & 45 deletions docs/codeql/codeql-language-guides/basic-query-for-go-code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
Basic query for Go code
=======================

Learn to write and run a simple CodeQL query using LGTM.
Learn to write and run a simple CodeQL query using Visual Studio Code with the CodeQL extension.

.. include:: ../reusables/vs-code-basic-instructions/setup-to-run-queries.rst

About the query
---------------
Expand All @@ -22,64 +24,35 @@ This is problematic because the receiver argument is passed by value, not by ref

For further information on using methods on values or pointers in Go, see the `Go FAQ <https://golang.org/doc/faq#methods_on_values_or_pointers>`__.

Running the query
-----------------

#. In the main search box on LGTM.com, search for the project you want to query. For tips, see `Searching <https://lgtm.com/help/lgtm/searching>`__.

#. Click the project in the search results.

#. Click **Query this project**.

This opens the query console. (For information about using this, see `Using the query console <https://lgtm.com/help/lgtm/using-query-console>`__.)

.. pull-quote::
.. include:: ../reusables/vs-code-basic-instructions/find-database.rst

Note
Running a quick query
---------------------

Alternatively, you can go straight to the query console by clicking **Query console** (at the top of any page), selecting **Go** from the **Language** drop-down list, then choosing one or more projects to query from those displayed in the **Project** drop-down list.
.. include:: ../reusables/vs-code-basic-instructions/run-quick-query-1.rst

#. Copy the following query into the text box in the query console:
#. In the quick query tab, delete ``select ""`` and paste the following query beneath the import statement ``import go``.

.. code-block:: ql

import go

from Method m, Variable recv, Write w, Field f
where
recv = m.getReceiver() and
w.writesField(recv.getARead(), f, _) and
not recv.getType() instanceof PointerType
select w, "This update to " + f + " has no effect, because " + recv + " is not a pointer."

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.

#. 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:

.. image:: ../images/query-progress.png
:align: center

.. pull-quote::

Note
.. include:: ../reusables/vs-code-basic-instructions/run-quick-query-2.rst

Your query is always run against the most recently analyzed commit to the selected project.
.. image:: ../images/codeql-for-visual-studio-code/basic-go-query-results-1.png
:align: center

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 ``w``, which is the location in the source code where the receiver ``recv`` is modified. The second column is the alert message.
If any matching code is found, click a link in the ``w`` column to open the file and highlight the matching location.

➤ `Example query results <https://lgtm.com/query/6221190009056970603/>`__
.. image:: ../images/codeql-for-visual-studio-code/basic-go-query-results-2.png
:align: center

.. pull-quote::

Note

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

#. If any matching code is found, click a link in the ``w`` column to view it in the code viewer.

The matching ``w`` 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.
.. include:: ../reusables/vs-code-basic-instructions/note-store-quick-query.rst

About the query structure
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -140,14 +113,24 @@ To exclude these values:
not recv.getType() instanceof PointerType and
not exists(ReturnStmt ret | ret.getExpr() = recv.getARead().asExpr())

#. Click **Run**.
#. Re-run the query.

There are now fewer results because value methods that return their receiver variable are no longer reported.

➤ `See this in the query console <https://lgtm.com/query/9110448975027954322/>`__

Further reading
---------------

.. include:: ../reusables/go-further-reading.rst
.. include:: ../reusables/codeql-ref-tools-further-reading.rst

.. Article-specific substitutions for the reusables used in docs/codeql/reusables/vs-code-basic-instructions

.. |language-text| replace:: Go

.. |language-code| replace:: ``go``

.. |example-url| replace:: https://github.com/go-gorm/gorm

.. |image-quick-query| image:: ../images/codeql-for-visual-studio-code/quick-query-tab-go.png

.. |result-col-1| replace:: The first column corresponds to ``w``, which is the location in the source code where the receiver ``recv`` is modified.
Loading