SDK - CLI
SDK CLIへようこそ。 このセクションでは、WorkatoのConnector SDK Ruby gem（SDK gem）を使用して、コネクターDevelopmentをローカルに移行する方法に焦点を当てます。
SDK gemとは
SDK Gemは、Workatoによるコネクターコードの解析と実行の仕組みをエミュレートするRubyソフトウェアパッケージです。
gemの特徴：
- インストールが簡単
- コマンドラインで実行可能
- 選択したIDE（統合Development Environment）で快適にコネクターを開発可能
前提条件
SDK gemを使用するには、次に精通している必要があります：
- 中級レベルのConnector SDK
- コマンドラインツールとその使用方法
- ユニットテスト用のRSpec。 詳細はRSpec docsを参照してください。
- VCR。 VCRの詳細については、この一般ガイドを参照するか、すぐに始めるにはこの入門ガイドを参照してください。
CLIを使用するメリット
- コネクターDevelopmentをローカルに移行し、選択したIDEで開発
- 強化されたデバッグツール
- チームメイトとのコラボレーション向上
- ユニットテストとCI/CDプロセスを実装し、デプロイメントの安定性を向上させる機能
- 自動デプロイメントを実装する機能
SDK gemの機能
SDK gemが自分に適しているかまだわかりませんか。 次のセクションでは、Cloud SDKのTest codeタブとSDK gemでコネクターを構築する際の主な違いについて説明します。
| Cloud SDK Test codeタブ | SDK Gem | |
|---|---|---|
| テストの具体性 | コネクション、アクション、トリガー全体をテスト可能 | コネクターの特定のキーを個別にテスト可能。 例：executeおよびoutput_fieldsは個別にテストできます
|
| UIテスト | 入力フィールドと出力フィールドの正確な見た目と操作感をテスト可能。 例：動的な入力フィールドと出力フィールド | UIはありませんが、CLI Utilsを使用して、入力フィールドと出力フィールドの結果のWorkatoスキーマを迅速に評価可能 |
| ユニットテスト | 利用不可 | CLIコマンドをユニットテストに迅速に変換可能 |
| Test codeタブのプロパティとルックアップ テーブル | Test codeタブではaccount_propertiesまたはルックアップ テーブルにアクセスできません
| account_propertiesと認証情報を暗号化/非暗号化形式で保存可能。 ルックアップ テーブルを非暗号化形式で保存可能。 |
SDK Gemとその機能の改善を継続するにつれて、さらに多くの機能が追加されます。
CLIによるコネクターDevelopment
では、チームでのコネクターDevelopmentはどのようなものでしょうか。
以下はプロセス例ですが、チーム固有のニーズやワークフローに合わせていつでも変更できます。
ステップごとに見ていきましょう：
ローカルDevelopment。 コネクターをローカルで実行します。 SDK gemの便利なCLIコマンドは、作業中のコネクターの構築、テスト、デバッグに役立ちます。
Workatoワークスペースでテスト。 機能性の確保は重要ですが、コネクターのUXも同様に重要です。 コネクターを個人またはチームのワークスペースにプッシュすることで、実際のレシピでコネクターをテストできます。
Gitにプッシュ。 他のユーザーとコラボレーションするには、コードをGitリポジトリにプッシュします。 これはGitHub、Gitlab、Bitbucket、または別のプロバイダーの場合があります。
レビューしてテスト。 チームメイトによる変更をレビューし、コネクターがすべてのユニットテストに合格することを確認します。
DEVへの自動プッシュ。 必要に応じて、リポジトリで自動ワークフローを設定し、プルリクエストがマージされたときに変更をDEVワークスペースへ自動的にプッシュできます。 これにより、追加のテストをトリガーできます。 例：レシピビルダーは、コネクターが期待どおりに動作することを確認するためにユーザー受け入れテストを実施できます。
プロダクションへリリース。 標準のレシピライフサイクルマネジメントプロセスに従って、コネクターをDEV > UAT > PROD Environment間で移行し、レシピと同様にコネクターがプロダクションへリリースされる前に十分にテストされていることを確認します。
はじめに
開発を開始する準備はできましたか。 使い始めるには、Getting Startedガイドを参照してください。
Last updated: