Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jcran committed Jul 4, 2012
1 parent e52c7a3 commit 65d2d04
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 2 deletions.
1 change: 0 additions & 1 deletion README

This file was deleted.

25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
== Metacuke

=== About

The Metacuke project brings together the awesome Metasploit Framework and the excellent Cucumber regression testing framework. It makes it possible to write plain-english tests for your infrastructure which are backed by Metasploit. For example, you can write a test:

Scenario: Check default logins
Given I have a list of default systems
And I have a list of default usernames and passwords
And I check for valid logins via http
Then I should have 0 valid logins

=== Getting Started

Metacuke can be installed by pulling down the repository from Github (https://github.com/jcran/metacuke)

Metacuke must be pointed at an instance of the Metasploit Framework RPC service. You can edit the configuration in the config/metacuke.config file. A sample has been provided in the config/ directory.

Once the config file has been edited, you must write tests for your infrastructure. You can find samples in the features/ directory.

=== Advanced

For more information on Metasploit, see: http://www.metasploit.com/

For more information on Cucumber, see: http://cukes.info/
1 change: 0 additions & 1 deletion utils/configure.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
FileUtils.mkdir(env_path) unless File.directory? env_path
FileUtils.mkdir(data_path) unless File.directory? data_path


#
# Populate known nets
#
Expand Down

0 comments on commit 65d2d04

Please sign in to comment.