Skip to content

Commit d9d8ebe

Browse files
committed
Describe basic conceptual ideas of chkware
1 parent fd0432a commit d9d8ebe

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

docs/05-References/050-concepts.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Concepts
3+
---
4+
5+
This page describes some key concepts before you use **`chkware`**.
6+
7+
There are two parts to **`chkware`** tool.
8+
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`.
11+
12+
### Supported sub-commands
13+
14+
- `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.
16+
17+
- `--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.
19+
20+
### Specification files
21+
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.
23+
24+
> In the future evolution path of **chkware** we are going to introduce more and more specification options and specification types and versions.
25+
26+
- [Http specification file](http-reference)

0 commit comments

Comments
 (0)