こんにちは、みんな！ 今日、私たちは IT 関係者に当社の製品、つまり API を操作するための IDE を紹介したいと思います。 テストメイス。 おそらく、すでに当社のことをご存知の方もいると思いますが、 以前の記事。 ただし、このツールの包括的なレビューはまだ行われていないため、この残念な欠点に対処します。

動機

実際に、私たちがどのようにしてこの人生に至り、API を使用した高度な作業を行うための独自のツールを作成することにしたのかということから始めたいと思います。 製品に必要な機能のリストから始めましょう。これについては、私たちの意見では、製品は「API を操作するための IDE」であると言えます。

• クエリとスクリプト（クエリのシーケンス）の作成と実行
• さまざまな種類のテストを書く
• テストの生成
• Swagger、OpenAPI、WADL などの形式からのインポートを含む、API 記述の操作。
• モックリクエスト
• 人気のあるライブラリとの統合を含む、スクリプト作成のための XNUMX つ以上の言語の優れたサポート
• 等

リストは好みに合わせて拡張できます。 さらに、IDE 自体だけでなく、クラウド同期、コマンド ライン ツール、オンライン監視サービスなどの特定のインフラストラクチャも作成することが重要です。 結局のところ、近年の傾向により、アプリケーションの強力な機能だけでなく、その快適なインターフェイスも重要になります。

誰がそのようなツールを必要とするでしょうか? 明らかに、API の開発とテストに少なくとも何らかの形で関係している人は全員、開発者とテスターです =)。 さらに、前者の場合、多くの場合、単一のクエリと単純なスクリプトを実行するだけで十分である場合、テスターに​​とって、これは主要なツールの XNUMX つであり、とりわけ、テストを実行する機能を備えたテストを作成するための強力なメカニズムが含まれている必要があります。 CI.

そこで、これらのガイドラインに従って製品の作成を開始しました。 この段階で何を達成したかを見てみましょう。

ファストスタート

まずはアプリケーションについてよく知ることから始めましょう。 ダウンロードできます 当社のウェブサイト上。 現時点では、Windows、Linux、MacOS の 3 つの主要プラットフォームがすべてサポートされています。 ダウンロード、インストール、起動。 初めて起動すると、次のウィンドウが表示される場合があります。

コンテンツ領域の上部にあるプラス記号をクリックして、最初のリクエストを作成します。 クエリタブは次のようになります。

さらに詳しく見てみましょう。 リクエスト インターフェイスは一般的な REST クライアントのインターフェイスに非常に似ているため、同様のツールからの移行が簡単になります。 URL に対して最初のリクエストを行ってみましょう https://next.json-generator.com/api/json/get/NJv-NT-U8

一般に、一見すると、応答パネルも何の驚きも引き起こしません。 ただし、いくつかの点に注意していただきたいと思います。

1. 応答の本文はツリーの形式で表されます。これにより、まず情報コンテンツが追加され、次に、以下の興味深い機能を追加できます。
2. [アサーション] タブがあり、指定されたリクエストのテストのリストが表示されます。

ご覧のとおり、私たちのツールは便利な REST クライアントとして使用できます。 ただし、その機能がリクエストの送信のみに限定されていれば、私たちはここにはいないでしょう。 次に、TestMace の基本的な概念と機能の概要を説明します。

基本概念と機能

結び目

TestMace の機能は、さまざまなタイプのノードに分かれています。 上の例では、RequestStep ノードの操作を示しました。 ただし、次のタイプのノードもアプリケーションで使用できるようになりました。

• リクエストステップ。 これは、リクエストを作成できるノードです。 子要素として持つことができる Assertion ノードは XNUMX つだけです。
• アサーション。 ノードはテストを作成するために使用されます。 RequestStep ノードの子ノードのみにすることができます。
• フォルダ。 Folder ノードと RequestStep ノードをそれらのノード内でグループ化できます。
• プロジェクト。 これはルート ノードであり、プロジェクトの作成時に自動的に作成されます。 それ以外の場合は、フォルダー ノードの機能が繰り返されます。
• リンク。 Folder または RequestStep ノードへのリンク。 クエリとスクリプトを再利用できます。
• 等

ノードはスクラッチ (左下のパネル。「XNUMX 回限り」のクエリをすばやく作成するために使用されます) とプロジェクト (左上のパネル) にあります。これについては後で詳しく説明します。

プロジェクト

アプリケーションを起動すると、左上隅にプロジェクト行が XNUMX つだけあることに気づくかもしれません。 これはプロジェクト ツリーのルートです。 プロジェクトを開始すると、一時プロジェクトが作成されます。そのパスはオペレーティング システムによって異なります。 プロジェクトはいつでも都合の良い場所に移動できます。

プロジェクトの主な目的は、開発内容をファイル システムに保存し、バージョン管理システムを通じてさらに同期したり、CI でスクリプトを実行したり、変更をレビューしたりできることです。

変数

