nucleus 0.1.0

data/lib/nucleus/core/import/version_detector.rb

@@ -0,0 +1,18 @@
+module Nucleus
+  module VersionDetector
+    # Get all abstraction layer versions that are included in the project via the adapters.
+    # The abstraction layer versions are identified by the presence of a directory below 'adapters/'.
+    # An abstraction layer's directory will resolve to its version.
+    # Therefore, if there is a directory 'adapters/v3', 'v3' will be on of the returned versions.
+    # The method caches its detected versions and returns the previous result if called multiple times.
+    #
+    # @return [Array<String>] names of the abstraction layer versions
+    def self.api_versions
+      return @api_versions if @api_versions
+      abstraction_layer_api_versions_dir = "#{Nucleus.root}/lib/nucleus/adapters/*"
+      @api_versions = Dir.glob(abstraction_layer_api_versions_dir).map do |f|
+        File.basename(f) if File.directory?(f)
+      end.compact
+    end
+  end
+end

data/lib/nucleus/core/models/abstract_model.rb

@@ -0,0 +1,29 @@
+module Nucleus
+  #
+  # @author Cedric Roeck (cedric.roeck@gmail.com)
+  # @since 0.1.0
+  class AbstractModel
+    include Kwalify::Util::HashLike
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :created_at
+    attr_accessor :updated_at
+
+    def initialize(hash = nil)
+      return if hash.nil?
+      @name = hash['name']
+      @id = hash['id']
+    end
+
+    def to_s
+      return name if self.respond_to?('name')
+      return id if id
+      super.to_s
+    end
+
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/nucleus/core/models/endpoint.rb

@@ -0,0 +1,30 @@
+module Nucleus
+  # The {Endpoint} model will initially be imported from +.yaml+ description files and shall be persisted
+  # in the {Nucleus::DB::Store store}. The endpoint has the following properties:<br>
+  # * id (String)
+  # * name (String)
+  # * provider (Nucleus::Provider)
+  # * url (String)
+  # * app_domain (String)
+  # * trust (Boolean)
+  #
+  # @author Cedric Roeck (cedric.roeck@gmail.com)
+  # @since 0.1.0
+  class Endpoint < Nucleus::AbstractModel
+    include Kwalify::Util::HashLike
+
+    attr_accessor :provider
+    attr_accessor :url # str
+    attr_accessor :app_domain # str
+    attr_accessor :trust # bool
+
+    def initialize(hash = nil)
+      super(hash)
+      @trust = false
+      return if hash.nil?
+      @url = hash['url']
+      @app_domain = hash['app_domain']
+      @trust = hash['trust'] if hash.key?('trust')
+    end
+  end
+end

data/lib/nucleus/core/models/provider.rb

@@ -0,0 +1,26 @@
+module Nucleus
+  # The {Provider} model will initially be imported from +.yaml+ description files and shall be persisted
+  # in the {Nucleus::DB::Store store}. The provider has the following properties:<br>
+  # * id (String)
+  # * name (String)
+  # * vendor (Nucleus::Vendor)
+  # * endpoints (Array<Nucleus::Endpoint>)
+  #
+  # @author Cedric Roeck (cedric.roeck@gmail.com)
+  # @since 0.1.0
+  class Provider < Nucleus::AbstractModel
+    include Kwalify::Util::HashLike
+
+    attr_accessor :vendor
+    attr_accessor :endpoints # seq
+
+    def initialize(hash = nil)
+      super(hash)
+      @endpoints = []
+      return if hash.nil?
+
+      return unless hash.key?('endpoints')
+      @endpoints = hash['endpoints'].map! { |e| e.is_a?(Nucleus::Endpoint) ? e : Nucleus::Endpoint.new(e) }
+    end
+  end
+end

data/lib/nucleus/core/models/vendor.rb

@@ -0,0 +1,22 @@
+module Nucleus
+  # The {Vendor} model will initially be imported from +.yaml+ description files and shall be persisted
+  # in the {Nucleus::DB::Store store}. The vendor has the following properties:<br>
+  # * id (String)
+  # * name (String)
+  # * providers (Array<Nucleus::Provider>)
+  #
+  # @author Cedric Roeck (cedric.roeck@gmail.com)
+  # @since 0.1.0
+  class Vendor < Nucleus::AbstractModel
+    attr_accessor :providers # seq
+
+    def initialize(hash = nil)
+      super(hash)
+      @providers = []
+      return if hash.nil?
+
+      return unless hash.key?('providers')
+      @providers = hash['providers'].map! { |e| e.is_a?(Nucleus::Provider) ? e : Nucleus::Provider.new(e) }
+    end
+  end
+end

