genesis_framework 0.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab603bd2b1113f7ec2bdc86187156625e40a333d
+  data.tar.gz: 75d4060aa531be4bef61a680cb7ee39ef51363c2
+SHA512:
+  metadata.gz: 2f3723dff9601c50c2ac4bc8a4d3b48e9aa09dc7691d69776a781f287385490665ff03194ab2d9ddfd6b57a1a040096e3d820a99297b5595b3902b418b80bad1
+  data.tar.gz: ca2ff9803849bba62cbafe426f663fe803c1a53b34bd4a78fa8629a21429cac58948e004016e70e50f3282951f802dabd172ff0d2332f3f6fdd1d98f746c57bf

data/bin/genesis

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'rake'
+rescue LoadError
+  require 'rubygems'
+  require 'rake'
+end
+
+ENV['GENESIS_ROOT'] ||= '/var/run/genesis'
+
+# rake does chdir also, so don't put this in a block to avoid the warning
+Dir::chdir( File.join(ENV['GENESIS_ROOT'], '/tasks') )
+
+# run the normal rake application, but change its name to genesis
+rake = Rake.application
+rake.init('genesis')
+rake.load_rakefile
+rake.top_level

data/lib/genesisframework.rb

@@ -0,0 +1,6 @@
+# put the facter path in the LOAD_PATH so facter looks for new facts there
+# this path needs to have a 'facter' dir as an immediate subdir
+$LOAD_PATH << File.join(File.expand_path(File.dirname(__FILE__)),'genesisframework')
+require 'genesisframework/task'
+require 'genesisframework/tasks'
+require 'genesisframework/utils'

data/lib/genesisframework/facter/test_fact.rb

@@ -0,0 +1,5 @@
+Facter.add(:test_fact) do
+  setcode do
+    "gabes_test_fact"
+  end
+end

data/lib/genesisframework/task.rb

@@ -0,0 +1,175 @@
+require 'collins_client'
+require 'syslog'
+require 'retryingfetcher'
+require 'promptcli'
+require 'facter'
+require 'open3'
+
+module Genesis
+  module Framework
+    module Task
+      def self.included base
+        base.extend TaskDslMethods
+      end
+
+      module TaskDslMethods
+        attr_accessor :blocks, :options
+
+        def description desc
+          set_option :description, desc
+        end
+
+        def precondition description, &block
+          add_block :precondition, description, block
+        end
+
+        def init &block
+          set_block :init, block
+        end
+
+        def condition description, &block
+          add_block :condition, description, block
+        end
+
+        def run &block
+          set_block :run, block
+        end
+
+        def rollback &block
+          set_block :rollback, block
+        end
+
+        def success &block
+          set_block :success, block
+        end
+
+        def timeout secs
+          set_option :timeout, secs
+        end
+
+        def retries count
+          if count.is_a? Enumerator then
+            set_option :retries, count.to_a
+          else
+            set_option :retries, count.times.to_a
+          end
+        end
+
+        def collins
+          Genesis::Framework::Utils.collins
+        end
+
+        def facter
+          # lets cache the facts on first use
+          # TODO symbolize these keys?
+          # TODO implement method_missing? on this hash for easy access
+          Genesis::Framework::Utils.facter
+        end
+
+        def run_cmd *cmd, stdin_data: '', return_both_streams: false, return_merged_streams: false
+          if return_both_streams && return_merged_streams
+            raise "Invalid run_cmd invocation, can's specify both and merged together"
+          end
+
+          if return_merged_streams
+            output, status = Open3.capture2e(*cmd, stdin_data: stdin_data)
+          else
+            stdout, stderr, status = Open3.capture3(*cmd, stdin_data: stdin_data)
+            if return_both_streams
+              output = [stdout, stderr]
+            else
+              output = stdout
+            end
+          end
+
+          if status.exitstatus != 0
+            log("Run Command failed for '%s' with exit status '%d' and output: %s" % [cmd.to_s, status.exitstatus, output.to_s])
+            raise 'run_cmd exited with status: ' + status.exitstatus.to_s
+          end
+
+          return output
+        end
+
+        def config
+          # We are intentionally causing a deep copy here so one task
+          # can't pollute another task's config setup
+          # TODO: consider possibly patching hash to not allow setting members?
+          @config ||= Marshal.load(Marshal.dump(Genesis::Framework::Utils.config_cache))
+        end
+
+        def log message
+          Genesis::Framework::Utils.log(self.class.name, message)
+        end
+
+        def prompt message, seconds=15, default=false
+          Genesis::PromptCLI.ask message, seconds, default
+        end
+
+        def install provider, *what
+          if provider == :rpm
+            Kernel.system("yum", "install", "-y", *what)
+            if $?.exitstatus != 0
+              raise 'yum install exited with status: ' + $?.exitstatus.to_s
+            end
+          elsif provider == :gem
+            # we give a decent try at detecting if the gem is installed before trying to reinstall again
+            # if it contains a - (aka you are specifying a specific version or a / (aka you are specifying a path to find it)
+            # then we punt on trying to determine if the gem is already installed and just pass it to install anyway
+            gems = what.select { |item| item.include?("-") || item.include?("/") || Gem::Dependency.new(item).matching_specs.count == 0 }
+            Kernel.system("gem", "install", "--no-ri", "--no-rdoc", *gems)
+            if $?.exitstatus != 0
+              raise 'gem install exited with status: ' + $?.exitstatus.to_s
+            end
+
+            # now need to clear out the Gem cache so we can load it
+            Gem.clear_paths
+
+            # Now we require all the gems you asked to be installed
+            what.all? { |gem| require gem }
+          else
+            raise "Unknown install provider: " + provider.to_s
+          end
+        end
+
+        def fetch what, filename, base_url: ENV['GENESIS_URL']
+          filepath = tmp_path(filename)
+          Genesis::RetryingFetcher.get(what, base_url) {|data| File.open(filepath, "w", 0755) { |file| file.write data }}
+        end
+
+        def tmp_path filename
+          Genesis::Framework::Utils.tmp_path(filename, self.class.name)
+        end
+
+        #############################################################
+        # These methods are private and not part of the exposed DSL.
+        # Use at your own risk.
+        #############################################################
+
+        def set_block sym, block
+          self.init_defaults
+          self.blocks[sym] = block
+        end
+
+        def add_block sym, description, block
+          self.init_defaults
+          if self.blocks[sym].has_key?(description)
+            raise "Task defines multiple conditions with the same description"
+          end
+          self.blocks[sym][description] = block
+        end
+
+        def set_option sym, option
+          self.init_defaults
+          self.options[sym] = option
+        end
+
+        def init_defaults
+          self.blocks ||= { :precondition => {}, :init => nil, :condition => {}, :run => nil, :rollback => nil, :success => nil }
+          self.options ||= { :retries => 3.times.to_a, :timeout => 0, :description => nil }
+        end
+
+      end
+    end
+  end
+end
+

