nucleon 0.1.0

data/README.rdoc

@@ -0,0 +1,26 @@
+= coral_gem
+
+This gem provides starter scaffolding for further development.  It is 
+scaffolding but it is functional.
+
+== Contributing to coral_gem
+ 
+* Check out the latest {major}.{minor} branch to make sure the feature hasn't 
+  been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested 
+  it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a 
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want 
+  to have your own version, or is otherwise necessary, that is fine, but 
+  please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Licensed under GPLv3.  See LICENSE.txt for further details.
+
+Copyright (c) 2013  Adrian Webb <adrian.webb@coraltech.net>
+Coral Technology Group LLC

data/Rakefile

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+require 'bundler'
+require 'jeweler'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+require 'yard'
+
+require './lib/nucleon.rb'
+
+#-------------------------------------------------------------------------------
+# Dependencies
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+#-------------------------------------------------------------------------------
+# Gem specification
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name                  = "nucleon"
+  gem.homepage              = "http://github.com/coralnexus/nucleon"
+  gem.rubyforge_project     = 'nucleon'
+  gem.license               = "GPLv3"
+  gem.email                 = "adrian.webb@coralnexus.com"
+  gem.authors               = ["Adrian Webb"]
+  gem.summary               = %Q{Framework that provides a simple foundation for building distributively configured, extremely pluggable and extendable, and easily parallel Ruby applications}
+  gem.description           = %Q{Framework that provides a simple foundation for building distributively configured, extremely pluggable and extendable, and easily parallel Ruby applications}
+  gem.required_ruby_version = '>= 1.8.1'
+  gem.has_rdoc              = true
+  gem.rdoc_options << '--title' << 'Nucleon' <<
+                      '--main' << 'README.rdoc' <<
+                      '--line-numbers'
+                      
+  # Dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+#-------------------------------------------------------------------------------
+# Testing
+
+RSpec::Core::RakeTask.new(:spec, :tag) do |spec, task_args|
+  options = []
+  options << "--tag #{task_args[:tag]}" if task_args.is_a?(Array) && ! task_args[:tag].to_s.empty?  
+  spec.rspec_opts = options.join(' ')
+end
+
+task :default => :spec
+
+#-------------------------------------------------------------------------------
+# Documentation
+
+version   = Nucleon::VERSION
+doc_title = "nucleon #{version}"
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = doc_title
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+#---
+
+YARD::Rake::YardocTask.new do |ydoc|
+  ydoc.files   = [ 'README*', 'lib/**/*.rb' ]
+  ydoc.options = [ "--output-dir yardoc", "--title '#{doc_title}'" ]
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/nucleon.rb