data/lib/nucleus/ext/kernel.rb

@@ -0,0 +1,5 @@
+module Kernel
+  def nucleus_config
+    Configatron::RootStore.instance
+  end
+end

data/lib/nucleus/ext/regexp.rb

@@ -0,0 +1,49 @@
+class Regexp
+  PERFECT_URL_PATTERN = %r{
+    \A
+
+    # protocol identifier
+    (?:(?:https?|ftp)://)
+
+    # user:pass authentication
+    (?:\S+(?::\S*)?@)?
+
+    (?:
+      # IP address exclusion
+      # private & local networks
+      (?!10(?:\.\d{1,3}){3})
+      (?!127(?:\.\d{1,3}){3})
+      (?!169\.254(?:\.\d{1,3}){2})
+      (?!192\.168(?:\.\d{1,3}){2})
+      (?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})
+
+      # IP address dotted notation octets
+      # excludes loopback network 0.0.0.0
+      # excludes reserved space >= 224.0.0.0
+      # excludes network & broacast addresses
+      # (first & last IP address of each class)
+      (?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])
+      (?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}
+      (?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))
+    |
+      # host name
+      (?:(?:[a-z\u00a1-\uffff0-9]+-?)*[a-z\u00a1-\uffff0-9]+)
+
+      # domain name
+      (?:\.(?:[a-z\u00a1-\uffff0-9]+-?)*[a-z\u00a1-\uffff0-9]+)*
+
+      # TLD identifier
+      (?:\.(?:[a-z\u00a1-\uffff]{2,}))
+    )
+
+    # port number
+    (?::\d{2,5})?
+
+    # resource path
+    (?:/[^\s]*)?
+
+    \z
+  }xi
+
+  UUID_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i
+end

data/lib/nucleus/os.rb

@@ -0,0 +1,15 @@
+# Operating System module to detect the current platform
+# From: http://stackoverflow.com/questions/170956/how-can-i-find-which-operating-system-my-ruby-program-is-running-on
+module OS
+  # Is the current platform windows?
+  # @return [Boolean] true if on windows, else false
+  def self.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  # Is the current platform Unix?
+  # @return [Boolean] true if on Unix, else false
+  def self.unix?
+    !OS.windows?
+  end
+end

data/lib/nucleus/root_dir.rb

@@ -0,0 +1,13 @@
+module Nucleus
+  # Return the project's root directory.
+  # @return [Path] project's root directory
+  def self.root
+    File.join(__dir__, '..', '..')
+  end
+
+  # Return the project's main source code directory 'lib/nucleus''.
+  # @return [Path] project's main source code directory
+  def self.src
+    File.join(Nucleus.root, '/lib/nucleus')
+  end
+end

data/lib/nucleus/scripts/finalize.rb

@@ -0,0 +1,8 @@
+# Lock the configuration, so it can't be manipulated
+nucleus_config.lock!
+
+puts "Rack environment: #{ENV['RACK_ENV']}" if ENV.key?('RACK_ENV')
+puts 'Configuration locked!'
+
+puts 'Initialization complete'
+puts '-----------------------------------------------'

data/lib/nucleus/scripts/initialize.rb

@@ -0,0 +1,9 @@
+include Nucleus::Logging
+
+begin
+  # Shutdown hook to cleanup
+  require 'nucleus/scripts/shutdown'
+rescue Nucleus::StartupError => e
+  log.error "Application startup failed (#{e.exit_code}), exit now"
+  exit e.exit_code
+end

data/lib/nucleus/scripts/initialize_config_defaults.rb

