lorj_cloud 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4233f4744a02510e08773415b97e9e2c1d22a573
+  data.tar.gz: 65f7e65ab5b524739d081bfd6fac667a0b92e815
+SHA512:
+  metadata.gz: 6942511c15d7ca200f7994f3e78db471cc1d051aef996d68118694e2512e6decae0310f14b1b470aa725cc3079cdeaf5b037d5986f0db54d6e5afcd8a2c748f2
+  data.tar.gz: b6e027ec8f848aec4be5ad2bd8a241c2f1e65699bcf5234b0c815b85f2979230336b0960503deb2dd442e8a114d21e4d7267a164ab50d84571ab99475c5400f5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitreview

@@ -0,0 +1,4 @@
+[gerrit]
+host=review.forj.forj.io
+port=29418
+project=forj-oss/lorj-cloud.git

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,46 @@
+# Copyright 2013 Hewlett-Packard Development Company, L.P.
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+# use: rubocop --show-cops
+#      to validate configuration.
+# rubocop config
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'docker/**/*'
+    - 'bin/scripts/**/*'
+    - 'git/**/*'
+    - 'tmp/**/*'
+#Documentation:
+#  Enabled: false
+#Metrics/LineLength:
+#  Max: 99
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# lets start with 40, but 10 is way to small..
+Metrics/MethodLength:
+  Max: 40
+# If Method length is increased, class length need to be extended as well.
+Metrics/ClassLength:
+  Max: 150
+
+# allow arguments to be longer than 15
+Metrics/AbcSize:
+  Max: 40
+# forj-docker binary name gets an exception
+Style/FileName:
+  Exclude: ['bin/forj-docker', 'lib/**/forj-docker.rb']

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lorj_cloud.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# LorjCloud
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lorj_cloud`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lorj_cloud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lorj_cloud
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lorj_cloud/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+#
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'rdoc/task'
+
+task :default => [:lint, :spec]
+
+desc 'Generate lorj documentation'
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'lib', 'example', 'bin')
+end
+
+desc 'Run the specs.'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.rspec_opts = '-f doc'
+end
+
+desc 'Run RuboCop on the project'
+RuboCop::RakeTask.new(:lint) do |task|
+  task.formatters = ['progress']
+  task.verbose = true
+  task.fail_on_error = true
+end
+
+task :build => [:lint, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lorj_cloud'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lorj_cloud/version.rb

@@ -0,0 +1,4 @@
+# LorjCloud module
+module LorjCloud
+  VERSION = '0.1.0'
+end

data/lib/lorj_cloud.rb

@@ -0,0 +1,6 @@
+require 'lorj_cloud/version'
+
+require 'lorj'
+
+Lorj.declare_process('cloud', File.dirname(__FILE__),
+                     :controllers_dir => 'providers')

data/lib/process/cloud/process/common.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# Common definition
+class Lorj::BaseDefinition # rubocop: disable Style/ClassAndModuleChildren
+  # All objects used by this process are built from a Controller
+  process_default :use_controller => true
+end
+
+# Class to manage retry on errors before failing
+class SSLErrorMgt
+  def initialize(iMaxRetry = 5)
+    @retry = 0
+    @max_retry = iMaxRetry
+  end
+
+  def wait(message, issue = nil)
+    if @retry < @max_retry
+      sleep(2)
+      @retry += 1
+      if PrcLib.level == 0
+        msg = format('%s/%s try... ', @retry, @max_retry)
+        msg += issue unless issue.nil?
+        print msg
+      end
+      return false
+    else
+      PrcLib.error('Too many retry. %s', message)
+      return true
+    end
+  end
+
+  def error_detected(message, backtrace, e)
+    if message.match('SSLv2/v3 read server hello A: unknown protocol')
+      return wait(message, "'unknown protocol' SSL Error")
+    elsif e.is_a?(Excon::Errors::InternalServerError)
+      return wait(message, ANSI.red(e.class))
+    else
+      PrcLib.error("Exception %s: %s\n%s", e.class, message,
+                   backtrace.join("\n"))
+      return true
+    end
+  end
+end

data/lib/process/cloud/process/connection.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# rubocop: disable Style/ClassAndModuleChildren
+
+# Connection process code
+class CloudProcess
+  def connect(sCloudObj, hParams)
+    ssl_error_obj = SSLErrorMgt.new # Retry object
+    PrcLib.debug("%s:%s Connecting to '%s' "\
+                 "- Project '%s'",
+                 self.class, sCloudObj, config[:provider], hParams[:tenant])
+    begin
+      controller_connect(sCloudObj)
+   rescue => e
+     retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+
+     PrcLib.error('%s:%s: Unable to connect.\n%s',
+                  self.class, sCloudObj, e.message)
+     nil
+    end
+  end
+end
+
+# Define services model
+class Lorj::BaseDefinition
+  # predefined list of objects.
+  # Links between objects is not predefined. To do it, use needs declaration
+  # in your provider class.
+
+  # object to get list of services
+  # Defines Process handler to call
+  define_obj(:services,
+
+             :create_e => :connect
+            )
+  obj_needs :data, :auth_uri
+  obj_needs :data, :account_id
+  obj_needs :data, :account_key
+  obj_needs :data, :tenant
+
+  undefine_attribute :id    # Do not return any predefined ID
+  undefine_attribute :name  # Do not return any predefined NAME
+end
+
+# compute_connection
+class Lorj::BaseDefinition
+  define_obj(:compute_connection,
+
+             :create_e => :connect # Will call ForjProcess connect
+            )
+  obj_needs :data, :account_id
+  obj_needs :data, :account_key
+  obj_needs :data, :auth_uri
+  obj_needs :data, :tenant
+  obj_needs :data, :compute
+
+  undefine_attribute :id    # Do not return any predefined ID
+  undefine_attribute :name  # Do not return any predefined NAME
+end
+
+# network_connection
+class Lorj::BaseDefinition
+  define_obj(:network_connection,
+
+             :create_e => :connect
+            )
+  obj_needs :data, :account_id
+  obj_needs :data, :account_key
+  obj_needs :data, :auth_uri
+  obj_needs :data, :tenant
+  obj_needs :data, :network
+
+  undefine_attribute :id    # Do not return any predefined ID
+  undefine_attribute :name  # Do not return any predefined NAME
+end

data/lib/process/cloud/process/external_network.rb

@@ -0,0 +1,90 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# rubocop: disable Style/ClassAndModuleChildren
+
+# External network process attached to a network
+class CloudProcess
+  def forj_get_or_create_ext_net(sCloudObj, hParams)
+    PrcLib.state("Checking router '%s' gateway", hParams[:router, :name])
+
+    router_obj = hParams[:router]
+    router_name = hParams[:router, :name]
+    network_id = hParams[:router, :gateway_network_id]
+    if network_id
+      external_network = forj_query_external_network(sCloudObj,
+                                                     { :id => network_id },
+                                                     hParams)
+      PrcLib.info("Router '%s' is attached to the "\
+                  "external gateway '%s'.", router_name,
+                  external_network[:name])
+    else
+      PrcLib.info("Router '%s' needs to be attached to an "\
+                  'external gateway.', router_name)
+      PrcLib.state('Attaching')
+      external_network = forj_query_external_network(:network, {}, hParams)
+      if !external_network.empty?
+        router_obj[:gateway_network_id] = external_network[:id]
+        controller_update(:router, router_obj)
+        PrcLib.info("Router '%s' attached to the "\
+                    "external network '%s'.",
+                    router_name, external_network[:name])
+      else
+        PrcLib.fatal(1, "Unable to attach router '%s' to an external gateway. "\
+                        'Required for boxes to get internet access. ',
+                     get_data(:router, :name))
+      end
+    end
+
+    # Need to keep the :network object as :external_network object type.
+    external_network.type = sCloudObj
+    external_network
+  end
+
+  def forj_query_external_network(_sCloudObj, sQuery, _hParams)
+    PrcLib.state('Identifying External gateway')
+    begin
+      # Searching for external network
+      query = sQuery.merge(:external => true)
+      info = {
+        :notfound => 'No external network found',
+        :checkmatch => 'Found 1 %s. Checking if it is an %s.',
+        :nomatch => 'No %s identified as %s match',
+        :found => "Found external %s '%s'.",
+        :more => 'Found several %s. Searching for the first one to be an %s.'
+      }
+      networks = query_single(:network, query, 'external network', info)
+      return Lorj::Data.new if networks.length == 0
+      networks[0]
+    rescue => e
+      PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+    end
+  end
+end
+
+# Identify an external network thanks to the network router.
+class Lorj::BaseDefinition
+  define_obj(:external_network,
+
+             :create_e => :forj_get_or_create_ext_net,
+             :query_e => :forj_query_external_network
+            )
+
+  obj_needs :CloudObject,  :network_connection
+  obj_needs :CloudObject,  :router
+end

data/lib/process/cloud/process/flavor.rb

@@ -0,0 +1,97 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# ---------------------------------------------------------------------------
+# flavor management
+# ---------------------------------------------------------------------------
+class CloudProcess
+  # Depending on clouds/rights, we can create flavor or not.
+  # Usually, flavor records already exists, and the controller may map them
+  # CloudProcess predefines some values. Consult CloudProcess.rb for details
+  def forj_get_or_create_flavor(sCloudObj, hParams)
+    flavor_name = hParams[:flavor_name]
+    PrcLib.state("Searching for flavor '%s'", flavor_name)
+
+    flavors = query_flavor(sCloudObj, { :name => flavor_name }, hParams)
+    if flavors.length == 0
+      if !hParams[:create]
+        PrcLib.error("Unable to create %s '%s'. Creation is not "\
+                     'supported.', sCloudObj, flavor_name)
+        ForjLib::Data.new.set(nil, sCloudObj)
+      else
+        create_flavor(sCloudObj, hParams)
+      end
+    else
+      flavors[0]
+    end
+  end
+
+  # Should return 1 or 0 flavor.
+  def query_flavor(sCloudObj, sQuery, hParams)
+    flavor_name = hParams[:flavor_name]
+    #  list = forj_query_flavor(sCloudObj, sQuery, hParams)
+    #  query_single(sCloudObj, list, sQuery, flavor_name)
+    query_single(sCloudObj, sQuery, flavor_name)
+  end
+
+  # Should return 1 or 0 flavor.
+  def forj_query_flavor(sCloudObj, sQuery, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      list = controller_query(sCloudObj, sQuery)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+    list
+  end
+end
+
+# Flavor Object
+# Identify flavor
+class Lorj::BaseDefinition # rubocop: disable ClassAndModuleChildren
+  define_obj(:flavor,
+
+             :create_e => :forj_get_or_create_flavor,
+             :query_e => :forj_query_flavor
+            #         :get_e      => :forj_get_flavor,
+            #         :update_e   => :forj_update_flavor,
+            #         :delete_e   => :forj_delete_flavor
+            )
+
+  obj_needs :CloudObject,  :compute_connection
+  obj_needs :data,         :flavor_name,         :for => [:create_e]
+  # Cloud provider will need to map to one of those predefined flavors.
+  # limitation values may match exactly or at least ensure those limitation
+  # are under provider limitation
+  # ie, at least the CloudProcess limitation can less than the
+  # Cloud provider defines.
+  # CloudProcess EHD = 160, then Provider EHD = 200 is ok
+  # but Provider EHD = 150 is not ok.
+  predefine_data_value('tiny',    :desc => 'VCU: 1,  RAM:512M, HD:1G,   '\
+                                           'EHD: 0G,   Swap: 0G')
+  predefine_data_value('xsmall',  :desc => 'VCU: 1,  RAM:1G,   HD:10G,  '\
+                                           'EHD: 10G,  Swap: 0G')
+  predefine_data_value('small',   :desc => 'VCU: 2,  RAM:2G,   HD:30G,  '\
+                                           'EHD: 10G,  Swap: 0G')
+  predefine_data_value('medium',  :desc => 'VCU: 2,  RAM:4G,   HD:30G,  '\
+                                           'EHD: 50G,  Swap: 0G')
+  predefine_data_value('large',   :desc => 'VCU: 4,  RAM:8G,   HD:30G,  '\
+                                           'EHD: 100G, Swap: 0G')
+  predefine_data_value('xlarge',  :desc => 'VCU: 8,  RAM:16G,  HD:30G,  '\
+                                           'EHD: 200G, Swap: 0G')
+end

data/lib/process/cloud/process/images.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# ---------------------------------------------------------------------------
+# Image management
+# ---------------------------------------------------------------------------
+class CloudProcess
+  def forj_get_or_create_image(sCloudObj, hParams)
+    image_name = hParams[:image_name]
+    PrcLib.state("Searching for image '%s'", image_name)
+
+    search_the_image(sCloudObj, { :name => image_name }, hParams)
+    # No creation possible.
+  end
+
+  def search_the_image(sCloudObj, sQuery, hParams)
+    image_name = hParams[:image_name]
+    images = forj_query_image(sCloudObj, sQuery, hParams)
+    case images.length
+    when 0
+      PrcLib.info("No image '%s' found", image_name)
+      nil
+    when 1
+      PrcLib.info("Found image '%s'.", image_name)
+      images[0, :ssh_user] = ssh_user(images[0, :name])
+      images[0]
+    else
+      PrcLib.info("Found several images '%s'. Selecting the first "\
+                  "one '%s'", image_name, images[0, :name])
+      images[0, :ssh_user] = ssh_user(images[0, :name])
+      images[0]
+    end
+  end
+
+  def forj_query_image(sCloudObj, sQuery, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      images = controller_query(sCloudObj, sQuery)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+    add_ssh_user(images)
+    images
+  end
+
+  def add_ssh_user(images)
+    images.each do |image|
+      image[:ssh_user] = ssh_user(image[:name])
+    end
+  end
+
+  def ssh_user(image_name)
+    return 'fedora' if image_name =~ /fedora/i
+    return 'centos' if image_name =~ /centos/i
+    'ubuntu'
+  end
+
+  def forj_get_image(sCloudObj, sId, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      image = controller_get(sCloudObj, sId)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+    add_ssh_user([image])
+    image
+  end
+end
+
+# ************************************ Image Object
+# Identify image
+class Lorj::BaseDefinition # rubocop: disable Style/ClassAndModuleChildren
+  define_obj(:image,
+
+             :create_e => :forj_get_or_create_image,
+             :query_e => :forj_query_image,
+             :get_e => :forj_get_image
+            #         :update_e   => :forj_update_image
+            #         :delete_e   => :forj_delete_image
+            )
+
+  obj_needs :CloudObject,  :compute_connection
+  obj_needs :data,         :image_name,          :for => [:create_e]
+end

data/lib/process/cloud/process/internet_network.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# rubocop: disable Style/ClassAndModuleChildren
+
+# Internet network Object
+# Define Internet network
+#
+# This object contains the logic to ensure the router's network has a gateway
+# to the external network (internet)
+# is capable to connect to internet
+# And to create this connection if possible.
+class Lorj::BaseDefinition # rubocop: disable ClassAndModuleChildren
+  define_obj(:internet_network,    :nohandler => true)
+
+  obj_needs :CloudObject,  :external_network # External network to connect if
+  # needed.
+end