grandprix 0.0.4

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@grandprix --create

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grandprix.gemspec
+gemspec
+
+group :test do
+  gem "rspec"
+end
+
+group :development do
+  gem "rb-inotify", :require => false #Notify guard of file changes
+  gem "libnotify", :require => false #System notifications integration
+  gem "guard-rspec"
+end

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rafael de F. Ferreira
+
+MIT License
+
+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.md

@@ -0,0 +1,118 @@
+# Grandprix
+
+Grandprix is a small project with the sole function of imposing an ordering for
+a happens-before relation. It was created to help with deploy orchestration, to
+sort out which system should be upgraded before another, based on their
+dependency relationship. For instance, say we have four systems: a backend
+server, two frontend servers and a client. And we want to deploy new versions of
+every system.
+
+```                
+                    
+                        ----------------
+               ---------|  frontend_A  |<--------
+               v        ----------------        |
+    -------------                              ------------  
+    |  backend  |                              |  client  | 
+    -------------                              ------------ 
+               ^        ----------------        |
+               ---------|  frontend_B  |<--------
+                        ----------------
+```
+
+ You give grandprix a description of the ordering dependencies and a list of
+ elements:
+
+```
+client:
+  after: [frontend_A, frontend_B]
+
+frontend_A:
+  after: [backend]
+
+frontend_B:
+  after: [backend]
+```
+
+```
+backend
+client
+frontend_A
+frontend_B
+```
+
+And grandprix will output a correct ordering:
+
+```yaml
+backend
+frontend_A
+frontend_B
+client
+```
+
+We call the description of the dependencies a _topology_.
+
+## Using from the command line
+
+### Instalation
+The project is packaged as a rubygem, just make sure you have Ruby 1.9 installed
+and run:
+
+    $ gem install grandprix
+
+### Usage
+An executable called `grandprix` will be installed, and can be called like this:
+
+    $ topology -t topology_file elements_file
+
+The elements file argument can be omitted and grandprix will read them from
+the standard in.
+
+The `doc/sample/simple` directory has sample topology and elements files.
+
+
+## Using as a library
+
+### Instalation
+Add this line to your application's Gemfile:
+
+    gem 'grandprix'
+
+And then execute:
+
+    $ bundle
+
+### Usage
+
+The programatic API is very similar to the command line tool. Just call the
+`run!` instance method on the `Grandprix::Runner` class, passing in a hash
+representing the topology and an array of elements.
+
+The `doc/sample/as_a_library` directory has an example ruby script calling
+grandprix programatically.
+
+
+## More 
+
+Grandprix offers a few more conveniences, illustrated on the `doc/sample`
+directories:
+
+* Elements can contain extra data that will carry over to the output, such as
+  version numbers. Just append an equals sign and the info you want to each
+  element. Check out the `elements_with_extra_info` directory.
+* The topology itself can define information that will propagate to the
+  output, in the form of an `annotation` attribute. See the `annotated_topology`
+  directory.
+* Besides declaring that an element needs to come after others, grandprix also
+  allows for an element to specify that it must always be accompanied by
+  another, via the `alongside` attribute. This will extend the provided elements
+  input. See the `alongside_elements` and `alongside_elements_2` directories.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/grandprix

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'grandprix'
+require 'optparse'
+require 'yaml' 
+
+def usage(options, message=nil)
+  puts message if message
+  puts "usage: topology -t topology_file elements_file"
+  puts "       topology -t topology_file"
+  puts
+  puts " Read elements file from a named file or standard in"
+  puts 
+  puts options
+  exit (message.nil? ? 1 : 0)
+end
+
+options = OptionParser.new do |o|
+  o.on("-t", "--topology FILENAME", "path to the topology YAML file") do |filename|
+    $topology_file = filename
+  end
+  o.on('-h') { usage(o); exit }
+  o.parse!
+end
+
+topology = YAML.load_file($topology_file) rescue usage(options, "invalid topology file")
+
+elements_input = ARGF.read.chomp
+elements = elements_input.lines.map(&:chomp).to_a
+
+output = Grandprix::Runner.new.run! topology, elements
+STDOUT.puts output.strings.join("\n")

data/doc/sample/alongside_elements/elements

@@ -0,0 +1,4 @@
+frontend=v1
+client=v3
+backend=v5
+

data/doc/sample/alongside_elements/sample_output

@@ -0,0 +1,6 @@
+external_backend=v5
+backend=v5
+client=v3
+assets=v1
+frontend=v1
+images=v1

data/doc/sample/alongside_elements/topology.yml

@@ -0,0 +1,11 @@
+frontend:
+  after: [backend]             
+  alongside: [assets, images]   # Frontend is always accompanied
+                                # by assets and images
+
+backend:
+  alongside: [external_backend]
+
+images:
+  after: [client] #images that is an alongside dep of frontend
+                  # can declare itself as after client

data/doc/sample/alongside_elements_2/elements

@@ -0,0 +1,4 @@
+frontend=v1
+client=v3
+backend=v5
+

data/doc/sample/alongside_elements_2/sample_output

@@ -0,0 +1,6 @@
+external_backend=v5
+backend=v5
+client=v3
+assets=v1
+frontend=v1
+images=v1

data/doc/sample/alongside_elements_2/topology.yml

@@ -0,0 +1,11 @@
+frontend:
+  after: [backend, assets]     # frontend depends on assets in addition to
+  alongside: [assets, images]  # having it declared alongside
+
+backend:
+  alongside: [external_backend]
+
+images:
+  after: [client, frontend]    # Images must come before frontend, which
+                               # is perfectly compatible with it being
+                               # declared as alongside frontend

data/doc/sample/annotated_topology/elements

