zygote 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e1710f705eaf6deb71e1287c48ccb34aa694ac5
-  data.tar.gz: dc68648147162e92d2769f3c61dc24bf5d795fa9
+  metadata.gz: 79f6d6d816134c8cfadd3335a62a59c5c199da29
+  data.tar.gz: 95426b7b07578c63f29d74c3eeb54385abe66ba1
 SHA512:
-  metadata.gz: 50fd707aff6f9d087059356a75c2265a31d154d5195e398dfe1a3216edfd14e45e2df69e1961c6442c708157a8b5dcd4883acc27b9a91b3320509d5f23f051f4
-  data.tar.gz: 055e5c78d9cb948f3e42b0a7ef9a2c40f04488ff3b82641303ac56febf4ed374f152aea0d58e2a0c662417d7f7a30288eee63a04fa4e832a9f42c5b0a2bb3e08
+  metadata.gz: 59fbfb4088ae7fe0adbd49c0b5a172ce943d6cb20b5fa876f37277e01a0b16cce8bfeb905ed27e2281b1c9ceed6998131fb12fe67a8518bcd283f5f7b8577e07
+  data.tar.gz: dc120384aad70375fd37cb4ce71c9ca003f639c0e2b6045b7540cbe4c991862a254064912be1b48d8a9aed299eada522ec578aa2537c473e607c38ded37d0d3d

data/lib/zygote/cell_queue.rb

@@ -1,49 +1,51 @@
 require 'zygote/memory'
 
-# An entry into the queue
-class CellQueueEntry < SuperModel::Base
-  include SuperModel::Marshal::Model
-end
+module Zygote
+  # An entry into the queue
+  class CellQueueEntry < SuperModel::Base
+    include SuperModel::Marshal::Model
+  end
 
-# A means of storing Cell queue data for a given sku
-module CellQueue
-  extend self
-  COLLECTION = :assets
-  ARRAY_KEY = :cell_queue
-  Memory.load
+  # A means of storing Cell queue data for a given sku
+  module CellQueue
+    extend self
+    COLLECTION = :assets
+    ARRAY_KEY = :cell_queue
+    Memory.load
 
-  def push(key, data)
-    entry = CellQueueEntry.find_by_name(key)
-    unless entry
-      entry = CellQueueEntry.new(name: key, data: [])
+    def push(key, data)
+      entry = CellQueueEntry.find_by_name(key)
+      unless entry
+        entry = CellQueueEntry.new(name: key, data: [])
+        entry.save
+      end
+      entry.data << data
       entry.save
+      Memory.save
     end
-    entry.data << data
-    entry.save
-    Memory.save
-  end
 
-  def shift(key)
-    entry = CellQueueEntry.find_by_name(key)
-    return nil unless entry
-    first = entry.data.shift
-    entry.save
-    Memory.save
-    first
-  end
+    def shift(key)
+      entry = CellQueueEntry.find_by_name(key)
+      return nil unless entry
+      first = entry.data.shift
+      entry.save
+      Memory.save
+      first
+    end
 
-  def show(key)
-    entry = CellQueueEntry.find_by_name(key)
-    entry ? entry.data : []
-  end
+    def show(key)
+      entry = CellQueueEntry.find_by_name(key)
+      entry ? entry.data : []
+    end
 
-  def purge(key)
-    entry = CellQueueEntry.find_by_name(key)
-    entry.data = [] if entry
-    entry.save if entry
-  end
+    def purge(key)
+      entry = CellQueueEntry.find_by_name(key)
+      entry.data = [] if entry
+      entry.save if entry
+    end
 
-  def all
-    CellQueueEntry.all
+    def all
+      CellQueueEntry.all
+    end
   end
 end

data/lib/zygote/http.rb

@@ -8,130 +8,126 @@ require 'rack/contrib'
 
 require 'zygote/util'
 require 'zygote/cell_queue'