@@ -0,0 +1,172 @@
+
+#*******************************************************************************
+# Nucleon
+#
+# Framework that provides a simple foundation for building distributively 
+# configured, extremely pluggable and extendable, and easily parallel 
+# applications.
+#
+# Author::    Adrian Webb (mailto:adrian.webb@coralnexus.com)
+# License::   GPLv3
+
+#-------------------------------------------------------------------------------
+# Global namespace
+
+module Kernel
+   
+  def dbg(data, label = '')
+    # Invocations of this function should NOT be committed to the project
+    require 'pp'
+    
+    puts '>>----------------------'
+    unless label.empty?
+      puts label
+      puts '---'
+    end
+    pp data
+    puts '<<'
+  end
+  
+  #---  
+    
+  def nucleon_locate(command)
+    command = command.to_s
+    exts    = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts.each do |ext|
+        exe = File.join(path, "#{command}#{ext}")
+        return exe if File.executable?(exe)
+      end
+    end
+    return nil
+  end
+    
+  #---
+  
+  def nucleon_require(base_dir, name)
+    name = name.to_s
+    top_level_file = File.join(base_dir, "#{name}.rb")
+    
+    require top_level_file if File.exists?(top_level_file) 
+     
+    directory = File.join(base_dir, name)
+      
+    if File.directory?(directory)
+      Dir.glob(File.join(directory, '**', '*.rb')).each do |sub_file|
+        require sub_file
+      end
+    end  
+  end
+end
+
+#-------------------------------------------------------------------------------
+# Top level properties 
+
+lib_dir          = File.dirname(__FILE__)
+core_dir         = File.join(lib_dir, 'nucleon')
+mixin_dir        = File.join(core_dir, 'mixin')
+mixin_config_dir = File.join(mixin_dir, 'config')
+mixin_action_dir = File.join(mixin_dir, 'action')
+macro_dir        = File.join(mixin_dir, 'macro')
+util_dir         = File.join(core_dir, 'util')
+mod_dir          = File.join(core_dir, 'mod')
+plugin_dir       = File.join(core_dir, 'plugin')
+  
+#-------------------------------------------------------------------------------
+# Coral requirements
+
+git_location = nucleon_locate('git')
+
+$:.unshift(lib_dir) unless $:.include?(lib_dir) || $:.include?(File.expand_path(lib_dir))
+
+#---
+  
+require 'rubygems'
+
+require 'pp'
+require 'i18n'
+require 'log4r'
+require 'log4r/configurator'
+require 'base64'
+require 'deep_merge'
+require 'facter'
+require 'yaml'
+require 'multi_json'
+require 'digest/sha1'
+require 'optparse'
+require 'thread' # Eventually depreciated
+require 'celluloid'
+require 'celluloid/autostart'
+
+#---
+
+# TODO: Make this dynamically settable
+
+I18n.enforce_available_locales = false
+I18n.load_path << File.expand_path(File.join('..', 'locales', 'en.yml'), lib_dir)
+
+#---
+
+if git_location
+  require 'grit'
+  nucleon_require(util_dir, :git)
+end
+
+#---
+
+# Object modifications (100% pure monkey patches)
+Dir.glob(File.join(mod_dir, '*.rb')).each do |file|
+  require file
+end
+
+#---
+
+# Mixins for classes
+Dir.glob(File.join(mixin_dir, '*.rb')).each do |file|
+  require file
+end
+Dir.glob(File.join(mixin_config_dir, '*.rb')).each do |file|
+  require file
+end
+Dir.glob(File.join(mixin_action_dir, '*.rb')).each do |file|
+  require file
+end
+Dir.glob(File.join(macro_dir, '*.rb')).each do |file|
+  require file
+end
+
+#---
+
+# Include bootstrap classes
+nucleon_require(core_dir, :errors)
+nucleon_require(core_dir, :codes)
+nucleon_require(util_dir, :data)
+nucleon_require(core_dir, :config)
+nucleon_require(util_dir, :interface) 
+nucleon_require(core_dir, :core) 
+
+#---
+
+# Include core utilities
+[ :liquid, 
+  :cli, 
+  :disk, 
+  :package, 
+  :shell
+].each do |name| 
+  nucleon_require(util_dir, name)
+end
+
+# Include core systems
+nucleon_require(core_dir, :facade)
+nucleon_require(core_dir, :gems)
+nucleon_require(core_dir, :manager)
+nucleon_require(plugin_dir, :base)
+nucleon_require(core_dir, :plugin)
+
+#-------------------------------------------------------------------------------
+# Basic information
+
+module Nucleon
+  VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
+end

data/locales/en.yml