@@ -0,0 +1,26 @@
+# Check the API versions once and make them available via configatron
+nucleus_config.api.versions = Nucleus::VersionDetector.api_versions
+
+# make sure the key is always set
+key_file = nil
+if nucleus_config.ssh.key?(:custom_key) && !nucleus_config.ssh.custom_key.nil?
+  puts "Loading custom SSH key #{nucleus_config.ssh.custom_key}"
+  # use the custom key file
+  key_file = nucleus_config.ssh.custom_key
+
+  # fail if file does not exist
+  unless File.exist?(key_file)
+    msg = "Could not find the SSH key: '#{key_file}'"
+    STDERR.puts msg
+    fail Nucleus::StartupError.new(msg, Nucleus::ExitCodes::INVALID_SSH_KEY_FILE)
+  end
+
+  if File.read(key_file).include?('ENCRYPTED')
+    msg = "Provided private key '#{key_file}' must not be protected with a passphrase."
+    STDERR.puts msg
+    fail Nucleus::StartupError.new(msg, Nucleus::ExitCodes::INVALID_SSH_KEY_FILE_PROTECTED)
+  end
+end
+
+# now setup the SSHHandler
+nucleus_config.ssh.handler = Nucleus::SSHHandler.new(key_file)

data/lib/nucleus/scripts/load.rb

@@ -0,0 +1,17 @@
+# First, load 3rd party dependencies
+require_relative 'load_dependencies'
+
+# require all patched classes
+require_rel '../ext'
+
+# OS detection
+require 'nucleus/os'
+
+# Root directory convenience module
+require 'nucleus/root_dir'
+
+# core
+require_rel '../core'
+
+# adapters
+require_rel '../adapters'

data/lib/nucleus/scripts/load_dependencies.rb

@@ -0,0 +1,43 @@
+require 'require_all'
+
+# actually more native
+require 'tmpdir'
+require 'find'
+require 'time'
+require 'securerandom'
+require 'logger'
+
+# database
+require 'moneta'
+require 'daybreak'
+require 'lmdb'
+
+# schema
+require 'kwalify'
+
+# serialization
+require 'oj'
+
+# SSH keys
+require 'sshkey'
+
+# Http clients, ...
+# Currently we need excon AND rest_client, due to excon not supporting multipart requests. See also:
+# https://github.com/excon/excon/issues/353
+require 'excon'
+require 'rest_client'
+# faye is used to fetch logs from cloud foundry, using websocket communication
+require 'faye/websocket'
+require 'protobuf'
+require 'eventmachine'
+require 'em-http'
+
+# others
+require 'request_store'
+require 'git'
+require 'mime-types'
+
+# require archive dependencies
+require 'zip'
+require 'zlib'
+require 'rubygems/package'

data/lib/nucleus/scripts/setup_config.rb

@@ -0,0 +1,28 @@
+# configuration
+require 'logger'
+require 'configatron/core'
+require 'nucleus/ext/kernel'
+require 'nucleus/os'
+
+# import the configuration file that resides in the user's home directory as initial choice
+if OS.windows?
+  home_dir_config = File.expand_path(File.join(Dir.home, 'nucleus', 'nucleus_config.rb'))
+else
+  home_dir_config = File.expand_path(File.join(Dir.home, '.nucleus', 'nucleus_config.rb'))
+end
+if File.exist?(home_dir_config)
+  puts "Applying configuration from: #{home_dir_config}"
+  require home_dir_config
+end
+
+# include the configuration of the project to overwrite the home dir config
+project_dir_config = '../../../config/nucleus_config.rb'
+if File.exist?(File.expand_path(project_dir_config, File.dirname(__FILE__)))
+  puts "Applying configuration from: #{File.expand_path(project_dir_config, File.dirname(__FILE__))}"
+  require_relative project_dir_config
+end
+
+# make sure we have a logging directory
+unless nucleus_config.logging.key?(:path)
+  nucleus_config.logging.path = File.join(__dir__, '..', '..', '..', 'log')
+end

data/lib/nucleus/scripts/shutdown.rb

@@ -0,0 +1,11 @@
+# Implement shutdown actions, tidy up the DB
+at_exit do
+  puts '-----------------------------------------------', ''
+  puts 'Cleaning up...'
+
+  # delete the SSHHandler generated files
+  puts '... delete SSH files ...'
+  nucleus_config.ssh.handler.cleanup if nucleus_config.key?(:ssh) && nucleus_config.ssh.key?(:handler)
+
+  puts '... done!'
+end

data/lib/nucleus/version.rb

@@ -0,0 +1,3 @@
+module Nucleus
+  VERSION = '0.1.0'
+end

