kpm 0.7.0 → 0.8.2

data/lib/kpm/tenant_config.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 require 'tmpdir'
 require 'json'
 require 'killbill_client'
 
 module KPM
-
   class TenantConfig
     # Killbill server
     KILLBILL_HOST = ENV['KILLBILL_HOST'] || '127.0.0.1'
-    KILLBILL_URL = 'http://'.concat(KILLBILL_HOST).concat(':8080')
-    KILLBILL_API_VERSION = '1.0'
+    KILLBILL_URL = "http://#{KILLBILL_HOST}:8080"
 
     # USER/PWD
     KILLBILL_USER = ENV['KILLBILL_USER'] || 'admin'
@@ -20,112 +20,97 @@ module KPM
 
     # Temporary directory
     TMP_DIR_PEFIX = 'killbill'
-    TMP_DIR = Dir.mktmpdir(TMP_DIR_PEFIX);
-    
-    #Tenant key prefixes
-    KEY_PREFIXES = ['PLUGIN_CONFIG','PUSH_NOTIFICATION_CB','PER_TENANT_CONFIG',
-      'PLUGIN_PAYMENT_STATE_MACHINE','CATALOG','OVERDUE_CONFIG',
-      'INVOICE_TRANSLATION','CATALOG_TRANSLATION','INVOICE_TEMPLATE','INVOICE_MP_TEMPLATE']
-    
-    
+    TMP_DIR = Dir.mktmpdir(TMP_DIR_PEFIX)
+
+    # Tenant key prefixes
+    KEY_PREFIXES = %w[PLUGIN_CONFIG PUSH_NOTIFICATION_CB PER_TENANT_CONFIG
+                      PLUGIN_PAYMENT_STATE_MACHINE CATALOG OVERDUE_CONFIG
+                      INVOICE_TRANSLATION CATALOG_TRANSLATION INVOICE_TEMPLATE INVOICE_MP_TEMPLATE].freeze
+
     def initialize(killbill_api_credentials = nil, killbill_credentials = nil, killbill_url = nil, logger = nil)
       @killbill_api_key = KILLBILL_API_KEY
-      @killbill_api_secrets = KILLBILL_API_SECRET
+      @killbill_api_secret = KILLBILL_API_SECRET
       @killbill_url = KILLBILL_URL
       @killbill_user = KILLBILL_USER
       @killbill_password = KILLBILL_PASSWORD
       @logger = logger
 
-      set_killbill_options(killbill_api_credentials,killbill_credentials,killbill_url)
-
+      set_killbill_options(killbill_api_credentials, killbill_credentials, killbill_url)
     end
-    
-    def export(key_prefix = nil)
 
+    def export(key_prefix = nil)
       export_data = fetch_export_data(key_prefix)
-      
-      if export_data.size == 0
-        raise Interrupt, 'key_prefix not found'
-      end
-      
+
+      raise ArgumentError, "Data for key_prefix=#{key_prefix} not found" if export_data.empty?
+
       export_file = store_into_file(export_data)
 
-      if not File.exist?(export_file)
-        raise Interrupt, 'key_prefix not found'
-      else
-        @logger.info "\e[32mData exported under #{export_file}\e[0m"
-      end
+      @logger.info "\e[32mData exported under #{export_file}\e[0m"
 
       export_file
     end
-    
+
     private
-      
-      def fetch_export_data(key_prefix)
-        tenant_config = []
-        pefixes = key_prefix.nil? ? KEY_PREFIXES : [key_prefix]
-        
-        pefixes.each do |prefix|
-           
-           config_data = call_client(prefix)
-           
-           if config_data.size > 0
-             config_data.each {|data| tenant_config << data }
-             @logger.info "Data for key prefix \e[1m#{prefix.to_s}\e[0m was \e[1mfound and is ready to be exported\e[0m."
-           else
-             @logger.info "Data for key prefix \e[1m#{prefix.to_s}\e[0m was \e[31mnot found\e[0m." 
-           end
-        end
-        
-        tenant_config
-      end
-    
-      def call_client(key_prefix)
-        
-        KillBillClient.url = @killbill_url
-        options = {
-          :username => @killbill_user,
-          :password => @killbill_password,
-          :api_key => @killbill_api_key,
-          :api_secret => @killbill_api_secrets
-        }
-         
-        tenant_config_data = KillBillClient::Model::Tenant.search_tenant_config(key_prefix, options)
-        
-        tenant_config_data
-      end
-      
-      def store_into_file(export_data)
-        export_file = TMP_DIR + File::SEPARATOR + 'kbdump'
 
