tele 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Michel Martens and Damian Janowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,121 @@
+TELE(1)
+
+NAME
+      tele -- Provisioning at a distance.
+
+SYNOPSIS
+      tele [-h] [-d path] (init|status|install)
+
+DESCRIPTION
+      Tele is a small provisioning framework that allows you to run bash
+      scripts on remote servers over SSH. It uses your own SSH, not a Ruby
+      version, so you can profit from your settings and public/private keys.
+
+      It uses the following directory structure to store the recipes and
+      configuration files:
+
+          .tele/layout.json
+          .tele/ssh_config
+          .tele/recipes/redis/status.sh
+          .tele/recipes/redis/install.sh
+          .tele/recipes/unicorn/status.sh
+          .tele/recipes/unicorn/install.sh
+
+      In the example, there are recipes for Redis and Unicorn. Please note that you are in
+      charge of creating them.
+
+      layout.json
+          The server layout, with the available roles and servers. Example:
+
+          {
+            "roles": {
+              "db": ["redis"],
+              "web": ["ruby", "unicorn"],
+              "app": ["db", "web"]
+            },
+
+            "servers": {
+              "app-1": ["db", "web"],
+              "app-2": ["db"],
+              "app-3": ["app"]
+            }
+          }
+
+          The key "roles" stores a tree, where each key is mapped
+          to an array of recipes. The leaves--those elements in the tree that
+          are not present as keys--are the ones that have to be available as
+          bash scripts. In this example, both "redis" and "unicorn" are leaves,
+          while "db", "web" and "app" are recipes composed of other recipes.
+
+          The key "servers" stores a map of servers to roles. The keys can be
+          either hostnames declared in .tele/ssh_config or IP addresses.
+
+      ssh_config
+          Configuration file for the SSH connection. Check the SSH_CONFIG man
+          page for more information.
+
+      The following options are available:
+
+      -h
+          Display this help message.
+
+      -d path
+          Sets path as the directory where tele will search for scripts and
+          configuration files. You can also use the environment variable
+          TELE_HOME.
+
+      init
+          Copies a .tele template to the current directory.
+
+      status
+          Runs every status.sh script on the servers declared in layout.json,
+          and prints the responses. The status.sh script must return 0 if
+          everything is correct, and a value different form zero otherwise.
+          What to check in the script is up to the user.
+
+      install
+          Runs every install.sh script on the servers declared in layout.json,
+          but only if the status.sh returns an error. The exit code must be 0
+          if the installation was successful.
+
+USAGE
+      To provision two servers called `server1` and `server2` with Redis,
+      starting from scratch:
+
+          # Create the .tele directory.
+          $ tele init
+
+          # Create directories for the recipes.
+          $ mkdir -p .tele/recipes/redis
+
+          # Create status.sh script.
+          $ cat "which redis-server" > ./tele/recipes/redis/status.sh
+
+          # Create install.sh script (ommited).
+
+          # Edit .tele/layout.json as follows:
+
+            {
+              "roles": {
+                "db": ["redis"]
+              },
+
+              "servers": {
+                "server1": ["db"],
+                "server2": ["db"]
+              }
+            }
+
+          # Edit .tele/ssh_config:
+
+            Host server1
+              Hostname 10.0.0.1
+
+            Host server2
+              Hostname 10.0.0.2
+
+          # Run tele install
+          $ tele install
+
+INSTALLATION
+      $ gem install tele

data/Rakefile

@@ -0,0 +1,7 @@
+task :test do
+  require "cutest"
+
+  Cutest.run(Dir["test/tele.rb"])
+end
+
+task :default => :test

data/bin/tele