data/nucleus.gemspec

@@ -0,0 +1,88 @@
+# coding: utf-8
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'nucleus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nucleus'
+  spec.version       = Nucleus::VERSION
+  spec.authors       = ['Stefan Kolb', 'Cedric Röck']
+  spec.email         = ['stefan.kolb@uni-bamberg.de']
+  spec.summary       = 'Nucleus unifies core management functions of Platform-as-a-Service (PaaS) systems.'
+  spec.description   = 'Nucleus is a unified API for deployment and management of '\
+                        'Platform-as-a-Service (PaaS) systems.'
+  spec.homepage      = 'https://github.com/stefan-kolb/nucleus'
+  spec.license       = 'MIT'
+  spec.executables   = 'nucleus'
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0'
+
+  # we ignore the test files and icons as they tremendously increase the gem size (up to 43MB)
+  spec.files         = `git ls-files -z --exclude-standard`.split("\x0").reject do |f|
+    f[%r{^(lib/nucleus_api|spec/adapter|icons)/}]
+  end
+  # again only unit and integration, but no adapter test files
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+
+  # used as global configuration
+  spec.add_runtime_dependency 'configatron', '~> 4.5'
+  # DB store (1)
+  spec.add_runtime_dependency 'daybreak', '~> 0.3'
+  # Required for log tailing against HTTP endpoints
+  spec.add_runtime_dependency 'em-http-request', '~> 1.1'
+  # Used as main HTTP / REST client
+  spec.add_runtime_dependency 'excon', '~> 0.44'
+  # Required for log tailing against websockets
+  spec.add_runtime_dependency 'faye-websocket', '~> 0.9'
+  # Application data handling
+  spec.add_runtime_dependency 'git', '~> 1.2'
+  # Used to build the API
+  spec.add_runtime_dependency 'grape', '~> 0.12'
+  spec.add_runtime_dependency 'grape-entity', '~> 0.4', '>= 0.4.5'
+  # Used to document the API
+  spec.add_runtime_dependency 'grape-swagger', '~> 0.10', '>= 0.10.1'
+  # Used to import the vendor, provider & adapter setup from configuration with schema validation
+  spec.add_runtime_dependency 'kwalify', '~> 0.7'
+  # DB store (2)
+  spec.add_runtime_dependency 'lmdb', '~> 0.4'
+  # Logging
+  spec.add_runtime_dependency 'logger', '~> 1.2'
+  # Application archive handling, detect unsupported uploads
+  spec.add_runtime_dependency 'mime-types', '~> 2.4'
+  # Generic interface for DB store implementations
+  spec.add_runtime_dependency 'moneta', '~> 0.8'
+  # Openshift logging access and direct Git SSH requests
+  spec.add_runtime_dependency 'net-ssh', '~> 3.0'
+  # Used for JSON / Hash conversion and test cassette serialization (is way faster than other JSON libs)
+  spec.add_runtime_dependency 'oj', '~> 2.12'
+  # Required for Cloud Foundry log messages
+  spec.add_runtime_dependency 'protobuf', '~> 3.4'
+  # To make sure HTTPS is used instead of HTTP
+  spec.add_runtime_dependency 'rack-ssl-enforcer', '~> 0.2', '>= 0.2.8'
+  # TODO: Should be removed as soon as excon supports multipart requests
+  spec.add_runtime_dependency 'rest-client', '~> 1.8'
+  # Used to build a streaming API for the log tail action
+  spec.add_runtime_dependency 'rack-stream', '= 0.0.5'
+  # Save certain information for the current request, e.g. the already loaded adapter
+  spec.add_runtime_dependency 'request_store', '~> 1.1'
+  # Application setup, require libs
+  spec.add_runtime_dependency 'require_all', '~> 1.3'
+  # Application data handling
+  spec.add_runtime_dependency 'rubyzip', '~> 1.1'
+  # Application data handling when using git deployment
+  spec.add_runtime_dependency 'sshkey', '~> 1.7'
+  # The ONLY supported server ATM
+  spec.add_runtime_dependency 'thin', '~> 1.6'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-rack'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'guard-yard'
+  spec.add_development_dependency 'inch', '~> 0.7'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rubocop', '~> 0.34'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'webmock', '~> 1.20'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end