-        File.open(export_file, 'w') { |io| io.puts export_data.to_json }
+    def fetch_export_data(key_prefix)
+      tenant_config = []
+      pefixes = key_prefix.nil? ? KEY_PREFIXES : [key_prefix]
 
-        export_file
+      pefixes.each do |prefix|
+        config_data = call_client(prefix)
+
+        if !config_data.empty?
+          config_data.each { |data| tenant_config << data }
+          @logger.debug "Data for key prefix \e[1m#{prefix}\e[0m was \e[1mfound and is ready to be exported\e[0m."
+        else
+          @logger.debug "Data for key prefix \e[1m#{prefix}\e[0m was \e[31mnot found\e[0m."
+        end
       end
-          
-      def set_killbill_options(killbill_api_credentials, killbill_credentials, killbill_url)
 
-        if not killbill_api_credentials.nil?
+      tenant_config
+    end
 
-          @killbill_api_key = killbill_api_credentials[0]
-          @killbill_api_secrets = killbill_api_credentials[1]
+    def call_client(key_prefix)
+      KillBillClient.url = @killbill_url
+      KillBillClient.logger = @logger
+      options = {
+        username: @killbill_user,
+        password: @killbill_password,
+        api_key: @killbill_api_key,
+        api_secret: @killbill_api_secret
+      }
+
+      begin
+        return KillBillClient::Model::Tenant.search_tenant_config(key_prefix, options)
+      rescue KillBillClient::API::Unauthorized
+        raise ArgumentError, "Unable to export tenant details, wrong credentials? username=#{@killbill_user}, password=#{mask(@killbill_password)}, api_key=#{@killbill_api_key}, api_secret=#{mask(@killbill_api_secret)}"
+      end
+    end
 
-        end
+    def store_into_file(export_data)
+      export_file = TMP_DIR + File::SEPARATOR + 'kbdump'
 
-        if not killbill_credentials.nil?
+      File.open(export_file, 'w') { |io| io.puts export_data.to_json }
 
-          @killbill_user = killbill_credentials[0]
-          @killbill_password = killbill_credentials[1]
+      export_file
+    end
 
-        end
+    def set_killbill_options(killbill_api_credentials, killbill_credentials, killbill_url)
+      unless killbill_api_credentials.nil?
+        @killbill_api_key = killbill_api_credentials[0]
+        @killbill_api_secret = killbill_api_credentials[1]
+      end
 
-        if not killbill_url.nil?
+      unless killbill_credentials.nil?
+        @killbill_user = killbill_credentials[0]
+        @killbill_password = killbill_credentials[1]
+      end
 
-          @killbill_url = killbill_url
+      @killbill_url = killbill_url unless killbill_url.nil?
+    end
 