+require 'zygote/identifier'
+
+# Main zygote container namespace
+module Zygote
+  # Main HTTP class, handles routing methods
+  # Uses sinatra format (all sinatra docs on routing methods apply)
+  class Web < Sinatra::Base
+    register Sinatra::Async
+
+    use ::Rack::PostBodyContentTypeParser
+
+    # Throw exceptions so we can catch and nicely log them
+    set :raise_errors, true
+    set :show_exceptions, false
+    set :dump_errors, false
+
+    # Requested by iPXE on boot, chains into /boot.
+    # This enables us to customize what details we want iPXE to send us
+    # The iPXE undionly.kpxe should contain an embedded script to call this URL
+    aget '/' do
+      body { erb :boot }
+    end
 
-# Main HTTP class, handles routing methods
-# Uses sinatra format (all sinatra docs on routing methods apply)
-class ZygoteWeb < Sinatra::Base
-  register Sinatra::Async
-
-  use ::Rack::PostBodyContentTypeParser
-
-  # Throw exceptions so we can catch and nicely log them
-  set :raise_errors, true
-  set :show_exceptions, false
-  set :dump_errors, false
-
-  # Requested by iPXE on boot, chains into /boot.
-  # This enables us to customize what details we want iPXE to send us
-  # The iPXE undionly.kpxe should contain an embedded script to call this URL
-  aget '/' do
-    body { erb :boot }
-  end
-
-  # Chainload the primary menu
-  aget '/chain' do
-    # Clean params into a simple hash
-    cleaned = clean_params(params.to_h)
-    # Add the request ip into the params
-    ip = request.ip == '127.0.0.1' ? @env['HTTP_X_FORWARDED_FOR'] : request.ip
-    ip = '127.0.0.1' if ENV['TESTING'] || ip.nil? || ip.empty?
-    cleaned['ip'] = ip
-    # Compute SKU from parameters
-    sku = compute_sku(cleaned['manufacturer'], cleaned['serial'], cleaned['board-serial'])
-    cleaned['sku'] = sku
-    # Check if there are is any queued data for this SKU, and if so, merge it in to params
-    queued_data = CellQueue.shift(sku)
-    cleaned.merge!(queued_data) if queued_data
-    body { erb :menu, locals: { opts: ZygoteWeb.cell_config.merge('params' => cleaned || {}) } }
-  end
-
-  [ :aget, :apost ].each do |method|
-    send method, %r{/cell/(?<cell>\S*)/(?<action>\S*)$} do
-      # Render an action for a particular cell
+    # Chainload the primary menu
+    aget '/chain' do
       # Clean params into a simple hash
       cleaned = clean_params(params.to_h)
-      # Add the cell to the parameters
-      cell = cleaned['cell']
-      # Merge the cleaned params in with any cell options
-      cell_opts = ZygoteWeb.cell_config['index']['cells'][cell] || {}
-      opts = cell_opts.merge('params' => cleaned || {})
-      body { erb :"#{cell}/#{cleaned['action']}".to_sym, locals: { opts: opts } }
+      # Add the request ip into the params
+      ip = request.ip == '127.0.0.1' ? @env['HTTP_X_FORWARDED_FOR'] : request.ip
+      ip = '127.0.0.1' if ENV['TESTING'] || ip.nil? || ip.empty?
+      cleaned['ip'] = ip
+      # Compute SKU from parameters
+      sku = compute_sku(cleaned['manufacturer'], cleaned['serial'], cleaned['board-serial'])
+      cleaned['sku'] = sku
+      # Check if there are is any queued data for this SKU, and if so, merge it in to params
+      queued_data = CellQueue.shift(sku)
+      cleaned.merge!(queued_data) if queued_data
+
+      # Provide a hook for an external identifier to alter behavior
+      cleaned = Zygote::Identifier.identify(cleaned)
+      body { erb :menu, locals: { opts: Zygote::Web.cell_config.merge('params' => cleaned || {}) } }
     end
-  end
-
-  # Show the queue for a SKU
-  aget %r{/queue/(?<sku>\S*)$} do
-    body { JSON.pretty_generate(CellQueue.show(params['sku'])) }
-  end
 
