SDK - CLI

SDK - CLI へようこそ。このセクションでは、Workato の Connector SDK Ruby gem (SDK gem) を使用して、コネクターの開発をローカルで行う方法に焦点を当てます。

SDK gem とは

SDK Gem は、Workato がどのようにコネクターコードを解析および実行するかをエミュレートする Ruby ソフトウェアパッケージです。

Gem の特徴は次のとおりです。

• インストールが容易
• コマンドラインで実行可能
• 選択した IDE (統合開発環境) で快適にコネクターを開発可能

前提条件

SDK gem を使用するには、以下に関する知識が必要です。

1. 中級レベルの Connector SDK
2. コマンドラインツールとその使用方法
3. 単体テストのための RSpec。詳細については、RSpec に関するドキュメント (opens new window)を参照してください。
4. VCR。VCR の詳細については、この一般的なガイド (opens new window)を参照するか、すぐに開始する場合は、こちらの入門ガイド (opens new window)を参照してください。

CLI を使用することによるメリット

• コネクター開発をローカルで行うことにより、選択した IDE で開発可能
• デバッグツールの強化
• チームメイトとのコラボレーションの改善
• 単体テストと CI/CD プロセスを実装でき、デプロイの安定性が向上
• 自動デプロイを実装可能

SDK gem の機能

SDK gem が自分に合っているかまだ確信が持てない方のために、以下に、Cloud SDK コンソールでのコネクターの構築と、SDK gem での構築の主な違いを明らかにします。

	Cloud SDK コンソール	SDK Gem
テストの特性	コネクター、アクション、およびトリガーを全体としてテストできます。	コネクターの固有キーを別々にテストできます。たとえば、execute と output_fields は、別々にテストできます。
UI テスト	入力と出力の項目の正確なルックアンドフィールをテストできます。例: 動的な入力項目および出力項目	UI はありませんが、CLI のユーティリティを使用して、結果として生じる入力および出力項目の Workato スキーマを迅速に評価できます。
単体テスト	使用できません。	CLI コマンドを単体テストに迅速に変換できます。
アカウントプロパティと Lookup table	デバッガーコンソールの account_properties または Lookup table へのアクセスはありません。	暗号化フォーマット / 暗号化されていないフォーマットで account_properties および資格情報を格納できます。暗号化されていないフォーマットで Lookup table を格納できます。

SDK Gem とその機能については常に改善を続けているため、今後もより多くの機能が追加されます。

CLI によるコネクター開発

では、チームにとって、コネクター開発はどのようなものでしょうか。

下にプロセス例を示しますが、これはチーム固有のニーズやワークフローに合わせていつでも変更できます。

ステップごとに見ていきましょう。

1

ローカル開発。 コネクターをローカルに実行します。SDK gem の便利な CLI コマンドは、コネクターの構築、テスト、およびデバッグを行うのに役立ちます。

2

Workato ワークスペースでのテスト。 機能を保証することは重要ですが、コネクターのユーザーエクスペリエンスも重要です。個人の Workato ワークスペースにコネクターをプッシュすることができ、実際のレシピでコネクターをテストできます。

3

Git へのプッシュ。 他者とコラボレートするには、Git リポジトリにコードをプッシュします。このリポジトリとしては、GitHub、Gitlab、Bitbucket、その他のプロバイダーを利用できます。

4

レビューとテスト。 チームメイトによる変更をレビューして、コネクターがすべての単体テストに合格することを確認します。

5

DEV への自動プッシュ。 プル要求が結合された場合に、必要に応じて、リポジトリで、DEV ワークスペースに自動的に変更をプッシュする自動ワークフローを設定できます。これにより、追加のテストをトリガーできます。たとえば、レシピの作成者は、ユーザー受け入れテストを実行し、期待どおりにコネクターが機能することを確認できます。

6

本番環境へのリリース。 標準レシピのライフサイクル管理プロセスにより、DEV > UAT > PROD の各環境へとコネクターを移行します。これにより、レシピなどのコネクターは、本番環境にリリースされる前に十分にテストされます。

開始

開発を始める準備はできましたか。入門ガイドを確認して、今すぐ始めましょう。