foreman_docker 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb649de5602373b55a8f2647f5316df3d71e780
-  data.tar.gz: f4e3932fa65ab2b2a557a08f770dd968b9fe7a80
+  metadata.gz: 11781ae40d79526d1ce98c52dddbb9341c9aa211
+  data.tar.gz: 87df5bd21364b87d937dda8d3de05cf9bae0b303
 SHA512:
-  metadata.gz: aa8ce159e649b5ef010e426261e10dfee7ef27e2f28f095918747f31082828a305e3d8a26eff32e7254c996dc3627422364ae6df5ef3a41d624ae3f6b08b08c8
-  data.tar.gz: 38d3229d713c16058c462922b5a2d3f744afad3fee0e7fbcef469da7cc5a1bbaadfffc9508f20207392e441056fc3f19d64e0a949b0526e705d08c7fa8358b0d
+  metadata.gz: 0c70da7838dc58dc17fb4e9bbd716fe0d3d34d3bba529923ad5d62968db33f58331760fd662806cb123df7922409e19009a5f8ddaeed51a12d9991db10d8eeeb
+  data.tar.gz: 5cde392c952ca19d530f17a8cac8e92ecb89f612143cce0d445ebe2e87e06b88895a25e28fd69025723e80a4f4c56bdd0af63822bb8c3bf0c999832aaa5abd09

data/README.md

@@ -10,17 +10,23 @@ Please see the Foreman manual for appropriate instructions:
 
 The gem name is "foreman_docker".
 
+RPM users can install the "ruby193-rubygem-foreman_docker" or "rubygem-foreman_docker" packages.
+
 ## Compatibility
 
 | Foreman Version | Plugin Version |
 | ---------------:| --------------:|
-| >  1.4          | 0.0.1          |
+| >=  1.5         | 0.0.1          |
+
+## Testing
+
+Run `rake test:docker:test` from your Foreman directory to run the test suite.
 
 ## Latest code
 
 You can get the develop branch of the plugin by specifying your Gemfile in this way:
 
-    gem 'foreman_docker', :git => "https://github.com/abenari/foreman_docker.git"
+    gem 'foreman_docker', :git => "https://github.com/theforeman/foreman-docker.git"
 
 # Copyright
 

data/Rakefile

@@ -1,7 +1,18 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 begin
   require 'bundler/setup'
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  Rails.logger.error 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue => _
+  puts "Rubocop not loaded."
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
 end

data/app/assets/stylesheets/foreman_docker/terminal.css.scss

@@ -0,0 +1,85 @@
+.terminal {
+  .terminal-output .format {
+    display: inline-block;
+  }
+  .terminal-output div div {
+    display: inline-block;
+  }
+  .clipboard {
+    position: absolute;
+    bottom: 0;
+    left: 0;
+    opacity: 0.01;
+    filter: alpha(opacity = 0.01);
+    filter: progid:DXImageTransform.Microsoft.Alpha(opacity=0.01);
+    width: 2px;
+  }
+}
+
+.terminal {
+  padding: 10px;
+  position: relative;
+  overflow-y: scroll ;
+}
+
+.terminal {
+  .terminal-output div div {
+    display: block;
+    line-height: 14px;
+    height: auto;
+  }
+  .prompt {
+    display: block;
+    line-height: 14px;
+    height: auto;
+    float: left;
+  }
+  font-family: FreeMono,monospace;
+  color: rgba(255, 255, 255, 1);
+  background-color: rgba(47, 47, 47, 1);
+  font-size: 12px;
+  line-height: 14px;
+}
+
+.terminal-output > div {
+  min-height: 14px;
+}
+
+.terminal {
+  .terminal-output div span {
+    display: inline-block;
+  }
+  .terminal-output div {
+    div::-moz-selection, span::-moz-selection {
+      color: rgba(255, 255, 255, 1);
+      background-color: rgba(47, 47, 47, 1);
+    }
+    div {
+      a::-moz-selection, &::selection, a::selection {
+        color: rgba(255, 255, 255, 1);
+        background-color: rgba(47, 47, 47, 1);
+      }
+    }
+    span::selection {
+      color: rgba(255, 255, 255, 1);
+      background-color: rgba(47, 47, 47, 1);
+    }
+  }
+  .terminal-output div.error {
+    color: red;
+    div {
+      color: red;
+    }
+  }
+}
+
+.clear {
+  clear: both;
+}
+
+.terminal a {
+  color: #0F60FF;
+  &:hover {
+    color: red;
+  }
+}

