salt-matrix 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51df135caadd82053d8c9d8f4eb5226e5426d825
+  data.tar.gz: 033cd2406ccbe7bee05e34e7cf726054a270826f
+SHA512:
+  metadata.gz: f76d68d5200d533ae6b5d286998576288ab59f13dd983feb5274354411808351d726f2aafd74c5601c5c31ee070bee93c5d34bd9ce49ef7a60c097d2a76c49ad
+  data.tar.gz: cb7a5067e537d25d145bb3cab44779cfb57e0c97a090642b8d752b3c8f63e5ecb9199b1d444c8bc724c1fc840ed215f5ba0b857b7f96b0e5f4fb67b9d5a2e8db

data/README.md

@@ -0,0 +1,21 @@
+salt-matrix
+===========
+
+
+
+File Format
+-----------
+
+Saltfile
+
+```
+
+formula 'custom_grains', :git => 'http://stash.service.audsci.net/scm/salt/custom_grains-formula.git', '0.1.0'
+
+formula 'custom_grains', :git => 'http://stash.service.audsci.net/scm/salt/custom_grains-formula.git', :branch => 'master'
+
+formula 'custom_grains', :git => 'http://stash.service.audsci.net/scm/salt/custom_grains-formula.git', :tag => 'this_rel'
+
+
+
+```

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/bin/salt-matrix

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << lib unless $LOAD_PATH.include? lib
+
+require 'colorize'
+require 'salt/matrix'
+
+
+begin
+  cli = Salt::Matrix::Cli.start
+rescue Interrupt
+  exit(1)
+rescue SystemExit => e
+  exit(e.status)
+rescue Exception => e
+  $stderr.puts "\nUnhandled exception: #{e.inspect}".red
+  $stderr.puts e.backtrace.join("\n")
+  exit(1)
+end

data/lib/salt/formula.rb

@@ -0,0 +1,36 @@
+
+
+module Salt
+  module Formula
+
+    # Register an module implementation for later generation
+    def self.register(klass)
+      @klasses ||= []
+      @klasses << klass
+    end
+    
+    # Look up the implementing class and instantiate an object
+    #
+    # This method takes the arguments for normal object generation and checks all
+    # inheriting classes to see if they implement the behavior needed to create
+    # the requested object. It selects the first class that can implement an object
+    # with `name, args`, and generates an object of that class.
+    #
+    # @param [String] name The unique name of the module
+    # @param [String] basedir The root to install the module in
+    # @param [Object] args An arbitary value or set of values that specifies the implementation
+    #
+    # @return [Object < R10K::Module] A member of the implementing subclass
+    def self.new(name, basedir, args)
+      if implementation = @klasses.find { |klass| klass.implement?(name, args) }
+        obj = implementation.new(name, basedir, args)
+        obj
+      else
+        raise "Module #{name} with args #{args.inspect} doesn't have an implementation. (Are you using the right arguments?)"
+      end
+    end
+    
+    require 'salt/formula/base'
+    require 'salt/formula/git'
+  end
+end

data/lib/salt/formula/base.rb

@@ -0,0 +1,78 @@
+
+require 'salt/formula'
+
+
+# This class defines a common interface for module implementations.
+class Salt::Formula::Base
+
+  # @!attribute [r] name
+  #   @return [String] The name of the module
+  attr_reader :name
+
+  # @param [r] dirname
+  #   @return [String] The name of the directory containing this module
+  attr_reader :dirname
+
+  # @deprecated
+  alias :basedir :dirname
+
+  # @!attribute [r] path
+  #   @return [Pathname] The full path of the module
+  attr_reader :path
+
+  # @param title [String]
+  # @param dirname [String]
+  # @param args [Array]
+  def initialize(name, dirname, args)
+    @name = name
+    @dirname = dirname
+    @args    = args
+    @path = Pathname.new(File.join(@dirname, @name))
+  end
+
+  # @deprecated
+  # @return [String] The full filesystem path to the module.
+  def full_path
+    path.to_s
+  end
+
+  # Synchronize this module with the indicated state.
+  # @abstract
+  def sync
+    raise NotImplementedError
+  end
+
+  # Return the desired version of this module
+  # @abstract
+  def version
+    raise NotImplementedError
+  end
+
+  # Return the status of the currently installed module.
+  #
+  # This can return the following values:
+  #
+  #   * :absent - there is no module installed
+  #   * :mismatched - there is a module installed but it must be removed and reinstalled
+  #   * :outdated - the correct module is installed but it needs to be updated
+  #   * :insync - the correct module is installed and up to date, or the module is actually a boy band.
+  #
+  # @return [Symbol]
+  # @abstract
+  def status
+    raise NotImplementedError
+  end
+
+  def accept(visitor)
+    visitor.visit(:module, self)
+  end
+
+  # Return the properties of the module
+  #
+  # @return [Hash]
+  # @abstract
+  def properties
+    raise NotImplementedError
+  end
+
+end