-        end
-      end
-    
+    def mask(string, all_but = 3, char = '*')
+      string.gsub(/.(?=.{#{all_but}})/, char)
+    end
   end
-  
-end
+end

data/lib/kpm/tomcat_manager.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'uri'
 
 module KPM
   class TomcatManager
-
     DOWNLOAD_URL = 'https://s3.amazonaws.com/kb-binaries/apache-tomcat-7.0.42.tar.gz'
 
     def initialize(tomcat_dir, logger)
@@ -19,10 +20,10 @@ module KPM
         file = Pathname.new(dir).join('tomcat.tar.gz')
 
         @logger.info "Starting download of #{DOWNLOAD_URL} to #{file}"
-        Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
-          File.open(file, 'wb+') do |file|
+        Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          File.open(file, 'wb+') do |f|
             http.get(uri.path) do |body|
-              file.write(body)
+              f.write(body)
             end
           end
         end
@@ -36,7 +37,7 @@ module KPM
 
     def setup
       # Remove default webapps
-      %w(ROOT docs examples host-manager manager).each do |webapp|
+      %w[ROOT docs examples host-manager manager].each do |webapp|
         FileUtils.rm_rf(@tomcat_dir.join('webapps').join(webapp))
       end
 
@@ -55,9 +56,9 @@ module KPM
 
     def help
       "Tomcat installed at #{@tomcat_dir}
-Start script: #{@tomcat_dir.join('bin').join('startup.sh').to_s}
-Stop script: #{@tomcat_dir.join('bin').join('shutdown.sh').to_s}
-Logs: #{@tomcat_dir.join('logs').to_s}"
+Start script: #{@tomcat_dir.join('bin').join('startup.sh')}
+Stop script: #{@tomcat_dir.join('bin').join('shutdown.sh')}
+Logs: #{@tomcat_dir.join('logs')}"
     end
 
     private

data/lib/kpm/trace_logger.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module KPM
   class TraceLogger
     def initialize
-      @trace = Hash.new
+      @trace = {}
     end
 
     # Return JSON representation of the logs
-    def to_json
+    def to_json(*_args)
       @trace.to_json
     end
 
@@ -21,32 +23,32 @@ module KPM
       @trace
     end
 
-    def add(group=nil, key, message)
-      add_to_hash(group,key,message);
+    def add(group, key, message)
+      add_to_hash(group, key, message)
     end
 
     private
-    # This procedures will store the logs into a hash to be later returned
-    def add_to_hash(group=nil, key, message)
 
+    # This procedures will store the logs into a hash to be later returned
+    def add_to_hash(group, key, message)
       if group.nil? || key.nil?
         add_with_key(group || key, message)
       else
         container_key = group.to_sym
 
-        @trace[container_key] ||= Hash.new
+        @trace[container_key] ||= {}
         child_key = key.to_sym
 
-        unless @trace[container_key][child_key].nil?
-          child_is_an_array = @trace[container_key][child_key].kind_of?(Array)
+        if @trace[container_key][child_key].nil?
+          @trace[container_key][child_key] = message
+        else
+          child_is_an_array = @trace[container_key][child_key].is_a?(Array)
 
           old_message = nil
           old_message = @trace[container_key][child_key] unless child_is_an_array
           @trace[container_key][child_key] = [] unless child_is_an_array
           @trace[container_key][child_key].push(old_message) unless old_message.nil?
           @trace[container_key][child_key].push(message)
-        else
-          @trace[container_key][child_key] = message
         end
       end
     end
@@ -54,17 +56,17 @@ module KPM
     def add_with_key(key, message)
       child_key = key.to_sym
 
-      unless @trace[child_key].nil?
-        child_is_an_array = @trace[child_key].kind_of?(Array)
+      if @trace[child_key].nil?
+        @trace[child_key] = message
+      else
+        child_is_an_array = @trace[child_key].is_a?(Array)
 
         old_message = nil
         old_message = @trace[child_key] unless child_is_an_array
         @trace[child_key] = [] unless child_is_an_array
         @trace[child_key].push(old_message) unless old_message.nil?
         @trace[child_key].push(message)
-      else
-        @trace[child_key] = message
       end
     end
   end
-end
+end

data/lib/kpm/uninstaller.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
 module KPM
   class Uninstaller
     def initialize(destination, logger = nil)
@@ -7,21 +11,45 @@ module KPM
         @logger.level = Logger::INFO
       end
 
-      destination ||= KPM::BaseInstaller::DEFAULT_BUNDLES_DIR
-      @installed_plugins = Inspector.new.inspect(destination)
+      @destination = (destination || KPM::BaseInstaller::DEFAULT_BUNDLES_DIR)
+      refresh_installed_plugins
 
-      plugins_installation_path = File.join(destination, 'plugins')
+      plugins_installation_path = File.join(@destination, 'plugins')
       @plugins_manager = PluginsManager.new(plugins_installation_path, @logger)
 
-      sha1_file_path = File.join(destination, KPM::BaseInstaller::SHA1_FILENAME)
+      sha1_file_path = File.join(@destination, KPM::BaseInstaller::SHA1_FILENAME)
       @sha1checker = KPM::Sha1Checker.from_file(sha1_file_path, @logger)
     end
 
-    def uninstall_plugin(plugin, force = false)
+    def uninstall_plugin(plugin, force = false, version = nil)
       plugin_info = find_plugin(plugin)
       raise "No plugin with key/name '#{plugin}' found installed. Try running 'kpm inspect' for more info" unless plugin_info
 
-      remove_all_plugin_versions(plugin_info, force)
+      versions = version.nil? ? plugin_info[:versions].map { |artifact| artifact[:version] } : [version]
+      remove_plugin_versions(plugin_info, force, versions)
+    end
+
+    def uninstall_non_default_plugins(dry_run = false)
+      plugins = categorize_plugins
+
+      if plugins[:to_be_deleted].empty?
+        KPM.ui.say 'Nothing to do'
+        return false
+      end
+
+      if dry_run
+        msg = "The following plugin versions would be removed:\n"
+        msg += plugins[:to_be_deleted].map { |p| "  #{p[0][:plugin_name]}: #{p[1]}" }.join("\n")
+        msg += "\nThe following plugin versions would be kept:\n"
+        msg += plugins[:to_keep].map { |p| "  #{p[0][:plugin_name]}: #{p[1]}" }.join("\n")
+        KPM.ui.say msg
+        false
+      else
+        plugins[:to_be_deleted].each do |p|
+          remove_plugin_version(p[0], p[1])
+        end
+        true
+      end
     end
 
     private
@@ -40,23 +68,48 @@ module KPM
       plugin_info
     end
 
-    def remove_all_plugin_versions(plugin_info, force = false)
-      versions = plugin_info[:versions].map { |artifact| artifact[:version] }
+    def categorize_plugins
+      plugins = { to_be_deleted: [], to_keep: [] }
+      @installed_plugins.each do |_, info|
+        info[:versions].each do |artifact|
+          (artifact[:is_default] ? plugins[:to_keep] : plugins[:to_be_deleted]) << [info, artifact[:version]]
+        end
+      end
+      plugins
+    end
+
+    def remove_plugin_versions(plugin_info, force = false, versions = [])
       KPM.ui.say "Removing the following versions of the #{plugin_info[:plugin_name]} plugin: #{versions.join(', ')}"
       if !force && versions.length > 1
-        return false unless 'y' == KPM.ui.ask('Are you sure you want to continue?', limited_to: %w(y n))
+        return false unless KPM.ui.ask('Are you sure you want to continue?', limited_to: %w[y n]) == 'y'
       end
 
-      FileUtils.rmtree(plugin_info[:plugin_path])
-
-      @plugins_manager.remove_plugin_identifier_key(plugin_info[:plugin_key])
       versions.each do |version|
-        remove_sha1_entry(plugin_info, version)
+        remove_plugin_version(plugin_info, version)
       end
-
       true
     end
 
+    def remove_plugin_version(plugin_info, version)
+      # Be safe
+      raise ArgumentError, 'plugin_path is empty' if plugin_info[:plugin_path].empty?
+      raise ArgumentError, "version is empty (plugin_path=#{plugin_info[:plugin_path]})" if version.empty?
+
+      plugin_version_path = File.expand_path(File.join(plugin_info[:plugin_path], version))
+      safe_rmrf(plugin_version_path)
+
+      remove_sha1_entry(plugin_info, version)
+
+      # Remove the identifier if this was the last version installed
+      refresh_installed_plugins
+      if @installed_plugins[plugin_info[:plugin_name]][:versions].empty?
+        safe_rmrf(plugin_info[:plugin_path])
+        @plugins_manager.remove_plugin_identifier_key(plugin_info[:plugin_key])
+      end
+
+      refresh_installed_plugins
+    end
+
     def remove_sha1_entry(plugin_info, version)
       coordinates = KPM::Coordinates.build_coordinates(group_id: plugin_info[:group_id],
                                                        artifact_id: plugin_info[:artifact_id],
@@ -65,5 +118,19 @@ module KPM
                                                        version: version)
       @sha1checker.remove_entry!(coordinates)
     end
+
+    def refresh_installed_plugins
+      @installed_plugins = Inspector.new.inspect(@destination)
+    end
+
+    def safe_rmrf(dir)
+      validate_dir_for_rmrf(dir)
+      FileUtils.rmtree(dir)
+    end
+
+    def validate_dir_for_rmrf(dir)
+      raise ArgumentError, "Path #{dir} is not a valid directory" unless File.directory?(dir)
+      raise ArgumentError, "Path #{dir} is not a subdirectory of #{@destination}" unless Pathname.new(dir).fnmatch?(File.join(@destination, '**'))
+    end
   end
 end