如何使用PieceofScript“ bike”开发和测试API

• 以几乎自然的语言描述YAML格式的API方法，并以该方法的名称来表示，这便于阅读测试
• 足够灵活以YAML格式描述模型并从中生成随机数据
• 用简单易懂的语言和简单的语法编写复杂的API调用脚本
• 获得JUnit和HTML格式的测试结果

测试项目，其结构和启动

./tests endpoints.yaml -  API generators.yaml -  start.pos -    

 pos.phar run ./start.pos --junit=junit_report.xml -vvv --config=config.yaml 

测试脚本

 require "./globals.pos" //    ,  $domain include "./globals_local.pos" //     ,    include "./user/*.pos" //       ./user  ./post include "./post/*.pos" //       var $author = User() var $reader = User() var $banned = User() var $post = Post() Register $author //   API,     must $response.code == 201 //     Register $reader must $response.code == 201 Register $banned must $response.code == 201 Add $banned to blacklist of $author //$banned      $author Create post $post by $author //   API   must $response.code == 201 //    API   201 // ...,   ,       assert $response.body.post.content == $post.content var $postId = $response.body.post.id // Id     Read post $postId by $author //     must $response.code == 200 assert $response.body.post.content == $post.content Read post $postId by $reader //      must $response.code == 200 assert $response.body.post.content == $post.content Read post $postId by $banned //        assert $response.code == 404 

 >Include $user to group $userGroup 

 var $n = 20 var $i = 2 var $fib1 = 1; \ $fib2 = 1 while $i <= $n var $fib_sum = \ $fib2 + $fib1 print toString($i) + "  :" + \ toString($fib_sum) var $fib1 = $fib2 var $fib2 = $fib_sum var $i = $i + 1 

运营商完整列表

API测试方法

 Auth $user: method: "POST" url: $domain + "/login" headers: Content-Type: "application/json" format: "json" data: login: $user.login password: $user.password after: - assert $response.code == 200 - let $user.auth_token = $response.body.auth_token Create post $post by $user: method: "POST" url: $domain + "/posts" format: "json" data: $post headers: auth: "Bearer " + $user.auth_token content-type: "application/json" after: - assert $response.code == 201 Read post $postId by $user: method: "GET" url: $domain + "/posts/" + $postId headers: auth: "Bearer " + $user.auth_token content-type: "application/json" after: - assert ($response.code == 200) || ($response.code == 404) Create comment $comment on $post by $user: method: "POST" url: $domain + "/comments/create/" + $post.id format: "json" data: $comment headers: auth: "Bearer " + $user.auth_token content-type: "application/json" after: - assert $response.code == 201 

 Get comments of $post {{$page=1; $perPage=$defaultGlobalPageSize}}: method: "GET" url: $domain + "/comments/" + $post.id query: page: $page per_page: $perPage headers: auth: "Bearer " + $user.auth_token content-type: "application/json" after: - assert $response.code == 200 

 Get comments of $newPost //     $page  $perPage Get comments of $newPost {{$page=$currentPage+1}} Get comments of {$newPost} {{$perPage=10;$page=100}} 

API方法描述字段

 auth: login: $login password: $password type: "basic" //  "digest"  "ntlm", - "basic" 

• 无 -请求没有内文
• json-发送到JSON
• raw-按原样发送字符串
• 表格 -应用程式/ x-www-form-urlencoded格式
• 多部分 -多部分/表单数据格式

• 如果没有 -可能缺少数据格式（如果存在），将被忽略
• 对于json格式，任何值
• 对于原始格式，任何标量值
• 对于表单格式，其键为字段名称的数组：
  
  

   data: login: "Bob" password: $password remember_me: 1 

• 对于多部分格式，具有以下结构的数组：
  
  

   data: user_id: value: 42 headers: X-Baz: "bar" avatar: file: "/path/to/file" photo: file: "http://url.to/file" filename: "custom_filename.jpg" 

API方法调用

 Create comment $comments.1 on {$newPost} by {$postAuthor} 

 Create comment {$comments[$i]} on $posts.0 by $users.1 Read post {123} by $user Get comments of $users.1.id {{$page = 2}} 

$请求结构

$响应结构

