Skip to content

Commit

Permalink
doc: copyright 2021 (#356)
Browse files Browse the repository at this point in the history
Signed-off-by: Yvonnick Esnault <[email protected]>
  • Loading branch information
yesnault authored Jan 18, 2021
1 parent fc69bc1 commit ae793f2
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 🐍 Venom

Venom run executors (script, HTTP Request, etc. ) and assertions.
It can also output xUnit results files.
Venom execute "executors" (script, HTTP Request, etc. ) and assertions.
It can also generate xUnit result files.

<img src="./venom.gif" alt="Venom Demonstration">

Expand Down Expand Up @@ -95,7 +95,7 @@ $ docker run -it $(docker build -q .) --rm -v $(pwd)/outputs:/outputs -v $(pwd):

# TestSuites

A test suite is a collection of test cases that are intended to be used to test a software program to show that it has some specified set of behaviours.
A test suite is a collection of test cases that are intended to be used to test a software program to show that it has a specified set of behaviors.
A test case is a specification of the inputs, execution conditions, testing procedure, and expected results that define a single test to be executed to achieve a particular software testing objective, such as to exercise a particular program path or to verify compliance with a specific requirement.

In `venom` the testcases are executed sequentially within a testsuite. Each testcase is an ordered set of steps. Each step is based on an `executor` that enable some specific kind of behavior.
Expand Down Expand Up @@ -408,9 +408,6 @@ Available formats: jUnit (xml), json, yaml, tap reports
* ShouldHappenOnOrAfter - [example](https://github.com/ovh/venom/tree/master/tests/assertions/ShouldHappenOnOrAfter.yml)
* ShouldHappenBetween - [example](https://github.com/ovh/venom/tree/master/tests/assertions/ShouldHappenBetween.yml)

Most assertion keywords documentation can be found on https://pkg.go.dev/github.com/ovh/venom/assertions.


# Advanced usage
## Debug your testsuites

Expand Down Expand Up @@ -505,7 +502,7 @@ $ make build

# License

Copyright 2020 OVH SAS
Copyright 2021 OVH SAS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down

0 comments on commit ae793f2

Please sign in to comment.