percheron 0.7.8 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab4029c23cb8f0a448262aeb764830a1e316cf76
-  data.tar.gz: 38c2f479439afb7d69117272c1fff74f5041c880
+  metadata.gz: b678eef204ffac98f7d6acd4a3662d4a63cb84f1
+  data.tar.gz: ba9c1ed0a6d2ac94227f68358fe375be5223e211
 SHA512:
-  metadata.gz: 67689cafe1f650f03a5bf8defe0fc9d2f207d346e93f9cdcfc4e264c0f17852b44456525a3b87ef6cc6939e30c3e6baec9d375bb2c63fe41bfa49d12cd69b393
-  data.tar.gz: 73d86345a6c9ac3e8759fa7e3d4824d89c7af2640ed33129efa0d0b81db97708d6dd60ffa536996c8016df68e1fe72a058298303f002b066217e7574e908a446
+  metadata.gz: 688ffbead7b0363bf147ad733a8753f30208a317cb5c3fb64740edaeba024aa79ded4a29c7a02d962edae4c66530bca27a809b2df393e4ca740ab2e5418282a1
+  data.tar.gz: 50b5c69bed848d0498f7630e6e220ce26ce8aabb078c9a1cde09eab41ec9518c91d11e85e305bb85429d9f107bc65ce8eec9e55ea55cc72102540a90a3b6fbbe

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 before_install: gem install bundler --version 1.9.7
+gemfile: Gemfile.travis
 rvm:
   - 2.0
   - 2.1

data/Gemfile

@@ -7,6 +7,5 @@ group :test do
 end
 
 group :development do
-  gem 'pry-byebug', '~> 3.0',     platforms: [ :ruby_20, :ruby_21 ], require: false
-  gem 'awesome_print', '~> 1.0',  require: false
+  gem 'ruby-filemagic', '~> 0.6', require: false
 end

data/Gemfile.travis

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', '~> 0.1', require: false
+end

data/README.md

@@ -16,6 +16,7 @@ Organise your Docker containers with muscle and intelligence.
 * Build 'base' images as a dependancy and then build from there
 * Support for pre-build and post-start scripts when generating images and starting containers
 * Version control of building images and containers
+* Generate Graphviz dependancy graphs dynamically
 * Written in Ruby :)
 
 ## Supported platforms
@@ -67,6 +68,7 @@ docker:
 
 stacks:
   - name: consul-stack
+    description: A demo consul stack with one master and two agents
     units:
       - name: master
         version: 1.0.0
@@ -77,6 +79,7 @@ stacks:
           - 8600:53/udp
       - name: agent
         version: 1.0.0
+        instances: 2
         docker_image: progrium/consul:latest
         start_args: "-server -join master"
         dependant_unit_names:
@@ -95,15 +98,21 @@ percheron start consul-stack
 open http://boot2docker:8500/ui
 ```
 
-5) Perform a DNS lookup
+5) Perform some DNS lookups
 
 ```bash
 dig @boot2docker -p 8600 master.node.consul +short
+dig @boot2docker -p 8600 agent1.node.consul +short
+dig @boot2docker -p 8600 agent2.node.consul +short
 ```
 
+## Dependancy graph
+
+![consul-stack](https://raw.githubusercontent.com/ashmckenzie/percheron-consul/master/assets/stack.png)
+
 ## Demo
 
-[![asciicast](https://asciinema.org/a/19216.png)](https://asciinema.org/a/19216)
+[![asciicast](https://asciinema.org/a/7l1ar35xlmfsaphhptrqvx7jg.png)](https://asciinema.org/a/7l1ar35xlmfsaphhptrqvx7jg)
 
 ## Debugging
 
@@ -113,14 +122,17 @@ To perform debugging you will need to install the `pry-byebug` gem:
 gem install pry-byebug
 ```
 
-To debug Percheron, set the `DEBUG=true` environment variable.  To debug Percheron and Docker, set the `DOCKER_DEBUG=true` environment variable.
+To debug Percheron, set the `DEBUG=true` environment variable.
+
+To debug Percheron and Docker, set the `DOCKER_DEBUG=true` environment variable.
 
 ## Examples
 
