Gruntle Software & Testing

によって Stewart Tristian投稿日 投稿日 ガイド

このチュートリアルは、Karate Frameworkを使用したAPIテストの入門編です。 Karateテストスクリプトの構造と最初のテストスクリプトを構築する手順について学びます：

APIとは、Application Programming Interfaceの頭文字をとったもので、簡単に言えば、アプリケーション間の通信を可能にするソフトウェアの仲介役と定義することができる。

APIテストが必要なのは

  • 結果の公開が早いので、APIが正常に動作しているかどうかを確認するために待つ必要がありません。
  • また、APIの導入も迅速な対応により、短納期での導入が可能となります。
  • アプリのUIが出来上がる前から、早期に障害を検知することで、リスクを軽減し、障害を修正することができます。
  • 短時間で大量納品が可能

APIテストには、Postman、Mocha、Chaiといった様々なツールがあります。 これらはAPIテストに有効な結果をもたらし、効果的な使い方を示していますが、コードの影響が大きいため、これらを使いこなすには、プログラミング言語に精通した技術的知識が必要です。

Karate Frameworkは、先行するソフトウェアツールのこの問題を見事に解決しています。

空手フレームワークとは

空手？ 空手の話をしよう 日本の空手か？ どうだろう？ 偉大なブルース・リーが暇な時に開発したものかもしれない。

空手の興味深いルーツについて掘り下げてみたいところですが、とりあえずは 空手道具 が開発したものです。 ピーター・トーマス APIテスターを救済する素晴らしいツールの一つです。

Karateフレームワークは、BDDアプローチに則ったCucumberスタイルでプログラムを記述します。 プログラマーでなくても理解しやすい構文です。 また、このフレームワークは、APIオートメーションとパフォーマンステストを1つのスタンドアロンツールに統合した、唯一のAPIテストツールとなっています。

テストケースを並列で実行し、JSON & XMLのチェックを行う機能を提供します。

この情報をもとに、空手道具をより詳しく理解するためのポイントを推測することができます：

  • KarateはTDDではなく、BDDのテストフレームワークです。
  • ノンプログラマーでも簡単に使えるように設計されています。 この機能は、技術的な背景や能力に関係なく、多くの人が利用・アクセスできるようにするもので、画期的なことだと思います。
  • Cucumberの機能ファイルとGherkins言語を利用してテストを書くので、とてもわかりやすい。

これらすべての機能により、現在最も有利な自動化ツールの1つとなっています。

空手の歴史 フレームワーク

作成したのは、' ピーター・トーマスの Javaで書かれているため、ファイルも同じ言語であることが予想されますが、幸いにもそうではありません。

自動化ソフトウェアはCucumberの拡張機能であるため、Gherkinsファイルの使用を継承しています。 両者の大きな違いは、Karateはテスト中にJavaを使用しませんが、Cucumberは使用します。

Gherkinsのシンタックスは非常に読みやすく、包括的であるため、ノンプログラマーを対象とする理由はまさにここにあります。 これが、Karateが自動APIテストの世界に参入するために最も適しており、推奨されている理由です。

Karate Testing Frameworkの特徴は以下の通りです：

  • 理解しやすいGherkins言語を使用します。
  • Javaのような専門的なプログラミングの知識は必要ありません。
  • 人気の高いキューカンバーの規格をベースにしています。
  • フレームワークの作成が容易
  • 並列テストは、Karate自体が提供するコア機能であり、それ故に、私たちは、Karateに依存する必要がありません。 Maven、Gradle などがあります。
  • TestをデバッグするためのUIです。
  • 他のファイルから機能ファイルを呼び出す。
  • 自社で構築したデータドライバテストをサポートするため、外部フレームワークに依存する必要がありません。
  • Native Rest Reportsを内蔵。 さらに、Cucumberと統合することで、より良いUI Reportsを提供し、より分かりやすくすることができます。
  • 異なるテスト環境（QA、Stage、Prod、Pre-Prod）にまたがるスイッチングの設定を社内でサポートします。
  • 便利なCI/CD統合をシームレスにサポートします。
  • 様々なHTTP呼び出しに対応できる：
    • Web Socket対応
    • SOAPリクエスト
    • HTTP
    • ブラウザのクッキーの取り扱い
    • HTTPS
    • HTML形式のデータ
    • XMLリクエスト

カラテとレスト・アシュアードを比較する

安心してください RESTサービスをテストするためのJavaベースのライブラリです。 Java言語を使用してコードを記述します。 多数のリクエストカテゴリーをテストするのに役立ち、さらにさまざまなビジネスロジックの組み合わせを検証することができます。

空手フレームワーク : Cucumber/Gherkinsベースのツールで、SOAPやRESTサービスのテストに使用されます。

以下の表は、Rest-Assured & Karate Frameworkのより顕著な違いを列挙したものです：

S.No ベース 空手フレームワーク REST-アシュアード
1 言語 キュウリとガーキンを組み合わせて使用しています Java言語を利用しています。
2 コードサイズ 通常、Cucumberのような構造になっているため、コードの行数は少なくなります Java言語を使用するため、コード行数が多くなる
3 必要な技術知識 ノンプログラマーでも簡単にGherkinsのコードを書くことができます。 Javaコードを書くために技術的な知識が必要です
4 データ駆動型テスト TestNGまたはそれに準ずるものを利用して対応する必要がある 自社製タグを使用して、データテストをサポートすることができる
5 SOAP呼び出しに対応しているか はい、提供します。 RESTリクエストにのみ関係する
6 パラレルテスト はい、並行テストは、並行レポート生成も簡単にサポートします。 多くの人が挑戦しているが、成功率よりも失敗率の方が高い。
7 報告する また、Cucumberのレポートプラグインと統合することで、より良いUIを実現することも可能です。 Junit、TestNGのような外部プラグインに依存する必要がある。
8 外部データのCSV対応 はい、Karate 0.9.0からです。 いいえ、Javaコードまたはライブラリを使用する必要があります。
9 Web UIオートメーション Karate 0.9.5からWeb-UIオートメーションが可能になりました。 いいえ、サポート対象外です
10 サンプルGET Given param val1 = 'name1'

そして、param val2 = 'name2'

そしてパス「somelocation」。

メソッド取得時

すると、マッチレスポンスに「OKAY」が含まれる

given()です。

param("val1", "name1")。

param("val2", "name2")。

when()を使用します。

get("/somelocation").

then()とします。

body(containsString("OKAY"))；

したがって、上記の違いが示すように、空手は誰にでもできる簡単なものの一つであると言ってよいでしょう。

Karate Frameworkを使用するために必要なツール

さて、Karate Frameworkに関する基本的な知識は要領を得たので、Karateの環境を構築する際に必要なプロセスやツールについて見ていこうと思います。

#1）エクリプス

Eclipseは、コンピュータプログラミングの分野で使用される統合開発環境です。 主にJavaプログラミングに使用されます。 先に述べたように、KarateはJavaで書かれているので、APIテストソフトウェアのIDEとしてEclipseが選ばれるのはより理にかなっています。 また、オープンソースのツールであることも、このツールを選ぶ強い理由になっています。

注意してください： IntelliJやVisual Studioなど、市販されているさまざまなエディタを使うこともできますね。

#その2）Maven

主にJavaプロジェクトの構築に使用されるビルド自動化ツールです。 Karate環境を構築し、コードを書くための一つの方法です。 EclipseにMavenの要件を設定するには、ここをクリックしてMavenのインストールを行うことができます。

Mavenで作業しながら、Karate Frameworkをサポートするのに役立つMavenの依存関係を使用します。

以下の依存関係は、pom.xmlでMavenとともに使用されます。 

 com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test

注意してください： 最新版はMavenリポジトリで公開されている可能性があります。

#その3）Gradle

GradleはMavenの代替品で、同じように使うことができます。 両者には類似点と相違点がありますが、Karateコードの環境をセットアップする際に同じように使うことができます。

Gradleはより使いやすく、柔軟性があり、アプリケーションがモジュール化され、多くのプラグインを管理する必要がある場合に使用することをお勧めします。 Gradleのセットアップコードは次のようなものになります、 

 testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'

注意してください： を使うかのどちらかでしょう。 メイヴン または GRADLEです。

#その4）お使いのシステムのJava環境設定

Karate Frameworkのスクリプトを使い始めるために、JDKとJREの環境を設定する必要があります。

空手テストスクリプトの構造

Karateのテストスクリプトは、拡張子「.feature」を持っていることで知られています。 このプロパティはCucumberから継承されています。 Java規約によるファイル構成も同様に認められています。 Javaパッケージ規約に従って、自由にファイルを構成することができます。

しかし、Mavenのガイドラインでは、非Javaファイルの保存は別に行うように指示されています。 それらは、Mavenで作成された src/test/resources の構造になっています。 また、Javaファイルは src/main/java .

