tdi 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50bf92ccfb7cc658a5a734efa85932db69753365
-  data.tar.gz: 32f570d77ed29658de6fe18e400de8c33afe91ba
+  metadata.gz: 47c8026be31f39925f4b22a48afdd0070a0c0d39
+  data.tar.gz: 0c1286f06d7550f8a39b370afffecfaeaaafb5bc
 SHA512:
-  metadata.gz: d8821a6917ef8d92a3d97e93450eab9336fa1ab8cb09be4bd35fbb2cd65675374b80abb295cfe82e99be3de38617c6967154f283cce1e8ef97433efe9e48fa5d
-  data.tar.gz: ba7ba56c8af689897f311e93dbe6b5158221254c087939e413ebf698def05b975b812ff406b39b6d9942f72e27ad729b0f70b5d6b500b4cae9ccde0f54fb266c
+  metadata.gz: dba228dc172403647f00af1b49777b0ed7282ddb6dd368a2c3ece1f99a9598350bf1af368db8e5fc35ae5eff57712aa189c13cada7b8cf1e082565afb773a167
+  data.tar.gz: 4166852fd8e3059b7848d0fcaf948caa879ec910b8eab6440c761e1fbd2624a727bef55258b2d39ee4f8aa15e66f5bcf3240bce5fbcaf9109c3487d8c83ebad8

data/.gitignore

@@ -6,7 +6,6 @@
 InstalledFiles
 _yardoc
 coverage
-doc
 lib/bundler/man
 pkg
 rdoc

data/Gemfile.lock

@@ -1,9 +1,11 @@
 PATH
   remote: .
   specs:
-    tdi (0.1.6)
+    tdi (0.1.7)
+      awesome_print
       colorize
       etc
+      ipaddress
       net-ssh
       os
       slop (~> 3.6)
@@ -12,8 +14,10 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    colorize (0.7.5)
+    awesome_print (1.6.1)
+    colorize (0.7.7)
     etc (0.2.0)
+    ipaddress (0.8.0)
     net-ssh (2.9.2)
     os (0.9.6)
     rake (10.4.2)

data/README.md

@@ -1,46 +1,281 @@
 # TDI
 
-Test Driven Infrastructure acceptance helpers for validating your deployed
-infrastructure and external dependencies.
+Test Driven Infrastructure acceptance helpers.
+
+Validate your deployed infrastructure and external dependencies.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your Gemfile:
 
-    gem 'tdi'
+```bash
+gem 'tdi'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
-Or install it yourself as:
+Or install with:
 
-    $ gem install tdi
+```bash
+$ gem install tdi
+```
 
 ## Usage
 
-    $ tdi -h
+```bash
+$ tdi [-h]
 
 Usage:
 
-    tdi [options] test_plan_file
+    tdi test_plan_file [options]
 
 Examples:
 
     tdi tdi.json
-    tdi --plan admin tdi.json
-    tdi --plan admin::acl tdi.json
-    tdi -p admin::acl,admin::file tdi.json
-    tdi --nofail tdi.json
-    tdi --shred tdi.json
-    tdi -v tdi.json
-    tdi -vv tdi.json
-    tdi -vvv tdi.json
+
+    tdi tdi.json -n
+    tdi tdi.json --nofail
+
+    tdi tdi.json -p app
+    tdi tdi.json --plan app
+    tdi tdi.json --plan app::acl
+    tdi tdi.json --plan app::acl,app::file
+
+    tdi tdi.json -r /tmp/tdi-report.json
+    tdi tdi.json --reportfile /tmp/tdi-report.json
+
+    tdi tdi.json -s
+    tdi tdi.json --shred
+
+    tdi tdi.json -v
+    tdi tdi.json -vv
+    tdi tdi.json -vvv
+
+    tdi --version
 
 Options:
 