data/app/controllers/containers/steps_controller.rb

@@ -0,0 +1,55 @@
+module Containers
+  class StepsController < ::ApplicationController
+    include Wicked::Wizard
+
+    steps :preliminary, :image, :configuration, :environment
+    before_filter :find_container
+
+    def show
+      case step
+      when :preliminary
+        @container_resources = ComputeResource.select { |cr| cr.provider == 'Docker' }
+      when :image
+      when :configuration
+      when :environment
+      end
+      render_wizard
+    end
+
+    def update
+      case step
+      when :preliminary
+        @container.update_attribute(:compute_resource_id, params[:container][:compute_resource_id])
+      when :image
+        @container.image = params[:image]
+        @container.update_attributes(params[:container])
+      when :configuration
+        @container.update_attributes(params[:container])
+      when :environment
+        @container.update_attributes(params[:container])
+        @container.uuid = start_container.id
+      end
+      render_wizard @container
+    end
+
+    private
+
+    def finish_wizard_path
+      container_path(:id => params[:container_id])
+    end
+
+    def allowed_resources
+      ComputeResource.authorized(:view_compute_resources)
+    end
+
+    def find_container
+      @container = Container.find(params[:container_id])
+    rescue ActiveRecord::RecordNotFound
+      not_found
+    end
+
+    def start_container
+      @container.compute_resource.create_vm(@container.parametrize)
+    end
+  end
+end

data/app/controllers/containers_controller.rb

@@ -0,0 +1,62 @@
+class ContainersController < ::ApplicationController
+  before_filter :find_resource, :only => [:show]
+
+  def index
+    @container_resources = allowed_resources.select { |cr| cr.provider == 'Docker' }
+    if @container_resources.empty?
+      warning('You need a Compute Resource of type Docker to start managing containers')
+      redirect_to new_compute_resource_path
+    end
+  # This should only rescue Fog::Errors, but Fog returns all kinds of errors...
+  rescue
+    process_error
+  end
+
+  def new
+    @container = Container.create
+    redirect_to container_step_path(:container_id => @container.id, :id => :preliminary)
+  end
+
+  def destroy
+    if resource_deletion
+      process_success(:success_redirect => containers_path,
+                      :success_msg      => _("Container #{@deleted_identifier} is being deleted."))
+    else
+      process_error(:redirect => containers_path)
+    end
+  rescue ActiveRecord::RecordNotFound
+    not_found
+  end
+
+  def show
+  end
+
+  private
+
+  def resource_deletion
+    # Unmanaged container - only present in Compute Resource
+    if params[:compute_resource_id].present?
+      @deleted_identifier  = params[:id]
+      destroy_compute_resource_vm(params[:compute_resource_id], params[:id])
+    else # Managed container
+      find_resource
+      @deleted_identifier = @container.name
+
+      destroy_compute_resource_vm(@container.compute_resource, @container.uuid) &&
+      @container.destroy
+    end
+  end
+
+  def destroy_compute_resource_vm(resource_id, uuid)
+    @container_resource = ComputeResource.authorized(:destroy_compute_resources_vms)
+                                         .find(resource_id)
+    @container_resource.destroy_vm(uuid)
+  rescue => error
+    logger.error "#{error.message} (#{error.class})\n#{error.backtrace.join("\n")}"
+    false
+  end
+
+  def allowed_resources
+    ComputeResource.authorized(:view_compute_resources)
+  end
+end

data/app/helpers/container_steps_helper.rb

@@ -0,0 +1,11 @@
+module ContainerStepsHelper
+  def container_wizard(step)
+    wizard_header(
+      step,
+      _('Resource'),
+      _('Image'),
+      _('Configuration'),
+      _('Environment')
+    )
+  end
+end