変数は、アプリケーションの重要なメカニズムの XNUMX つです。 TestMace などのツールを使用している人は、私たちが何について話しているのかすでに理解しているかもしれません。 したがって、変数は共通データを保存し、ノード間で通信するための方法です。 たとえば、Postman や Insomnia の環境変数がこれに相当します。 しかし、私たちはさらに進んでトピックを発展させました。 TestMace では、変数をノード レベルで設定できます。 どれでも。 先祖から変数を継承したり、子孫で変数を重複させる仕組みもあります。 さらに、多数の組み込み変数があり、組み込み変数の名前は次のように始まります。 $。 それらのいくつかはここにあります：

• $prevStep — 前のノードの変数へのリンク
• $nextStep — 次のノードの変数へのリンク
• $parent - 同じことですが、祖先のみが対象です
• $response - サーバーからの応答
• $env - 現在の環境変数
• $dynamicVar - スクリプトまたはクエリの実行中に作成される動的変数

$env - これらは基本的に通常のプロジェクト ノード レベルの変数ですが、環境変数のセットは選択した環境に応じて変わります。

変数には次の方法でアクセスします。 ${variable_name}
変数の値は、別の変数、または式全体にすることもできます。 たとえば、url 変数は次のような式にすることができます。
http://${host}:${port}/${endpoint}.

これとは別に、スクリプトの実行中に変数を割り当てる可能性にも注目する価値があります。 たとえば、ログイン成功後にサーバーから送信された認証データ (トークンまたはヘッダー全体) を保存する必要があることがよくあります。 TestMace を使用すると、そのようなデータを祖先の XNUMX つの動的変数に保存できます。 既存の「静的」変数との衝突を避けるために、動的変数は別のオブジェクトに配置されます。 $dynamicVar.

シナリオ

上記の機能をすべて使用すると、クエリ スクリプト全体を実行できます。 たとえば、エンティティの作成 -> エンティティのクエリ -> エンティティの削除。 この場合、たとえば、Folder ノードを使用して複数の RequestStep ノードをグループ化できます。

オートコンプリートと式のハイライト

変数 (だけではありません) を便利に操作するには、オートコンプリートが必要です。 そしてもちろん、式の値を強調表示すると、特定の変数が何に等しいかを明確にしやすくなり、便利になります。 百回聞くより一度見たほうが良い場合は、まさにこれが当てはまります。

オートコンプリートは変数だけでなく、ヘッダー、特定のヘッダーの値 (Content-Type ヘッダーのオートコンプリートなど)、プロトコルなどにも実装されることに注意してください。 このリストは、アプリケーションの成長に合わせて常に更新されます。

元に戻す/やり直し

変更の取り消し/やり直しは非常に便利ですが、何らかの理由でどこでも実装されているわけではありません (API を操作するツールも例外ではありません)。 しかし、私たちはその一人ではありません!) プロジェクト全体に元に戻す/やり直しを実装しました。これにより、特定のノードの編集だけでなく、その作成、削除、移動なども元に戻すことができます。 最も重要な操作には確認が必要です。

テストの作成

アサーション ノードはテストの作成を担当します。 主な機能の XNUMX つは、組み込みのエディターを使用して、プログラミングを行わずにテストを作成できることです。

アサーション ノードは、一連のアサーションで構成されます。 各アサーションには独自のタイプがあり、現時点ではいくつかのタイプのアサーションがあります。

1. 値を比較 - 2 つの値を単純に比較します。 比較演算子には、等しい、等しくない、より大きい、以上、より小さい、以下などがあります。

2. 値を含む - 文字列内の部分文字列の出現をチェックします。

3. XPath - XML 内のセレクターに特定の値が含まれていることを確認します。

4. JavaScript アサーションは、成功した場合に true を返し、失敗した場合に false を返す任意の JavaScript スクリプトです。

最後のアサーションのみがユーザーのプログラミング スキルを必要とし、他の 3 つのアサーションはグラフィカル インターフェイスを使用して作成されることに注意してください。 たとえば、値の比較アサーションを作成するダイアログは次のようになります。

さらに素晴らしいのは、応答からアサーションをすばやく作成できることです。見てください。

ただし、このようなアサーションには明らかな制限があるため、JavaScript アサーションを使用して克服することをお勧めします。 そして、ここで TestMace は、オートコンプリート、構文の強調表示、さらには静的アナライザーを備えた快適な環境も提供します。

APIの説明

TestMace を使用すると、API を使用できるだけでなく、それを文書化することもできます。 さらに、説明自体にも階層構造があり、プロジェクトの残りの部分に有機的に適合します。 さらに、現在、Swagger 2.0 / OpenAPI 3.0 形式から API 記述をインポートすることが可能です。 説明自体は単に存在するだけではなく、プロジェクトの残りの部分と緊密に統合されています。特に、URL、HTTP ヘッダー、クエリ パラメーターなどの自動補完が利用可能であり、将来的にはテストを追加する予定です。応答が API の説明に準拠しているかどうか。

共有ノード

ケース: 問題のあるリクエストやスクリプト全体を同僚と共有したり、単にバグに添付したりしたいと考えています。 TestMace はこのケースもカバーしています。このアプリケーションを使用すると、URL 内の任意のノードやサブツリーさえもシリアル化できます。 コピーして貼り付けるだけで、リクエストを別のマシンまたはプロジェクトに簡単に転送できます。