-  aget %r{/queue} do
-    response = {}
-    CellQueue.all.each do |queue_entry|
-      response[queue_entry.name] = queue_entry.data
+    [:aget, :apost].each do |method|
+      send method, %r{/cell/(?<cell>\S*)/(?<action>\S*)$} do
+        # Render an action for a particular cell
+        # Clean params into a simple hash
+        cleaned = clean_params(params.to_h)
+        # Add the cell to the parameters
+        cell = cleaned['cell']
+        # Merge the cleaned params in with any cell options
+        cell_opts = Zygote::Web.cell_config['index']['cells'][cell] || {}
+        opts = cell_opts.merge('params' => cleaned || {})
+        body { erb :"#{cell}/#{cleaned['action']}".to_sym, locals: { opts: opts } }
+      end
     end
-    body { JSON.pretty_generate(response) }
-  end
-
-  # Delete the queue for a SKU
-  adelete %r{/queue$} do
-    CellQueue.purge(params['sku'])
-    body { JSON.pretty_generate(CellQueue.show(params['sku'])) }
-  end
-
-  # Enable push cells (with optional data) to the cell queue for a SKU
-  apost %r{/queue/(?<sku>\S*)/(?<selected_cell>\S*)$} do
-    # Clean params into a simple hash
-    cleaned = clean_params(params.to_h)
-    # Enqueue some data for this sku
-    sku = cleaned.delete('sku')
-    CellQueue.push(sku, cleaned)
-    body { JSON.pretty_generate(CellQueue.show(sku)) }
-  end
-
-  def self::cell_config
-    @@cell_config
-   end
-
-  def self::cell_config=(value)
-    @@cell_config = value
-  end
 
-  def self::views
-    @@views
-   end
+    # Show the queue for a SKU
+    aget %r{/queue/(?<sku>\S*)$} do
+      body { JSON.pretty_generate(CellQueue.show(params['sku'])) }
+    end
 
-  def self::views=(value)
-    @@views = value
-  end
+    aget %r{/queue} do
+      response = {}
+      CellQueue.all.each do |queue_entry|
+        response[queue_entry.name] = queue_entry.data
+      end
+      body { JSON.pretty_generate(response) }
+    end
 
-  helpers do
-    # Enable partial template rendering
-    def partial(template, locals = {})
-      erb(template, layout: false, locals: locals)
+    # Delete the queue for a SKU
+    adelete %r{/queue$} do
+      CellQueue.purge(params['sku'])
+      body { JSON.pretty_generate(CellQueue.show(params['sku'])) }
     end
 
-    # Override template search directorys to add spells
-    def find_template(_views, *a, &block)
-      Array(ZygoteWeb.views).each { |v| super(v, *a, &block) }
+    # Enable push cells (with optional data) to the cell queue for a SKU
+    apost %r{/queue/(?<sku>\S*)/(?<selected_cell>\S*)$} do
+      # Clean params into a simple hash
+      cleaned = clean_params(params.to_h)
+      # Enqueue some data for this sku
+      sku = cleaned.delete('sku')
+      CellQueue.push(sku, cleaned)
+      body { JSON.pretty_generate(CellQueue.show(sku)) }
     end
 
-    # Define our asynchronous scheduling mechanism, could be anything
-    # Chose EM.defer for simplicity
-    # This powers our asynchronous requests, and keeps us from blocking the main thread.
-    def native_async_schedule(&b)
-      EM.defer(&b)
+    class << self
+      attr_accessor :cell_config
+      attr_accessor :views
     end
 
-    # Needed to properly catch exceptions in async threads
-    def handle_exception!(context)
-      if context.message == 'Sinatra::NotFound'
-        error_msg = "Resource #{request.path} does not exist"
-        puts error_msg
-        ahalt(404, error_msg)
-      else
-        puts context.message
-        puts context.backtrace.join("\n")
-        ahalt(500, 'Uncaught exception occurred')
+    helpers do
+      # Enable partial template rendering
+      def partial(template, locals = {})
+        erb(template.to_sym, layout: false, locals: locals)
+      end
+
+      # Override template search directorys to add spells
+      def find_template(_views, *a, &block)
+        Array(Zygote::Web.views).each { |v| super(v, *a, &block) }
+      end
+
+      # Define our asynchronous scheduling mechanism, could be anything
+      # Chose EM.defer for simplicity
+      # This powers our asynchronous requests, and keeps us from blocking the main thread.
+      def native_async_schedule(&b)
+        EM.defer(&b)
+      end
+
+      # Needed to properly catch exceptions in async threads
+      def handle_exception!(context)
+        if context.message == 'Sinatra::NotFound'
+          error_msg = "Resource #{request.path} does not exist"
+          puts error_msg
+          ahalt(404, error_msg)
+        else
+          puts context.message
+          puts context.backtrace.join("\n")
+          ahalt(500, 'Uncaught exception occurred')
+        end
       end
     end
   end

