foreman_docker 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26d60710f8feff575f0ad158fe70dcd4ca943a4b
-  data.tar.gz: c2cb12599647a844761982076c1b8b176d5c378e
+  metadata.gz: ebb80b781a7f84fa7654be95ec8d3404a4164931
+  data.tar.gz: 27d789e92be3bd4b2e10078808f8769aece0874c
 SHA512:
-  metadata.gz: 96ad25c6bd9fa70731aaa122c26d4515e6094162bd0b998b88b0d64d5f5cd1bc420b21f932ea624c65b5fb9410030a232d5e6dc0c587321b0e4952717f4abd18
-  data.tar.gz: 1e1853fbe2f9f8ce9ecf4f3b8811d7cd0a2a2fbf0afa43298662607559f0cbf7e0d143de93e4c384ce7e16a393aaf157bca069d408c5b931364205aa468860e2
+  metadata.gz: 5a9d5ffaf42b7a30a2a67f41ee5250dba09da5f18ba7e92e02ffe120791de1c5558b7b1b458c2f9e50a48e778dc0efd4e5d6972225345787ea3e8a88c2afb553
+  data.tar.gz: bd2b7877e5fd9e3c2c95a8991b0c9f189b67cc8d82def3d2e43442f0afb47ffd443664a6a991fa35a3b5fec3fc2cc58ac1a6bfad8272dfd4c7877c9f04342f52

data/.rubocop.yml

@@ -1,38 +1,38 @@
+# TODO: remove this file by either moving cops here or fixing code
+inherit_from:
+  - .rubocop_todo.yml
+
 AllCops:
-  RunRailsCops: true # always run the rails cops
+  TargetRubyVersion: 2.0
+
+Rails: # always run the rails cops
+  Enabled: true
+
+# Don't is_a? over kind_of?
+Style/ClassCheck:
+  Enabled: false
 
 # Don't enforce documentation
 Style/Documentation:
   Enabled: false
 
-# Need to support ruby 1.8
+# Support both ruby19 and hash_rockets
 Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
-# Force before_filter until upgrade to Rails 4
-Rails/ActionFilter:
-  EnforcedStyle: filter
-
-Metrics/LineLength:
-  Max: 100
+  Enabled: false
 
-Metrics/MethodLength:
-  Max: 20
+Style/StringLiterals:
+  Enabled: false
 
-StringLiterals:
+Style/FrozenStringLiteralComment:
   Enabled: false
 
 Metrics/ClassLength:
-  Max: 200
-
-Metrics/AbcSize:
-  Enabled: false # should we turn this on?
-
-Style/MethodCalledOnDoEndBlock:
-  Enabled: true
+  Exclude:
+    - 'test/**/*'
 
-Style/DotPosition:
-  EnforcedStyle: 'leading'
+Performance/FixedSize:
+  Exclude:
+    - 'test/**/*'
 
 Rails/Date:
   Exclude:

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

@@ -26,10 +26,36 @@ function setupAutoComplete(registryType) {
   });
 }
 