data/lib/genesisframework/tasks.rb

@@ -0,0 +1,136 @@
+require 'timeout'
+require 'promptcli'
+require 'yaml'
+
+module Genesis
+  module Framework
+    module Tasks
+      def self.load_config file
+        begin
+          data = File.read(file)
+
+          ## TODO: consider tokenizing the keys of the hash? needed???
+          Genesis::Framework::Utils.config_cache = YAML::load(data)
+        rescue => e
+          raise "Unable to parse config %s: %s" % [file, e.message]
+        end
+      end
+
+      def self.call_block blocks, sym, msg = nil
+        if blocks.has_key?(sym) && blocks[sym].respond_to?(:call)
+          puts msg if msg
+          blocks[sym].call
+        else
+          true
+        end
+      end
+
+      def self.load_tasks dir
+        # expand the LOAD_PATH to include modules, so facts are available
+        $:.unshift File.join(File.expand_path(dir),'modules')
+        puts "\nParsing tasks from directory: %s" % [dir]
+
+        Dir.glob(File.join(dir,'*.rb')) do |f|
+          begin
+            Genesis::Framework::Tasks.class_eval File.read(f)
+          rescue => e
+            raise "Error parsing task %s: %s" % [f, e.message]
+          end
+        end
+
+        @tasks = Genesis::Framework::Tasks.constants.select do |c|
+          Genesis::Framework::Tasks.const_get(c).include?( Genesis::Framework::Task )
+        end
+
+        @tasks.sort!
+      end
+
+      def self.execute task_name
+        puts "\n#{task_name}\n================================================="
+
+        return unless Genesis::PromptCLI.ask("Would you like to run this task?", 10, true) == true
+
+        task = Genesis::Framework::Tasks.const_get(task_name)
+
+        if task.blocks.nil?
+          puts "task is empty with nothing to do, skipping..."
+          return true
+        end
+
+        begin
+          puts "task is now testing if it needs to be initialized..."
+          if task.blocks.has_key?(:precondition)
+            task.blocks[:precondition].each do |description, block|
+              puts "Testing: %s" % description
+              unless self.call_block(task.blocks[:precondition], description)
+                puts "task is being skipped..."
+                return true
+              end
+            end
+          end
+        rescue => e
+          puts "%s task had error on testing if it needs initialization: %s" % [task_name, e.message]
+          return false
+        end
+
+        begin
+          puts "task is now initializing..."
+          self.call_block(task.blocks, :init);
+          puts "task is now initialized..."
+        rescue => e
+          puts "%s task threw error on initialization: %s" % [task_name, e.message]
+          return false
+        end
+
+        begin
+          puts "task is now testing if it can run..."
+          if task.blocks.has_key?(:condition)
+            task.blocks[:condition].each do |description, block|
+              puts "Checking: %s" % description
+              unless self.call_block(task.blocks[:condition], description)
+                puts "Conditional failed. Task is being skipped."
+                return true
+              end
+            end
+          end
+        rescue => e
+          puts "%s task had error on testing if it needs running: %s" % [task_name, e.message]
+          return false
+        end
+
+        success = nil
+        task.options[:retries].each_with_index do |sleep_interval, index|
+          attempt = index + 1
+          begin
+            puts "task is attempting run #%d..." % [attempt]
+            Timeout::timeout(task.options[:timeout]) do
+              success = self.call_block(task.blocks, :run)
+            end
+            # a run block should raise an error or be false for a failure
+            success = true if success.nil?
+          rescue => e
+             puts "%s task [run #%d] caused error: %s" % [task_name, attempt, e.message]
+             success = nil      # cause a retry
+          end
+          break unless success.nil? # if we got an answer, we're done
+          puts "task is sleeping for %d seconds..." % [sleep_interval]
+          Kernel.sleep(sleep_interval)
+        end
+        success = false if success.nil? # must have used all the retries, fail
+
+        if success
+          success = self.call_block(task.blocks, :success)
+          puts "task is successful!"
+        else
+          puts 'task failed!!!'
+          success = self.call_block(task.blocks, :rollback, "rolling back!")
+        end
+
+        puts "\n\n"
+        return success
+      end
+
+    end
+  end
+end
+

