チーム内でのクックブック共有

チーム内でのクックブック共有

誰か一人がコード品質や生産性を高めるためにSenseiレシピを作成した場合、クックブックを共有することでチーム全員がその恩恵を受けることができます。

Senseiでは、クックブックを共有するためのいくつかの仕組みを提供しています。

• プロジェクトのバージョン管理下にクックブックを保存
• 共有フォルダにクックブックを保存
• GitHubにクックブックを保存
• HTTP(s)経由でZIPファイルを共有

クックブックを共有することで、Senseiはチームのナレッジ共有を促進します。このコラボレーションにより、コミュニケーションが円滑になり、合意されたコード品質へのアプローチを定着させることができます。

例えば、クックブックを共有することで以下のようなメリットがあります。

• チームメンバー同士で役立つレシピを共有できる。
• チームリーダーが合意済みのコーディング規約をコード化し、ジュニアスタッフが一般的な違反を特定して、合意された修正案をすぐに適用できるよう支援する。
• チーム間の連携を促進する（例：AppSecチームがコード内の問題を指摘するレシピを作成し、開発チームがその修正案を作成するなど）。

次のセクションでは、各共有メカニズムの実装方法について説明します。

プロジェクトのバージョン管理下にクックブックを保存

クックブックファイルを作成する際、デフォルトのオプションとしてプロジェクトの「.sensei」フォルダが選択されます。

• `project://.sensei`

すべてのクックブックとレシピは、プロジェクト内の「.sensei」フォルダに保存されます。

最も簡単な共有方法は、プロジェクトの「.sensei」フォルダをバージョン管理に追加することです。

これにより、「.sensei」フォルダはプロジェクトに関連する他の共有コード成果物と同様に管理できるようになります。クックブックはYAML形式で保存されるため、コミットやレビューのプロセスで簡単にマージが可能です。

これは、公開されている「sensei-blog-examples」プロジェクトで採用されている手法です。

• https://github.com/SecureCodeWarrior/sensei-blog-examples

「.sensei」フォルダにはすべてのレシピを含むクックブックが格納されており、リポジトリをクローンしたすべてのユーザーが利用可能です。

クックブックを任意のフォルダに保存する

チームで共有の場所に保存されたクックブックを利用することも可能です。

書き込み権限が共有されたフォルダにクックブックを保存すれば、チーム全員でレシピを更新し、各自が作業中のプロジェクトにインポートできるようになります。

場所にはディレクトリパスを設定します。

GitHubにレシピを保存する

Senseiは、GitHubリポジトリに保存されたレシピにもアクセスできます。プライベートリポジトリとパブリックリポジトリの両方に対応しています。

SSH経由のGitHub

SSHリポジトリへのアクセスは、場所の設定で以下の構文を使用して構成します。

git@github.com:SecureCodeWarrior/acookbook.git

これを機能させるには、リポジトリ内にクックブックフォルダの中身が含まれている必要があります。

クックブックのブランチやサブフォルダを指定することも可能です（例：masterブランチ内のcookbookサブフォルダなど）。

例：

• git@github.com:SecureCodeWarrior/sensei-blog-examples.git|master|.sensei

プライベートリポジトリを利用する場合は、SSHキーの設定が必要です。

• https://github.com/settings/keys

なお、キーにはパスフレーズを設定しないでください。

HTTPS経由のGitHub

HTTPS経由でパブリックリポジトリにアクセスすることも可能です。その際も同様に repo.git|branch|folder という構文を使用します（例：）。

ブログのサンプルプロジェクトの場合：

• https://github.com/SecureCodeWarrior/sensei-blog-examples.git|master|.sensei

「Basic Protection」のサンプルセットでは、デフォルトでmasterブランチが取得され、`rules.sensei`ファイルがルートフォルダにあるため、ブランチやサブフォルダの指定を省略できます：

• https://github.com/SecureCodeWarrior/cookbook-basic-protection-set

HTTP(s)経由のZIPファイル

Senseiは、HTTPまたはHTTPS経由で提供されるZIP形式のクックブックにも対応しています。

例：ローカルの8000番ポートでHTTPサーバーを起動している場合

• http://localhost:8000/rules.sensei.zip

ZIP形式のクックブックファイルには、rules.senseiファイルなど、クックブックフォルダーの中身を含める必要があります。

共有の概要

Senseiは複数のクックブックを利用できるため、各プログラマーは自身の学習や生産性向上に役立つレシピを個別に持つことができます。

さらに重要な点として、チームは知識を共有することで最も効果的に機能します。特定のプロジェクトやライブラリ、あるいは共通の移行パターンなど、チームでリポジトリを共有することで、チーム全体の生産性を高め、経験を形式知化できます。

クックブックを共有すれば、複数のチームで同じものを使用できるため、AppSec（アプリケーションセキュリティ）と開発部門といった、異なる専門分野間での連携も強化されます。

Senseiには4つの主要な共有メカニズムが用意されており、知識共有を促進するための最適な方法が必ず見つかるはずです。

---

SenseiはIntelliJの「Preferences \ Plugins」（Mac）または「Settings \ Plugins」（Windows）からインストールできます。「sensei secure code」で検索してください。

Senseiのブログ記事で使用されているコードやレシピは、すべて以下のGitHubリポジトリで公開されています。

• https://github.com/SecureCodeWarrior/sensei-blog-examples