-    -n, --nofail       No fail mode.
-    -p, --plan         Test plan list.
-    -s, --shred        Wipe out the test plan, leaving no trace behind.
-    -v, --verbose      Verbose mode.
-    -h, --help         Display this help message.
+    -n, --nofail          No fail mode.
+    -p, --plan            Test plan list.
+    -r, --reportfile      Report file to save test plan status.
+    -s, --shred           Wipe out the test plan, leaving no trace behind.
+    -v, --verbose         Verbose mode.
+        --version         Version.
+    -h, --help            Display this help message.
+```
+
+## Test plan samples
+
+[Sample TDI JSONs](https://github.com/globocom/tdi/tree/master/doc/json)
+
+### ACL
+
+Test network access/filters for TCP services.
+
+[acl.json](https://github.com/globocom/tdi/tree/master/doc/json/acl.json)
+
+```json
+{
+  "app": {
+    "desc": "Test role",
+    "acl": {
+      "port": 80,
+
+      "www.globo.com": {},
+
+      "globoesporte.globo.com": {},
+
+      "cartolafc.globo.com": {},
+
+      "doesnotexist.globo.com": {},
+
+      "www.example.com": {
+        "port": [80, 9999],
+        "timeout": 3
+      },
+
+      "localhost": {
+        "port": [22, 31337]
+      }
+    }
+  }
+}
+```
+
+### FILE
+
+Test files and diretories permissions.
+
+[file.json](https://github.com/globocom/tdi/tree/master/doc/json/file.json)
+
+```json
+{
+  "app": {
+    "desc": "Test role",
+    "file": {
+      "user": "nobody",
+      "perm": "rw",
+      "type": "file",
+      "location": "local",
+
+      "/tmp/afile1.txt": {},
+
+      "/tmp/afile2.txt": {
+        "perm": "ro"
+      },
+
+      "/tmp/afile3.txt": {
+        "user": "root"
+      },
+
+      "/tmp/doesnotexist/afile.txt": {},
+
+      "/tmp/doesnotexist": {
+        "type": "directory"
+      },
+
+      "/tmp": {
+        "type": "directory"
+      }
+    }
+  }
+}
+```
+
+### HTTP
+
+Test URLs and match expected responses.
+
+[http.json](https://github.com/globocom/tdi/tree/master/doc/json/http.json)
+
+```json
+{
+  "app": {
+    "desc": "Test role",
+    "http": {
+      "globoesporte.globo.com": {
+        "match": "<html"
+      },
+
+      "http://globoesporte.com": {
+        "code": 301,
+        "expect_header": "Location: http://globoesporte.globo.com/"
+      },
+
+      "http://api.sde.globo.com/docs": {
+        "code" : 301
+      },
+
+      "https://api.sde.globo.com/path/to/resource": {
+        "code" : 401
+      },
+
+      "doesnotexist.globo.com": {},
+
+      "https://api.cartola.globo.com/mercado/status.json": {},
+
+      "https://api.cartola.globo.com/wrong-url": {},
+
+      "http://g1.globo.com": {
+        "code": 301,
+        "match": "<html"
+      },
+
+      "http://g1.globo.com/index.html": {
+        "match": "<html"
+      }
+    }
+  }
+}
+```
+
+### SSH
+
+Test SSH access and login using public/private key pairs.
+
+[ssh.json](https://github.com/globocom/tdi/tree/master/doc/json/ssh.json)
+
+```json
+{
+  "app": {
+    "desc": "Test role",
+    "ssh": {
+      "timeout": 7,
+
+      "u_remote@localhost": {
+        "local_user": "u_local"
+      },
+
+      "u_remote2@localhost": {
+        "local_user": ["u_local", "u_local2"]
+      }
+    }
+  }
+}
+```
+
+## Generating test plans
+
+You may write your test plans as JSON in the following ways:
+
+* By hand, as pure JSON files
+
+* Using some templating engine (ERB, Jinja, etc...)
+
+* With your favorite programming language (Ruby, Python, etc...)
+
+It does not matter how you generate your test plan, as long as it results in a
+valid JSON file. Certainly it would be a good idea to write your test plans from
+within Capistrano/Fabric/Chef/Puppet. Since the difference between environments
+(development, staging, production) should be known by your deployment tool, it
+would be clever to let that tool decide which paths, users, permissions and
+addresses to write into the test plan file.
+
+Bellow we give you some suggestions on how to generate your test plans more
+efficiently (because writting JSON by hand is boring):
+
+### Ruby
+
+```ruby
+require 'json'
+
+tdi_plan = {
+  :app => {
+    :desc => 'Test role',
+    :acl => {'localhost' => {:port => [22, 80]}},
+    :http => {'globo.com' => {:code => 301}},
+  }
+}
+
+File.open('tdi.json', 'w').write(JSON.pretty_generate(tdi_plan))
+```
+
+### Python
+
+```python
+import json
+
+tdi_plan = {
+  'app': {
+    'desc': 'Test role',
+    'acl': {'localhost': {'port': [22, 80]}},
+    'http': {'globo.com': {'code': 301}},
+  }
+}
+
+open('tdi.json', 'w').write(json.dumps(tdi_plan, indent=2))
+```
+
+### Validate
+
+Use JSONLint site to validate your JSONs.
+
+http://jsonlint.com/
+
+## Contributors
+
+[People](https://github.com/globocom/tdi/graphs/contributors)

data/bin/tdi

@@ -20,7 +20,7 @@
 #
 # === Copyright
 #
-# Copyright (C) 2013-2014 Globo.com
+# Copyright (C) 2013-2015 Globo.com
 #
 
 # This file is part of TDI.
@@ -157,31 +157,43 @@ end
 
 # Command line options.
 begin
-  opts = Slop.parse(:help => true, :strict => true) do
+  opts = Slop.parse(help: true, strict: true) do
     banner <<-EOS
 Usage:
 
-    tdi [options] test_plan_file
+    tdi test_plan_file [options]
 
 Examples:
 
     tdi tdi.json
-    tdi --plan admin tdi.json
-    tdi --plan admin::acl tdi.json
-    tdi -p admin::acl,admin::file tdi.json
-    tdi --nofail tdi.json
-    tdi --shred tdi.json
-    tdi -v tdi.json
-    tdi -vv tdi.json
-    tdi -vvv tdi.json
+
+    tdi tdi.json -n
+    tdi tdi.json --nofail
+
+    tdi tdi.json -p app
+    tdi tdi.json --plan app
+    tdi tdi.json --plan app::acl
+    tdi tdi.json --plan app::acl,app::file
+
+    tdi tdi.json -r /tmp/tdi-report.json
+    tdi tdi.json --reportfile /tmp/tdi-report.json
+
+    tdi tdi.json -s
+    tdi tdi.json --shred
+
+    tdi tdi.json -v
+    tdi tdi.json -vv
+    tdi tdi.json -vvv
+
     tdi --version
 
 Options:
 EOS
     on :n, :nofail, 'No fail mode.'
-    on :p, :plan, 'Test plan list.', :as => Array, :argument => :optional
+    on :p, :plan, 'Test plan list.', as: Array, argument: :optional
+    on :r, :reportfile, 'Report file to save test plan status.', argument: :required
     on :s, :shred, 'Wipe out the test plan, leaving no trace behind.'
-    on :v, :verbose, 'Verbose mode.', :as => :count
+    on :v, :verbose, 'Verbose mode.', as: :count
     on :version, 'Version.'
   end
 rescue => e

data/doc/json/acl.json

@@ -0,0 +1,25 @@
+{
+  "app": {
+    "desc": "Test role",
+    "acl": {
+      "port": 80,
+
+      "www.globo.com": {},
+
+      "globoesporte.globo.com": {},
+
+      "cartolafc.globo.com": {},
+
+      "doesnotexist.globo.com": {},
+
+      "www.example.com": {
+        "port": [80, 9999],
+        "timeout": 3
+      },
+
+      "localhost": {
+        "port": [22, 31337]
+      }
+    }
+  }
+}

data/doc/json/file.json

@@ -0,0 +1,31 @@
+{
+  "app": {
+    "desc": "Test role",
+    "file": {
+      "user": "nobody",
+      "perm": "rw",
+      "type": "file",
+      "location": "local",
+
+      "/tmp/afile1.txt": {},
+
+      "/tmp/afile2.txt": {
+        "perm": "ro"
+      },
+
+      "/tmp/afile3.txt": {
+        "user": "root"
+      },
+
+      "/tmp/doesnotexist/afile.txt": {},
+
+      "/tmp/doesnotexist": {
+        "type": "directory"
+      },
+
+      "/tmp": {
+        "type": "directory"
+      }
+    }
+  }
+}