+* [consul](https://github.com/ashmckenzie/percheron-consul) - consul server + UI and two agents
 * [Rails](https://github.com/ashmckenzie/percheron-rails#quickstart) - Rails 4.2, PostgreSQL, redis, HAProxy and postfix
 * [Redis](https://github.com/ashmckenzie/percheron-redis#quickstart) - Redis cluster + sentinel, master, two slaves and tools
 * [Torrent](https://github.com/ashmckenzie/percheron-torrent#quickstart) - Tracker (chihaya), seeder (aria2) and three peers (aria2)
-* [SaltStack](https://github.com/ashmckenzie/percheron-saltstack#quickstart) - SaltStack v2015.2.0rc2 with master and minion
+* [SaltStack](https://github.com/ashmckenzie/percheron-saltstack#quickstart) - SaltStack v2015.5.0 with master and two minions
 
 ## Testing
 

data/bin/percheron

@@ -11,4 +11,5 @@ begin
   Percheron::Commands::Main.run
 rescue => e
   puts Percheron::OhDear.new(e).generate
+  exit(1)
 end

data/lib/percheron/commands/graph.rb

@@ -0,0 +1,18 @@
+module Percheron
+  module Commands
+    class Graph < Abstract
+
+      parameter('STACK_NAME', 'stack name', required: true)
+      option([ '-o', '--output' ], 'OUTPUT', 'Output file')
+
+      def execute
+        super
+        stack.graph!(output || default_output)
+      end
+
+      def default_output
+        'percheron_%s.png' % stack.name
+      end
+    end
+  end
+end

data/lib/percheron/commands/main.rb

@@ -12,6 +12,7 @@ module Percheron
       subcommand 'purge', 'Purge a stack', Purge
       subcommand 'shell', 'Shell into a unit', Shell
       subcommand 'logs', 'Show logs for a unit', Logs
+      subcommand 'graph', 'Generate a stack graph', Graph
     end
   end
 end

data/lib/percheron/commands.rb

@@ -12,6 +12,7 @@ require 'percheron/commands/build'
 require 'percheron/commands/recreate'
 require 'percheron/commands/shell'
 require 'percheron/commands/logs'
+require 'percheron/commands/graph'
 require 'percheron/commands/main'
 
 module Percheron

data/lib/percheron/graph.rb

@@ -0,0 +1,103 @@
+require 'graphviz'
+
+module Percheron
+  class Graph
+
+    def initialize(stack)
+      @stack = stack
+      @nodes = {}
+      @graphs = {}
+    end
+
+    def save!(file)
+      generate
+      save(file)
+    end
+
+    private
+
+      attr_reader :stack
+      attr_accessor :nodes, :graphs
+
+      def generate
+        add_nodes
+        add_links
+      end
+
+      def save(file)
+        graph.output(png: file)
+      end
+
+      def graph
+        @graph ||= GraphViz.new(:G, graph_opts)
+      end
+
+      def graph_opts
+        { type: :digraph, nodesep: 0.75, ranksep: 1.0, label: header_label, fontsize: 12 }
+      end
+
+      def units
+        @units ||= stack.units
+      end
+
+      def header_label
+        '\n%s\n%s\n' % [ stack.name, stack.description ]
+      end
+
+      def add_nodes
+        units.each do |_, unit|
+          if unit.pseudo?
+            add_pseudo_node(unit)
+          else
+            add_node(unit)
+          end
+        end
+      end
+
+      def add_node(unit)
+        nodes[unit.name] = graph.add_nodes(unit.name, node_opts(unit))
+      end
+
+      def add_pseudo_node(unit)
+        create_cluster(unit)
+        nodes[unit.name] = graphs[unit.pseudo_name].add_nodes(unit.name, pseudo_node_opts(unit))
+      end
+
+      def create_cluster(unit)
+        return nil if graphs[unit.pseudo_name]
+        opts = 'cluster%s' % graphs.keys.count, cluster_opts(unit)
+        graphs[unit.pseudo_name] = graph.add_graph(opts)
+      end
+
+      def cluster_opts(unit)
+        { label: unit.pseudo_name, style: 'filled', color: 'lightgrey' }
+      end
+
+      def node_opts(unit)
+        shape = unit.startable? ? 'box' : 'ellipse'
+        label = [ unit.name ]
+        unit.ports.each { |ports| label << 'public: %s, internal: %s' % ports.split(':') }
+        { shape: shape, label: label.join("\n"), fontname: 'arial', fontsize: 12 }
+      end
+
+      def pseudo_node_opts(unit)
+        node_opts(unit).merge!(style: 'filled', color: 'white')
+      end
+
+      def add_links
+        units.each do |name, unit|
+          unit.dependant_units.each do |dependant_name, dependant_unit|
+            graph.add_edges(nodes[name], nodes[dependant_name], node_link_opts(dependant_unit))
+          end
+        end
+      end
+
+      def node_link_opts(unit)
+        direction = unit.startable? ? 'forward' : 'none'
+        style     = unit.startable? ? 'solid' : 'solid'
+        color     = unit.startable? ? 'black' : 'gray'
+        { dir: direction, style: style, color: color }
+      end
+
+  end
+end

data/lib/percheron/logger.rb

@@ -5,9 +5,11 @@ $logger = Logger.new(STDOUT)
 logger_level = Logger::INFO
 logger_level = Logger::WARN if ENV['QUIET'] == 'true'
 
+# :nocov:
 if ENV['DEBUG'] == 'true' || ENV['DOCKER_DEBUG'] == 'true'
   logger_level = Logger::DEBUG
   Docker.logger = $logger if ENV['DOCKER_DEBUG'] == 'true'
 end
+# :nocov:
 
 $logger.level = logger_level

data/lib/percheron/stack.rb

@@ -36,6 +36,11 @@ module Percheron
       end
     end
 
+    def graph!(file)
+      Graph.new(self).save!(file)
+      $logger.info "Saved '%s'" % file
+    end
+
     def shell!(unit_name, command: Percheron::Actions::Shell::DEFAULT_COMMAND)
       Actions::Shell.new(unit_from_name(unit_name), command: command).execute!
     end

data/lib/percheron/unit.rb

@@ -118,7 +118,7 @@ module Percheron
 
     def update_dockerfile_md5!
       md5 = current_dockerfile_md5
-      $logger.info "Setting MD5 for '#{name}' unit to #{md5}"
+      $logger.debug "Setting MD5 for '#{name}' unit to #{md5}"
       $metastore.set("#{metastore_key}.dockerfile_md5", md5)
     end
 
@@ -150,6 +150,10 @@ module Percheron
       Validators::Unit.new(self).valid?
     end
 
+    def pseudo?
+      !pseudo_name.nil?
+    end
+
     alias_method :startable?, :startable
 
     private
@@ -172,8 +176,5 @@ module Percheron
         Hashie::Mash.new(container.info)
       end
 
-      def pseudo?
-        !pseudo_name.nil?
-      end
   end
 end

data/lib/percheron/version.rb

@@ -1,3 +1,3 @@
 module Percheron
-  VERSION = '0.7.8'
+  VERSION = '0.7.9'
 end

data/lib/percheron.rb

@@ -15,6 +15,7 @@ require 'percheron/config'
 require 'percheron/errors'
 require 'percheron/config_delegator'
 require 'percheron/formatters'
+require 'percheron/graph'
 require 'percheron/stack'
 require 'percheron/null_stack'
 require 'percheron/unit'

data/percheron.gemspec

@@ -27,10 +27,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'metastore', '~> 0.3'
   spec.add_runtime_dependency 'highline', '~> 1.7.1'
   spec.add_runtime_dependency 'liquid', '~> 3.0'
+  spec.add_runtime_dependency 'ruby-graphviz', '~> 1.2'
 
   spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.1'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   spec.add_development_dependency 'timecop', '~> 0.7'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percheron
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
 platform: ruby
 authors:
 - Ash McKenzie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -277,6 +305,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.travis
 - Guardfile
 - LICENSE.txt
 - README.md
@@ -301,6 +330,7 @@ files:
 - lib/percheron/commands/build.rb
 - lib/percheron/commands/console.rb
 - lib/percheron/commands/create.rb
+- lib/percheron/commands/graph.rb
 - lib/percheron/commands/list.rb
 - lib/percheron/commands/logs.rb
 - lib/percheron/commands/main.rb
@@ -318,6 +348,7 @@ files:
 - lib/percheron/formatters.rb
 - lib/percheron/formatters/stack.rb
 - lib/percheron/formatters/stack/table.rb
+- lib/percheron/graph.rb
 - lib/percheron/logger.rb
 - lib/percheron/metastore.rb
 - lib/percheron/null_stack.rb