data/lib/salt/formula/git.rb

@@ -0,0 +1,70 @@
+require 'salt/formula'
+require 'salt/matrix/gitrepo'
+require 'forwardable'
+
+class Salt::Formula::Git < Salt::Formula::Base
+
+  Salt::Formula.register(self)
+
+  def self.implement?(name, args)
+    args.is_a? Hash and (args.has_key?(:git) or args.has_key?(:github))
+  rescue
+    false
+  end
+
+  # @!attribute [r] repo
+  #   @api private
+  #   @return [Salt::Matrix::Gitrepo]
+  attr_reader :repo
+
+  def initialize(name, dirname, args)
+    super
+    parse_options(@args)
+    @name = name
+    @repo = Salt::Matrix::Gitrepo.new(@remote, @name, @ref, dirname)
+  end
+
+  def version
+    @ref
+  end
+
+  def properties
+    {
+      :expected => @ref,
+      :actual   => (@repo.head || "(unresolvable)"),
+      :type     => :git,
+    }
+  end
+
+  extend Forwardable
+
+  def_delegators :@repo, :sync, :status
+
+  private
+
+  def parse_options(options)
+    @remote = options.delete(:git) || options.delete(:github)
+
+    if options[:branch]
+      @ref = "origin/#{options.delete(:branch)}"
+    end
+
+    if options[:tag]
+      @ref = options.delete(:tag)
+    end
+
+    if options[:commit]
+      @ref = options.delete(:commit)
+    end
+
+    if options[:ref]
+      @ref = options.delete(:ref)
+    end
+
+    @ref ||= 'master'
+
+    unless options.empty?
+      raise ArgumentError, "Unhandled options #{options.keys.inspect} specified for #{self.class}"
+    end
+  end
+end

data/lib/salt/matrix.rb

@@ -0,0 +1,53 @@
+
+require 'singleton'
+require 'version'
+require 'salt/saltfile'
+require 'salt/matrix/error'
+
+
+module Salt  
+  
+  class Matrix
+    include Singleton 
+    
+    autoload :Cli,  'salt/matrix/cli'
+
+    attr_reader :debug
+    
+    is_versioned
+    
+    def initialize
+      @debug_buf = []
+    end
+
+
+    def set_debug
+      @debug = true
+      unless @debug_buf.empty?
+        debug {|fh| @debug_buf.each {|m| fh.write "#{m}\n" }}
+      end
+    end
+
+    def self.set_debug
+      self.instance.set_debug
+    end
+
+
+    def debug(msg, &block)
+      if block_given?
+        yield $stdout
+      elsif @debug
+        puts "*** #{msg}"
+      else
+        # just in case we turn debug on in a bit.
+        @debug_buf << msg
+      end
+    end
+
+    def self.debug(msg, &block)
+      self.instance.debug(msg, &block)
+    end
+    
+  end
+  
+end

data/lib/salt/matrix/cli.rb

@@ -0,0 +1,61 @@
+
+require 'thor'
+
+
+module Salt
+  class Matrix
+    class Cli < Thor
+      
+      autoload :Deploy, 'salt/matrix/cli/deploy'
+      
+      
+      #class_option :trace, :type => :boolean
+      
+      
+      desc 'version', 'Display version information'
+      def version
+        puts Salt::Matrix::VERSION
+      end
+      
+      desc 'deploy', 'Deploy an environment from Saltfile'
+      long_desc <<-LONGDESC
+        Process a Saltfile and build an environment from the formulas
+        specified within the file. Saltfile consists of one or more entries
+        of the form:
+        \n
+        formula 'NAME', ARG, ARG, ARG ...
+        \n
+        NAME is the formula name which will be the directory name that
+        contains the formula. ARGs will vary depending upon the location
+        of the formula. Generally the ARGs will consist of the key :git set
+        to the location of the Git repository for the formula and a refernce
+        to the Git tag, branch or commit ID. 
+        \n
+        With the --dir option, one may specify another directory other than
+        the current working directory to find the Saltfile.
+      LONGDESC
+      option :dir, :default => '.'
+      option :debug, :default => false
+      def deploy 
+        if options['debug']
+          Salt::Master.set_debug
+        end
+        deploy_dir = File.expand_path options['dir']
+        Salt::Matrix.debug "Deployment directory set to #{deploy_dir}"
+        saltfile = Salt::Saltfile.new deploy_dir
+        saltfile.load
+        saltfile.formulas.each do |f| 
+          f.sync
+        end
+      end
+      
+      
+      desc 'foo', 'Throw an exception'
+      def foo
+        raise RuntimeError, 'This is foo'
+      end
+      
+      
+    end
+  end
+end