@@ -0,0 +1,232 @@
+en:
+  nucleon:
+    errors:
+      batch_error: |-
+        An issue was encountered during batch processing
+    core:
+      util:
+        cli:
+          options:
+            help: |-
+              Display help information for this command
+            log_level: |-
+              Set the logging level for this execution run
+            encoded: |-
+              Optional encoded parameter set that contains default action settings (machine use only)
+          parse:
+            error: |-
+              There was a problem with the command arguments given
+        batch:
+          unexpected_error: |
+            There was a problem with batch %{process}: %{message}
+          coral_error: |
+            There was a problem with batch %{process}: %{message}
+      mixins:
+        project:
+          options:
+            provider: |-
+              Coral plugin provider to use for this project (default %{default_value})
+            reference: |-
+              Project URL or reference string to set as primary remote (default %{default_value})
+            revision: |-
+              Revision or branch to load (default %{default_value})
+        commit:
+          options:
+            commit: |-
+              Commit any uncommitted changes (default %{default_value})
+            empty: |-
+              Allow commits with no changes (default %{default_value})
+            message: |-
+              Commit message (defaults to auto generated commit information)
+            author: |-
+              Author of the changes being committed if different from the committer
+            propogate: |-
+              Propogate commits throughout the project tree (default %{default_value})
+        push:
+          options:
+            push: |-
+              Push changes to remote server (default %{default_value})
+            propogate: |-
+              Propogate pushes to the remote throughout the project tree (default %{default_value})
+            remote: |-
+              Remote name to push to (default %{default_value})
+            revision: |-
+              Branch to push (default %{default_value})
+        node:
+          options:
+            parallel: |-
+              Enable parallelism of node action execution (default %{default_value})
+            net_provider: |-
+              Coral network provider to use for managing cloud nodes (default %{default_value})
+            node_provider: |-
+              Default to using a specific node provider but individual node references can override (default %{default_value})
+            nodes: |-
+              Optional nodes on which to execute this action
+          errors:
+            network_provider: |-
+              Network plugin provider %{value} is not loaded >> Pick from the following: %{choices}
+            node_provider: |-
+              Node plugin provider %{value} is not loaded >> Pick from the following: %{choices}
+            nodes: |-
+              Node reference %{value} failed to parse or provider %{provider} isn't loaded (%{name})
+        keypair:
+          options:
+            private_key: |-
+              Optional existing private SSH key to use for SSH communication (new keys are generated by default)
+            require_password: |-
+              Require and prompt for a password for generated keys (default %{default_value})
+            key_type: |-
+              Type of SSH key to generate (default %{default_value})
+            key_bits: |-
+              Strength of generated key encryption in bits (default %{default_value})
+            key_comment: |-
+              Optional key comment (attached at the end of the public key)
+          errors:
+            private_key_not_found: |-
+              Private key %{value} not found
+            private_key_parse_error: |-
+              Private key %{value} failed to parse and can not be accepted as a valid private SSH key
+            key_type: |-
+              SSH key type %{value} not supported >> Pick from the following: %{choices}
+            key_bits: |-
+              Encryption strength must be greater than %{required} bits (%{value} specified)
+            no_password: |-
+              Password verification of private key was terminated (verification required to use encrypted SSH keys)             
+      exec:
+        help:
+          usage: |-
+            Usage
+          header: |-
+            Available actions
+          footer: |-
+            For help on any individual action run `coral <action> -h`
+        errors:
+          missing_argument: |-
+            Argument <%{name}> must be specified
+    actions:
+      extract:
+        options:
+          path: |-
+            Base path in which to extract the encoded data
+          encoded: |-
+            Encoded data to be extracted into the base path
+        errors:
+          path: |-
+            "Base path for extracted files must be an existing directory"
+          encoded: |-
+            "Data is either not properly encoded or is empty %{value}"
+      create:
+        options:
+          reference: |-
+            Git repository URL of Coral cloud to start project from (default %{default_value})
+          revision: |-
+            Revision or branch to initialize the project with (default %{default_value})
+          path: |-
+            Project path (default %{default_value})
+          start: |-
+            Creating a new Coral cloud at %{path} from %{reference}
+      add:
+        options:
+          sub_reference: |-
+            Repository URL of Coral component (module or library) to include in the project
+          sub_path: |-
+            Subproject path
+          editable: |-
+            Whether or not this sub project should be added as an editable remote (default %{default_value})
+        start: |-
+          Adding new subproject from %{sub_reference} at %{sub_path}
+      remove:
+        options:
+          sub_path: |-
+            Subproject path
+        start: |-
+          Removing existing subproject at %{sub_path}
+      update:
+        start: |-
+          Starting update run from provider %{project_provider} (ref: %{reference} rev: %{revision})
+        provision: |-
+          Running provisioning updates on %{node_name} from node provider %{node_provider}
+      save:
+        options:
+          files: |-
+            Optional space separated list of files to save
+        start: |-
+          Saving project changes with provider %{project_provider} (ref: %{reference} rev: %{revision})
+      images:
+        options:
+          match_case: |-
+            Match case on any search terms given when searching for images (default %{default_value})
+          require_all: |-
+            Require all search terms to be present in image descriptions to be included (default %{default_value})
+          provider: |-
+            Node provider to retrieve images for
+          search: |-
+            Optional array of search terms to filter image results
+        start: |-
+          Retrieving a list of defined images from %{node_provider}
+        results: |-
+          Total of %{images} images found
+      machines:
+        options:
+          node_provider: |-
+            Node provider to retrieve machine types
+        start: |-
+          Retrieving a list of available machines from %{node_provider}
+        results: |-
+          Total of %{machines} machine types found
+      spawn:
+        options:
+          parallel: |-
+            Enable or disable parallelism of node creation (default %{default_value})
+          seed: |-
+            Coral project reference with cloud project to seed new machines with (default %{default_value})
+          region: |-
+            Machine provider region in which to create the machines (defaults to first defined in provider)
+          machine_type: |-
+            Provider ID of machine type to create (defaults to first defined in provider - usually smallest)
+          provider: |-
+            Create machines with this node provider
+          image: |-
+            Provider ID of operating system image on which to initialize the new machines           
+          hostnames: |-
+            Hostnames of machines to create on provider infrastructure
+        start: |-
+          Spawning new machines on %{provider}
+      bootstrap:
+        options:
+          bootstrap_path: |-
+            Bootstrap script top level local directory (default %{default_value})
+          bootstrap_init: |-
+            Gateway bootstrap script within the bootstrap project directory (default %{default_value})
+          bootstrap_glob: |-
+            Path glob to use in searching bootstrap scripts for remote execution (default %{default_value})
+          auth_files: |-
+            Any additional authorization or state files to pass to the node during bootstrap (relative to local home)
+          home_env_var: |-
+            Home directory environment variable on remote server (default %{default_value})
+          home: |-
+            Specified home directory on remote server (default %{default_value})
+          bootstrap_nodes: |-
+            Node references to bootstrap
+        errors:
+          bootstrap_path: |-
+            Bootstrap path must be an existing directory
+          auth_files: |-
+            Authorization file %{value} does not exist on the local system
+          bootstrap_nodes: |-
+            Provider %{node_provider} node %{name} is not a valid node to bootstrap (%{value} given)
+        start: |-
+          Starting bootstrap of machine %{hostname} (%{id})
+        success: |-
+          Machine %{hostname} (%{id}) successfully bootstrapped
+      exec:
+        options:
+          command: |-
+            Command line executable and arguments to execute on machine
+      seed:
+        options:
+          home: |-
+            Home directory in which to initialize the deploy SSH keys (default %default_value})
+        errors:
+          project_reference: |-
+            Project reference %{value} failed to parse or provider %{provider} isn't loaded >> Possible providers: %{choices}

