tesults 1.0.0

Upload test results to Tesults
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# tesults

Rust library for uploading test results to [Tesults](https://www.tesults.com).

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
tesults = "1"
```

## Usage

```rust
use tesults::{Case, Data};

fn main() {
    let tc = Case {
        name:   "Test 1".into(),
        suite:  "Suite A".into(),
        result: "pass".into(),
        ..Default::default()
    };

    let data = Data {
        target: "your-target-token".into(),
        cases:  vec![tc],
        ..Default::default()
    };

    let r = tesults::upload(data);
    println!("Success: {}", r.success);
    println!("Message: {}", r.message);
    println!("Warnings: {}", r.warnings.len());
    println!("Errors: {}", r.errors.len());
}
```

## API

### `tesults::upload(data: Data) -> Response`

#### `Case` fields

| Field        | Type                        | Required | Description                         |
|--------------|-----------------------------|----------|-------------------------------------|
| name         | String                      | yes      | Test case name                      |
| result       | String                      | yes      | `"pass"`, `"fail"`, or `"unknown"`  |
| suite        | String                      | no       | Suite / group name                  |
| desc         | String                      | no       | Description                         |
| reason       | String                      | no       | Failure reason                      |
| raw_result   | String                      | no       | Raw result from the framework       |
| start        | i64                         | no       | Start time — ms since epoch         |
| end          | i64                         | no       | End time — ms since epoch           |
| files        | Vec\<String\>               | no       | Absolute paths to files to upload   |
| params       | HashMap\<String, String\>   | no       | Parametrised test values            |
| custom       | HashMap\<String, String\>   | no       | Custom fields (stored with `_` prefix) |
| steps        | Vec\<Step\>                 | no       | Test steps                          |

#### `Step` fields

| Field  | Type   | Description              |
|--------|--------|--------------------------|
| name   | String | Step name                |
| result | String | `"pass"`, `"fail"`, or `"unknown"` |
| desc   | String | Step description         |
| reason | String | Failure reason           |

#### `Response` fields

| Field    | Type          | Description                    |
|----------|---------------|--------------------------------|
| success  | bool          | `true` if upload succeeded     |
| message  | String        | Status message                 |
| warnings | Vec\<String\> | File upload warnings           |
| errors   | Vec\<String\> | Upload errors                  |

## License

MIT