Skip to content

Commit e55fb99

Browse files
committed
updated core concepts
1 parent a7c2228 commit e55fb99

1 file changed

Lines changed: 23 additions & 7 deletions

File tree

docs/05-References/050-concepts.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,42 @@
11
---
2-
title: Concepts
2+
title: Core concepts and usage
33
---
44

55
This page describes some key concepts before you use **`chkware`**.
66

77
There are two parts to **`chkware`** tool.
88

9-
1. The command line tool `chk`, that you can run. `chk` supported sub-commands are listed below.
10-
2. The specification files those contains configuration in _YAML based dsl_. These files have extension `.chk`.
9+
1. The command line tool `chk`, that you can run. `chk` [supported sub-commands](#supported-sub-commands) are listed below.
10+
2. The [specification files](#specification-files) those contains configuration in _YAML based dsl_. These files have extension `.chk`.
1111

1212
### Supported sub-commands
1313

1414
- `chk http [--result] [FILE].chk`
15-
> Purpose of this sub command is to run a spec. file written in format supported by [http spec. file](http-reference). After you execute this command `chk` should make request by given request format, and display the response. You can also customize the response with `request`.`result` key.
15+
16+
This sub command runs a file written in [http specification file](http-reference) format.
17+
18+
After you execute this command `chk` should make request by given request format, and display the response. You can also customize the response with `request.result` key. see [usage](/Examples/http-examples#request-with-form) and [documentation](/References/http-reference).
1619

20+
**[Options]**
1721
- `--result` <small>***optional***</small>: When you put this option, the you'll see only the result.
18-
- `[FILE].chk` <small>***required***</small>: File that you want to execute. See below for details.
22+
23+
**[Arguments]**
24+
- `[FILE].chk` <small>***required***</small>: File that you want to execute.
25+
26+
- `chk testcase [FILE].chk`
27+
28+
This sub command runs a file written in [testcase specification file](testcase-reference) format.
29+
30+
After you execute this command `chk` should re-use `http` utility to request as per given structure on the file, execute test assertions, and display the result of the assertions. See [example](/Examples/testcase-examples).
31+
32+
**[Arguments]**
33+
- `[FILE].chk` <small>***required***</small>: File that you want to execute.
1934

2035
### Specification files
2136

22-
Test specification files are written in YAML, having file extension `.chk`. So, before you start writing any specification file, you should have a proper introduction to YAML, if you do not have already. Here is a fine [YAML cheatsheet](https://quickref.me/yaml) to grasp some knowledge. We are using this specific extension (`.chk`) so these files do not make you confuse in typical project layout.
37+
Test specification files are written in YAML, having file extension `.chk`. So, before you start writing any specification file, you MUST have a proper knowledge of YAML, see [YAML cheatsheet](https://quickref.me/yaml). We are using this specific extension (`.chk`) so these files do not make you confuse in typical project layout.
2338

2439
> In the future evolution path of **chkware** we are going to introduce more and more specification options and specification types and versions.
2540
26-
- [Http specification file](http-reference)
41+
- [Http specification file](http-reference)
42+
- [Testcase specification file](testcase-reference)

0 commit comments

Comments
 (0)