しかし、Karate Frameworkの開発者は、Javaと非Javaの両方のファイルを並べておくことを強く信じています。 彼らによると、標準のMaven構造に従うよりも、*.javaと*.featureのファイルを一緒に保管する方が、より簡単に探すことができるそうです。

これは、以下のようにpom.xmlを調整することで簡単に行うことができます（Mavenの場合）： 

 src/test/java **/*.java ...

以下は、「空手フレームワーク」の一般的な構成の概要である：

さて、このKarate FrameworkはRunnerファイルを使用していますが、これはCucumberでも機能ファイルを実行するために必要なものなので、ほとんどの記述はCucumberの標準に従うことになります。

しかし、Cucumberとは異なり、Karateではステップに明確な定義が必要なく、それが逆に柔軟性や操作性を高めています。 Cucumberのフレームワークに従うと通常追加しなければならない余計な接着剤は必要ないのです。

ランナー」クラスは、ほとんどの場合、名前がついている TestRunner.java。

そうすると、TestRunner.javaファイルは、以下のような形になります： 

 import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { }.

を語ることも。 .feature ファイルには、APIが期待される要件通りに動作することを確認するためにテストする必要があるすべてのテストシナリオが含まれています。

一般的な*.featureファイルは、以下のような形をしています： 

 機能：ユーザー詳細の取得 シナリオ：ユーザー詳細の取得をテストする 与えられたurl '//reqres.in/api/users/2' When method GET Then status 200

最初の基本的な空手テストスクリプトを作成する

このセクションでは、Karateフレームワークの形でAPIを変換するために役立つ、非常に最初のテストスクリプトの作成に着手するのに役立ちます。

Karateの基本的なテストスクリプトを書く前に、以下の必要なものをあなたのマシンにインストールしてください：

  • エクリプスIDE
  • Maven 適切なMavenのパスを設定します。
  • JDK & JRE.適切なパスを設定してください。

それでは、ステップバイステップで見ていきましょう：

#1) を新規に作成します。 メイヴン Eclipseエディタでのプロジェクト

  • オープンエクリプス
  • ファイル」をクリックし、「新規プロジェクト」を選択します。

  • Maven プロジェクトを選択する

  • ワークスペースの場所を選択します。
  • アーキタイプを選択する（通常、私たちは" Maven-archetype-クイックスタート 1.1 "単純なMavenプロジェクトの場合)。
  • グループID & アーティファクトID（この例では、以下の値を使用しました）を入力します。
    • グループID : 空手
    • アーティファクトIDです： KarateTestScriptsSample
  • Finishをクリックして設定を完了します。

#2) 作成されると、今度はプロジェクトエクスプローラーウィンドウに以下のような構成が表示されます。

#3) すべての依存関係を含めます。

セットアップ後、最初に行うことは、次のことです。 すべての依存関係を含める POM.xmlの下に、実行に必要なタグをすべて置いておきます（POM.xmlの使い方はすでにご存じだと思います）。

  • POM.xmlを開き、dependencyタグの下に以下のコードをコピーして、ファイルを保存します。 
 com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test

ソースはこちらをご覧ください。

#4) この空手ベーシックテストスクリプトで何をテストするのか、シナリオを考えてみましょう。

シナリオです：

このURLでAPIをテストする予定です。

パスです： api/users/2

方法です： ジーティー

そして、検証する必要がある を返しているのか、リクエストの サクセスコード (200) をするかしないか。

簡単に言うと、サンプルのAPIが正常に実行されているかどうかをテストしているだけなのです。

注意してください： テスト用のサンプルAPIをお預かりしています。 PATHは自由に選択できますし、お客様のAPIを参照することも可能です。

ソースはこちらをご覧ください。

#5) さて、次のステップでは .feature ファイルを作成します。

序章で述べたように、この .feature ファイル はCucumberから継承されたプロパティです。 このファイルでは、APIテストを実行するために必要なテストシナリオを書き出すことになります。

  • フォルダへ移動 src/test/java をプロジェクトに組み込んでください。

  • 右クリックして、新しいファイルを作成する-。 userDetails.featureになります。 その後、「Finish」ボタンをクリックします。

これで、フォルダの下に以下のファイルが表示されます。 src/test/java

のことです。 グリーンカラーのアイコン に似ている。 .feature fi ルを、先ほど作成したCucumberで作成します。

  • ファイルの作成が完了したら、次のセクションで説明するテストシナリオを作成します。

#6) シナリオとブランクがあるので、. 特徴 ファイルの準備ができましたので、最初のスクリプトを書き始めましょう。 では、コーディングを始めます。

手順5で作成したuserDetails.featureファイルの下に、以下のコードを記述してください： 

 機能：ユーザー詳細の取得 シナリオ：ユーザー詳細の取得をテストする 与えられたurl '//reqres.in/api/users/2' When method GET Then status 200

上記のファイルに書かれているコンポーネントを理解するために、試してみましょう：

  • 特徴です： キーワードは、テストする機能の名称を説明します。
  • 背景を説明します： このセクションは、Pre-requisiteセクションとして扱われるオプションのセクションです。 APIをテストするために必要なものを定義するために使用することができます。 以下の内容を含みます。 HEADER, URL & PARAM のオプションがあります。
  • シナリオです： あなたが目にするすべてのフィーチャーファイルは、少なくとも1つのフィーチャーを持っています（ただし、それは与えることができます）。 複数 シナリオ）である。 テストケースの記述である。
  • 与えられた： 他のテストステップが実行される前に実行される必要があるステップです。 実行されることが必須とされるアクションです。
  • いつの間にか： 次のテストステップを実行するために満たすべき条件を指定するものである。
  • それから： に記載されている条件が満たされた場合、どのようなことが起こるかを教えてくれるものです。 いつ が満たされる。

注意してください： 上記のキーワードはすべてGherkins言語によるもので、Cucumberを使ったテストスクリプトの標準的な記述方法です。

さらに、特集ファイルで使われている単語をいくつか紹介します：

  • 200: 期待するステータス/レスポンスコードです（ステータスコードの一覧はこちら）。
  • GETすることができます： POST、PUTなどのAPIメソッドのことです。

この説明で、上記のファイルに何が書かれているのかが理解できたと思います。

ここで、TestRunner.javaファイルを作成する必要があります。

上記のセクションで説明したように、Cucumberは、実行に必要なRunnerファイルを必要とします。 .feature ファイルには、テストシナリオが含まれています。

  • フォルダへ移動 src/test/java そちらで

  • その上で右クリックし、新しいJavaファイルを作成します： テストランナー（TestRunner）.java
  • ファイルの作成が完了したら は、その下に次のようなコード行を配置します： 
 import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { }.
  • テストランナーは、ステップ5で記述したシナリオを実行するためのファイルです。

#7) これで両ファイルの準備は完了です。 TestRunner.Java と userDeatils.feature。 私たちに残された課題はただ一つ 走る スクリプトです。

  • TestRunner.javaに移動し、下図のようにファイルを右クリックします。

  • 名前を付けて実行を選択 -> Junit Test
  • さて、選択すると、テストケースが開始されたことが確認できるようになります。
  • テストスクリプトが実行されるのを待ちます。 実行されると、ウィンドウに下の画像のようなものが表示されます。

  • 最後に、私たちは最初の基本的なものを作ることに成功したと言えるでしょう。 テストスクリプト を使用しています。 空手のフレームワーク。

#8) 最後に、Karateフレームワークは、実行された実行のためのHTMLレポートプレゼンテーションも提供します。

  • 対象フォルダに移動 -> surefire-reports-> ここに、開くことができるHTMLレポートが表示されます。

** Chromeブラウザで開くと、より見やすくなります。

  • 以下のようなHTMLレポートが表示されます。 シナリオ＆テスト というシナリオを実行しました：

結論

このチュートリアルでは、APIテスト、市場で入手可能なさまざまなテストツール、そしてKarate Frameworkが他のものと比べてどのように優れているのかについて説明しました。

最初の基本的なテストスクリプトを作成するために、ステップバイステップのアプローチに従いました。 まず、基本的なテストスクリプトを作成することから始めました。 Eclipse IDEでMavenプロジェクト で、すべてのテストシナリオを含む .feature ファイルと、.feature ファイルに記載されているテストケースを実行する Runner ファイルを作成します。

複数のステップの最後には、テスト結果の実行レポートも見ることができました。

このチュートリアルが、Karate Frameworkを使用して最初のテストスクリプトを構築し、APIテストを実行する方法を学ぶ上で、初心者の方のお役に立てれば幸いです。 この詳細なステップバイステップのアプローチは、APIの様々なテストを実行し実行する素晴らしい手段となっています。

NEXT>>；

トップへスクロール