data/lib/salt/matrix/cli/deploy.rb

@@ -0,0 +1,20 @@
+
+require 'thor'
+
+
+module Salt
+  class Matrix
+    class Cli
+      class Deploy < Thor
+      
+      
+        desc 'deploy environment', 'Some description'
+        def environment
+          
+          
+        end
+        
+      end
+    end
+  end
+end

data/lib/salt/matrix/error.rb

@@ -0,0 +1,33 @@
+
+
+module Salt
+  class Matrix
+    
+    class Error < StandardError
+      
+      attr_accessor :original
+      
+      def self.wrap(original, mesg, options = {})
+        new(mesg, options).tap do |e|
+          e.set_backtrace(caller(4))
+          e.original = original
+        end
+      end
+          
+
+      def initialize(mesg, options = {})
+        super(mesg)
+
+        bt = options.delete(:backtrace)
+        if bt
+          set_backtrace(bt)
+        end
+
+        @options = options
+      end
+          
+    end
+    
+  end
+  
+end

data/lib/salt/matrix/gitrepo.rb

@@ -0,0 +1,178 @@
+
+require 'fileutils'
+require 'yaml'
+require 'git'
+
+
+module Salt
+  class Matrix
+
+    ## 
+    # Gitrepo class provides the low level interface to a Git repository. 
+
+    class Gitrepo
+    
+      def initialize(remote, name, ref, dirname)
+        @ref = ref
+        @remote = remote
+        @dirname = dirname
+        @formuladir = File.join(dirname, name)
+        @repodir = File.join(dirname, '.cache', name)
+        @name = name
+        
+        # Grab the last settings if they exist.
+        @settings = {}
+        if File.exist? "#{@formuladir}/.salt-matrix.yaml"
+          @settings = YAML.load_file("#{@formuladir}/.salt-matrix.yaml")
+        end
+        
+        @git = nil
+        if Dir.exist? @repodir
+          @git = Git.open @repodir
+        end
+      end
+      
+      
+      def sync
+        
+        case status
+        when :absent
+          puts "#{"%-30s" % @name}" + "Cloning".yellow
+          replicate_repo
+          puts "#{"%-30s" % @name}" + "Syncing".cyan
+          replicate_formula
+        when :mismatched
+          puts "#{"%-30s" % @name}" + "Syncing".cyan
+          replicate_formula
+        when :badrepo
+          puts "#{"%-30s" % @name}" + "Kill repo".yellow
+          destroy_repo
+          puts "#{"%-30s" % @name}" + "Kill formula".yellow
+          destroy_formula
+          puts "#{"%-30s" % @name}" + "Cloning".yellow
+          replicate_repo
+          puts "#{"%-30s" % @name}" + "Syncing".cyan
+          replicate_formula
+        when :outdated
+          puts "#{"%-30s" % @name}" + "Updating repo".cyan
+          update_repo
+          puts "#{"%-30s" % @name}" + "Syncing".cyan
+          replicate_formula
+        when :insync
+          puts "#{"%-30s" % @name}" + "OK".green
+        else
+          puts "#{"%-30s" % @name}" + "Invalid State".red
+        end
+
+        save_settings
+      end
+      
+      
+      def status
+        # Reported conditions:
+        #
+        #   :absent         Nothing currently exists
+        #   :mismatched     Formula is not derived from repo
+        #   :badrepo        Cloned repo is not what is specified
+        #   :outdated       Expected, but needs to be sync'ed
+        #   :insync         Expected and upto date
+        
+        if !Dir.exist? @formuladir or !Dir.exist? @repodir
+          return :absent
+        end
+        
+        
+          
+        if @settings.empty?
+          return :mismatched
+        elsif @settings[:remote] != @remote
+          return :badrepo
+        end
+        
+        # Check the repo settings 
+        unless @git.nil?
+          @git.fetch
+          if @settings[:remote] != @git.remote.url
+            return :badrepo
+          elsif @settings[:sha] != @git.object(@ref).sha
+            return :outdated
+          else
+            return :insync
+          end
+        else
+          # Ideally this should never get returned!
+          return :invalid
+        end
+      end
+    
+    
+    
+      private
+    
+      def destroy_repo
+        FileUtils.rm_r @repodir
+        @git = nil
+      end
+      
+      def destroy_formula
+        FileUtils.rm_r @formuladir
+      end
+      
+      def replicate_repo
+        unless Dir.exists? "#{@dirname}/.cache"
+          Dir.mkdir "#{@dirname}/.cache"
+        end
+        
+        # clone to the .cache directory
+        Dir.chdir "#{@dirname}/.cache"
+        begin
+          if @git.nil?
+            Salt::Matrix.debug "Cloning: #{@remote}"
+            @git = Git.clone(@remote, @name)
+          end
+        rescue Exception => e
+          puts "Exception: #{e}"
+          puts e.backtrace.join("\n")
+          puts e.inspect
+        end
+        
+        # Checkout to the correct revsion
+        Salt::Matrix.debug "Checking out: #{@ref}"
+        @git.checkout @ref
+        
+        # Record the Git ID
+        @settings[:sha] = @git.object("HEAD").sha
+      end
+      
+      def update_repo
+        @git.fetch
+        @git.pull
+      end
+        
+        
+      def replicate_formula
+        # Locate the formula directory and copy it
+        #    for now we treat the name as the formula directory name
+        if Dir.exist? File.join(@repodir, @name)
+          system("rsync -a --delete --exclude .salt-matrix.yaml #{File.join(@repodir, @name)} #{@dirname}")
+          #FileUtils.cp_r(File.join(@repodir, @name), @dirname)
+          @settings[:name] = @name
+          @settings[:remote] = @remote
+          @settings[:ref] = @ref
+        else
+          puts "#{"%-30s" % @name}" + "Invalid formula".red
+        end
+      end
+    
+      
+      def save_settings
+        if Dir.exist? @formuladir
+          File.open("#{@formuladir}/.salt-matrix.yaml", 'w') do |fh|
+            fh.write @settings.to_yaml
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/salt/saltfile.rb

