foreman_ovm 0.0.1

data/README.md

@@ -0,0 +1,91 @@
+# Foreman Oracle VM Plugin
+
+[![Code Climate](https://codeclimate.com/github/theforeman/foreman-digitalocean/badges/gpa.svg)](https://codeclimate.com/github/theforeman/foreman-digitalocean)
+[![Gem Version](https://badge.fury.io/rb/foreman_digitalocean.svg)](http://badge.fury.io/rb/foreman_digitalocean)
+[![Dependency Status](https://gemnasium.com/theforeman/foreman-digitalocean.svg)](https://gemnasium.com/theforeman/foreman-digitalocean)
+
+```foreman-ovm``` enables provisioning and managing of [Oracle VM](https://www.oracle.com/virtualization/vm-server-for-x86/index.html) instances in [Foreman](http://github.com/theforeman/foreman), all of that under the GPL v3+ license.
+
+* Website: [TheForeman.org](http://theforeman.org)
+* ServerFault tag: [Foreman](http://serverfault.com/questions/tagged/foreman)
+* Issues: [foreman-ovm Github Issues](http://www.github.com/mattwilmott/foreman-ovm/issues)
+* Wiki: [Foreman wiki](http://projects.theforeman.org/projects/foreman/wiki/About)
+* Community and support: #theforeman for general support, #theforeman-dev for development chat in [Freenode](irc.freenode.net)
+* Mailing lists:
+    * [foreman-users](https://groups.google.com/forum/?fromgroups#!forum/foreman-users)
+    * [foreman-dev](https://groups.google.com/forum/?fromgroups#!forum/foreman-dev)
+
+
+## WARNING
+
+This gem is likely broken until version 0.1.x. It is currently undergoing heavy development
+
+## Installation
+
+Please see the Foreman manual for appropriate instructions:
+
+* [Foreman: How to Install a Plugin](http://theforeman.org/manuals/latest/index.html#6.1InstallaPlugin)
+
+### Red Hat, CentOS, Fedora, Scientific Linux (rpm)
+
+Set up the repo as explained in the link above, then run
+
+    # yum install ruby193-rubygem-foreman_ovm
+
+### Debian, Ubuntu (deb)
+
+Set up the repo as explained in the link above, then run
+
+    # apt-get install ruby-foreman-ovm
+
+### Bundle (gem)
+
+Add the following to bundler.d/Gemfile.local.rb in your Foreman installation directory (/usr/share/foreman by default)
+
+    $ gem 'foreman_ovm'
+
+Then run `bundle install` from the same directory
+
+-------------------
+
+To verify that the installation was successful, go to Foreman, top bar **Administer > About** and check 'foreman_ovm' shows up in the **System Status** menu under the Plugins tab.
+
+## Compatibility
+
+
+| Foreman Version | Plugin Version |
+| --------------- | --------------:|
+| >= 1.13.0       | ~> 0.0.1       |
+
+## Configuration
+
+Go to **Infrastructure > Compute Resources** and click on "New Compute Resource".
+
+Choose the **OVM provider**, and fill in all the fields. You need a service account with read and write access. It will be encrypted in the database.
+
+That's it. You're now ready to create and manage droplets in your new OVM compute resource.
+
+You should see something like this in the Compute Resource page:
+
+![](http://i.imgur.com/cyFYOWg.png)
+![](http://i.imgur.com/CTedBU1.png)
+
+## How to contribute?
+
+Generally, follow the [Foreman guidelines](http://theforeman.org/contribute.html). For code-related contributions, fork this project and send a pull request with all changes. Some things to keep in mind:
+* [Follow the rules](http://theforeman.org/contribute.html#SubmitPatches) about commit message style and create a Redmine issue. Doing this right will help reviewers to get your contribution merged faster.
+* [Rubocop](https://github.com/bbatsov/rubocop) will analyze your code, you can run it locally with `rake rubocop`.
+* All of our pull requests run the full test suite in our [Jenkins CI system](http://ci.theforeman.org/). Please include tests in your pull requests for any additions or changes in functionality
+
+
+### Latest code
+
+You can get the nightly branch of the plugin by specifying your Gemfile in this way:
+
+    gem 'foreman_ovm', :git => "https://github.com/mattwilmott/foreman-ovm.git"
+
+# License
+
+It is licensed as GPLv3 since it is a [Foreman](http://theforeman.org) plugin.
+
+See LICENSE for more details.

data/app/helpers/ovm_images_helper.rb

@@ -0,0 +1,33 @@
+module OvmImagesHelper
+  def ovm_image_field(f)
+    images = @compute_resource.available_images
+    images.each { |image| image.name = image.id if image.name.nil? }
+    select_f f, :uuid, images.to_a.sort_by(&:full_name),
+      :id, :full_name, {}, :label => _('Image')
+  end
+
+  def select_image(f, compute_resource)
+    images = possible_images(compute_resource, nil, nil)
+
+    select_f(f,
+             :image_id,
+             images,
+             :id,
+             :slug,
+             { :include_blank => (images.empty? || images.size == 1) ? false : _('Please select an image') },
+             { :label => ('Image'), :disabled => images.empty? } )
+  end
+
+#  def select_region(f, compute_resource)
+#    regions = compute_resource.regions
+#    f.object.region = compute_resource.region
+#    select_f(f,
+#             :region,
+#             regions,
+#             :slug,
+#             :slug,
+#             {},
+#             :label => ('Region'),
+#             :disabled => compute_resource.images.empty?)
+#  end
+end

data/app/models/concerns/fog_extensions/ovm/image.rb

@@ -0,0 +1,34 @@
+module FogExtensions
+  module Ovm
+    module Image
+      extend ActiveSupport::Concern
+
+      attr_accessor :os_version, :uuid
+
+      # Override attribute :name
+      included do
+        define_method :name, instance_method(:full_name)
+        define_method :name=, instance_method(:full_name=)
+      end
+
+      def full_name= value
+        self.os_version = value
+      end
+
+      def full_name
+        requires :distribution, :os_version
+        "#{distribution} #{os_version}"
+      end
+
+      # Attempt guessing arch based on the name from ovm
+      def arch
+        requires :os_version
+        if os_version.end_with?("x64")
+          "x86_64"
+        elsif os_version.end_with?("x32")
+          "i386"
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/fog_extensions/ovm/server.rb

@@ -0,0 +1,55 @@
+module FogExtensions
+  module Ovm
+    module Server
+      extend ActiveSupport::Concern
+
+      attr_accessor :image_id
+
+      def identity_to_s
+        identity.to_s
+      end
+
+      def vm_description
+        flavor.try(:name)
+      end
+
+      def flavor
+        requires :flavor_id
+        @flavor ||= service.flavors.get(flavor_id.to_i)
+      end
+
+      def flavor_name
+        requires :flavor
+        @flavor_name ||= @flavor.try(:name)
+      end
+
+      def image
+        requires :image_id
+        @image ||= service.images.get(image_id.to_i)
+      end
+
+      def image_name
+        @image_name ||= @image.try(:name)
+      end
+
+#      def region
+#        requires :region_id
+#        @region ||= service.regions.get(region_id.to_i)
+#      end
+
+#      def region_name
+#        requires :region
+#        @region_name ||= @region.try(:name)
+#      end
+
+      def ip_addresses
+        [public_ip_address, private_ip_address].flatten.select(&:present?)
+      end
+
+      def state
+        requires :status
+        @state ||= status
+      end
+    end
+  end
+end

data/app/models/foreman_ovm/concerns/host_managed_extensions.rb

@@ -0,0 +1,16 @@
+module ForemanOvm
+  module Concerns
+    module HostManagedExtensions
+      extend ActiveSupport::Concern
+
+      included do
+        # Rails 4 does not provide dynamic finders for delegated methods and
+        # the SSH orchestrate compute method uses them.
+        def self.find_by_ip(ip)
+          nic = Nic::Base.find_by_ip(ip)
+          nic.host if nic.present?
+        end
+      end
+    end
+  end
+end

data/app/models/foreman_ovm/ovm.rb

@@ -0,0 +1,159 @@
+module ForemanOvm
+  class Ovm < ComputeResource
+    #alias_attribute :api_key, :password
+    #alias_attribute :region, :url
+
+    has_one :key_pair, :foreign_key => :compute_resource_id, :dependent => :destroy
+    delegate :flavors, :to => :client
+
+    validates :username, :presence => true
+    validates :password, :presence => true
+    before_create :test_connection
+
+    #after_create :setup_key_pair
+    #after_destroy :destroy_key_pair
+
+    def to_label
+      "#{name} (#{provider_friendly_name})"
+    end
+
+    def provided_attributes
+      super.merge(:uuid => :identity_to_s, :ip => :public_ip_address)
+    end
+
+    def self.model_name
+      ComputeResource.model_name
+    end
+
+    def capabilities
+      [:image]
+    end
+
+    def find_vm_by_uuid(uuid)
+      client.servers.get(uuid)
+    rescue Fog::Compute::Ovm::Error
+      raise(ActiveRecord::RecordNotFound)
+    end
+
+    def create_vm(args = {})
+      args["ssh_keys"] = [ssh_key] if ssh_key
+      args['image'] = args['image_id']
+      super(args)
+    rescue Fog::Errors::Error => e
+      logger.error "Unhandled Ovm error: #{e.class}:#{e.message}\n " + e.backtrace.join("\n ")
+      raise e
+    end
+
+    def available_images
+      images = []
+      collection = client.images
+      begin
+        images += collection.to_a
+      end until !collection.next_page
+      images
+    end
+
+    def regions
+      return [] if api_key.blank?
+      client.regions
+    end
+
+    def test_connection(options = {})
+      super
+      errors[:password].empty? && regions.count
+    rescue Excon::Errors::Unauthorized => e
+      errors[:base] << e.response.body
+    rescue Fog::Errors::Error => e
+      errors[:base] << e.message
+    end
+
+    def destroy_vm(uuid)
+      vm = find_vm_by_uuid(uuid)
+      vm.delete if vm.present?
+      true
+    end
+
+    # not supporting update at the moment
+    def update_required?(*)
+      false
+    end
+
+    def self.provider_friendly_name
+      "OVM"
+    end
+
+    def associated_host(vm)
+      associate_by("ip", [vm.public_ip_address])
+    end
+
+    def user_data_supported?
+      true
+    end
+
+    def default_region_name
+      @default_region_name ||= client.regions[region.to_i].try(:name)
+    rescue Excon::Errors::Unauthorized => e
+      errors[:base] << e.response.body
+    end
+
+    private
+
+    def client
+      @client ||= Fog::Compute.new(
+        :provider => "Ovm",
+        :version => 'V1',
+        :username => username,
+        :password => password
+      )
+    end
+
+    def vm_instance_defaults
+      super.merge(
+        :size => client.flavors.first.slug
+      )
+    end
+
+/*
+    # Creates a new key pair for each new Ovm compute resource
+    # After creating the key, it uploads it to Ovm
+    def setup_key_pair
+      public_key, private_key = generate_key
+      key_name = "foreman-#{id}#{Foreman.uuid}"
+      client.create_ssh_key key_name, public_key
+      KeyPair.create! :name => key_name, :compute_resource_id => id, :secret => private_key
+    rescue => e
+      logger.warn "failed to generate key pair"
+      logger.error e.message
+      logger.error e.backtrace.join("\n")
+      destroy_key_pair
+      raise
+    end
+
+    def destroy_key_pair
+      return unless key_pair
+      logger.info "removing DigitalOcean key #{key_pair.name}"
+      client.destroy_ssh_key(ssh_key.id) if ssh_key
+      key_pair.destroy
+      true
+    rescue => e
+      logger.warn "failed to delete key pair from DigitalOcean, you might need to cleanup manually : #{e}"
+    end
+
+    def ssh_key
+      @ssh_key ||= begin
+        key = client.list_ssh_keys.data[:body]["ssh_keys"].find { |i| i["name"] == key_pair.name }
+        key['id'] if key.present?
+      end
+    end
+
+    def generate_key
+      key = OpenSSL::PKey::RSA.new 2048
+      type = key.ssh_type
+      data = [key.to_blob].pack('m0')
+
+      openssh_format_public_key = "#{type} #{data}"
+      [openssh_format_public_key, key.to_pem]
+    end
+*/
+  end
+end

data/app/views/api/v1/compute_resources/ovm.json

@@ -0,0 +1 @@
+attributes :user

data/app/views/api/v2/compute_resources/ovm.json

@@ -0,0 +1 @@
+attributes :user

data/app/views/compute_resources/form/_ovm.html.erb

@@ -0,0 +1,12 @@
+<%= password_f f, :password, :label => _("Password"), :unset => unset_password? %>
+<% regions = f.object.regions rescue [] %>
+
+<div id='region_selection'>
+  <%= selectable_f(f, :region, regions.map(&:slug), {},
+    :label => _('Default Region'), :disabled => regions.empty?,
+    :help_inline => link_to_function(
+      regions.empty? ? _("Load Regions") : _("Test Connection"), "testConnection(this)",
+      :class => "btn + #{regions.empty? ? "btn-default" : "btn-success"}",
+      :'data-url' => test_connection_compute_resources_path) +
+     hidden_spinner('', :id => 'test_connection_indicator').html_safe) %>
+</div>

data/app/views/compute_resources/show/_ovm.html.erb

@@ -0,0 +1,4 @@
+<tr>
+  <td><%= _("Default Region") %></td>
+  <td><%= @compute_resource.default_region_name %></td>
+</tr>

data/app/views/compute_resources_vms/form/ovm/_base.html.erb

@@ -0,0 +1,7 @@
+<%= select_f f, :size, compute_resource.flavors, :slug, :slug, {}, {:label => _('Flavor')}  %>
+<div id='image_selection'>
+  <%= select_image(f, compute_resource) %>
+</div>
+<div id='region_selection'>
+  <%= select_region(f, compute_resource) %>
+</div>

data/app/views/compute_resources_vms/index/_ovm.html.erb

@@ -0,0 +1,26 @@
+<table class="table table-bordered" data-table='inline'>
+  <thead>
+    <tr>
+      <th><%= _('Name') %></th>
+      <th><%= _('Image') %></th>
+      <th><%= _('Type') %></th>
+      <th><%= _('Region') %></th>
+      <th><%= _('State') %></th>
+      <th></th>
+    </tr>
+  </thead>
+  <% @vms.each do |vm| %>
+    <tr>
+      <td><%= link_to_if_authorized vm.name, hash_for_compute_resource_vm_path(:compute_resource_id => @compute_resource, :id => vm.identity).merge(:auth_object => @compute_resource, :authorizer => authorizer) %></td>
+      <td><%= vm.image['slug'] if vm.image.present? %></td>
+      <td><%= vm.size['slug'] %></td>
+      <td><%= vm.region['slug'] %></td>
+      <td> <span <%= vm_power_class(vm.ready?) %>> <%= vm_state(vm) %></span> </td>
+      <td>
+        <%= action_buttons(
+                vm_power_action(vm, authorizer),
+                display_delete_if_authorized(hash_for_compute_resource_vm_path(:compute_resource_id => @compute_resource, :id => vm.id).merge(:auth_object => @compute_resource, :authorizer => authorizer))) %>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/app/views/compute_resources_vms/show/_ovm.html.erb

@@ -0,0 +1,13 @@
+<% title @vm.name %>
+<div class='col-md-12'>
+  <table class="table table-bordered table-striped">
+    <tr><th colspan="2">Properties</th></tr>
+    <%= prop :public_ip_address %>
+    <%= prop :private_ip_address %>
+    <%= prop :state %>
+    <%= prop :created_at, 'Created' %>
+    <%= prop :image_name, 'Image' if @vm.image.present? %>
+    <%= prop :flavor_name, "Type (flavor)" %>
+    <%= prop :region_name, "Region" %>
+  </table>
+</div>

data/app/views/images/form/_ovm.html.erb

@@ -0,0 +1,6 @@
+<%= text_f f,
+  :username,
+  :value => @image.username || "root",
+  :help_inline => _("The user that is used to ssh into the instance, normally cloud-user, ec2-user, ubuntu, root etc") %>
+<%= ovm_image_field(f) %>
+<%= checkbox_f f, :user_data, :help_inline => _("Does this image support user data input (e.g. via cloud-init)?") %>

data/lib/foreman_ovm/engine.rb

@@ -0,0 +1,49 @@
+require 'fast_gettext'
+require 'gettext_i18n_rails'
+
+module ForemanOvm
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_ovm'
+
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+
+    initializer 'foreman_ovm.register_gettext', :after => :load_config_initializers do
+      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_domain = 'foreman_ovm'
+
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+
+    initializer 'foreman_ovm.register_plugin', :before => :finisher_hook do
+      Foreman::Plugin.register :foreman_ovm do
+        requires_foreman '>= 1.13'
+        compute_resource ForemanOvm::Ovm
+        parameter_filter ComputeResource, :username, :password, :uri
+      end
+    end
+
+    rake_tasks do
+      load "#{ForemanOvm::Engine.root}/lib/foreman_ovm/tasks/test.rake"
+    end
+
+    config.to_prepare do
+      require 'xlab-si/fog-oracle'
+      #require 'fog/digitalocean/compute_v2'
+      #require 'fog/digitalocean/models/compute_v2/image'
+      #require 'fog/digitalocean/models/compute_v2/server'
+      require File.expand_path(
+        '../../../app/models/concerns/fog_extensions/ovm/server',
+        __FILE__)
+      require File.expand_path(
+        '../../../app/models/concerns/fog_extensions/ovm/image',
+        __FILE__)
+
+      Fog::Compute::Ovm::Image.send :include,
+        FogExtensions::Ovm::Image
+      Fog::Compute::Ovm::Server.send :include,
+        FogExtensions::Ovm::Server
+      ::Host::Managed.send :include,
+        ForemanOvm::Concerns::HostManagedExtensions
+    end
+  end
+end

data/lib/foreman_ovm/tasks/test.rake

@@ -0,0 +1,45 @@
+require File.expand_path("../engine", File.dirname(__FILE__))
+namespace :test do
+  desc "Run the plugin unit test suite."
+  task :ovm => ['db:test:prepare'] do
+    test_task = Rake::TestTask.new('ovm_test_task') do |t|
+      t.libs << ["test", "#{ForemanOvm::Engine.root}/test"]
+      t.test_files = [
+        "#{ForemanOvm::Engine.root}/test/**/*_test.rb"
+      ]
+      t.verbose = true
+      t.warning = false
+    end
+
+    Rake::Task[test_task.name].invoke
+  end
+end
+
+namespace :ovm do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_ovm) do |task|
+        task.patterns = ["#{ForemanOvm::Engine.root}/app/**/*.rb",
+                         "#{ForemanOvm::Engine.root}/lib/**/*.rb",
+                         "#{ForemanOvm::Engine.root}/test/**/*.rb"]
+      end
+    rescue
+      puts "Rubocop not loaded."
+    end
+
+    Rake::Task['rubocop_ovm'].invoke
+  end
+end
+
+Rake::Task[:test].enhance do
+  Rake::Task['test:ovm'].invoke
+end
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task["jenkins:unit"].enhance do
+    Rake::Task['test:ovm'].invoke
+    Rake::Task['ovm:rubocop'].invoke
+  end
+end

data/lib/foreman_ovm/version.rb

@@ -0,0 +1,3 @@
+module ForemanOvm
+  VERSION = '0.0.1'
+end

data/lib/foreman_ovm.rb

@@ -0,0 +1,3 @@
+require 'foreman_ovm/engine'
+module ForemanOvm
+end

data/locale/Makefile

@@ -0,0 +1,6 @@
+#
+# Makefile for PO merging and MO generation. For more info see
+# locale/README in the Foreman Core.
+#
+include ../.foreman_app/locale/Makefile
+DOMAIN = ovm

data/test/factories/compute_resources.rb

@@ -0,0 +1,14 @@
+FactoryGirl.define do
+  factory :container_resource, :class => ComputeResource do
+    sequence(:name) { |n| "compute_resource#{n}" }
+
+    trait :ovm do
+      provider 'Ovm'
+      username 'test'
+      password 'test'
+      region 'everywhere'
+    end
+
+    factory :ovm_cr, :class => ForemanOvm::Ovm, :traits => [:ovm]
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,6 @@
+# This calls the main test_helper in Foreman core
+require 'test_helper'
+
+# Add plugin to FactoryGirl's paths
+FactoryGirl.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryGirl.reload

data/test/unit/foreman_ovm/ovm.test.rb

@@ -0,0 +1,18 @@
+require 'test_plugin_helper'
+
+module ForemanOvm
+  class OvmTest < ActiveSupport::TestCase
+    should validate_presence_of(:username)
+    should validate_presence_of(:password)
+    #should have_one(:key_pair)
+
+    setup { Fog.mock! }
+    teardown { Fog.unmock! }
+
+    test 'ssh key pair gets created after its saved' do
+      ovm = FactoryGirl.build(:ovm_cr)
+      #ovm.expects(:setup_key_pair)
+      ovm.save
+    end
+  end
+end