Skip to content
Permalink
Browse files

doc: fix typos and misspellings (#172)

  • Loading branch information...
NicoPennec authored and bnjjj committed Oct 15, 2018
1 parent 894df3d commit 79db11aaac910a605a4e5f047292b98d5cb6dcf7
Showing with 36 additions and 36 deletions.
  1. +2 βˆ’2 CONTRIBUTING.md
  2. +8 βˆ’8 README.md
  3. +1 βˆ’1 executors/http/README.md
  4. +2 βˆ’2 executors/imap/README.md
  5. +4 βˆ’4 executors/kafka/README.md
  6. +6 βˆ’6 executors/ovhapi/README.md
  7. +8 βˆ’8 executors/redis/README.md
  8. +2 βˆ’2 executors/smtp/README.md
  9. +2 βˆ’2 executors/ssh/README.md
  10. +1 βˆ’1 executors/web/README.md
@@ -16,7 +16,7 @@ pay attention to a few things:

## Submitting Modifications:

The contributions should be github Pull Requests. The guidelines are the same
The contributions should be GitHub Pull Requests. The guidelines are the same
as the patch submission for the Linux kernel except for the DCO which
is defined below. The guidelines are defined in the
'SubmittingPatches' file, available in the directory 'Documentation'
@@ -45,7 +45,7 @@ on patches that are being contributed.
The sign-off is a simple line at the end of the explanation for the
patch, which certifies that you wrote it or otherwise have the right
to pass it on as an open-source patch. The rules are pretty simple:
to pass it on as an open-source patch. The rules are pretty simple:
if you can certify the below:
By making a contribution to this project, I certify that:
@@ -1,6 +1,6 @@
# Venom

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

<img src="./venom.gif" alt="Venom Demonstration" width="80%">
@@ -179,7 +179,7 @@ Builtin variables:
On this new version, venom use the testsuite folder as the basepath instead of location of venom execution.


Considering this workspace :
Considering this workspace:

```yaml
@@ -208,7 +208,7 @@ You must execute venom on the testsuite dir.

On version 2, venom use as basepath the testsuite file. So no matter where you execute venom command, testa.json will be found.

To specify the version 2, add *version* property on the testsuite :
To specify the version 2, add *version* property on the testsuite:

```yaml
@@ -247,7 +247,7 @@ venom run --var-from-file vars.yaml --parallel=5
## RUN Venom, with an export xUnit

```bash
venom run --format=xml --output-dir="."
venom run --format=xml --output-dir="."
```

## Assertion
@@ -372,7 +372,7 @@ func (Executor) Run(ctx context.Context, l venom.Logger, step venom.TestStep) (v
r := Result{
Code: ouputCode, // return Output Code
Command: e.Command, // return Command executed
Systemout: systemout, // return Output string
Systemout: systemout, // return Output string
Executor: e, // return executor, useful for display Executor context in failure
}
@@ -386,9 +386,9 @@ Feel free to open a Pull Request with your executors.

## TestCase Context

TestCase Context allows you to inject datas in all Steps.
TestCase Context allows you to inject data in all steps.

Define a context is optional, but can be useful to keep data between teststeps on a testcase.
Define a context is optional, but can be useful to keep data between test steps on a testcase.

### Write your TestCase Context

@@ -434,7 +434,7 @@ func (tcc *DefaultTestCaseContext) Close() error {
}
```

Methods SetTestCase and GetName are implemented by CommonTestCaseContext
Methods SetTestCase and GetName are implemented by CommonTestCaseContext

# Dependencies

@@ -6,7 +6,7 @@ Step for execute a HTTP Request
In your yaml file, you can use:

```yaml
- method optional, default value : GET
- method optional, default value: GET
- url mandatory
- path optional
- body optional
@@ -1,6 +1,6 @@
# Venom - Executor IMAP

Use case: your software send a mail ?
Use case: your software send a mail?
Venom can test if mail is received. Body of mail can be reused in further steps.

## Input
@@ -40,7 +40,7 @@ Input must contain at least one of searchfrom, searchto, searchsubject or search

## Output

* result.err is there is an arror.
* result.err is there is an error.
* result.subject: subject of searched mail
* result.body: body of searched mail

@@ -1,6 +1,6 @@
# Venom - Executor Kafka

Step to use read / write on a kafka topic.
Step to use read / write on a Kafka topic.

## Input
In your yaml file, you can use:
@@ -14,7 +14,7 @@ In your yaml file, you can use:
- user optional
- password optional
- client_type mandator : producer or consumer
- client_type mandator: producer or consumer
# for consumer client type:
- group_id mandatory
@@ -30,15 +30,15 @@ In your yaml file, you can use:
```

Example :
Example:

```yaml
name: My Kafka testsuite
version: "2"
testcases:
- name: Kafka test
description: Test kafka
description: Test Kafka
steps:
- type: kafka
clientType: producer
@@ -1,17 +1,17 @@
# Venom - Executor OVHAPI

Step to test ovh api
Step to test OVH API

Use case: you software need to make call to OVH api.<br>
You will need ovh credentials to make api call. Please follow this tutorial to get all needed keys : <br>
FR : https://www.ovh.com/fr/g934.premiers_pas_avec_lapi <br>
EN : https://api.ovh.com/g934.first_step_with_api
Use case: you software need to make call to OVH API.<br>
You will need OVH credentials to make API call. Please follow this tutorial to get all needed keys: <br>
FR: https://www.ovh.com/fr/g934.premiers_pas_avec_lapi <br>
EN: https://api.ovh.com/g934.first_step_with_api

## Input
In your yaml file, you can use:

```
- method optional, default value : GET
- method optional, default value: GET
- path mandatory, example "/me"
- noAuth optional
- body optional
@@ -1,18 +1,18 @@
# Venom - Executor Redis

Step to execute command into redis
Step to execute command into Redis

Use case: your software need to make call to a redis.
Use case: your software need to make call to a Redis.


## Input

In your yaml file, you can use:

- context : required. Must contains dialURL property. DialURL connects to a Redis server at the given URL using the Redis URI scheme.
- context: required. Must contains dialURL property. DialURL connects to a Redis server at the given URL using the Redis URI scheme.
URLs should follow the draft IANA specification for the scheme (https://www.iana.org/assignments/uri-schemes/prov/redis).
- commands : an array of redis command
- path : a file which contains a series of redis command. See example below.
- commands: an array of Redis command
- path: a file which contains a series of Redis command. See example below.

If path property is filled, commands property will be ignored.

@@ -77,8 +77,8 @@ result.executor
result.commands
```

- result.executor.commands contains the list of redis command
- result.executor.commands contains the list of Redis command
- result.executor.FilePath contains the path of file

- result.commands contains the list of executed redis command
- result.commands.commandI.response represents the response of redis command. It can be an array or a string, depends of redis command
- result.commands contains the list of executed Redis command
- result.commands.commandI.response represents the response of Redis command. It can be an array or a string, depends of Redis command
@@ -2,7 +2,7 @@

Step for sending SMTP

Use case: you software have to check mails for doing something with them ?
Use case: you software have to check mails for doing something with them?
Venom can send mail then execute some tests on your software.

## Input
@@ -28,7 +28,7 @@ testcases:

## Output

Noting, except result.err is there is an arror.
Nothing, except result.err is there is an error.

## Default assertion

@@ -1,6 +1,6 @@
# Venom - Executor SSH

Step for execute a script on remote server via ssh
Step for execute a script on remote server via SSH


## Input
@@ -10,7 +10,7 @@ In your yaml file, you can use:
```yaml
- host mandatory
- command mandatory
- user optional (default is os username)
- user optional (default is OS username)
- password optional (mandatory if no privatekey is found)
- privatekey optional (default is $HOME/.ssh/id_rsa)
```
@@ -2,7 +2,7 @@

Navigate in a web application

Use case: You have a web application and you want to check some behaviours ?
Use case: You have a web application and you want to check some behaviours?
Venom allows you to navigate into it and execute actions.

## Input

0 comments on commit 79db11a

Please sign in to comment.
You can’t perform that action at this time.