data/lib/zygote/identifier.rb

@@ -0,0 +1,35 @@
+module Zygote
+  # Provides a hook for identifiers to alter boot-time behavior
+  # To do so, extend this class with a new identify method.
+  # You may NOT define more than one identifier - the last one wins.
+  # class MyIdentifier < Zygote::Identifier
+  #   def identify
+  #     mutate_params(@params)
+  #   end
+  # end
+  class Identifier
+    class << self
+      def inherited(subclass)
+        @identifier = subclass
+      end
+
+      def identify(params)
+        @identifier ||= self
+        @identifier.new(params).identify
+      end
+
+      def reset!
+        @identifier = self
+      end
+    end
+
+    def initialize(params)
+      @params = params
+    end
+
+    # Called only if this class is never subclassed
+    def identify
+      @params
+    end
+  end
+end

data/lib/zygote/memory.rb

@@ -3,24 +3,27 @@ require 'fileutils'
 
 require 'supermodel'
 
-# A simple means of persistence
-# This can easily be swapped out for redis, but file-based is simpler and good enough for now
-# https://github.com/maccman/supermodel/blob/master/README
-module Memory
-  extend self
-  DATABASE_PATH = (ENV['DATABASE_PATH'] || File.expand_path('../data/memory.db', $PROGRAM_NAME)).freeze
-  SuperModel::Marshal.path = DATABASE_PATH
+# Zygote container
+module Zygote
+  # A simple means of persistence
+  # This can easily be swapped out for redis, but file-based is simpler and good enough for now
+  # https://github.com/maccman/supermodel/blob/master/README
+  module Memory
+    extend self
+    DATABASE_PATH = (ENV['DATABASE_PATH'] || File.expand_path('../data/memory.db', $PROGRAM_NAME)).freeze
+    SuperModel::Marshal.path = DATABASE_PATH
 
-  def save
-    FileUtils.mkdir_p(File.dirname(DATABASE_PATH)) # FIXME: - don't make if it already exists
-    SuperModel::Marshal.dump
-  end
+    def save
+      FileUtils.mkdir_p(File.dirname(DATABASE_PATH)) # FIXME: - don't make if it already exists
+      SuperModel::Marshal.dump
+    end
 
-  def load
-    SuperModel::Marshal.load
+    def load
+      SuperModel::Marshal.load
+    end
   end
-end
 
-at_exit do
-  Memory.save
+  at_exit do
+    Memory.save
+  end
 end

data/lib/zygote/server.rb

@@ -1,44 +1,53 @@
 require 'zygote/http'
 require 'thin'
 
-class ZygoteServer
-  def initialize(port: 7000, threads:1000, host: '0.0.0.0', config_path: nil, cells: [], debug:false)
-    debug ||= ENV['DEBUG']
+# Main zygote namespace
+module Zygote
+  # Wrapper around thin / event machine to run zygote sinatra rack app in.
+  class Server
+    def initialize(port: 7000, threads: 1000, host: '0.0.0.0', config_path: nil, cells: [], debug: false)
+      debug ||= ENV['DEBUG']
 
-    cell_config = YAML.load(File.read(config_path || File.join(Dir.pwd, 'config', 'cells.yml')))
-    ZygoteWeb.views = [File.expand_path('../../../views', __FILE__), cells].flatten
-    ZygoteWeb.cell_config = cell_config
-    if debug
-      $stdout.sync = true
-      $stderr.sync = true
-    end
+      cell_config = YAML.load(File.read(config_path || File.join(Dir.pwd, 'config', 'cells.yml')))
+      Zygote::Web.views = [File.expand_path('../../../views', __FILE__), cells].flatten
+      Zygote::Web.cell_config = cell_config
+      if debug
+        $stdout.sync = true
+        $stderr.sync = true
+      end
 