data/app/helpers/containers_helper.rb

@@ -0,0 +1,54 @@
+module ContainersHelper
+  def managed_icon(container, resource)
+    if managed?(container, resource)
+      '<span class="glyphicon glyphicon-check"></span>'.html_safe
+    else
+      '<span class="glyphicon glyphicon-unchecked"></span>'.html_safe
+    end
+  end
+
+  def managed?(container, resource)
+    uuids_in_resource(resource).include? container.identity
+  end
+
+  def uuids_in_resource(resource)
+    Container.where(:compute_resource_id => resource.id).pluck(:uuid)
+  end
+
+  def link_to_container(container, resource)
+    link_to_if_authorized container.name[1..-1].titleize,
+                          container_link_hash(container, resource)
+  end
+
+  def container_link_hash(container, resource)
+    if managed?(container, resource)
+      hash_for_container_path(:id => Container.find_by_uuid(container.identity).id)
+    else
+      hash_for_compute_resource_vm_path(:compute_resource_id => resource,
+                                        :id                  => container.identity)
+    end
+  end
+
+  def container_title_actions(container)
+    @compute_resource = container.compute_resource
+    title_actions(
+        button_group(
+          link_to_if_authorized(_("Commit"), hash_for_container_path(:id => container)
+                                  .merge(:auth_object => container,
+                                         :permission  => 'commit_containers'),
+                                :title => _('Saves differences between image' \
+                                            'and current state of container' \
+                                            'as a new image'))
+        ),
+        button_group(vm_power_action(container.in_fog)),
+        button_group(
+          display_delete_if_authorized(
+            hash_for_container_path(:id => container.id)
+                                    .merge(:auth_object => container,
+                                           :auth_action => 'destroy',
+                                           :authorizer  => authorizer),
+            :confirm     => _("Delete %s?") % container.name)
+        )
+    )
+  end
+end

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

@@ -8,7 +8,6 @@ module FogExtensions
       def name
         repo_tags.empty? ? (repository || id) : repo_tags.first
       end
-
     end
   end
-end
+end

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

@@ -6,18 +6,28 @@ module FogExtensions
       include ActionView::Helpers::NumberHelper
 
       def state
-        state_running ? "Running" :"Stopped"
+        state_running ? 'Running' : 'Stopped'
+      end
+
+      # Last time a container was started
+      # WARNING: this doesn't mean the container has been running since then.
+      def started_at
+        attributes['state_started_at']
+      end
+
+      def image_friendly_name
+        attributes['config_image']
       end
 
       def command
-        c=[]
-        c += entrypoint if entrypoint.any?
-        c += cmd if cmd.any?
+        c = []
+        c += entrypoint if entrypoint.present?
+        c += cmd if cmd.present?
         c.join(' ')
       end
 
       def poweroff
-        service.vm_action(:id =>id, :action => :kill)
+        service.vm_action(:id => id, :action => :kill)
       end
 
       def reset
@@ -26,9 +36,9 @@ module FogExtensions
       end
 
       def vm_description
-        _("%{cores} Cores and %{memory} memory") % {:cores => cpus, :memory => number_to_human_size(memory.to_i)}
+        _('%{cores} Cores and %{memory} memory') %
+          { :cores => cpus, :memory => number_to_human_size(memory.to_i) }
       end
-
     end
   end
-end
+end

data/app/models/container.rb