data/lib/genesisframework/utils.rb

@@ -0,0 +1,55 @@
+require 'syslog'
+require 'collins_client'
+require 'facter'
+
+module Genesis
+  module Framework
+    module Utils
+      def self.tmp_path filename, sandbox = ""
+        location = File.join(ENV['GENESIS_ROOT'], "tmp", sandbox)
+        Dir.mkdir(location, 0755) unless File.directory? location
+        File.join(location, filename)
+      end
+
+      @@config_cache = Hash.new
+      @@collins_conn = nil
+      @@facter = nil
+
+      # mimicking rail's cattr_accessor
+      def self.config_cache
+        @@config_cache
+      end
+
+      def self.config_cache= (obj)
+        @@config_cache = obj
+      end
+
+      def self.collins
+        if @@collins_conn.nil?
+          cfg = { :host => self.config_cache['collins']['host'], :username => self.config_cache['collins']['username'], :password => self.config_cache['collins']['password'] }
+          @@collins_conn = ::Collins::Client.new(cfg)
+        end
+
+        @@collins_conn
+      end
+
+      def self.facter
+        if @@facter.nil?
+          @@facter = Facter.to_hash
+        end
+
+        @@facter
+      end
+
+      def self.log subsystem, message
+        logline = subsystem.to_s + " :: " + message
+        puts logline
+        Syslog.open("genesis", Syslog::LOG_PID, Syslog::LOG_USER) unless Syslog.opened?
+        Syslog.log(Syslog::LOG_INFO, logline)
+        if self.facter['asset_tag']
+          self.collins.log! self.facter['asset_tag'], message
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: genesis_framework
+version: !ruby/object:Gem::Version
+  version: 0.5.2
+platform: ruby
+authors:
+- Jeremy Johnstone
+- Roy Marantz
+- Gabe Conradi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: genesis_promptcli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: genesis_retryingfetcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: collins_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: facter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Genesis is a project used to manage provisioning of hardware. This is
+  the framework which runs the specified tasks.
+email: opensourcesoftware@tumblr.com
+executables:
+- genesis
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/genesis
+- lib/genesisframework/facter/test_fact.rb
+- lib/genesisframework/task.rb
+- lib/genesisframework/tasks.rb
+- lib/genesisframework/utils.rb
+- lib/genesisframework.rb
+homepage: https://github.ewr01.tumblr.net/Tumblr/genesis
+licenses:
+- Apache License, 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Generic server onboarding framework
+test_files: []