data/nucleon.gemspec

@@ -0,0 +1,109 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "nucleon"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adrian Webb"]
+  s.date = "2014-02-19"
+  s.description = "Framework that provides a simple foundation for building distributively configured, extremely pluggable and extendable, and easily parallel Ruby applications"
+  s.email = "adrian.webb@coralnexus.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/nucleon.rb",
+    "locales/en.yml",
+    "nucleon.gemspec",
+    "spec/coral_mock_input.rb",
+    "spec/coral_test_kernel.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/coralnexus/nucleon"
+  s.licenses = ["GPLv3"]
+  s.rdoc_options = ["--title", "Nucleon", "--main", "README.rdoc", "--line-numbers"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.1")
+  s.rubyforge_project = "nucleon"
+  s.rubygems_version = "1.8.11"
+  s.summary = "Framework that provides a simple foundation for building distributively configured, extremely pluggable and extendable, and easily parallel Ruby applications"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<log4r>, ["~> 1.1"])
+      s.add_runtime_dependency(%q<i18n>, ["~> 0.6"])
+      s.add_runtime_dependency(%q<deep_merge>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<celluloid>, ["~> 0.15"])
+      s.add_runtime_dependency(%q<sshkey>, ["~> 1.6"])
+      s.add_runtime_dependency(%q<hiera>, ["~> 1.3"])
+      s.add_runtime_dependency(%q<multi_json>, ["~> 1.7"])
+      s.add_runtime_dependency(%q<grit>, ["~> 2.5"])
+      s.add_runtime_dependency(%q<octokit>, ["~> 2.7"])
+      s.add_runtime_dependency(%q<netrc>, ["~> 0.7"])
+      s.add_runtime_dependency(%q<fog>, ["~> 1.20"])
+      s.add_runtime_dependency(%q<rgen>, ["~> 0.6"])
+      s.add_runtime_dependency(%q<facter>, ["~> 1.7"])
+      s.add_runtime_dependency(%q<puppet>, ["~> 3.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.10"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8"])
+    else
+      s.add_dependency(%q<log4r>, ["~> 1.1"])
+      s.add_dependency(%q<i18n>, ["~> 0.6"])
+      s.add_dependency(%q<deep_merge>, ["~> 1.0"])
+      s.add_dependency(%q<celluloid>, ["~> 0.15"])
+      s.add_dependency(%q<sshkey>, ["~> 1.6"])
+      s.add_dependency(%q<hiera>, ["~> 1.3"])
+      s.add_dependency(%q<multi_json>, ["~> 1.7"])
+      s.add_dependency(%q<grit>, ["~> 2.5"])
+      s.add_dependency(%q<octokit>, ["~> 2.7"])
+      s.add_dependency(%q<netrc>, ["~> 0.7"])
+      s.add_dependency(%q<fog>, ["~> 1.20"])
+      s.add_dependency(%q<rgen>, ["~> 0.6"])
+      s.add_dependency(%q<facter>, ["~> 1.7"])
+      s.add_dependency(%q<puppet>, ["~> 3.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.2"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.10"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<yard>, ["~> 0.8"])
+    end
+  else
+    s.add_dependency(%q<log4r>, ["~> 1.1"])
+    s.add_dependency(%q<i18n>, ["~> 0.6"])
+    s.add_dependency(%q<deep_merge>, ["~> 1.0"])
+    s.add_dependency(%q<celluloid>, ["~> 0.15"])
+    s.add_dependency(%q<sshkey>, ["~> 1.6"])
+    s.add_dependency(%q<hiera>, ["~> 1.3"])
+    s.add_dependency(%q<multi_json>, ["~> 1.7"])
+    s.add_dependency(%q<grit>, ["~> 2.5"])
+    s.add_dependency(%q<octokit>, ["~> 2.7"])
+    s.add_dependency(%q<netrc>, ["~> 0.7"])
+    s.add_dependency(%q<fog>, ["~> 1.20"])
+    s.add_dependency(%q<rgen>, ["~> 0.6"])
+    s.add_dependency(%q<facter>, ["~> 1.7"])
+    s.add_dependency(%q<puppet>, ["~> 3.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.2"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.10"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<yard>, ["~> 0.8"])
+  end
+end
+

data/spec/coral_mock_input.rb

@@ -0,0 +1,29 @@
+
+class MockInput
+
+  #-----------------------------------------------------------------------------
+  # Constructor / Destructor
+  
+  def initialize(strings)
+    if strings.is_a?(String)
+      strings = [ strings ]
+    end
+    @strings = strings
+  end
+  
+  #---
+  
+  def self.with(strings)
+    $stdin = self.new(strings)
+    yield
+  ensure
+    $stdin = STDIN
+  end
+  
+  #-----------------------------------------------------------------------------
+  # Accessors / Modifiers
+
+  def gets
+    return @strings.shift
+  end  
+end

data/spec/coral_test_kernel.rb

@@ -0,0 +1,22 @@
+
+module Kernel
+
+  #-----------------------------------------------------------------------------
+  # Utilities
+
+  def capture
+    out     = StringIO.new
+    $stdout = out
+    
+    error   = StringIO.new
+    $stderr = error
+    
+    # Go do stuff!
+    yield    
+    return out, error
+    
+  ensure
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+
+require 'rspec'
+require 'stringio'
+require 'nucleon'
+
+require 'coral_test_kernel'
+require 'coral_mock_input'
+
+#-------------------------------------------------------------------------------
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+  config.color_enabled  = true
+  config.formatter      = 'documentation'
+end