ワークスペースに追加する前にカスタムツールをテストしてデバッグするにはどうすればよいですか

***

##開発環境のセットアップ

カスタムツールをテストする前に、開発環境が適切に構成されていることを確認してください。これは、適切なIDE、デバッガー、SDK、および展開ツールをインストールすることを意味します。

たとえば、Google Workspaceアドオンを開発している場合、Apps Script IDE、node.js、Python環境、およびトンネリング用のngrokなどのツールが便利です。 Visual Studioコードは、リッチなデバッグ機能に広く推奨されているIDEですが、T4テキストテンプレートや単一ファイルゲネレーターなどの特定のカスタムツールをデバッグするにはVisual Studioが必要です。

環境のセットアップには以下が含まれます。
- 必要なランタイムとライブラリ(node.js、python、.netなど)のインストール。
- デバッグ用のIDEの構成(VSコードのLaunch.JSON、またはVisual Studioのlaunch.vs.json)。
- ツールが対話するAPIまたはサービスへのアクセス。
- 環境で未発表または開発者ツールをテストするために必要な権限を取得します。

共同試験のために、プロジェクトの共有や編集者アクセスの付与など、適切なアクセス管理を確認してください。

***

##未発表ツールのローカルテスト

公開する前に、制御されたローカルまたは開発環境でカスタムツールをテストしてください。たとえば、Google Workspaceアドオンは、サポートされているホストアプリケーション(Gmail、Docs、Sheet)内で直接テストするために、未発表のバージョンとしてインストールできます。

ローカルでテストする手順は次のとおりです。
1.アプリスクリプトエディターで、Deploy> Test Deployments機能を使用して、未発表のアドオンをインストールします。
2.ホストアプリケーションを更新して、アドオンが表示されるようにします。
3.プロンプトが表示された場合はアドオンを承認します。
4.動作を検証するためにツールの機能を行使します。

Visual Studioカスタムツールまたはコードジェネレーターの場合、テストとは、カスタムツールを手動で実行するか、IDEで直接デバッグするスタートアッププロジェクトとしてツールプロジェクトを設定することを意味します。

***

IDESのデバッグテクニック

ツール開発中に問題を特定して修正するには、デバッグが重要です。ほとんどの最新のIDEは、ブレークポイント、変数の検査、コールスタック、例外処理をサポートしています。

###ビジュアルスタジオ

Visual Studioで開発されたカスタムツール(シングルファイルゲネレーターやT4テンプレートなど)の場合：
- デバッガーをVisual Studioの実行中のインスタンスに添付します(ツール>添付プロセス> Devenv.exe)。
- または、ビジュアルスタジオ自体をツールのスタートアッププロジェクトとして設定します。
- コード生成ロジック内のブレークポイントを使用して、実行をトレースします。
-launch.vs.jsonを使用してカスタムビルドまたはデバッグ構成を起動して、デバッグセッションを制御します。
- 時計、地元の人などの詳細なデバッガーウィンドウを使用し、スタックを呼び出してランタイム状態を検査します。

T4テキストテンプレートの場合、ソリューションを再構築し、デバッグを開始して、テンプレート処理中に変換ステップと潜在的なエラーを確認します。

Visual Studio Code

VSコードは、launch.jsonファイルを介してデバッグ構成の作成をサポートします。
-Node.js、Python、またはその他の言語の初期構成を生成します。
- 起動またはデバッグを添付するためにカスタム構成を追加します。
- ブレークポイント、可変時計、およびインタラクティブなデバッグコンソールを使用します。
- 言語固有のデバッグエンハンスメントに拡張機能を使用します。
-Github CopilotなどのAI統合を使用すると、デバッグ構成をより速く生成できます。

***

##リモートおよびローカル環境のデバッグ

リモートサーバーまたは環境に展開されているツールの場合、デバッグが必要になる場合があります。
-SSHトンネルをセットアップして、リモートマシンからローカルIDEにデバッグポートを転送します。
- リモートデバッグ構成を使用して、IDEデバッガーをリモートプロセスに添付します。
-NGROKなどのツールを使用して、リアルタイムテストのためにローカルホストエンドポイントに安全なトンネルを作成します。

例：HTTPリクエストをリモートで実行するGoogle Workspaceアドオンのデバッグは、デバッガーポートを有効にし、SSHトンネルの設定し、ローカルIDEデバッガーの接続を行うことで実行できます。

***

##自動テストと継続的統合

信頼性を向上させるには、カスタムツールの自動テストを統合します。
- コアロジックのユニットと統合テストを書き込みます。
- 継続的な統合(CI)システムを使用して、コミットでテストを自動的に実行します。
- ライブユニットテスト機能(Visual Studioのライブユニットテストなど)を使用して、コーディング中にテスト結果を確認します。
- エラー処理、エッジケース、パフォーマンスボトルネックを検証します。

***

##テスト用のコラボレーション

準備ができたら、外部テストのためにカスタムツールを他の人と共有します。
- 未発表のアドオンのエディターアクセスまたは共有インストール手順を提供します。
- フィードバックとバグレポートを体系的に収集します。
- バージョン制御ブランチを使用して、メインコードとは別の変更を管理します。
- 既知の問題と使用手順を明確に文書化します。

***

##一般的なデバッグの課題とソリューション

- 承認の問題：Google Workspaceアドオンなどのツールには、OAUTHスコープとアクセス許可が必要です。承認の欠落または誤った承認は失敗を引き起こします。
- 環境の違い：局所的に展開された環境と展開環境が異なる場合があります。ロギングと一貫した構成を使用します。
- ツール実行エラー：ホストプロセスに接続するか、冗長ロギングを使用してデバッグします。
- ブレークポイントはヒットしません：デバッグシンボルがロードされ、正しいプロセスが添付されていることを確認します。
- パフォーマンスの問題：IDES内に統合されたプロファイリングツールを使用して、ボトルネックを識別します。

***

＃＃ まとめ

ワークスペースに追加する前にカスタムツールのテストとデバッグには、開発環境の準備、ローカルテストの実行とデバッグセッション、IDEデバッグ機能の活用、リモートのデバッグ、テストの自動化、フィードバックのコラボレーションが含まれます。詳細なセットアップとデバッグ手法は、ツールのプラットフォームと言語によって異なりますが、フォローされた構造化された手順により、リリース前に堅牢で信頼できるツールが保証されます。

たとえば、Google Workspaceで：
- 未発表のアドオンを展開およびテストするために、アプリスクリプトIDEを使用します。
-NgrokとSSHを使用して、リモートHTTPアドオンをデバッグします。
- ブレークポイントと検査コードのために、Visual StudioコードまたはVisual Studioのデバッグツールを使用します。

Visual Studioカスタムツールの場合：
- デバッガーをVisual Studioプロセスに添付します。
- 起動構成ファイルとカスタムビルド/デバッグタスクを使用します。
- デバッグセッション内で再構築して、T4テンプレートをデバッグします。

これらのベストプラクティスとワークフローを順守することは、カスタムツールがメインワークスペースの一部になる前に、問題を効果的に特定および修正するのに役立ちます。

***