Hướng dẫn này giới thiệu về Thử nghiệm API bằng Karate Framework. Tìm hiểu về cấu trúc của Tập lệnh kiểm tra Karate và các bước xây dựng tập lệnh kiểm tra đầu tiên:
API là từ viết tắt của Giao diện lập trình ứng dụng. Nói một cách đơn giản, chúng tôi có thể định nghĩa nó là một phần mềm trung gian cho phép giao tiếp giữa các ứng dụng.
Chúng tôi cần thử nghiệm API vì:
- Kết quả được công bố nhanh hơn, do đó không cần phải chờ xem API có hoạt động tốt hay không.
- Với phản hồi nhanh hơn, việc triển khai các API này cũng trở nên nhanh hơn, do đó cho phép thời gian quay vòng nhanh.
- Phát hiện lỗi sớm, ngay cả trước khi tạo giao diện người dùng của ứng dụng, hãy cho phép chúng tôi giảm thiểu rủi ro và sửa lỗi.
- Có thể phân phối quy mô lớn trong thời gian ngắn hơn.
Để có thể thực hiện Thử nghiệm API, chúng tôi có sẵn nhiều công cụ khác nhau trên thị trường như Postman, Mocha và Chai. Những điều này đã chứng minh kết quả tốt và cách sử dụng hiệu quả để thử nghiệm API, tuy nhiên, những điều này bị ảnh hưởng nặng nề bởi mã. Để có thể sử dụng những thứ này, một người phải có kỹ thuật vững chắc và quen thuộc với các ngôn ngữ lập trình.
Khung Karate giải quyết vấn đề này một cách tuyệt vời của các công cụ phần mềm trước đó.
Khuôn khổ Karate là gì
Karate? Hãy nói về Karate. Nó có phải là một từ Nhật Bản? Bạn nghĩ sao? Có thể đó là Bruce vĩ đạiTập lệnh thử nghiệm cơ bản Karate này.
Kịch bản:
Chúng tôi sẽ thử nghiệm API với URL này.
Đường dẫn: api/users/2
Phương thức: GET
Và chúng tôi cần xác thực , xem yêu cầu có trả về Mã thành công hay không ( 200) hay không.
Nói một cách đơn giản, chúng tôi sẽ thử nghiệm một API mẫu để xem liệu API đó có được thực thi thành công hay không.
Lưu ý: Chúng tôi đang lấy một API mẫu có sẵn để thử nghiệm. Bạn có thể chọn bất kỳ PATH nào hoặc có thể tham khảo API của mình.
Nhấp vào đây để xem nguồn.
#5) Bây giờ, bước tiếp theo của chúng ta là tạo Tệp .feature .
Như đã thảo luận trong phần giới thiệu, tệp .feature là tài sản được kế thừa từ Cucumber. Trong tệp này, chúng tôi sẽ viết ra các kịch bản thử nghiệm cần được thực hiện để thực hiện Kiểm tra API.
- Chuyển đến Thư mục src/test/java trong dự án của bạn.
- Nhấp chuột phải vào nó và tạo một tệp mới – userDetails.feature. Sau đó nhấp vào nút Kết thúc.
Bây giờ bạn sẽ thấy tệp sau trong thư mục src/test/java
Biểu tượng Xanh lục giống với tệp .feature fi trong Cucumber mà chúng ta vừa tạo.
- Sau khi tệp đã được tạo, bây giờ chúng ta sẽ viết các kịch bản thử nghiệm sẽ được thảo luận trong phần sau.
#6) Vì chúng ta có kịch bản vàtệp . feature trống đã sẵn sàng, bây giờ hãy bắt đầu với tập lệnh đầu tiên của chúng ta. Chúng ta hãy bắt đầu viết mã
Viết dòng Mã sau trong tệp userDetails.feature mà chúng ta đã tạo ở Bước #5:
Feature: fetching User Details Scenario: testing the get call for User Details Given url '//reqres.in/api/users/2' When method GET Then status 200
Hãy để chúng tôi hiểu các thành phần được viết trong tệp trên:
- Tính năng: Từ khóa giải thích tên của tính năng chúng tôi đang thử nghiệm.
- Bối cảnh: Đây là phần tùy chọn được coi là phần Điều kiện tiên quyết. Điều này có thể được sử dụng để xác định tất cả những gì cần thiết để kiểm tra API. Nó chứa HEADER, URL & Tùy chọn PARAM .
- Kịch bản: Mọi tệp đối tượng mà bạn thấy sẽ có ít nhất một đối tượng (mặc dù nó có thể đưa ra nhiều kịch bản) . Đó là mô tả của trường hợp thử nghiệm.
- Cho trước: Đây là bước cần được thực hiện trước khi thực hiện bất kỳ bước thử nghiệm nào khác. Đây là hành động bắt buộc phải thực hiện.
- Khi nào: Nó chỉ định điều kiện cần đáp ứng để thực hiện bước kiểm tra tiếp theo.
- Sau đó: Nó cho chúng tôi biết điều gì sẽ xảy ra trong trường hợp điều kiện được đề cập trong phần Khi được thỏa mãn.
Lưu ý: Tất cả các từ khóa được đề cập ở trên đều từ ngôn ngữ Gherkins. Đây là cách tiêu chuẩn để viết tập lệnh thử nghiệm bằng Cucumber.
Và một số từ khác được sử dụng trong tệp tính năng là:
- 200: Đó là mã trạng thái/phản hồi mà chúng ta đangmong đợi (Nhấp vào đây để xem danh sách mã trạng thái)
- NHẬN: Đó là phương thức API như POST, PUT, v.v.
Chúng tôi hy vọng lời giải thích này rất dễ hiểu cho bạn. Bây giờ bạn sẽ có thể hiểu chính xác nội dung được viết trong tệp trên.
Bây giờ chúng ta cần tạo tệp TestRunner.java
Như đã giải thích ở trên phần, Cucumber cần có tệp Runner để thực thi tệp .feature chứa các kịch bản thử nghiệm.
- Chuyển đến Thư mục src/test/java trong dự án của bạn
- Nhấp chuột phải vào nó và tạo một tệp Java mới: TestRunner.java
- Sau khi tệp đã được tạo, đặt các dòng mã sau vào bên dưới tệp:
import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { }- Test Runner là tệp hiện sẽ được thực thi để thực hiện kịch bản mong muốn đã được viết trong Bước #5.
#7) Bây giờ chúng ta đã sẵn sàng với cả hai tệp TestRunner.Java và userDeatils.feature. Nhiệm vụ duy nhất còn lại của chúng ta là Chạy tập lệnh.
- Truy cập tệp TestRunner.java và nhấp chuột phải vào tệp như trong hình bên dưới.
- Chọn Run As -> Junit Test
- Bây giờ, sau khi được chọn, bạn sẽ bắt đầu quan sát rằng trường hợp thử nghiệm hiện đã bắt đầu.
- Đợi tập lệnh thử nghiệm thực thi. Sau khi hoàn tất, bạn sẽ quan sát thấy một thứ như trong hình bên dưới trong cửa sổ của mình.
- Cuối cùng, chúng ta có thể nóirằng chúng tôi đã tạo thành công Tập lệnh kiểm tra cơ bản đầu tiên của mình bằng cách sử dụng Khuôn khổ Karate.
#8) Cuối cùng, Karate framework cũng cung cấp bản trình bày báo cáo HTML cho quá trình thực thi đã được thực hiện.
- Chuyển đến Thư mục đích -> báo cáo chắc chắn thành công-> Tại đây, bạn sẽ thấy báo cáo HTML mà bạn có thể mở.
** Chúng tôi cũng khuyên bạn nên mở báo cáo tương tự bằng Chrome Trình duyệt để có giao diện đẹp hơn.
- Báo cáo HTML sau đây sẽ hiển thị cho bạn mô tả Kịch bản & Thử nghiệm đã được thực thi cho kịch bản được đề cập:
Kết luận
Trong hướng dẫn này, chúng ta đã thảo luận về thử nghiệm API, các thử nghiệm khác nhau các công cụ có sẵn trên thị trường và cách Karate Framework là một lựa chọn tốt hơn so với các đối tác của nó.
Chúng tôi đã làm theo cách tiếp cận từng bước để tạo tập lệnh thử nghiệm cơ bản đầu tiên của mình. Chúng tôi đã bắt đầu với việc tạo một Dự án Maven cơ bản trong IDE Eclipse để tạo tệp .feature chứa tất cả kịch bản thử nghiệm và tệp Runner để thực thi trường hợp thử nghiệm được đề cập trong tệp .feature.
Khi kết thúc nhiều bước, chúng ta có thể xem báo cáo thực thi kết quả kiểm tra.
Chúng tôi hy vọng hướng dẫn này hữu ích cho những người mới bắt đầu học cách xây dựng kịch bản kiểm tra đầu tiên của họ bằng Karate Framework và thực hiện Thử nghiệm API. Từng bước chi tiết nàyphương pháp này là một cách tuyệt vời để chạy và thực hiện nhiều thử nghiệm khác nhau trên API.
NEXT>>
Lee đã phát triển cái này trong thời gian rảnh rỗi.Mặc dù chúng tôi muốn đi sâu vào nguồn gốc thú vị của Karate, nhưng bây giờ, hãy nói về Công cụ Karate đã được phát triển của Peter Thomas , một trong những công cụ tuyệt vời đã giải cứu những người kiểm tra API.
Khung Karate tuân theo phong cách viết chương trình của Cucumber theo cách tiếp cận BDD. Cú pháp dễ hiểu đối với những người không phải là lập trình viên. Và khung này là công cụ kiểm tra API duy nhất đã kết hợp Tự động hóa API và kiểm tra hiệu suất thành một công cụ độc lập duy nhất.
Khung này cung cấp cho người dùng khả năng thực thi song song các trường hợp kiểm tra và thực hiện JSON & Kiểm tra XML.
Với thông tin này, có thể suy ra một số điểm chính để hiểu rõ hơn về công cụ Karate một cách chi tiết:
- Karate là một khung kiểm tra BDD thay thế của một TDD.
- Nó được thiết kế để dễ dàng cho những người không phải là lập trình viên. Tính năng này là một yếu tố thay đổi cuộc chơi vì nó cho phép nhiều người sử dụng và truy cập hơn bất kể nền tảng kỹ thuật hoặc năng lực của họ.
- Tính năng này sử dụng tệp tính năng Cucumber và ngôn ngữ Gherkins để viết bài kiểm tra. rất dễ hiểu.
Tất cả các tính năng này làm cho nó trở thành một trong những công cụ tự động hóa thuận lợi nhất hiện nay.
Lịch sử khung Karate
Được tạo bởi ' Peter Thomas' vào năm 2017, phần mềm này nhằm mục đích thực hiện thử nghiệmchức năng có sẵn cho tất cả mọi người. Nó được viết bằng Java và hầu hết mọi người mong đợi các tệp của nó cũng ở cùng một ngôn ngữ, tuy nhiên, may mắn thay, không phải vậy.
Thay vào đó, nó sử dụng các tệp Gherkins, là kết quả của mối quan hệ của nó với Khung dưa chuột. Phần mềm tự động hóa là một phần mở rộng của Cucumber, do đó kế thừa việc sử dụng tệp Gherkins trong hoạt động của nó. Sự khác biệt lớn giữa hai loại này là Karate không sử dụng Java trong khi thi, nhưng Cucumber thì có.
Đây chính là lý do tại sao nó phục vụ cho những người không phải là lập trình viên vì cú pháp Gherkins siêu dễ đọc và toàn diện. Đây là lý do Karate phù hợp nhất và được khuyên dùng để tham gia vào thế giới kiểm tra API tự động.
Sau đây là một số tính năng của Khung kiểm tra Karate:
- Sử dụng ngôn ngữ Gherkins dễ hiểu.
- Không yêu cầu kiến thức lập trình kỹ thuật như Java.
- Nó dựa trên các tiêu chuẩn phổ biến của Cucumber.
- Dễ dàng tạo khung.
- Thử nghiệm song song là chức năng cốt lõi do chính Karate cung cấp, do đó chúng tôi không cần phụ thuộc vào Maven, Gradle , v.v.
- Giao diện người dùng để gỡ lỗi Thử nghiệm.
- Gọi một tệp tính năng từ một tệp khác.
- Cung cấp hỗ trợ cho Thử nghiệm trình điều khiển dữ liệu được xây dựng nội bộ, do đó không cần phụ thuộc vào các khuôn khổ bên ngoài.
- Nghỉ ngơi gốc tích hợp sẵnBáo cáo. Ngoài ra, nó có thể được tích hợp với Cucumber để có Báo cáo giao diện người dùng tốt hơn và rõ ràng hơn.
- Cung cấp hỗ trợ nội bộ để chuyển đổi cấu hình giữa các môi trường thử nghiệm khác nhau (QA, Stage, Prod, Pre-Prod).
- Hỗ trợ liền mạch cho tích hợp CI/CD có thể hữu ích.
- Có khả năng xử lý các lệnh gọi HTTP khác nhau:
- Hỗ trợ Web Socket
- Yêu cầu SOAP
- HTTP
- Xử lý cookie trình duyệt
- HTTPS
- Dữ liệu dạng HTML
- Yêu cầu XML
So sánh Karate với Rest-Assured
Rest Assured : Đây là một thư viện dựa trên Java để kiểm tra các dịch vụ REST. Nó sử dụng ngôn ngữ Java để viết các dòng mã. Nó giúp thử nghiệm nhiều danh mục yêu cầu, điều này dẫn đến việc xác minh các kết hợp logic kinh doanh khác nhau.
Khung Karate : Một công cụ dựa trên Cucumber/Gherkins, được sử dụng để thử nghiệm cho SOAP & Các dịch vụ REST.
Bảng sau liệt kê một vài điểm khác biệt nổi bật hơn giữa Yên tâm & Khung Karate:
| S.No | Basis | Khung Karate | Đảm bảo NGHỈ NGƠI |
|---|---|---|---|
| 1 | Ngôn ngữ | Nó sử dụng kết hợp Dưa chuột và Gherkins | Nó sử dụng Ngôn ngữ Java |
| 2 | Kích thước mã | Thông thường, dòng mã ít hơn, vì nó tuân theo cấu trúc giống như Dưa chuột | Dòng mã nhiều hơn vì nó liên quan đếncách sử dụng ngôn ngữ Java |
| 3 | Yêu cầu Kiến thức Kỹ thuật | Những người không phải là lập trình viên có thể dễ dàng viết mã Gherkins | Cần có kiến thức kỹ thuật để viết mã Java |
| 4 | Kiểm tra theo hướng dữ liệu | Cần sử dụng TestNG hoặc tương đương để hỗ trợ tương tự | Có thể sử dụng thẻ nội bộ để hỗ trợ kiểm tra dữ liệu |
| 5 | Nó có cung cấp hỗ trợ cuộc gọi SOAP không | Có, nó có cung cấp | Nó chỉ liên quan đến yêu cầu REST |
| 6 | Thử nghiệm song song | Có, thử nghiệm song song được hỗ trợ dễ dàng với việc tạo báo cáo song song cũng vậy | Không đáng kể. Mặc dù mọi người đã thử làm điều này nhưng tỷ lệ thất bại cao hơn tỷ lệ thành công |
| 7 | Báo cáo | Nó cung cấp báo cáo nội bộ, do đó không cần phụ thuộc vào các plugin bên ngoài. Chúng tôi thậm chí có thể tích hợp nó với plugin báo cáo Cucumber để có giao diện người dùng tốt hơn. | Cần phụ thuộc vào Plugin bên ngoài như Junit, TestNG |
| 8 | Hỗ trợ CSV cho Dữ liệu bên ngoài | Có, từ Karate 0.9.0 | Không, phải sử dụng Mã Java hoặc thư viện |
| 9 | Tự động hóa giao diện người dùng web | Có, có thể Tự động hóa giao diện người dùng web từ Karate 0.9.5 | Không, nó không được hỗ trợ |
| 10 | Lấy mẫu | Given param val1 = ‘name1’
| given().
|
Do đó, như được chứng minh bởi khác biệt ở trên, có thể nói rằng Karate là một trong những môn dễ nhất mà ai cũng có thể làm được.
Các công cụ cần thiết để làm việc với Karate Framework
Bây giờ, vì chúng ta đã có kiến thức cơ bản về Karate Framework đã rõ ràng, chúng ta hãy xem các quy trình và công cụ cần thiết để thiết lập môi trường Karate.
#1) Eclipse
Eclipse là Môi trường phát triển tích hợp được sử dụng trong lĩnh vực lập trình máy tính. Nó chủ yếu được sử dụng cho Lập trình Java. Như đã đề cập trước đó, Karate được viết bằng Java, vì vậy sẽ dễ hiểu hơn tại sao Eclipse là IDE dành cho phần mềm kiểm tra API. Một lý do khác là đây là một công cụ mã nguồn mở và đây là lý do khá thuyết phục để chọn công cụ này.
Lưu ý: Chúng tôi thậm chí có thể sử dụng IntelliJ, Visual Studio và các công cụ khác trình chỉnh sửa có sẵn trên thị trường.
#2) Maven
Đây là công cụ tự động hóa bản dựng được sử dụng chủ yếu để xây dựng các dự án Java. Đó là một cách để thiết lập môi trường Karate và viết mã. Để thiết lập Eclipse của bạn với các yêu cầu Maven, bạn có thể nhấp vào đây để cài đặt Maven.
Trong khi làm việc với Maven, hãy sử dụng các phụ thuộc Maven sẽ giúp bạn hỗ trợ Karate Framework.
Những điều sau đây phụ thuộc sẽ được sử dụng với Maven trong pom.xml.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Lưu ý: Các phiên bản mới nhất có thểcó sẵn trong kho lưu trữ Maven.
#3) Gradle
Gradle là một giải pháp thay thế cho Maven và có thể được sử dụng với dung lượng tương đương. Chúng có những điểm tương đồng và khác biệt nhưng có thể được sử dụng như nhau trong việc thiết lập môi trường cho mã Karate của chúng tôi.
Nó dễ sử dụng hơn, linh hoạt hơn và được khuyến nghị sử dụng khi ứng dụng của chúng tôi có một số yêu cầu quản lý và mô đun hóa với một loạt các plug-in. Mã thiết lập Gradle sẽ giống như thế này,
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Lưu ý: Bạn có thể sử dụng MAVEN hoặc GRADLE.
#4) Thiết lập Môi trường Java trong Hệ thống của bạn
Cần thiết lập môi trường JDK và JRE để bắt đầu với các kịch bản Karate Framework.
Cấu trúc của Kịch bản Kiểm tra Karate
Kịch bản kiểm tra Karate được biết là sở hữu phần mở rộng “.feature”. Tài sản này được thừa hưởng từ Cucumber. Việc tổ chức các tệp theo quy ước Java cũng được cho phép như nhau. Bạn có thể tự do sắp xếp các tệp của mình theo các quy ước của gói Java.
Tuy nhiên, các nguyên tắc của Maven hướng dẫn rằng việc lưu trữ các tệp không phải Java phải được thực hiện riêng. Chúng được thực hiện trong cấu trúc src/test/resources . Và các tệp Java được lưu giữ trong src/main/java .
Nhưng theo những người tạo ra Karate Framework, họ tin tưởng mạnh mẽ rằng chúng tôi giữ cả tệp Java và tệp không phải Java bên cạnh bên. Theo họ, sẽ dễ dàng hơn nhiều để tìm kiếmCác tệp *.java và *.feature khi chúng được giữ cùng nhau, thay vì tuân theo cấu trúc Maven tiêu chuẩn.
Bạn có thể dễ dàng thực hiện điều này bằng cách điều chỉnh tệp pom.xml của mình như sau (Đối với Maven):
src/test/java **/*.java ...
Sau đây là phác thảo về cấu trúc chung của Khung Karate:
Bây giờ, vì Khung Karate này đang được sử dụng tệp Người chạy, tệp này cũng cần có trong Cucumber để chạy các tệp tính năng, vì vậy hầu hết các bài viết sẽ tuân theo các tiêu chuẩn của Cucumber.
Nhưng, không giống như Cucumber, các bước không yêu cầu định nghĩa rõ ràng trong Karate và cái nào , lần lượt, tăng cường tính linh hoạt và dễ dàng hoạt động. Chúng ta không cần thêm keo mà chúng ta thường phải thêm khi làm theo khung Cucumber.
Lớp “Runner” hầu hết được đặt tên là TestRunner.java.
Sau đó, tệp TestRunner.java sẽ có dạng:
import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { }Và nói về tệp .feature , tệp này chứa tất cả các thử nghiệm các tình huống cần được thử nghiệm để đảm bảo rằng API đang hoạt động theo các yêu cầu dự kiến.
Tệp *.feature chung có dạng như hình bên dưới:
Feature: fetching User Details Scenario: testing the get call for User Details Given url '//reqres.in/api/users/2' When method GET Then status 200
Tạo Tập lệnh Kiểm tra Karate Cơ bản Đầu tiên
Phần này sẽ giúp bạn bắt đầu với việc tạo Tập lệnh Kiểm tra đầu tiên của mình, điều này sẽ hữu ích cho bạn trong việc chuyển đổi các API thành một khung Karate.
Trước khi viết kịch bản kiểm tra Karate cơ bản,vui lòng cài đặt các yêu cầu sau trên máy của bạn:
- Eclipse IDE
- Maven. Đặt đường dẫn Maven thích hợp.
- JDK & JRE. Đặt đường dẫn thích hợp.
Chúng ta hãy xem cách tiếp cận từng bước:
#1) Tạo một Dự án MAVEN mới trong Trình soạn thảo Eclipse
- Mở Eclipse
- Nhấp vào Tệp. Chọn Dự án mới.
- Chọn Dự án Maven
- Chọn vị trí Workspace.
- Chọn Archetype (thông thường chúng tôi chọn “ Maven-archetype-quickstart 1.1 ” cho các dự án Maven đơn giản).
- Cung cấp ID nhóm & ID vật phẩm (chúng tôi đã sử dụng các giá trị sau trong ví dụ của mình).
- ID nhóm : Karate
- ID tạo phẩm: KarateTestScriptsSample
- Nhấp vào Kết thúc để hoàn thành thiết lập.
#2) Sau khi được tạo, bây giờ bạn sẽ có thể thấy cấu trúc sau trong cửa sổ Project Explorer.
#3) Bao gồm tất cả các Phần phụ thuộc của bạn.
Bước đầu tiên của chúng tôi, sau khi thiết lập, chúng tôi sẽ bao gồm tất cả các phần phụ thuộc sẽ được yêu cầu cho việc thực hiện. Chúng tôi sẽ giữ tất cả các thẻ trong POM.xml (Giả sử bạn đã biết cách sử dụng POM.xml).
- Mở POM.xml và sao chép mã bên dưới vào thẻ phụ thuộc và lưu tệp tệp.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Nhấp vào đây để xem nguồn.
#4) Hãy suy nghĩ về kịch bản, chúng ta sẽ thử nghiệm cái gì