(参考)ローカルでのSemgrep実行

GitHub Actionsで実行する前に、ローカルでもSemgrepを実行して事前に結果を確認することもできます。Push前に手元で検知件数や残っている問題を確認でき、修正サイクルを短縮できます。

ワークフローと同じ Semgrep の公式 Docker イメージを使えば、ローカルにPythonパッケージを追加インストールする必要がなく、ワークフローと完全に同じ環境・バージョンで実行できます。

以下のコマンドで、Docker がインストールされていることを確認します。

docker --version

以下のように Docker のバージョンが表示されれば、インストールは確認できています。

Docker version 27.x.x, build xxxxxxx

バージョンが表示されない場合は、Docker Desktopのインストール を先に実施してください。

インストールが確認できたら、vulnerable_app.py があるフォルダで以下を実行します。

Macの場合:

docker run --rm -v "$(pwd):/src" semgrep/semgrep semgrep scan --config auto /src

Windowsの場合(PowerShell):

docker run --rm -v "${PWD}:/src" semgrep/semgrep semgrep scan --config auto /src

オプションを解説します。

--rm

実行後にコンテナを自動削除し、ローカル環境に不要ファイルを残さないようにします。

Macの場合:

-v "$(pwd):/src"

Windowsの場合(PowerShell):

-v "${PWD}:/src"

カレントディレクトリ(vulnerable_app.py が置かれているフォルダ)をコンテナ内の /src にマウントし、コンテナ内のSemgrepからローカルファイルを参照できるようにします。

semgrep scan --config auto /src

ワークフローと同じ semgrep scan コマンドで /src 配下をスキャンします。--config auto で対象言語のルールセットを自動適用するのも同じです。

ワークフローと同じ7件の検出が表示されれば、ローカル実行でもまったく同じ結果が得られていることが確認できます。あとは検出を1件ずつ修正しながら同じコマンドを再実行すれば、プルリクエストに上げる前に手元で「あと何件残っているか」をリアルタイムに把握できます。「ローカルである程度きれいにしてからプルリクエストを出し、最終確認はワークフローに任せる」という流れにすると、ワークフロー のフィードバックを毎回待つストレスがなくなります。