模型和测试数据的生成

 User: body: login: Faker\login() name: Faker\name() email: Faker\email() password: Faker\text(16) child: Child() birthday: dateFormat(Faker\datetime(), "U") settings: notifications_enabled: Faker\boolean() Child: body: name: Faker\name() gender: Faker\integer(1, 2) age: Faker\integer(0, 18) Comment($user): body: content: "Hi! I'm " + $user.name tags: - "tag1" - "tag2" 

 { "login": "fgadrkq", "name": "Lucy Cechtelar", "email": "tkshlerin@collins.com", "password": "gbnaueyaaf", "child": { "name": "Adaline Reichel", "gender": 2, "age": 12 }, "birthday": 318038400, "settings": { "notifications_enabled": true } } 

 # Userredentials     $user Userredentials($user): body: login: $user.email password: $user.password #    .     ,    GlobalSearchResult($posts, $comments, $users): body: posts: title: " " list: $posts comments: title: " " list: $comments users: title: " " list: $users 

 #      ,    , #    InvalidUser($user): body: $user replace: email: Faker\String(6, 15) #   password: Faker\String(1, 5) #    new_field: "      ,  " remove: name: size($user.name) < 10 #  ,    10  #      , #        InvalidNewUser: body: User() replace: login: "!@#$%^&*" #   remove: about: true settings: notifications: 100500 #       , #      true 

内建功能

变量操作：

使用字符串：

数组处理：

日期处理：

随机测试数据生成：

测试用例

 testcase Registration $device //     var $user = User() Register $user on $device assert $response.code == 201 //        var $user = User() //       InvalidUser() var $user.email = "some_bad_email" Register $user on $device assert $response.code == 400 

 run Get all users //   -,    run Get user $user_id //   -   run //   -,     

变量和范围

 const $a = 1 let $a = 2 //    var $b = 1 const $b = 3 //    const $c = 3; $c = 4 //   , $c      

 let $a = 1; $a = $a + 1; $a = $a + 2 print $a // 4 

 Testcase Context example changes $argument1, $argument2 and $argument3 var $a = "changed" let $b = "changed" const $c = "changed" import $i let $i = "changed" var $argument1 = "changed" var $argument2 = "changed" var $argument3 = "changed" // ,     var $a = "original" var $b = "original" var $i = "original" const $c = "original"; var $paramByRef = "original" var $paramByVal = "original" const $paramConst = "original" run Context example changes $paramByRef, {$paramByVal} and $paramConst //  $a     - print $a // "original" // $b     -,  let    $b print $b // "changed" // $i      print $i // "original" //      ,  var   print $c // "original" //     print $paramByRef // "changed" //     print $paramByVal // "original" //     ,     print $paramConst // "original" 

类型系统和操作

 let $a.1 = 100 let $i = 1 let $a[$i + 1] = 200 let $a.sum = $a.1 + $a.2 print " "; $a.sum //  300 var $b = array(true, 3, $a, "Hi") // [true, 3, {1: 100, 2: 200, "sum":300}, "Hi"] 

检查变量的存在和类型

• 一个字符串，其名称为变量类型或数组元素的类型（如果使用键）；
• 如果在可访问的上下文中找不到变量，或者数组中具有指定键的元素不存在，则返回null。

 var $a.string_field = "Hello World" var $a.number_field = 3.14 var $a.bool_field = true var $a.date_field = '+1 day' var $a.null_field = null var $a.array_field = array(1, "2") assert @a.string_field == "String" assert @a.number_field == "Number" assert @a.bool_field == "Boolean" assert @a.date_field == "Date" assert @a.null_field == "Null" assert @a.array_field == "Array" assert @a.array_field.0 == "Number" assert @a.array_field.1 == "String" assert @a.array_field.2 == null assert @notExistedVar == null 

 assert @comment.optional_field && $comment.optional_field > 20 

运行之间保存数据

 pos.phar run ./start.pos --storage=storage.yaml 

输出到标准输出

 pos.phar run ./start.pos --junit=junit_report.xml --html=report.html 

例子

病毒总数

 pos.phar run ./Virustotal/start.pos 

糕点店

 pos.phar run ./Pastery/start.pos 

里克与弗洛里

 pos.phar run ./RickAndMorty/20MinutesTest.pos 

未来的评论和计划（如果有）