autotest

• 中文 README

1.Overview

An automated testing framework for API services, such as HTTP and gRPC.

2.Features

• No program development is required, only configuration files need to be written
• You can specify dependencies between testcases
• Testcases without dependencies can be executed concurrently and execute faster
• Use XPath to extract variables for easy writing
• supports importing variables from files and extracting variables from response

3.Something you need to know

XPath Syntax

4.Install

1) use the compiled binary file

release

Obtain the bin file corresponding to the operating system and CPU architecture from the link above

2) compile by yourself

make build

or

go install github.com/vearne/autotest@latest

5.Usage

1) check configuration file

autotest test --config-file=${CONFIG_FILE}

2) execute automated tests

autotest run --config-file=${CONFIG_FILE} --env-file=${ENV_FILE}

3) extract the value corresponding to xpath

autotest extract --xpath=${XPATH} --json=${JSON}

6.Example

1) start a fake http api service

cd ./docker-compose
docker compose up -d

Add

curl -X POST 'http://localhost:8080/api/books' \
--header 'Content-Type: application/json' \
--data '{"title": "book3_title", "author": "book3_author"}'

Delete

curl -X DELETE 'http://localhost:8080/api/books/1'

Modify

curl -X PUT 'localhost:8080/api/books/3' \
--header 'Content-Type: application/json' \
--data '{"title": "book3_title", "author": "book3_author-2"}'

List

curl  'http://localhost:8080/api/books'

2) run automated test cases

autotest run -c=./config_files/autotest.yml -e=./config_files/.env.dev

3) extract the value corresponding to xpath

get the title of each book in the book list

autotest extract -x "//title" -j '[
 {
  "id": 2,
  "title": "Effective Go",
  "author": "The Go Authors"
 },
 {
  "id": 3,
  "title": "book3_title",
  "author": "book3_author-2"
 }
]'

7.Test Report

Report in csv format

Report in html format

8.Advanced Usage

In certain scenarios, we may need to use Lua scripts to generate the request body or to verify whether the response body meets expectations

- id: 6
  desc: "add a new book"
  request:
    # optional
    method: "post"
    url: "http://{{ HOST }}/api/books"
    headers:
      - "Content-Type: application/json"
    luaBody: |
      function body()
        local json = require "json";
        -- the string representation of today's date at 23:59:59.
        local today235959 = os.date("%Y%m%d235959");
        local data = {
          title   = "book4_title-" .. today235959,
          author  = "book4_author"
        };
        return json.encode(data);
      end
  rules:
    - name: "HttpStatusEqualRule"
      expected: 200
    - name: "HttpBodyEqualRule"
      xpath: "/author"
      expected: "book4_author"
    - name: "HttpLuaRule"
      lua: |
        function verify(r)
          local json = require "json";
          local book = json.decode(r:body());
          print("book.title:", book.title);
          print("---1---", 10);
          print("---2---", 20);
          local today235959 = os.date("%Y%m%d235959");
          local title = "book4_title-" .. today235959;
          return book.title == title;
        end

Notice:

• In LuaBody scripts, the form of functions is fixed.

function body()

• In HttpLuaRule.lua scripts, the form of functions is fixed too.

function verify(r)