@@ -0,0 +1,158 @@
+#! /usr/bin/env ruby
+
+help = File.expand_path(File.join("..", "README"), File.dirname(__FILE__))
+
+if ARGV.empty?
+  exec "less #{help}"
+end
+
+require "clap"
+require "json"
+
+def recipes_for(assigned_roles)
+  [].tap do |recipes|
+    assigned_roles.each do |name|
+      if roles[name]
+        recipes.concat(recipes_for(roles[name]))
+      else
+        recipes.push(name)
+      end
+    end
+  end
+end
+
+def path(*parts)
+  File.expand_path(File.join(*parts), ENV["TELE_HOME"])
+end
+
+def ssh(server, script)
+  %x{ssh -T -F #{path("ssh_config")} #{server} < #{script}}
+  $?.exitstatus
+end
+
+def layout
+  $layout ||= JSON.parse(File.read(path("layout.json")))
+end
+
+def servers
+  layout["servers"]
+end
+
+def roles
+  layout["roles"]
+end
+
+def recipe_script(recipe, command)
+  path("recipes", recipe, "#{command}.sh")
+end
+
+def run(server, recipe, command)
+  script = recipe_script(recipe, command)
+
+  if File.exist?(script)
+    ssh(server, script)
+  end
+end
+
+out = Module.new do
+  def self.server(name)
+    puts name
+  end
+
+  def self.error
+    puts "\033[01;31mERROR\033[00m"
+  end
+
+  def self.ok
+    puts "\033[01;32mOK\033[00m"
+  end
+
+  def self.missing
+    puts "\033[01;33mMISSING\033[00m"
+  end
+
+  def self.done
+    puts "\033[01;32mDONE\033[00m"
+  end
+
+  def self.unknown
+    puts "?"
+  end
+end
+
+###
+
+ENV["TELE_HOME"] ||= File.join(Dir.pwd, ".tele")
+
+commands = Clap.run ARGV,
+  "-h" => lambda {
+    exec "less #{help}"
+  },
+  "-d" => lambda { |path|
+    ENV["TELE_HOME"] = File.join(Dir.pwd, path)
+  }
+
+Clap.run commands,
+  "init" => lambda {
+    source = File.expand_path("../templates/.tele", File.dirname(__FILE__))
+    target = File.expand_path(Dir.pwd)
+
+    %x{cp -r #{source} #{target}}
+    out.done
+  }
+
+unless File.directory?(path)
+  $stderr.puts "Couldn't find a .tele directory"
+  exit 1
+end
+
+Clap.run commands,
+  "status" => lambda {
+    servers.each do |server, assigned_roles|
+      out.server(server)
+
+      recipes_for(assigned_roles).each do |recipe|
+        print "  #{recipe}: "
+
+        case run(server, recipe, :status)
+        when nil
+          out.unknown
+        when 0
+          out.ok
+        else
+          out.missing
+        end
+      end
+
+      puts
+    end
+  },
+
+  "install" => lambda {
+    servers.each do |server, assigned_roles|
+      out.server(server)
+
+      recipes_for(assigned_roles).each do |recipe|
+        print "  #{recipe}: "
+
+        if run(server, recipe, :status) == 0
+          out.ok
+        else
+          case run(server, recipe, :install)
+          when nil
+            out.unknown
+          when 0
+            if run(server, recipe, :status) == 0
+              out.done
+            else
+              out.missing
+            end
+          else
+            out.error
+          end
+        end
+      end
+
+      puts
+    end
+  }

data/tele.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name              = "tele"
+  s.version           = "0.0.1"
+  s.summary           = "Provisioning at a distance"
+  s.description       = "Tele is a small provisioning framework that allows you to run bash scripts on remote servers over SSH."
+  s.authors           = ["Damian Janowski", "Michel Martens"]
+  s.email             = ["djanowski@dimaion.com", "michel@soveran.com"]
+  s.homepage          = "http://github.com/djanowski/tele"
+
+  s.executables.push("tele")
+
+  s.add_dependency("clap")
+
+  s.files = ["LICENSE", "README", "Rakefile", "bin/tele", "templates/.tele/layout.json", "templates/.tele/ssh_config", "tele.gemspec", "test/tele.rb"]
+end

data/templates/.tele/layout.json

@@ -0,0 +1,9 @@
+{
+  "roles": {
+
+  },
+
+  "servers": {
+
+  }
+}

data/test/tele.rb

@@ -0,0 +1,90 @@
+require "shellwords"
+require "open3"
+
+ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+def root(*args)
+  File.join(ROOT, *args)
+end
+
+def tele(*args)
+  sh("ruby #{root "bin/tele"} #{Shellwords.join args}")
+end
+
+def sh(cmd)
+  Open3.capture3(cmd)
+end
+
+prepare do
+  `rm -rf /tmp/tele`
+  `mkdir /tmp/tele`
+end
+
+test "`tele status` without a config" do
+  out, err, status = tele("status")
+
+  assert err =~ /Couldn't find/
+  assert_equal 1, status.exitstatus
+end
+
+test "`tele status` with missing recipes" do
+  out, err = tele("status", "-d", "test/.tele.missing-recipes")
+
+  assert out =~ /db-1/
+  assert out =~ /redis: .*\?/
+end
+
+test "`tele status`" do
+  out, err = tele("status", "-d", "test/.tele.simple")
+
+  assert out =~ /db-1/
+  assert out =~ /redis: .*OK/
+  assert out =~ /cassandra: .*MISSING/
+end
+
+test "`tele status`" do
+  out, err = tele("status", "-d", "test/.tele")
+
+  assert err.empty?
+
+  parts = out.split("\n\n")
+
+  assert parts[0] =~ /app-1/
+  assert parts[0] =~ /redis/
+  assert parts[0] =~ /ruby/
+  assert parts[0] =~ /unicorn/
+
+  assert parts[1] =~ /app-2/
+  assert parts[1] =~ /redis/
+
+  assert parts[2] =~ /app-3/
+  assert parts[2] =~ /redis/
+  assert parts[2] =~ /ruby/
+  assert parts[2] =~ /unicorn/
+end
+
+test "`tele install`" do
+  out, err = tele("install", "-d", "test/.tele.simple")
+
+  assert out =~ /db-1/
+  assert out =~ /cassandra: .*ERROR/
+  assert out =~ /cdb: .*DONE/
+  assert out =~ /redis: .*OK/
+  assert out =~ /tokyo: .*MISSING/
+end
+
+test "`tele init`" do
+  `rm -rf test/tmp`
+  `mkdir test/tmp`
+
+  assert !File.exists?("test/tmp/.tele")
+
+  Dir.chdir("test/tmp") do
+    out, err = tele("init")
+
+    assert File.exists?(".tele")
+
+    out, err, status = tele("status")
+    assert status.exitstatus == 0
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: tele
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Damian Janowski
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-15 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: clap
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Tele is a small provisioning framework that allows you to run bash scripts on remote servers over SSH.
+email: 
+- djanowski@dimaion.com
+- michel@soveran.com
+executables: 
+- tele
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- Rakefile
+- bin/tele
+- templates/.tele/layout.json
+- templates/.tele/ssh_config
+- tele.gemspec
+- test/tele.rb
+has_rdoc: true
+homepage: http://github.com/djanowski/tele
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Provisioning at a distance
+test_files: []
+