+function paramsForSearch(registryType) {
+  var image = getRepo(registryType),
+      tag = getTag(registryType),
+      registryId = $('#docker_container_wizard_states_image_registry_id').val(),
+      params = {
+        registry: registryType,
+        search: image.val()
+      }
+
+  if (tag.val() != '') {
+    params.search = image.val() + ':' + tag.val();
+  };
+
+  if (registryType == 'registry' && registryId != '') {
+    params.registry_id = registryId;
+  };
+
+  return params;
+}
+
 function autoCompleteRepo(item) {
   var registryType = $(item).data('registry'),
       search_add_on = getImageConfirmation(registryType),
-      tag = getTag(registryType);
+      tag = getTag(registryType),
+      params = paramsForSearch(registryType);
+
+  if (params.search == '' ||
+      (registryType == 'registry' && typeof params.registry_id == 'undefined')) {
+    return;
+  }
 
   // Patternfly spinner uses 'float: left' and moves it to the left of the
   // search button. Instead, we use FontAwesome's spinner to keep it at
@@ -39,7 +65,7 @@ function autoCompleteRepo(item) {
   $.ajax({
     type:'get',
     url: $(item).attr('data-url'),
-    data: { search: item.val(), registry_id: $('#docker_container_wizard_states_image_registry_id').val() },
+    data: params,
     success:function (result) {
        if(result == 'true'){
         search_add_on.attr('title', 'Image found in the compute resource');
@@ -59,11 +85,15 @@ function autoCompleteRepo(item) {
 }
 
 function setAutocompleteTags(registryType) {
-  var tag = getTag(registryType);
+  var registryType = registryType,
+      tag = getTag(registryType),
+      source = [];
+
   tag.addClass('spinner-label');
   tag.val('');
-  var source = [];
-  $.getJSON( tag.data("url"), { search: getRepo(registryType).val(), registry_id: $('#docker_container_wizard_states_image_registry_id').val() },
+
+  $.getJSON( tag.data("url"),
+      paramsForSearch(registryType),
       function(data) {
         getSearchSpinner(registryType).hide();
         tag.removeClass('spinner-label');
@@ -90,7 +120,7 @@ function searchRepo(item) {
     type:'get',
     dataType:'text',
     url: $(item).attr('data-url'),
-    data: { search: search.val(), registry_id: $('#docker_container_wizard_states_image_registry_id').val() },
+    data: paramsForSearch(registryType),
     success: function (result) {
       results.html(result);
     },

data/app/controllers/api/v2/containers_controller.rb

@@ -17,11 +17,10 @@ module Api
       param_group :search_and_pagination, ::Api::V2::BaseController
 
       def index
-        if params[:compute_resource_id].present?
-          scoped = Container.where(:compute_resource_id => params[:compute_resource_id])
-        else
-          scoped = Container.where(nil)
+        compute_resource_id = params[:compute_resource_id].tap do |id|
+          id.present? ? { :compute_resource_id => id } : nil
         end
+        scoped = Container.where(compute_resource_id)
         @containers = scoped.search_for(params[:search], :order => params[:order])
                       .paginate(:page => params[:page])
       end
@@ -53,7 +52,7 @@ module Api
           param :memory, String
           param :cpu_shares, :number
           param :cpu_set, String
-          param :environment_variables, Hash
+          param :environment_variables, Array, :desc => N_("Optional array of environment variables hashes. e.g. 'environment_variables': [{'name' => 'example', 'value' => '123'}]")
           param :attach_stdout, :bool
           param :attach_stdin, :bool
           param :attach_stderr, :bool
@@ -73,16 +72,13 @@ module Api
         @container = service.start_container!(set_wizard_state)
         if service.errors.any?
           render :json => { :errors => service.errors,
-                            :full_messages => service.full_messages
+                            :full_messages => service.full_messages.join(', ')
                           },
                  :status => :unprocessable_entity
         else
           set_container_taxonomies
           process_response @container.save
         end
-      rescue ActiveModel::MassAssignmentSecurity::Error => e
-        render :json => { :error  => _("Wrong attributes: %s") % e.message },
-               :status => :unprocessable_entity
       end
 
       api :DELETE, '/containers/:id/', N_('Delete a container')
@@ -169,8 +165,14 @@ module Api
         end
 
         if params[:container][:environment_variables].present?
-          wizard_state.environment.environment_variables =
-            params[:container][:environment_variables]
+          environment_variables = []
+          params[:container][:environment_variables].each do |env_var|
+            environment_variable = DockerContainerWizardStates::EnvironmentVariable.new
+            environment_variable.key = env_var[:key]
+            environment_variable.value = env_var[:value]
+            environment_variables << environment_variable
+          end
+          wizard_state.environment.environment_variables = environment_variables
         end
         wizard_state.tap(&:save)
       end

data/app/controllers/containers/steps_controller.rb

@@ -39,6 +39,10 @@ module Containers
       instance_variable_set("@docker_container_wizard_states_#{step}", s)
     end
 
+    def docker_parameters_permited_params
+      [:key, :reference_id, :value, :_destroy, :id]
+    end
+
     def state_params
       attrs = case step
               when :preliminary
@@ -50,8 +54,9 @@ module Containers
               when :environment
                 [:tty, :docker_container_wizard_state_id,
                  :attach_stdin, :attach_stdout, :attach_stderr,
-                 :exposed_ports_attributes => [], :environment_variables_attributes => [],
-                 :dns_attributes => []
+                 :exposed_ports_attributes => docker_parameters_permited_params,
+                 :environment_variables_attributes => docker_parameters_permited_params,
+                 :dns_attributes => docker_parameters_permited_params
                 ]
               end
 
@@ -72,6 +77,7 @@ module Containers
                   else
                     service.create_container!(@state)
                   end
+      
       if container.present?
         process_success(:object => container, :success_redirect => container_path(container))
       else

data/app/controllers/containers_controller.rb

@@ -99,9 +99,10 @@ class ContainersController < ::ApplicationController
   end
 
   def container_deletion
-    if params[:compute_resource_id].present?
-      compute_resource_id = params[:compute_resource_id]
-      container_uuid      = params[:id]
+    # TODO: Refactor to recognize params[:compute_resource_id] as well.
+    compute_resource_id = params[:compute_resource_id].tap { |id| id.present? ? id : nil }
+    if compute_resource_id
+      container_uuid = params[:id]
       @container ||= Container.authorized("#{action_permission}_#{controller_name}".to_sym).find_by_uuid(container_uuid)
     else
       find_container

data/app/controllers/image_search_controller.rb

@@ -1,34 +1,21 @@
 class ImageSearchController < ::ApplicationController
-  before_filter :find_resource
-
-  # this is incredibly odd. for some reason, rails sees the
-  # requests ImageSearchControllerTest makes as requests from another host
-  # thus, violating CSRF.
-  protect_from_forgery :only => :nothing if Rails.env.test?
-
   def auto_complete_repository_name
     catch_network_errors do
-      text = if use_hub?
-               hub_image_exists?(params[:search])
-             else
-               registry_image_exists?(params[:search])
-             end
-      render :text => text.to_s
+      available = image_search_service.available?(params[:search])
+      render :text => available.to_s
     end
   end
 
   def auto_complete_image_tag
     catch_network_errors do
-      # This is the format jQuery UI autocomplete expects
-      tags = if use_hub?
-               hub_auto_complete_image_tags(params[:search])
-             else
-               registry_auto_complete_image_tags(params[:search])
-             end
+      tags = image_search_service.search({
+        term: params[:search],
+        tags: 'true'
+      })
+
       respond_to do |format|
         format.js do
-          tags.map! { |tag| { :label => CGI.escapeHTML(tag), :value => CGI.escapeHTML(tag) } }
-          render :json => tags
+          render :json => prepare_for_autocomplete(tags)
         end
       end
     end
@@ -36,11 +23,10 @@ class ImageSearchController < ::ApplicationController
 
   def search_repository
     catch_network_errors do
-      repositories = if use_hub?
-                       hub_search_image(params[:search])
-                     else
-                       registry_search_image(params[:search])
-                     end
+      repositories = image_search_service.search({
+        term: params[:search].split(':').first,
+        tags: 'false'
+      })
 
       respond_to do |format|
         format.js do
@@ -52,6 +38,8 @@ class ImageSearchController < ::ApplicationController
     end
   end
 
+  private
+
   def catch_network_errors
     yield
   rescue Docker::Error::NotFoundError => e
@@ -67,52 +55,6 @@ class ImageSearchController < ::ApplicationController
     @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).map do |item|
-      # el7 returns -> "name" => "docker.io: docker.io/centos",
-      # while f20 returns -> "name" => "centos"
-      # we need repo name to be => "docker.io/centos" for el7 and "centos" for fedora
-      # to ensure proper search with respect to the tags, image creation etc.
-      new_item = item.clone
-      new_item["name"] = item["name"].split.last
-      new_item
-    end
-  end
-
-  def registry_image_exists?(term)
-    result = ::Service::RegistryApi.new(:url => @registry.url,
-                                        :user => @registry.username,
-                                        :password => @registry.password).search(term)
-    registry_name = if term.split('/').size > 1
-                      term
-                    else
-                      "library/#{term}"
-                    end
-
-    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'
@@ -122,13 +64,28 @@ class ImageSearchController < ::ApplicationController
     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])
+  # This is the format jQuery UI autocomplete expects
+  def prepare_for_autocomplete(tags)
+    tags.map do |tag|
+      tag = tag.is_a?(Hash) ? tag.fetch('name', tag) : tag
+      tag = CGI.escapeHTML(tag)
+      { :label => tag, :value => tag }
+    end
+  end
+
+  def image_search_service
+    @image_search_service ||= ForemanDocker::ImageSearch.new(*sources)
+  end
+
+  def sources
+    if params[:registry] == 'hub'
+      @registry ||= Service::RegistryApi.docker_hub
+      @compute_resource ||= ComputeResource.authorized(:view_compute_resources).find(params[:id])
+      [@registry, @compute_resource]
+    elsif params[:registry] == 'registry' && params[:registry_id].present?
+      @registry ||= DockerRegistry.authorized(:view_registries)
+        .find(params[:registry_id]).api
+      [@registry]
     end
-  rescue ActiveRecord::RecordNotFound
-    not_found
   end
 end

data/app/helpers/container_steps_helper.rb

@@ -34,6 +34,15 @@ module ContainerStepsHelper
     active_tab.to_s == tab_name.to_s ? "active" : ""
   end
 
+  # el7 returns -> "name" => "docker.io: docker.io/centos",
+  # while f20 returns -> "name" => "centos"
+  # we need repo name to be => "docker.io/centos" for el7 and "centos" for fedora
+  # to ensure proper search with respect to the tags, image creation etc.
+  def cleanup_image_name(name)
+    name.split.last
+  end
+
+
   def model_for(registry_type)
     if active_tab.to_s == registry_type.to_s
       @docker_container_wizard_states_image
@@ -42,6 +51,18 @@ module ContainerStepsHelper
     end
   end
 
+  def image_search_wrapper_class(model)
+    if model.errors.messages[:image]
+      'form-group has-error'
+    else
+      'form-group'
+    end
+  end
+
+  def tab_active?(registry)
+    active_tab == registry.to_sym
+  end
+
   def active_tab
     if @docker_container_wizard_states_image.katello?
       :katello

data/app/models/concerns/foreman_docker/parameter_validators.rb

@@ -1,11 +1,34 @@
 module ForemanDocker
   module ParameterValidators
     extend ActiveSupport::Concern
-    include ::ParameterValidators
 
-    def parameters_symbol
-      return :environment_variables if is_a? Container
-      super
+    included do
+      validate :validate_unique_parameter_keys
+    end
+
+    def validate_unique_parameter_keys
+      parameters_symbol = [:environment_variables, :exposed_ports, :dns]
+      parameters_symbol.each do |param_symbol|
+        keys  = []
+        errors = false
+
+        self.public_send(param_symbol).each do |param|
+          errors = duplicate_key?(keys, param)
+        end
+
+        self.errors[param_symbol] = _('Please ensure the following parameters are unique') if errors
+      end
+    end
+
+    def duplicate_key?(keys, param)
+      if keys.include?(param.key)
+        param.errors[:key] = _('has already been taken')
+        return true
+      else
+        keys << param.key
+      end
+
+      false
     end
   end
 end