-    app = ZygoteWeb.new
-    dispatch = Rack::Builder.app do
-      map '/' do
-        run app
+      app = Zygote::Web.new
+      dispatch = Rack::Builder.app do
+        map '/' do
+          run app
+        end
       end
+      Thin::Logging.trace = true if debug
+      @server = Thin::Server.new(port, host, dispatch, threadpool_size: threads).backend
     end
-    Thin::Logging.trace=true if debug
-    @server = Thin::Server.new(port, host, dispatch, threadpool_size: threads).backend
-  end
 
-  def start
-    @server.start
-  rescue => ex
-    puts ex
-    puts ex.backtrace.join("\n")
-  end
-
-  def run
-    EM.run do
-      init_sighandlers
+    def start
       @server.start
+    rescue => ex
+      puts ex
+      puts ex.backtrace.join("\n")
+    end
+
+    def run
+      EM.run do
+        init_sighandlers
+        @server.start
+      end
     end
   end
-end
 
-def init_sighandlers
-  Signal.trap('INT')  { 'Got interrupt'; EM.stop; exit }
-  Signal.trap('TERM') { 'Got term';      EM.stop; exit }
+  def init_sighandlers
+    clean_quit = lambda do
+      EM.stop
+      exit
+    end
+
+    Signal.trap('INT') { clean_quit.call }
+    Signal.trap('TERM') { clean_quit.call }
+  end
 end

data/lib/zygote/test.rb

@@ -6,7 +6,9 @@ require 'rspec'
 require 'em-synchrony'
 require 'em-synchrony/em-http'
 
+# Main zygote class
 module Zygote
+  # Helper to set up test config
   module TestConfig
     extend self
     attr_reader :config_path, :cells, :port, :fixtures
@@ -24,7 +26,7 @@ module Zygote
       mod.class_eval %[
         around(:each) do |example|
           EM.synchrony do
-            ZygoteServer.new(
+            Zygote::Server.new(
               config_path: TestConfig.config_path,
               cells: TestConfig.cells
             ).start
@@ -70,7 +72,7 @@ module Zygote
 
   # Returns EventMachine::HttpClient
   def post(uri, params = {})
-    EM::Synchrony.sync(EventMachine::HttpRequest.new("http://127.0.0.1:#{TestConfig.port}/#{uri}").apost(body: JSON.dump(params), head: {'Content-Type' => 'application/json'}))
+    EM::Synchrony.sync(EventMachine::HttpRequest.new("http://127.0.0.1:#{TestConfig.port}/#{uri}").apost(body: JSON.dump(params), head: { 'Content-Type' => 'application/json' }))
   end
 
   def parameterize(params)

data/lib/zygote/util.rb

@@ -26,7 +26,7 @@ end
 
 def clean_params(params)
   params.delete_if { |x, _| x == 'splat' || x == 'captures' }
-  params = params.map { |k,v| [k, v.is_a?(Hash) ? encode64(v) : v] }.to_h
+  params = params.map { |k, v| [k, v.is_a?(Hash) ? encode64(v) : v] }.to_h
   params
 end
 

data/lib/zygote/version.rb

@@ -1,4 +1,4 @@
 # Namespace for our gem
 module Zygote
-  VERSION = '0.2.11'.freeze
+  VERSION = '0.2.12'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zygote
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Dale Hamel
@@ -178,6 +178,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
 description: Automate baremetal server actions with iPXE
 email: dale.hamel@srvthe.net
 executables: []
@@ -187,6 +201,7 @@ files:
 - lib/zygote.rb
 - lib/zygote/cell_queue.rb
 - lib/zygote/http.rb
+- lib/zygote/identifier.rb
 - lib/zygote/memory.rb
 - lib/zygote/server.rb
 - lib/zygote/test.rb
@@ -214,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Differentiate servers with iPXE