Merge pull request #65 from chkware/release/v0.4.3

Release: v0.4.3

Author: 0hsn

docs/examples/http-examples.md

@@ -53,7 +53,7 @@ request:
 
   # get only response code
 expose:
-  - $_response.code
+  - "{$_response.code}"
 ```
 
 ### Request with query string and header
@@ -189,7 +189,8 @@ request:
     photo: file:///home/username/student-photo-01.png
 
 # get only response body; response headers, code, etc will be dropped
-expose: $_response.body
+expose:
+  - "{$_response.body}"
 ```
 
 ### Request with file upload

docs/examples/testcase-examples.md

@@ -6,10 +6,13 @@ title: Testcase examples
 
 - This page should be use as reference for specification files.
 - This page is subject to change. It is requested to check this page frequently.
-  :::
+
+:::
 
 :::note
+
 Case-wise more example can be found in [https://github.com/chkware/cli](https://github.com/chkware/cli/blob/main/tests/resources/storage/sample_config/bitcoin-usd-testcase.chk) repository
+
 :::
 
 [Testcase specification document reference](/references/testcase-reference)
@@ -27,8 +30,8 @@ request:
 
 spec:
   asserts:
-    - { type: AssertEqual, actual: $_response.code, expected: 201 }
-    - { type: AssertIsMap, actual: $_response.body }
+    - { type: AssertEqual, actual: "{$_response.code}", expected: 201 }
+    - { type: AssertIsMap, actual: "{$_response.body}" }
 ```
 
 The above testcase spec. doc define a request that makes a `POST` call to `https://reqres.in/api/users` URL with a body `{"name": "My Name", "job": "My Job"}`.
@@ -46,7 +49,7 @@ Assertion [reference with examples](/references/testcase-reference#assertions) c
 
 ### A minimal Testcase with out-file request
 
-A http spec. doc can be written on separate file, that does same as above request. Let's call it `same-request.chk`. The http spec. doc by default exposes `$_response` object.
+A http spec. doc can be written on separate file, that does same as above request. Let's call it `same-request.chk`. The http spec. doc by default exposes `_response` object.
 
 ```yaml
 # file: same-request.chk
@@ -70,11 +73,11 @@ spec:
   execute:
     file: "./same-request.chk"
   asserts:
-    - { type: AssertEqual, actual: $_response.code, expected: 201 }
-    - { type: AssertIsMap, actual: $_response.body }
+    - { type: AssertEqual, actual: "{$_response.code}", expected: 201 }
+    - { type: AssertIsMap, actual: "{$_response.body}" }
 ```
 
-Please notice the `$_response` in the testcase doc. This variable is available after the request gets executed as local variable.
+Please notice the `_response` in the testcase doc. This variable is available after the request gets executed as local variable.
 
 ### A Testcase with out-file request passing data
 
@@ -92,7 +95,7 @@ variables:
 request:
   url: "https://reqres.in/api/users"
   method: POST
-  body[json]: { "name": $name, "job": $job }
+  body[json]: { "name": "{$name}", "job": "{$job}" }
 ```
 
 Now we can point out which value we want to pass using `with` statement in `execute` block.
@@ -109,8 +112,8 @@ spec:
       name: Her Name
       job: Her Job
   asserts:
-    - { type: AssertEqual, actual: $_response.code, expected: 201 }
-    - { type: AssertIsMap, actual: $_response.body }
+    - { type: AssertEqual, actual: "{$_response.code}", expected: 201 }
+    - { type: AssertIsMap, actual: "{$_response.body}" }
 ```
 
 Please notice that if we do not set a `with` then request will be sent with default value.

docs/examples/variable-examples.md

@@ -6,18 +6,19 @@ title: Variable examples
 
 - This page should be use as reference for specification files.
 - This page is subject to change. It is requested to check this page frequently.
-  :::
+
+:::
 
 :::note
+
 Case-wise more example can be found in [https://github.com/chkware/cli](https://github.com/chkware/cli/tree/main/tests/resources/storage/sample_config/pass_cases/variables) repository
+
 :::
 
 [Variable specification document reference](/references/variable-reference)
 
 We can also use variables inside a http and testcase specification file. See examples below.
 
-** \* This is highly experimental. Report any bug you can find.**
-
 ### Request with query string using variables
 
 ```yaml
@@ -26,15 +27,14 @@ version: default:http:0.7.2
 
 # define local variables
 variables:
-  Foo: 'bar'
+  Foo: "bar"
   Two: 2
   Server: https://example.org/api
 
 request:
   # put variables on the path for query string
-  url: {$Server}/path?foo={$Foo}&two={$Two}
+  url: "{$Server}/path?foo={$Foo}&two={$Two}"
   method: GET
-
 ```
 
 ### Request with basic authentication header using variables
@@ -51,17 +51,16 @@ variables:
   Server: https://example.org/api
 
 request:
-  url: {$Server}/resource/id
+  url: "{$Server}/resource/id"
   method: GET
 
   headers:
     Accept-Encoding: gzip, deflate
-    Content-Type: {$content_type}
+    Content-Type: "{$content_type}"
 
   auth[basic]:
-    username: {$userName}
-    password: {$password}
-
+    username: "{$userName}"
+    password: "{$password}"
 ```
 
 ### Testcase using variables
@@ -73,21 +72,18 @@ version: "default:testcase:0.7.2"
 variables:
   Name: "Morpheus"
   Job: "leader"
-  Response: ~
   Server: https://reqres.in/api/v1
 
 request:
   url: "{$Server}/users"
   method: POST
-  body[json]: { "name": $Name, "job": $Job }
-  return: ~
+  body[json]: { "name": "{$Name}", "job": "{$Job}" }
 
 spec:
   execute:
     file: ~
-    result: $Response
 
   asserts:
-    - { type: AssertEqual, actual: $Response.code, expected: 201 }
-    - { type: AssertIsMap, actual: $Response.body }
+    - { type: AssertEqual, actual: "{$_response.code}", expected: 201 }
+    - { type: AssertIsMap, actual: "{$_response.body}" }
 ```

docs/quick-start.md

@@ -6,7 +6,8 @@ title: Quick Start
 
 - **Prerequisite**: First, [setup **CHKware**](/setup) to continue
 - Find [More `http` examples](/examples/http-examples) here
-  :::
+
+:::
 
 ### Sample
 
@@ -25,8 +26,8 @@ Let's call an API that returns current bitcoin price in USD, and test it. Please
 
   spec:
     asserts:
-      - { type: AssertEqual, actual: $_response.code, expected: 200 }
-      - { type: AssertIsInt, actual: $_response.body.coin.priceBtc }
+      - { type: AssertEqual, actual: "{$_response.code}", expected: 200 }
+      - { type: AssertIsInt, actual: "{$_response.body.coin.priceBtc}" }
   ```
 
 - Hit enter after writing following command on terminal
@@ -45,8 +46,8 @@ Let's call an API that returns current bitcoin price in USD, and test it. Please
   - Prepare exposable [Success]
 
   ---
-  -> Running `AssertEqual` on `$_response.code` [Success]
-  -> Running `AssertIsInt` on `$_response.body.coin.priceBtc` [Success]
+  -> Running `AssertEqual` on `{$_response.code}` [Success]
+  -> Running `AssertIsInt` on `{$_response.body.coin.priceBtc}` [Success]
   ```
 
 - Congratulation! You have just tested an API. :wink::tada::confetti_ball: