smart_proxy_pulp 2.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 505ec0472b43a70f2f6c3c27da3586c0d8880665dfec8de14e38f4b5fe61a66c
-  data.tar.gz: 42ca3476e031944a1968e104bc6eee31d8df914c6174c09901964063fa62acfe
+  metadata.gz: 8ed75491dd5597b9032d38132676920c2d1ddfc5e52b9462bec134a8188719f4
+  data.tar.gz: a7994ef607521731efa8e2c815825fb3b68227bb0439cd755bf0119d5f59e4bc
 SHA512:
-  metadata.gz: 0a83d77270955785b69d3d777b86a089b632c32561eb7072a24e3fcafee382595a438fa6ff6e160f8e358f1d223f3cae98d0772e94272d181fdbe8fcb6031a90
-  data.tar.gz: 874d123e511b960abdd7da9cd70b9a2a743bfcb91173f8b5cf5382f780917f1fdbf3a4f7e740259eb0a874699384d94fb6a09b43e57952ee18e3c63cdb8a9023
+  metadata.gz: 90a817e0ee2c6b583e907c048ea6f1178777532463a6df2fc4ef3a8fc050e3f119f8711cd23e0a69672f274d811a896d6791556dcd6fdfc53a9a2b1383b9af6b
+  data.tar.gz: 3781082d3bf8644f9cb32c777bcf88d1642a4d77d3acb4ec3fa137cc6ec4a7493c66b2be758c4b19b8e7afefe94af21f0b8b50887796fa0f970f8b6e69ac6178

data/Gemfile

@@ -5,24 +5,5 @@ group :development do
   gem 'smart_proxy', :git => 'https://github.com/theforeman/smart-proxy', :branch => 'develop'
 end
 
-group :test do
-  gem 'webmock'
-  if RUBY_VERSION < '2.1'
-    gem 'public_suffix', '< 3'
-  else
-    gem 'public_suffix'
-  end
-  if RUBY_VERSION < '2.2'
-    gem 'rack-test', '< 0.8'
-  else
-    gem 'rack-test'
-  end
-end
-
-if RUBY_VERSION < '2.2'
-  gem 'sinatra', '< 2'
-  gem 'rack', '>= 1.1', '< 2.0.0'
-else
-  gem 'sinatra'
-  gem 'rack', '>= 1.1'
-end
+gem 'sinatra'
+gem 'rack', '>= 1.1'

data/lib/smart_proxy_pulp.rb

@@ -1,4 +1,2 @@
 require 'smart_proxy_pulp_plugin/version'
-require 'smart_proxy_pulp_plugin/pulp_plugin'
-require 'smart_proxy_pulp_plugin/pulp_node_plugin'
 require 'smart_proxy_pulp_plugin/pulpcore_plugin'

data/lib/smart_proxy_pulp_plugin/pulpcore_api.rb

@@ -1,6 +1,5 @@
 require 'sinatra'
 require 'smart_proxy_pulp_plugin/pulpcore_client'
-require 'smart_proxy_pulp_plugin/disk_usage'
 
 module PulpProxy
   class PulpcoreApi < Sinatra::Base
@@ -11,9 +10,9 @@ module PulpProxy
       begin
         result = PulpcoreClient.get("/pulp/api/v3/status/")
         return result.body if result.is_a?(Net::HTTPSuccess)
-        log_halt result.code, "Pulp server at #{::PulpProxy::Settings.settings.pulp_url} returned an error: '#{result.message}'"
+        log_halt result.code, "Pulp server at #{PulpcoreClient.pulp_url} returned an error: '#{result.message}'"
       rescue SocketError, Errno::ECONNREFUSED => e
-        log_halt 503, "Communication error with '#{URI.parse(::PulpProxy::Settings.settings.pulp_url.to_s).host}': #{e.message}"
+        log_halt 503, "Communication error with '#{URI.parse(PulpcoreClient.pulp_url).host}': #{e.message}"
       end
     end
   end

data/lib/smart_proxy_pulp_plugin/pulpcore_client.rb

@@ -1,13 +1,12 @@
 require 'net/http'
 require 'net/https'
 require 'uri'
-require 'smart_proxy_pulp_plugin/settings'
 require 'proxy/log'
 
 module PulpProxy
   class PulpcoreClient
     def self.get(path)
-      uri = URI.parse(::PulpProxy::PulpcorePlugin.settings.pulp_url.to_s)
+      uri = URI.parse(pulp_url)
       req = Net::HTTP::Get.new(URI.join(uri.to_s.chomp('/') + '/', path))
       req.add_field('Accept', 'application/json')
       self.http.request(req)
@@ -26,10 +25,14 @@ module PulpProxy
     end
 
     def self.http
-      uri = URI.parse(::PulpProxy::PulpcorePlugin.settings.pulp_url.to_s)
+      uri = URI.parse(pulp_url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = uri.scheme == 'https'
       http
     end
+
+    def self.pulp_url
+      ::PulpProxy::PulpcorePlugin.settings.pulp_url.to_s
+    end
   end
 end

data/lib/smart_proxy_pulp_plugin/pulpcore_plugin.rb

@@ -1,23 +1,31 @@
-require 'smart_proxy_pulp_plugin/validators/pulp_url_validator'
+require 'smart_proxy_pulp_plugin/validators'
 
 module PulpProxy
   class PulpcorePlugin < ::Proxy::Plugin
     plugin "pulpcore", ::PulpProxy::VERSION
     default_settings :pulp_url => 'https://localhost',
                      :content_app_url => 'https://localhost:24816/',
-                     :mirror => false
+                     :mirror => false,
+                     :client_authentication => ['password', 'client_certificate'],
+                     :rhsm_url => 'https://localhost/rhsm'
 
-    load_validators :url => ::PulpProxy::Validators::PulpUrlValidator
+    AUTH_TYPES = ['password', 'client_certificate', 'client_certificate_admin_only'].freeze
+
+    load_validators include: ::PulpProxy::Validators::Include
     validate :pulp_url, :url => true
     validate :content_app_url, :url => true
+    validate :client_authentication, :include => AUTH_TYPES
+    validate :rhsm_url, :url => true
 
     expose_setting :pulp_url
     expose_setting :mirror
     expose_setting :content_app_url
-    capability( lambda do ||
-      PulpcoreClient.capabilities
-    end)
-    http_rackup_path File.expand_path("pulpcore_http_config.ru", File.expand_path("../", __FILE__))
-    https_rackup_path File.expand_path("pulpcore_http_config.ru", File.expand_path("../", __FILE__))
+    expose_setting :username
+    expose_setting :password
+    expose_setting :client_authentication
+    expose_setting :rhsm_url
+
+    capability -> { PulpcoreClient.capabilities }
+    rackup_path File.expand_path('pulpcore_http_config.ru', __dir__)
   end
 end

data/lib/smart_proxy_pulp_plugin/validators.rb

@@ -0,0 +1,15 @@
+module PulpProxy
+  module Validators
+    class Include < ::Proxy::PluginValidators::Base
+      def validate!(settings)
+        setting_value = settings[@setting_name]
+
+        unless (setting_value - @params).empty?
+          raise ::Proxy::Error::ConfigurationError, "Parameter '#{@setting_name}' is expected to be one or more of #{@params}"
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_pulp_plugin/version.rb

@@ -1,3 +1,3 @@
 module PulpProxy
-  VERSION = "2.0.0"
+  VERSION = "3.2.0"
 end

data/settings.d/pulpcore.yml.example

@@ -2,4 +2,8 @@
 :enabled: true
 #:pulp_url: https://localhost/
 #:content_app_url: https://localhost:24816/
+#:username: admin
+#:password: password
 #:mirror: false
+#:client_authentication: ['password', 'client_certificate']
+#:rhsm_url: https://localhost/rhsm

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_pulp
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Dmitri Dolguikh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13'
 description: "    Basic Pulp support for Foreman Smart-Proxy\n"
 email:
 - dmitri@redhat.com
@@ -91,44 +91,34 @@ files:
 - LICENSE
 - bundler.d/pulp.rb
 - lib/smart_proxy_pulp.rb
-- lib/smart_proxy_pulp_plugin/disk_usage.rb
-- lib/smart_proxy_pulp_plugin/pulp_api.rb
-- lib/smart_proxy_pulp_plugin/pulp_client.rb
-- lib/smart_proxy_pulp_plugin/pulp_http_config.ru
-- lib/smart_proxy_pulp_plugin/pulp_node_http_config.ru
-- lib/smart_proxy_pulp_plugin/pulp_node_plugin.rb
-- lib/smart_proxy_pulp_plugin/pulp_plugin.rb
 - lib/smart_proxy_pulp_plugin/pulpcore_api.rb
 - lib/smart_proxy_pulp_plugin/pulpcore_client.rb
 - lib/smart_proxy_pulp_plugin/pulpcore_http_config.ru
 - lib/smart_proxy_pulp_plugin/pulpcore_plugin.rb
-- lib/smart_proxy_pulp_plugin/settings.rb
-- lib/smart_proxy_pulp_plugin/validators/pulp_url_validator.rb
+- lib/smart_proxy_pulp_plugin/validators.rb
 - lib/smart_proxy_pulp_plugin/version.rb
-- settings.d/pulp.yml.example
 - settings.d/pulpcore.yml.example
-- settings.d/pulpnode.yml.example
 homepage: https://github.com/theforeman/smart-proxy-pulp-plugin
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Basic Pulp support for Foreman Smart-Proxy
 test_files: []

data/lib/smart_proxy_pulp_plugin/disk_usage.rb

@@ -1,120 +0,0 @@
-module PulpProxy
-  class DiskUsage
-    include ::Proxy::Util
-    include ::Proxy::Log
-    SIZE = { :byte => 1, :kilobyte => 1_024, :megabyte => 1_048_576, :gigabyte => 1_073_741_824, :terabyte => 1_099_511_627_776 }
-
-    attr_reader :path, :stat, :size
-
-    def initialize(opts ={})
-      raise(::Proxy::Error::ConfigurationError, 'Unable to continue - must provide a path.') if opts[:path].nil?
-      @paths_hash = validate_path(path_hash(opts[:path]))
-      @path = @paths_hash.values
-      @size_format = opts[:size] || :kilobyte
-      @size = SIZE[@size_format]
-      @stat = {}
-      find_df
-      get_stat
-    end
-
-    def to_json
-      stat.to_json
-    end
-
-    private
-
-    attr_reader :command_path
-
-    def find_df
-      @command_path = which('df') || raise(::Proxy::Error::ConfigurationError, 'df command was not found unable to retrieve usage information.')
-    end
-
-    def command
-      [command_path, "-P", "-B", "#{size}", *path]
-    end
-
-    # Inspired and copied from Facter
-    # @ https://github.com/puppetlabs/facter/blob/2.x/lib/facter/core/execution/base.rb
-    # @TODO: Refactor http://projects.theforeman.org/issues/15235 when removing support for 1.8.7
-    def with_env(values)
-      old = {}
-      values.each do |var, value|
-        # save the old value if it exists
-        if old_val = ENV[var]
-          old[var] = old_val
-        end
-        # set the new (temporary) value for the environment variable
-        ENV[var] = value
-      end
-      # execute the caller's block, capture the return value
-      rv = yield
-        # use an ensure block to make absolutely sure we restore the variables
-    ensure
-      # restore the old values
-      values.each do |var, value|
-        if old.include?(var)
-          ENV[var] = old[var]
-        else
-          # if there was no old value, delete the key from the current environment variables hash
-          ENV.delete(var)
-        end
-      end
-      # return the captured return value
-      rv
-    end
-
-    def get_stat
-      with_env 'LC_ALL' => 'C' do
-        raw = Open3::popen3(*command) do |stdin, stdout, stderr, thread|
-          unless stderr.read.empty?
-            error_line = stderr.read
-            logger.error "[#{command_path}] #{error_line}"
-            raise(::Proxy::Error::ConfigurationError, "#{command_path} raised an error: #{error_line}")
-          end
-          stdout.read.split("\n")
-        end
-
-        logger.debug "[#{command_path}] #{raw.to_s}"
-
-        titles = normalize_titles(raw)
-        raw.each_with_index do |line, index|
-          mount_path = path[index]
-          values = normalize_values(line.split)
-          @stat[hash_key_for(mount_path)] = Hash[titles.zip(values)].merge({:path => mount_path, :size => @size_format})
-        end
-      end
-    end
-
-    def path_hash(path)
-      path.is_a?(Hash) ? path : Hash[path, path]
-    end
-
-    def hash_key_for(path)
-      @paths_hash.select { |k,v| v == path}.first[0]
-    end
-
-
-    def normalize_titles(raw)
-      replacers = {"mounted on" => :mounted, "capacity" => :percent, "1024-blocks" => :"1k-blocks" }
-      raw.shift.downcase.gsub(/(capacity|mounted on|1024-blocks)/) { |m| replacers.fetch(m,m)}.split.map(&:to_sym)
-    end
-
-    def normalize_values(values)
-      values.each_with_index do |value, index|
-        is_int = Integer(value) rescue false
-        values[index] = is_int if is_int
-      end
-      values
-    end
-
-    def validate_path(path_hash)
-      path_hash.each do |key, value|
-        unless File.readable?(value)
-          logger.warn "File at #{value} defined in #{key} parameter doesn't exist or is unreadable"
-          path_hash.delete(key)
-        end
-      end
-      path_hash
-    end
-  end
-end

data/lib/smart_proxy_pulp_plugin/pulp_api.rb

@@ -1,41 +0,0 @@
-require 'sinatra'
-require 'smart_proxy_pulp_plugin/pulp_client'
-require 'smart_proxy_pulp_plugin/disk_usage'
-require 'smart_proxy_pulp_plugin/settings'
-
-module PulpProxy
-  class Api < Sinatra::Base
-    helpers ::Proxy::Helpers
-    authorize_with_trusted_hosts
-    authorize_with_ssl_client
-
-    get "/status" do
-      content_type :json
-      begin
-        result = PulpClient.get("api/v2/status/")
-        return result.body if result.is_a?(Net::HTTPSuccess)
-        log_halt result.code, "Pulp server at #{::PulpProxy::Settings.settings.pulp_url} returned an error: '#{result.message}'"
-      rescue Errno::ECONNREFUSED => e
-        log_halt 503, "Pulp server at #{::PulpProxy::Settings.settings.pulp_url} is not responding"
-      rescue SocketError => e
-        log_halt 503, "Pulp server '#{URI.parse(::PulpProxy::Settings.settings.pulp_url.to_s).host}' is unknown"
-      end
-    end
-
-    get '/status/disk_usage' do
-      size = (params[:size] && DiskUsage::SIZE.keys.include?(params[:size].to_sym)) ? params[:size].to_sym : :kilobyte
-      monitor_dirs = Hash[::PulpProxy::Settings.settings.marshal_dump.select { |key, _| key == :pulp_dir || key == :pulp_content_dir || key == :mongodb_dir }]
-      begin
-        pulp_disk = DiskUsage.new({:path => monitor_dirs, :size => size})
-        pulp_disk.to_json
-      rescue ::Proxy::Error::ConfigurationError
-        log_halt 500, 'Could not find df command to evaluate disk space'
-      end
-    end
-
-    get '/status/puppet' do
-      content_type :json
-      {:puppet_content_dir => ::PulpProxy::Settings.settings.puppet_content_dir}.to_json
-    end
-  end
-end

data/lib/smart_proxy_pulp_plugin/pulp_client.rb

@@ -1,36 +0,0 @@
-require 'net/http'
-require 'net/https'
-require 'uri'
-require 'smart_proxy_pulp_plugin/settings'
-
-module PulpProxy
-  class PulpClient
-    def self.get(path)
-      uri = URI.parse(::PulpProxy::Settings.settings.pulp_url.to_s)
-      req = Net::HTTP::Get.new(URI.join(uri.to_s.chomp('/') + '/', path))
-      req.add_field('Accept', 'application/json')
-      req.content_type = 'application/json'
-      response = self.http.request(req)
-    end
-
-    def self.http
-      uri = URI.parse(::PulpProxy::Settings.settings.pulp_url.to_s)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = uri.scheme == 'https'
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
-      if http.use_ssl?
-        if Proxy::SETTINGS.ssl_ca_file && !Proxy::SETTINGS.ssl_ca_file.to_s.empty?
-          http.ca_file = Proxy::SETTINGS.ssl_ca_file
-          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        end
-
-        if Proxy::SETTINGS.ssl_certificate && !Proxy::SETTINGS.ssl_certificate.to_s.empty? && Proxy::SETTINGS.ssl_private_key && !Proxy::SETTINGS.ssl_private_key.to_s.empty?
-          http.cert = OpenSSL::X509::Certificate.new(File.read(Proxy::SETTINGS.ssl_certificate))
-          http.key  = OpenSSL::PKey::RSA.new(File.read(Proxy::SETTINGS.ssl_private_key), nil)
-        end
-      end
-      http
-    end
-  end
-end

data/lib/smart_proxy_pulp_plugin/pulp_http_config.ru

@@ -1,5 +0,0 @@
-require 'smart_proxy_pulp_plugin/pulp_api'
-
-map "/pulp" do
-  run PulpProxy::Api
-end

data/lib/smart_proxy_pulp_plugin/pulp_node_http_config.ru

@@ -1,5 +0,0 @@
-require 'smart_proxy_pulp_plugin/pulp_api'
-
-map "/pulpnode" do
-  run PulpProxy::Api
-end

data/lib/smart_proxy_pulp_plugin/pulp_node_plugin.rb

@@ -1,14 +0,0 @@
-module PulpNodeProxy
-  class Plugin < ::Proxy::Plugin
-    plugin "pulpnode", ::PulpProxy::VERSION
-    default_settings :pulp_url => 'https://localhost/pulp',
-                     :pulp_dir => '/var/lib/pulp',
-                     :pulp_content_dir => '/var/lib/pulp/content',
-                     :puppet_content_dir => '/etc/puppet/environments',
-                     :mongodb_dir => '/var/lib/mongodb'
-
-    expose_setting :pulp_url
-    http_rackup_path File.expand_path("pulp_node_http_config.ru", File.expand_path("../", __FILE__))
-    https_rackup_path File.expand_path("pulp_node_http_config.ru", File.expand_path("../", __FILE__))
-  end
-end

data/lib/smart_proxy_pulp_plugin/pulp_plugin.rb

@@ -1,15 +0,0 @@
-module PulpProxy
-  class Plugin < ::Proxy::Plugin
-    plugin "pulp", ::PulpProxy::VERSION
-    default_settings :pulp_url => 'https://localhost/pulp',
-                     :pulp_dir => '/var/lib/pulp',
-                     :pulp_content_dir => '/var/lib/pulp/content',
-                     :puppet_content_dir => '/etc/puppet/environments',
-                     :mongodb_dir => '/var/lib/mongodb'
-
-    expose_setting :pulp_url
-
-    http_rackup_path File.expand_path("pulp_http_config.ru", File.expand_path("../", __FILE__))
-    https_rackup_path File.expand_path("pulp_http_config.ru", File.expand_path("../", __FILE__))
-  end
-end

data/lib/smart_proxy_pulp_plugin/settings.rb

@@ -1,12 +0,0 @@
-require 'sinatra'
-require 'smart_proxy_pulp_plugin/pulp_node_plugin'
-require 'smart_proxy_pulp_plugin/pulp_plugin'
-
-module PulpProxy
-  class Settings 
-    def self.settings 
-      # work around until pulp node settings are no longer needed by foreman proxy, as pulp nodes have been removed
-      ::PulpProxy::Plugin.settings.pulp_url ? ::PulpProxy::Plugin.settings : ::PulpNodeProxy::Plugin.settings
-    end
-  end
-end

data/lib/smart_proxy_pulp_plugin/validators/pulp_url_validator.rb

@@ -1,12 +0,0 @@
-module PulpProxy
-  module Validators
-    class PulpUrlValidator < ::Proxy::PluginValidators::Base
-      def validate!(settings)
-        raise ::Proxy::Error::ConfigurationError, "Setting 'pulp_url' is expected to contain a url for pulp server" if settings[:pulp_url].to_s.empty?
-        URI.parse(settings[:pulp_url])
-      rescue URI::InvalidURIError
-        raise ::Proxy::Error::ConfigurationError.new("Setting 'pulp_url' contains an invalid url for pulp server")
-      end
-    end
-  end
-end

data/settings.d/pulp.yml.example

@@ -1,8 +0,0 @@
----
-:enabled: true
-#:pulp_url: https://localhost/pulp
-# Path to pulp, pulp content and mongodb directories
-#:pulp_dir: /var/lib/pulp
-#:pulp_content_dir: /var/lib/pulp/content
-#:puppet_content_dir: /etc/pupppet/environments
-#:mongodb_dir: /var/lib/mongodb

data/settings.d/pulpnode.yml.example

@@ -1,8 +0,0 @@
----
-:enabled: true
-#:pulp_url: https://localhost/pulp
-# Path to pulp, pulp content and mongodb directories
-#:pulp_dir: /var/lib/pulp
-#:pulp_content_dir: /var/lib/pulp/content
-#:puppet_content_dir: /etc/puppet/environments
-#:mongodb_dir: /var/lib/mongodb