foreman_docker 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e7371179124d8fa414db7e60fbcab48110a4372
-  data.tar.gz: 339e3c491804ae9432363136be744a48346af11c
+  metadata.gz: 4806b85ddbb93562b7c2c718f5daa8bf5a84d48d
+  data.tar.gz: 531ccfeaf0fadf4c227d89d98e1f53635a3dd7d2
 SHA512:
-  metadata.gz: 08356581341a4c80c452ae75dc851ef81c9ec51c61df9106c44d99d8f157ceda5bdf1f0d325e6182983f8591d602f1998618f0058704a3791105465eb0a4d044
-  data.tar.gz: b0c79637f96a572eadf4d82c2a322669d8152690e4a956be0696bd06ee32b82ab93d87dca0f5891799dc1cf58671f5043283a12d33d98a7d2ffe16a204e7ce00
+  metadata.gz: 8601bd6d7fab40b502542717f707e4fbe60252140da0483c975e3b31749d3db3261a92176cfbe989a70ca12767d0c3551b3cd7dfd6c330d6163fa6432a51f209
+  data.tar.gz: 721dc7939ecb7d142471baa127e30b83530b216b8f56738c609bdee784ba7346043f81513e13cd92d1eaed4adb4e973ca703f9ebff9384b5e33c9164e4e312db

data/README.md

@@ -1,5 +1,9 @@
 # Foreman Docker Plugin
 
