Skip to content

Slowhand0309/recot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

87 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Recot

Ruby evidence collect tool

Recot is a tool to gather evidence of the test.

Gem Version Build Status

Description

Create evidence document for test to easy.
Throw evidence(screen shots or file...) to specific folder for create evidence document.

Install

Install the gem with:

gem install recot

Usage

Recot command

$ rect <command>
Command Description
start Start recot to collect evidence.
export Export to another format.
cleanup Clean up cache.
destroy Delete all file.

If you want to export to another format, run the following command:

$ recot export

※ Yet now, .xlsx format only

If you want to delete cacche. run the following command:

$ recot cleanup

If you want to delete all file and directory, run the following command:

$ recot destroy
Sure you want to delete all the files? [y/N] > y
Removed all dependency files.

Start recot

To begin the test with the following command:

$ recot start
Start recot ver 0.2.2

    ____                  __
   / __ \___  _________  / /
  / /_/ / _ \/ ___/ __ \/ __/
 / _, _/  __/ /__/ /_/ / /
/_/ |_|\___/\___/\____/\__/
Options

recot start command has the following options:

Option Command Description Default
port -p, --port Set server port. 9292
open -o, --open Open top page by default browser. nil
Interactive command

Enter the test number as follows:

[1](recot) > A1

Directory corresponding to the test number is created under __output/resources.

├── __output
│   └── resources
│       ├── A1

It threw the evidence to the basket directory.

It will be reflected in the HTML automatically.

├── __output
│   ├── index.html
│   └── resources
│       ├── A1
│       │   ├── access.log
│       │   └── screenshot.png
│       └── A1.html

access the http://localhost:9292/__output/index.html

  • index.html img001

  • resource.html img002

When you click the image to display the popup. img003

If you want to output the contents of the clipboard as a log, run the following command:

[2](recot) > paste <filename>

e.g.

※ State that has already been copied to the clipboard.

[1](recot) > A100
[2](recot) > paste copy.log

copy.log is output to the location of the __output/resource/A100/.

If you want to delete the previous evidence, run the following command:

[2](recot) > cancle

If you want to delete all the evidence of the particular test number, run the following command:

[3](recot) > clear

If you want to test the end, run the following command:

[4](recot) > exit

Configuration

Can be configured in config.yml under the directory from which you started recot.

Themes

You can select a theme from the following:

  • white img002

  • dark img004

  • light img005

  • moon img006

  • sky img007

Set the following in config.yml.

theme: "white"

ProjectName

You can set a project name for evidecnce.

Set the following in 'config.yml'.

project_name: "Your project name"

Licence

MIT

Author

slowhand0309