README
¶
Venom - Executor SSH
Step for execute a script on remote server via ssh
Input
In your yaml file, you can use:
- host mandatory
- command mandatory
- user optional (default is os username)
- password optional (mandatory if no privatekey is found)
- privatekey optional (default is $HOME/.ssh/id_rsa)
Example
name: Title of TestSuite
testcases:
- name: Check if exit code != 1 and echo command response in less than 1s
steps:
- type: ssh
host: localhost:2222
command: echo 'foo'
assertions:
- result.code ShouldEqual 0
- result.timeseconds ShouldBeLessThan 1
Output
executor
systemout
systemerr
err
code
timeseconds
timehuman
- result.timeseconds & result.timehuman: time of execution
- result.executor.executor.script: script executed
- result.err: if exists, this field contains error
- result.systemout: Standard Output of executed script
- result.systemerr: Error Output of executed script
- result.code: Exit Code
Default assertion
result.code ShouldEqual 0
Documentation
¶
Index ¶
Constants ¶
View Source
const Name = "ssh"
Name for test ssh
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Executor ¶
type Executor struct {
Host string `json:"host,omitempty" yaml:"host,omitempty"`
Command string `json:"command,omitempty" yaml:"command,omitempty"`
User string `json:"user,omitempty" yaml:"user,omitempty"`
Password string `json:"password,omitempty" yaml:"password,omitempty"`
PrivateKey string `json:"privatekey,omitempty" yaml:"privatekey,omitempty"`
}
Executor represents a Test Exec
func (Executor) GetDefaultAssertions ¶
func (Executor) GetDefaultAssertions() *venom.StepAssertions
GetDefaultAssertions return default assertions for type exec
func (Executor) Run ¶
func (Executor) Run(testCaseContext venom.TestCaseContext, l venom.Logger, step venom.TestStep) (venom.ExecutorResult, error)
Run execute TestStep of type exec
func (Executor) ZeroValueResult ¶ added in v0.17.0
func (Executor) ZeroValueResult() venom.ExecutorResult
ZeroValueResult return an empty implemtation of this executor result
type Result ¶
type Result struct {
Executor Executor `json:"executor,omitempty" yaml:"executor,omitempty"`
Systemout string `json:"systemout,omitempty" yaml:"systemout,omitempty"`
Systemerr string `json:"systemerr,omitempty" yaml:"systemerr,omitempty"`
Err string `json:"err,omitempty" yaml:"err,omitempty"`
Code string `json:"code,omitempty" yaml:"code,omitempty"`
TimeSeconds float64 `json:"timeseconds,omitempty" yaml:"timeseconds,omitempty"`
TimeHuman string `json:"timehuman,omitempty" yaml:"timehuman,omitempty"`
}
Result represents a step result
Source Files
Click to show internal directories.
Click to hide internal directories.