@@ -0,0 +1,29 @@
+class Container < ActiveRecord::Base
+  belongs_to :compute_resource
+  belongs_to :image, :class_name => 'DockerImage', :foreign_key => 'docker_image_id'
+  belongs_to :tag,   :class_name => 'DockerTag',   :foreign_key => 'docker_tag_id'
+
+  attr_accessible :command, :image, :name, :compute_resource_id, :entrypoint,
+                  :cpu_set, :cpu_shares, :memory, :tty, :attach_stdin,
+                  :attach_stdout, :attach_stderr, :tag, :uuid
+
+  def parametrize
+    { :name => name, :image => tag.tag.blank? ? image.image_id : "#{image.image_id}:#{tag.tag}",
+      :tty  => tty, :memory => memory, :cmd => command.nil? ? '' : command.split(','),
+      :attach_stdout => attach_stdout, :attach_stdout => attach_stdout,
+      :attach_stderr => attach_stderr, :cpushares => cpu_shares, :cpuset => cpu_set }
+  end
+
+  def image=(image_id)
+    self[:docker_image_id] = DockerImage.find_or_create_by_image_id!(image_id).id
+  end
+
+  def tag=(tag_name)
+    self[:docker_tag_id] = DockerTag
+                          .find_or_create_by_tag_and_docker_image_id!(tag_name, image.id).id
+  end
+
+  def in_fog
+    @fog_container ||= compute_resource.vms.get(uuid)
+  end
+end

data/app/models/docker_image.rb

@@ -0,0 +1,7 @@
+class DockerImage < ActiveRecord::Base
+  has_many :tags, :class_name => 'DockerTag', :foreign_key => 'docker_image_id',
+                  :dependent  => :destroy
+  has_many :containers
+
+  attr_accessible :image_id, :size
+end

data/app/models/docker_tag.rb

@@ -0,0 +1,7 @@
+class DockerTag < ActiveRecord::Base
+  belongs_to :image, :class_name => 'DockerImage', :foreign_key => 'docker_image_id'
+
+  attr_accessible :tag, :image
+
+  validates :image, :presence => true
+end

data/app/models/foreman_docker/docker.rb

@@ -2,7 +2,6 @@ require 'uri'
 
 module ForemanDocker
   class Docker < ::ComputeResource
-
     validates :url, :format => { :with => URI.regexp }
 
     def self.model_name
@@ -18,16 +17,16 @@ module ForemanDocker
     end
 
     def provided_attributes
-      super.merge({:mac => :mac})
+      super.merge(:mac => :mac)
     end
 
-    #FIXME
+    # FIXME
     def max_cpu_count
       8
     end
 
     def max_memory
-      16*1024*1024*1024
+      16 * 1024 * 1024 * 1024
     end
 
     def available_images
@@ -35,26 +34,34 @@ module ForemanDocker
     end
 
     def image(id)
-      client.image.get(id) || raise(ActiveRecord::RecordNotFound)
+      client.image.get(id) || fail(ActiveRecord::RecordNotFound)
     end
 
     def provider_friendly_name
-      "Docker"
+      'Docker'
     end
 
-    def create_vm args = {}
-      args['cmd'] = Array.wrap( args.delete('cmd') )
+    def create_vm(args = {})
       options = vm_instance_defaults.merge(args)
       logger.debug("creating Docker with the following options: #{options.inspect}")
       client.servers.create options
-    rescue Fog::Errors::Error => e
+    rescue Excon::Errors::SocketError, Fog::Errors::Error => e
       logger.debug "Fog error: #{e.message}\n " + e.backtrace.join("\n ")
       errors.add(:base, e.message.to_s)
       false
     end
 
     def vm_instance_defaults
-      ActiveSupport::HashWithIndifferentAccess.new('name' => "foreman_#{Time.now.to_i}", 'cmd' => ['/bin/bash'])
+      ActiveSupport::HashWithIndifferentAccess.new('name' => "foreman_#{Time.now.to_i}",
+                                                   'cmd' => ['/bin/bash'])
+    end
+
+    def test_connection(options = {})
+      super
+      client
+    # This should only rescue Fog::Errors, but Fog returns all kinds of errors...
+    rescue => e
+      errors[:base] << e.message
     end
 
     protected
@@ -66,19 +73,18 @@ module ForemanDocker
       false
     end
 
-
     def client
       @client ||= ::Fog::Compute.new(
-          :provider         => "fogdocker",
-          :docker_username   => user,
-          :docker_password   => password,
-          :docker_url        => url
+          :provider         => 'fogdocker',
+          :docker_username  => user,
+          :docker_password  => password,
+          :docker_email     => email,
+          :docker_url       => url
       )
     end
 
     def api_version
       @api_version ||= client.send(:client).api_version
     end
-
   end
 end