TEUTON

Test your infrastructure as code.

The infrastructure test is useful for:

• Sysadmin teachers who want to evaluate students remote machines.
• Students who want to evaluate their learning process.
• Professionals who want to monitor their remote machines.

Installation

Install Ruby and then:

gem install teuton

Quickstart

Create your test file:

# File: examples/102-target/start.rb 
group "Practicing targets" do
  target "Create user obiwan"
  run "id obiwan"
  expect ["uid=", "(obiwan)", "gid="]

  target "Delete user vader", weight: 2
  run "id vader"
  expect_fail
end

play do
  show
  export
end

Usage: Run test with teuton run TESTPATH.

$ teuton examples/102-target 
 
 ☰ CASE RESULTS
┌──────┬───────────┬───────┬───────┐
│ CASE │ MEMBERS   │ GRADE │ STATE │
│ 01   │ anonymous │ 67.0  │       │
└──────┴───────────┴───────┴───────┘

Output: reports saved into var/102-target folder.

$ tree var 
var
└── 102-target
    ├── case-01.txt
    ├── moodle.csv
    └── resume.txt

Consult the generated output files

Features

• Use simple DSL to define your tests: target, run,expect and more.
• Remote devices only require SSH or Telnet service installed.
• Output format: txt, html, json, yaml, markdown, etc.
• Multiplatform.
• Free Software License.

Documentation

1. Installation
   • Teuton installation
   • SSH/Telnet installation
   • Modes of use: Classroom, contest, standalone.
2. Teuton commands
   • teuton config: suggest config file.
   • teuton check: check test syntax.
   • teuton doc: generate test documentation.
   • teuton help: show command help.
   • teuton new: create new test.
   • teuton run: run test.
3. Learning guide with examples.
   • Basic
     • Create NEW test
     • Evaluate TARGET
     • Check REMOTE HOSTS
     • Read CONFIG file
     • Target WEIGHT
     • SEND report copies to remote hosts
   • Medium
     • USE several files
     • CHECK test syntax
     • DEBUG results
     • UNIQUE values
     • INCLUDE more configuration files
     • Zero weight target
     • Negative weight target
   • Output: reports, logs and docs.
     • LOG messages
     • Export other FORMATS
     • Build DOC from test
     • PRESERVE old reports
     • Hide FEEDBACK from reports
     • MOODLE
   • Execution: Runs, expects, etc
     • Checking exit codes
     • RESULT object
     • expect vs result
     • EXPECT_SEQUENCE
     • RUN_SCRIPT
     • UPLOAD
   • Events
     • EVENT stop
     • EVENT scores to zero
     • EVENT zero and stop
     • EVENT all targets
   • Tutorials
     • How to test code
     • How to test SQL and database
   • Experimental
     • Don't get params, just read vars
     • ALIAS
     • MACROS
4. Configuration file: Reserved params, configure hosts, etc.
5. Language reference. DSL used to define tests.
   • expect: check run output with expectations.
   • export: save evaluation reports.
   • event: execute action when conditions are met.
   • get: read config params.
   • group: group targets.
   • play: starts main execution.
   • result: contains run output.
   • run: execute command on local/remote host.
   • send: send reports into remote machines.
   • set: write new param.
   • show: show progress on screen.
   • target: define new target.
6. More information

Contact

• Email: teuton.software@protonmail.com

Contributing

1. Make sure you have Ruby installed
2. Fork it
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create new Pull Request.

You can also create issues with your requests, incidences or suggestions.