@@ -0,0 +1,4 @@
+frontend=1.0.0
+images=2.0.3
+backend=4.0.0
+

data/doc/sample/annotated_topology/sample_output

@@ -0,0 +1,3 @@
+images=2.0.3={"recipe":"image-server","script":"install-images"}
+backend=4.0.0=["This","And that"]
+frontend=1.0.0=company-frontend-script

data/doc/sample/annotated_topology/topology.yml

@@ -0,0 +1,14 @@
+frontend:
+  after: [backend, images]
+  annotation: company-frontend-script #Simple string annotation
+
+images:
+  annotation:              #Complex annotation will serialize as JSON
+    recipe: image-server
+    script: install-images
+
+backend:
+  after: [db]
+  annotation:    #Will also serialize as JSON, an array in this case.
+    - This
+    - And that

data/doc/sample/as_a_library/Gemfile

@@ -0,0 +1 @@
+gem 'grandprix'

data/doc/sample/as_a_library/sample.rb

@@ -0,0 +1,29 @@
+#! /usr/bin/env ruby
+
+require 'grandprix'
+
+topology = {
+  "frontend" => {
+    "after" => ["backend"]
+  },
+  "backend" => {
+    "after" => ["db", "mq"],
+    "annotation" => {
+      "deploy-type" => "rolling",
+    }
+  },
+  "client" => {
+    "after" => ["frontend"],
+    "annotation" => {
+      "deploy-type" => "restart",
+    }
+  }
+}
+
+elements = ["frontend=v1.0.0", "db=v2.0.1", "client=v5.43.4"]
+
+output_elements = Grandprix::Runner.new.run! topology, elements
+
+puts "Just the names are:\n#{output_elements.names.inspect}"
+
+puts "The full elements are:\n#{output_elements.strings.inspect}"

data/doc/sample/elements_with_extra_info/elements

@@ -0,0 +1,4 @@
+frontend=1.0.0
+client=2.0.3
+backend=4.0.0
+

data/doc/sample/elements_with_extra_info/sample_output

@@ -0,0 +1,3 @@
+backend=4.0.0
+frontend=1.0.0
+client=2.0.3

data/doc/sample/elements_with_extra_info/topology.yml

@@ -0,0 +1,8 @@
+frontend:
+  after: [backend, assets]    
+
+backend:
+  after: [db]
+
+client:
+  after: [frontend] 

data/doc/sample/simple/elements

@@ -0,0 +1,4 @@
+backend
+client
+frontend_A
+frontend_B

data/doc/sample/simple/sample_output

@@ -0,0 +1,4 @@
+backend
+frontend_A
+frontend_B
+client

data/doc/sample/simple/topology.yml

@@ -0,0 +1,9 @@
+client:
+  after: [frontend_A, frontend_B]
+
+frontend_A:
+  after: [backend]
+
+frontend_B:
+  after: [backend]
+

data/grandprix.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grandprix/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rafael de F. Ferreira"]
+  gem.email         = ["public@rafaelferreira.net"]
+  gem.description   = %q{Deploy assistant.}
+  gem.summary       = %q{Deploy assistant}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "grandprix"
+  gem.require_paths = ["lib"]
+  gem.version       = File.read("version").chomp
+end

data/lib/grandprix.rb

@@ -0,0 +1,9 @@
+module Grandprix
+  # Your code goes here...
+end
+
+require 'json'
+require 'grandprix/elements'
+require 'grandprix/graph'
+require 'grandprix/planner'
+require 'grandprix/runner'

data/lib/grandprix/elements.rb

@@ -0,0 +1,98 @@
+class Grandprix::Elements
+  def self.build array
+    elements = array.map {|element| element.split '=' }
+    self.new(elements)
+  end
+
+  def initialize(array)
+    @array = array
+  end
+
+  #other is also an Elements object
+  def +(other)
+    self.class.new(@array + other.underlying)
+  end
+
+  #except is an array of names
+  def except(other)
+    self.class.new(@array.reject {|e| other.include? e.first})
+  end
+
+  # ordering is an array of names
+  def reorder(ordering)
+    names_in_order = ordering & names
+    new_array = names_in_order.map do |name| 
+      find(name)
+    end
+
+    self.class.new(new_array)
+  end
+
+  # extra is a hash from names to array of names
+  def alongside(extra)
+    extra_pairs = extra.flat_map do |origin_name, destination_names|
+      local_pair = find(origin_name)
+      if local_pair and local_pair.size == 2
+        extra = local_pair[1]
+        destination_names.map {|d| [d, extra] }
+      elsif local_pair
+        destination_names.map {|d| [d] }
+      else
+        []
+      end
+    end
+    
+    #self + extra_elements
+    self.class.new(@array + extra_pairs)
+  end
+
+  # annotations is a hash of names to metadata
+  def annotate(annotations)
+    def value_component(value)
+      return nil if value.nil?
+      return value if value.is_a? String
+      return JSON.dump(value)
+    end
+
+    new_elements = underlying.map do |element|
+      name = element.first
+      find(name).clone.tap do |row|
+        annotation = value_component annotations[name]
+        row[2] = annotation unless annotation.nil?
+      end
+    end
+
+    self.class.new new_elements
+  end
+
+  def strings
+    underlying.map {|e| e.join("=") }
+  end
+
+  def names
+    @array.map &:first
+  end
+
+  def to_a
+    names
+  end
+
+  def ==(other)
+    return false unless other.respond_to?(:underlying)
+    self.underlying == other.underlying
+  end
+
+  def to_s
+    "<Elements #{self.strings.inspect}>"
+  end
+
+  def underlying
+    @array
+  end
+
+  private
+  def find(name)
+    @array.find {|e| e.first == name}
+  end
+
+end