Visual Studio Code上でのAWS SAM CLI ローカルデバッグ方法メモ

• Visual Studio CodeでSAM CLIのデバッグ実行を行う方法についてメモする。

事前準備

• VS code 拡張機能のAWS Toolkitをインストールする
• テスト用SAM　CLIアプリを用意する。
  • こちらで作成したもの を流用する。
    • 事前にMySQL(Docker)を起動しておく

デバッグ設定

• VS Codeのコマンドパレットを開く(Windowsの場合、Ctrl+Shift+P)

• 「AWS:Edit SAM Debug Configuration」を選択する（SAMデバッグ設定画面が表示される）
  

• 下記項目を設定する

  • Configuration

    • Template Path : {YOUR_PROJECT_PATH}/template.yaml
    • Resource (Logical Id) : HelloWorldFunction
    • Runtime : 各自の環境にあわせる(筆者はPython3.9)

  • Additional Fields

    • Environment Variables(環境変数):下記JSONを直接指定する※こちらで作成したMySQLコンテナ接続先

      {
              "MYSQL_HOST":"db",
              "MYSQL_DATABASE":"test_db",
              "MYSQL_PORT":3308,
              "MYSQL_USER":"mysqluser",
              "MYSQL_PASSWORD":"mysqlpass"
      }
      

    • Docker Network : docker.internal(MySQLコンテナに接続するため)

• 「Save」を押下する（launch.json）として保存される

実行

• コード中の任意の箇所にブレークポイントを設定する

• 「Edit SAM Debug Configuration」コンソールの「Invoke」を押下する

  • スクリプトが実行され、ブレークポイント箇所でストップする

参考情報

• Configuration options for debugging serverless applications