+[![Code Climate](https://codeclimate.com/github/theforeman/foreman-docker/badges/gpa.svg)](https://codeclimate.com/github/theforeman/foreman-docker)
+[![Gem Version](https://badge.fury.io/rb/foreman_docker.svg)](http://badge.fury.io/rb/foreman_docker)
+[![Dependency Status](https://gemnasium.com/theforeman/foreman-docker.svg)](https://gemnasium.com/theforeman/foreman-docker)
+
 ```foreman_docker``` enables provisioning and managing of [Docker](http://docker.com) containers and images in [Foreman](http://github.com/theforeman/foreman), all of that under the GPL v3+ license.
 
 * Website: [TheForeman.org](http://theforeman.org)
@@ -81,14 +85,17 @@ That's it. You're now ready to create and manage containers in your new Docker c
 | ---------------:| --------------:|
 | >= 1.5         | 0.0.1 - 0.0.3   |
 | >= 1.6         | 0.1.0 - 0.2.0   |
+| >= 1.7         | 1.0.0           |
 
-## Known bugs
-* Unsaved new containers leave a dangling container object in the database
-* Power operations redirect to compute resource container view even for managed container
+We will follow [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html). This means:
+* MAJOR versions: will break compatibility with the latest supported Foreman version. For instance, foreman-docker 1.0 breaks Foreman 1.6 compatibility.
+* MINOR versions: will enhance foreman-docker with features in a backwards-compatible manner.
+* PATCH versions: will contain bugfixes for the latest minor version in a backwards-compatible manner.
 
 ## 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:
+* Code from the master branch can contain features only present in [Fog's](http://github.com/fog/fog) master branch, we commit to wait for the next Fog release to put that code in a foreman-docker release.
 * [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

data/app/assets/javascripts/foreman_docker/image_step.js

@@ -2,6 +2,7 @@ $(document).ready(function() {
   var tag = $('#tag');
   tag.autocomplete({
     source: [],
+    autoFocus: true,
     delay: 500,
     minLength: 0
   }).focus( function() {
@@ -9,25 +10,31 @@ $(document).ready(function() {
   });
 
   var target = $('#search');
-  autoCompleteImage(target);
+  //autoCompleteRepo(target);
   target.autocomplete({
-    source: function( request, response ) { autoCompleteImage(target); },
+    source: function( request, response ) { autoCompleteRepo(target); },
     delay: 500,
     minLength: 1
   });
+
+  $('#hub_tab').click( function() {
+      $('#wizard_states_image_registry_id').val('');
+  });
 });
 
-function autoCompleteImage(item) {
+function autoCompleteRepo(item) {
   $.ajax({
     type:'get',
     url: $(item).attr('data-url'),
-    data:'search=' + item.val(),
+    data: { search: item.val(), registry_id: $('#wizard_states_image_registry_id').val() },
+    //data:'search=' + item.val(),
     success:function (result) {
       if(result == 'true'){
         $('#search-addon').attr('title', 'Image found in the compute resource');
         $('#search-addon').removeClass('glyphicon-remove');
         $('#search-addon').css('color', 'lightgreen');
         $('#search-addon').addClass('glyphicon-ok');
+        setWaitingText('Image found: <strong>' + item.val() + '</strong>. Retrieving available tags, please wait...');
         setAutocompleteTags();
       } else {
         $('#search-addon').attr('title', 'Image NOT found in the compute resource');
@@ -45,12 +52,44 @@ function setAutocompleteTags() {
   tag.addClass('tags-autocomplete-loading');
   tag.val('');
   var source = [];
-  $.getJSON( tag.data("url"), { search: $('#search').val() },
+  $.getJSON( tag.data("url"), { search: $('#search').val(), registry_id: $('#wizard_states_image_registry_id').val() },
       function(data) {
+        $('#searching_spinner').hide();
         tag.removeClass('tags-autocomplete-loading');
         $.each( data, function(index, value) {
           source.push({label: value.label, value: value.value});
         });
+        $('#tag').focus();
       });
   tag.autocomplete('option', 'source', source);
 }
+
+function searchRepo(item) {
+  setWaitingText('<strong>Searching</strong> in the hub, this can be slow, please wait...');
+  $('#repository_search_results').html('');
+  $('#repository_search_results').show();
+  $.ajax({
+    type:'get',
+    dataType:'text',
+    url: $(item).attr('data-url'),
+    data: { search: $('#search').val(), registry_id: $('#wizard_states_image_registry_id').val() },
+    success: function (result) {
+      $('#repository_search_results').html(result);
+    },
+    complete: function (result) {
+      $('#searching_spinner').hide();
+    }
+  });
+}
+
+function repoSelected(item) {
+  $('#repository_search_results').hide();
+  setWaitingText('Image selected: <strong>' + item.text + '</strong>. Retrieving available tags, please wait...');
+  $('#search').val(item.text);
+  setAutocompleteTags(item);
+}
+
+function setWaitingText(string) {
+  $('#waiting_text').html(string);
+  $('#searching_spinner').show();
+}

data/app/controllers/concerns/foreman_docker/find_container.rb

@@ -0,0 +1,19 @@
+# To be replaced by find_resource, FindCommon after 1.6 support is deprecated
+module ForemanDocker
+  module FindContainer
+    extend ActiveSupport::Concern
+
+    def find_container
+      if params[:id].blank?
+        not_found
+        return
+      end
+      @container = Container.authorized("#{action_permission}_#{controller_name}".to_sym)
+                            .find(params[:id])
+    end
+
+    def allowed_resources
+      ForemanDocker::Docker.authorized(:view_compute_resources)
+    end
+  end
+end

data/app/controllers/containers/steps_controller.rb

@@ -1,62 +1,48 @@
 module Containers
   class StepsController < ::ApplicationController
     include Wicked::Wizard
+    include ForemanDocker::FindContainer
 
     steps :preliminary, :image, :configuration, :environment
-    before_filter :find_container
+
+    before_filter :build_state
+    before_filter :set_form
 
     def show
-      case step
-      when :preliminary
-        @container_resources = ComputeResource.select { |cr| cr.provider == 'Docker' }
-      when :image
-      when :configuration
-      when :environment
-      end
+      @container_resources = allowed_resources if step == :preliminary
       render_wizard
     end
 
     def update
-      case step
-      when :preliminary
-        @container.update_attribute(:compute_resource_id, params[:container][:compute_resource_id])
-      when :image
-        @container.update_attributes!(
-            :image => (image = DockerImage.find_or_create_by_image_id!(params[:image])),
-            :tag => DockerTag.find_or_create_by_tag_and_docker_image_id!(params[:container][:tag],
-                                                                         image.id))
-      when :configuration
-        @container.update_attributes(params[:container])
-      when :environment
-        @container.update_attributes(params[:container])
-        if (response = start_container)
-          @container.uuid = response.id
-        else
-          process_error(:object => @container.compute_resource, :render => 'environment')
-          return
-        end
+      if step == wizard_steps.last
+        create_container
+      else
+        render_wizard @state
       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])
+    def build_state
+      @state = DockerContainerWizardState.find(params[:wizard_state_id])
+      @state.send(:"build_#{step}", params[:"docker_container_wizard_states_#{step}"])
     rescue ActiveRecord::RecordNotFound
       not_found
     end
 
-    def start_container
-      @container.compute_resource.create_container(@container.parametrize)
+    def set_form
+      instance_variable_set("@#{step}", @state.send(:"#{step}") || @state.send(:"build_#{step}"))
+    end
+
+    def create_container
+      @state.send(:"create_#{step}", params[:"docker_container_wizard_states_#{step}"])
+      container = Service::Containers.start_container!(@state)
+      if container.present?
+        process_success(:object => container, :success_redirect => container_path(container))
+      else
+        @environment = @state.environment
+        process_error(:object => @state.environment, :render => 'environment')
+      end
     end
   end
 end

data/app/controllers/containers_controller.rb

@@ -1,11 +1,10 @@
 class ContainersController < ::ApplicationController
-  before_filter :find_container, :only => [:show,
-                                           :auto_complete_image,
-                                           :auto_complete_image_tags,
-                                           :commit]
+  include ForemanDocker::FindContainer
+
+  before_filter :find_container, :only => [:show, :commit]
 
   def index
-    @container_resources = allowed_resources.select { |cr| cr.provider == 'Docker' }
+    @container_resources = allowed_resources
     if @container_resources.empty?
       warning('You need a Compute Resource of type Docker to start managing containers')
       redirect_to new_compute_resource_path
@@ -16,12 +15,12 @@ class ContainersController < ::ApplicationController
   end
 
   def new
-    @container = Container.create
-    redirect_to container_step_path(:container_id => @container.id, :id => :preliminary)
+    redirect_to wizard_state_step_path(:wizard_state_id => DockerContainerWizardState.create.id,
+                                       :id              => :preliminary)
   end
 
   def destroy
-    if resource_deletion
+    if container_deletion
       process_success(:success_redirect => containers_path,
                       :success_msg      => (_("Container %s is being deleted.") %
                                             @deleted_identifier))
@@ -35,24 +34,6 @@ class ContainersController < ::ApplicationController
   def show
   end
 
-  def auto_complete_image
-    if @container.compute_resource.exist?(params[:search])
-      render :text => 'true'
-    else
-      render :text => 'false'
-    end
-  end
-
-  def auto_complete_image_tags
-    images = @container.compute_resource.all_images(params[:search]).map do |image|
-      image.info['RepoTags'].map do |image_tag|
-        _, tag = image_tag.split(':')
-        { :label => CGI.escapeHTML(tag), :value => CGI.escapeHTML(tag) }
-      end
-    end
-    render :json => images.flatten
-  end
-
   def commit
     Docker::Container.get(@container.uuid).commit(:author  => params[:commit][:author],
                                                   :repo    => params[:commit][:repo],
@@ -71,7 +52,7 @@ class ContainersController < ::ApplicationController
 
   def action_permission
     case params[:action]
-    when 'auto_complete_image', 'auto_complete_image_tags'
+    when 'auto_complete_repository_name', 'auto_complete_tag', 'search_repository'
       :view
     when 'commit'
       :commit
@@ -80,13 +61,13 @@ class ContainersController < ::ApplicationController
     end
   end
 
-  def resource_deletion
+  def container_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
+      find_container
       @deleted_identifier = @container.name
 
       destroy_compute_resource_vm(@container.compute_resource, @container.uuid) &&
@@ -102,18 +83,4 @@ class ContainersController < ::ApplicationController
     logger.error "#{error.message} (#{error.class})\n#{error.backtrace.join("\n")}"
     false
   end
-
-  def allowed_resources
-    ComputeResource.authorized(:view_compute_resources)
-  end
-
-  # To be replaced by find_resource after 1.6 support is deprecated
-  def find_container
-    if params[:id].blank?
-      not_found
-      return
-    end
-    @container = Container.authorized("#{action_permission}_#{controller_name}".to_sym)
-                          .find(params[:id])
-  end
 end

data/app/controllers/image_search_controller.rb

@@ -0,0 +1,88 @@
+class ImageSearchController < ::ApplicationController
+  before_filter :find_resource
+
+  def auto_complete_repository_name
+    render :text => (use_hub? ? hub_image_exists?(params[:search]) :
+        registry_image_exists?(params[:search])).to_s
+  end
+
+  def auto_complete_image_tag
+    # This is the format jQuery UI autocomplete expects
+    tags = use_hub? ? hub_auto_complete_image_tags(params[:search]) :
+        registry_auto_complete_image_tags(params[:search])
+    respond_to do |format|
+      format.js do
+        tags.map! { |tag| { :label => CGI.escapeHTML(tag), :value => CGI.escapeHTML(tag) } }
+        render :json => tags
+      end
+    end
+  end
+
+  def search_repository
+    repositories = use_hub? ? hub_search_image(params[:search]) :
+                              registry_search_image(params[:search])
+    respond_to do |format|
+      format.js do
+        render :partial => 'repository_search_results',
+               :locals  => { :repositories => repositories }
+      end
+    end
+  end
+
+  def use_hub?
+    @registry.nil?
+  end
+
+  def hub_image_exists?(terms)
+    @compute_resource.exist?(terms)
+  end
+
+  def hub_auto_complete_image_tags(terms)
+    @compute_resource.tags(terms)
+  end
+
+  def hub_search_image(terms)
+    @compute_resource.search(terms)
+  end
+
+  def registry_image_exists?(term)
+    result = ::Service::RegistryApi.new(:url => @registry.url,
+                                        :user => @registry.username,
+                                        :password => @registry.password).search(term)
+    registry_name = term.split('/').size > 1 ? term :
+        'library/' + term
+    result['results'].any? { |r| r['name'] == registry_name }
+  end
+
+  def registry_auto_complete_image_tags(terms)
+    ::Service::RegistryApi.new(:url => @registry.url,
+                               :user => @registry.username,
+                               :password => @registry.password).list_repository_tags(terms).keys
+  end
+
+  def registry_search_image(terms)
+    r = ::Service::RegistryApi.new(:url => @registry.url,
+                                   :user => @registry.username,
+                                   :password => @registry.password).search(terms)
+    r['results']
+  end
+
+  def action_permission
+    case params[:action]
+    when 'auto_complete_repository_name', 'auto_complete_image_tag', 'search_repository'
+      :search_repository
+    else
+      super
+    end
+  end
+
+  def find_resource
+    if params[:registry_id].present?
+      @registry = DockerRegistry.authorized(:view_registries).find(params[:registry_id])
+    else
+      @compute_resource = ComputeResource.authorized(:view_compute_resources).find(params[:id])
+    end
+  rescue ActiveRecord::RecordNotFound
+    not_found
+  end
+end

data/app/controllers/registries_controller.rb

@@ -0,0 +1,47 @@
+class RegistriesController < ::ApplicationController
+  include Foreman::Controller::AutoCompleteSearch
+  before_filter :find_registry, :only => [:edit, :update, :destroy]
+
+  def index
+    @registries = DockerRegistry.search_for(params[:search], :order => params[:order])
+      .paginate :page => params[:page]
+  end
+
+  def new
+    @registry = DockerRegistry.new
+  end
+
+  def create
+    @registry = DockerRegistry.new(params[:docker_registry])
+    if @registry.save
+      process_success
+    else
+      process_error
+    end
+  end
+
+  def edit
+  end
+
+  def update
+    if @registry.update_attributes(params[:docker_registry])
+      process_success
+    else
+      process_error
+    end
+  end
+
+  def destroy
+    if @registry.destroy
+      process_success
+    else
+      process_error
+    end
+  end
+
+  def find_registry
+    @registry = DockerRegistry.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    not_found
+  end
+end