人間が判読できるプロジェクト保存形式

現時点では、各ノードは yml 拡張子が付いた個別のファイル (アサーション ノードの場合と同様)、またはノードの名前とその中にindex.yml ファイルが含まれるフォルダーに保存されます。
たとえば、上記のレビューで作成したリクエスト ファイルは次のようになります。

インデックス.yml

children: []
variables: {}
type: RequestStep
assignVariables: []
requestData:
  request:
    method: GET
    url: 'https://next.json-generator.com/api/json/get/NJv-NT-U8'
  headers: []
  disabledInheritedHeaders: []
  params: []
  body:
    type: Json
    jsonBody: ''
    xmlBody: ''
    textBody: ''
    formData: []
    file: ''
    formURLEncoded: []
  strictSSL: Inherit
authData:
  type: inherit
name: Scratch 1

ご覧のとおり、すべてが非常に明確です。 必要に応じて、この形式は手動で簡単に編集できます。

ファイル システム内のフォルダーの階層は、プロジェクト内のノードの階層を完全に繰り返します。 たとえば、次のようなスクリプトです。

ファイル システムを次の構造にマッピングします (フォルダー階層のみが示されていますが、本質は明らかです)

これにより、プロジェクトのレビュープロセスが容易になります。

Postman からインポート

上記をすべて読んだ後、ユーザーの中には、新製品を試してみたり (冗談じゃない!) プロジェクトで完全に使用したくなったりする人もいるでしょう。 ただし、同じ Postman 内で多数の開発が行われると、移行が停止する可能性があります。 このような場合に備えて、TestMace は Postman からのコレクションのインポートをサポートしています。 現時点ではテストなしのインポートがサポートされていますが、将来的にはサポートされる可能性も排除されません。

予定

ここまで読んでいただいた多くの方に気に入っていただければ幸いです。 しかし、それだけではありません。 製品の開発は本格的に進められており、間もなく追加する予定の機能をいくつか紹介します。

クラウド同期

最も要望の多かった機能の XNUMX つ。 現時点では、同期にバージョン管理システムを使用することを提案しており、そのためにこのタイプのストレージに適した形式を作成しています。 ただし、このワークフローはすべての人に適しているわけではないため、多くの人に馴染みのある同期メカニズムをサーバーを通じて追加する予定です。

CLI

前述したように、IDE レベルの製品は、既存のアプリケーションやワークフローとのあらゆる種類の統合なしでは機能しません。 CLI は、TestMace で作成されたテストを継続的統合プロセスに統合するためにまさに必要なものです。 CLI での作業は本格化しています。初期バージョンでは、単純なコンソール レポートを使用してプロジェクトが起動されます。 将来的には、JUnit 形式のレポート出力を追加する予定です。

プラグインシステム

私たちのツールの強力な機能にもかかわらず、解決策が必要なケースは無限にあります。 結局のところ、特定のプロジェクトに固有のタスクが存在します。 そのため、将来的にはプラグイン開発用の SDK を追加し、各開発者が好みに応じて機能を追加できるようにする予定です。

ノードタイプの範囲の拡大

このノードのセットは、ユーザーが必要とするすべてのケースをカバーしているわけではありません。 追加予定のノード:

• スクリプト ノード - js と対応する API を使用してデータを変換し、配置します。 このタイプのノードを使用すると、Postman でリクエスト前スクリプトやリクエスト後スクリプトなどの作業を行うことができます。
• GraphQL ノード - GraphQL サポート
• カスタム アサーション ノード - プロジェクト内の既存のアサーションのセットを拡張できます。
  当然のことながら、これは最終的なリストではなく、特に皆様からのフィードバックにより常に更新されます。

よくある質問

ポストマンとどう違うの？

1. ノードの概念。これにより、プロジェクトの機能をほぼ無限に拡張できます。
2. 人間が判読できるプロジェクト形式でファイル システムに保存するため、バージョン管理システムを使用した作業が簡素化されます。
3. プログラミングなしでテストを作成できる機能と、テスト エディターでのより高度な JS サポート (オートコンプリート、静的アナライザー)
4. 高度なオートコンプリートと変数の現在値の強調表示

これはオープンソース製品ですか?

いいえ、現時点では情報源は非公開ですが、将来的には情報源を公開する可能性を検討しています。

何で生きてるんですか？）

無料版に加えて、有料版のリリースも予定しています。 これには主に、同期など、サーバー側を必要とするものが含まれます。

まとめ

私たちのプロジェクトは安定版リリースに向けて飛躍的に進んでいます。 ただし、この製品はすでに使用可能であり、初期のユーザーからの肯定的なフィードバックがそれを証明しています。 コミュニティとの緊密な協力がなければ、優れたツールを構築することは不可能であるため、私たちは積極的にフィードバックを収集します。 ここで私たちを見つけることができます:

公式サイト

Telegram

Slack

Facebook

問題トラッカー

皆様のご希望やご提案をお待ちしております！

出所： habr.com