@@ -0,0 +1,77 @@
+
+require 'salt/formula'
+
+module Salt
+  
+  class Saltfile
+    
+    attr_reader :basedir
+    attr_reader :formuladir
+    attr_reader :formulas
+    attr_reader :saltfile
+    
+    # @param [String] basedir
+    # @param [String] formuladir
+    # @param [String] saltfile
+    def initialize(basedir='.', formuladir=nil, saltfile=nil)
+      @basedir = basedir
+      @formuladir = formuladir || @basedir
+      @saltfile = saltfile || File.join(@basedir, 'Saltfile')
+      
+      @formulas = []
+    end
+    
+    
+    def load 
+      if File.readable? @saltfile
+        self.load!
+      else
+        $stderr.puts "Saltfile (#{@saltfile}) missing or unreadable"
+      end
+    end
+    
+    
+    def load!
+      dsl = DSL.new(self)
+      dsl.instance_eval(saltfile_contents, @saltfile)
+    rescue SyntaxError, LoadError => e
+      puts e.inspect.magenta
+      raise Salt::Matrix::Error.wrap(e, "Failed to process #{@saltfile}")
+    end
+    
+    
+    # @param [String] name
+    # @param [*Object] args
+    def add_formula(name, args)
+      @formulas << Salt::Formula.new(name, @formuladir, args)
+    end
+      
+    # @return [File]
+    def saltfile_contents
+      File.read(@saltfile)
+    end
+    
+    
+    
+    class DSL
+      
+      # @param [*Object] librarian
+      def initialize(librarian)
+        @librarian = librarian
+      end
+      
+      # @param [String] name
+      # @param [*Object] args
+      def formula(name, args=nil)
+        @librarian.add_formula(name, args)
+      end
+      
+      def method_missing(methods, *args)
+        raise NoMethodError, "unrecognized declaration: #{method}"
+      end
+      
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: salt-matrix
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Gerard Hickey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 10.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 10.4.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Tool to build salt environments from various sources
+email: gerard.hickey@audiencescience.com
+executables:
+- salt-matrix
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- VERSION
+- bin/salt-matrix
+- lib/salt/formula.rb
+- lib/salt/formula/base.rb
+- lib/salt/formula/git.rb
+- lib/salt/matrix.rb
+- lib/salt/matrix/cli.rb
+- lib/salt/matrix/cli/deploy.rb
+- lib/salt/matrix/error.rb
+- lib/salt/matrix/gitrepo.rb
+- lib/salt/saltfile.rb
+homepage: http://stash.service.audsci.net/projects/SALT/repos/salt-matrix/
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Tool to build salt environments
+test_files: []