kpm 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d42c3f647760630bf77cd1b747651801726d523
-  data.tar.gz: b8bb3427daf343b4b58da5381241bfddda7c038f
+  metadata.gz: 1a60374d9426b71862a9dc7deba1f6b196af27ea
+  data.tar.gz: 3e72b27242ce530e18eea45961f361ec70e73b0f
 SHA512:
-  metadata.gz: 321702e297c7ef18cb523e474e59ba12780d289b336cc541f58964e95fd72b5cb841b66826528b4cbac424cb7c858f307377e4c71fd7ac3d663b4947b7d71417
-  data.tar.gz: 6c60dceeba121d962c8d71e953ece53f427638be7531f9351174cba8e3824008cf7aedae34eacf0c044c49f1e118ce33071f6696c1151c8382564b69e2c2ddbb
+  metadata.gz: 07dd7d2ad53197d3cca095c6c7a4cdc92e14bd7182d0da960611f43b229539b06723a46534b14fd660d8ef1cb9a476a9c4f24c4f54c1a9241bfca29d64d43e9b
+  data.tar.gz: 9223ffad42ddadc56feb517b085ff9f1454bf57c12e56e2dd2bc4f43cb64ebc9ebb835f30f37f2ca5c9f950e961c09d0fc0cb199970b5ecd245517ec86083097

data/kpm.gemspec

@@ -40,7 +40,6 @@ Gem::Specification.new do |s|
   s.rdoc_options << '--exclude' << '.'
 
   s.add_dependency 'highline', '~> 1.6.21'
-  s.add_dependency 'nexus_cli', '~> 4.1.0'
   s.add_dependency 'thor', '~> 0.19.1'
   s.add_dependency 'rubyzip', '~>1.2.0'
   s.add_dependency 'killbill-client', '~> 1.0'

data/lib/kpm.rb

@@ -20,7 +20,10 @@ module KPM
   autoload :System, 'kpm/system'
   autoload :Account, 'kpm/account'
   autoload :Database, 'kpm/database'
-  autoload :TenantConfig, 'kpm/tenant_config.rb'
+  autoload :TenantConfig, 'kpm/tenant_config'
+  autoload :DiagnosticFile, 'kpm/diagnostic_file'
+  autoload :NexusFacade, 'kpm/nexus_helper/nexus_facade'
+  autoload :TraceLogger, 'kpm/trace_logger'
 
   class << self
     def root

data/lib/kpm/base_artifact.rb

@@ -1,5 +1,4 @@
 require 'digest/sha1'
-require 'nexus_cli'
 require 'rexml/document'
 
 module KPM
@@ -44,8 +43,8 @@ module KPM
         pull_from_fs_and_put_in_place(logger, file_path, destination_path)
       end
 
-      def nexus_remote(overrides={}, ssl_verify=true)
-        nexus_remote ||= NexusCli::RemoteFactory.create(nexus_defaults.merge(overrides || {}), ssl_verify)
+      def nexus_remote(overrides={}, ssl_verify=true, logger=nil)
+        nexus_remote ||= KPM::NexusFacade::RemoteFactory.create(nexus_defaults.merge(overrides || {}), ssl_verify, logger)
       end
 
       def nexus_defaults
@@ -102,6 +101,7 @@ module KPM
           logger.info "      Starting download of #{coordinates} to #{tmp_destination_dir}"
 
           downloaded_artifact_info = pull_and_verify(logger, artifact_info[:sha1], coordinates, tmp_destination_dir, sha1_file, verify_sha1, overrides, ssl_verify)
+          remove_old_default_bundles(coordinate_map,artifact_info,downloaded_artifact_info)
           if artifact_info[:is_tgz]
             artifact_info[:bundle_dir] = Utils.unpack_tgz(downloaded_artifact_info[:file_path], artifact_info[:dir_name], skip_top_dir)
             FileUtils.rm downloaded_artifact_info[:file_path]
@@ -172,10 +172,10 @@ module KPM
 
         coordinates = KPM::Coordinates.build_coordinates(coordinate_map)
         begin
-          nexus_info = nexus_remote(overrides, ssl_verify).get_artifact_info(coordinates)
-        rescue NexusCli::ArtifactMalformedException => e
-          raise NexusCli::NexusCliError.new("Invalid coordinates #{coordinate_map}")
-        rescue NexusCli::NexusCliError => e
+          nexus_info = nexus_remote(overrides, ssl_verify, logger).get_artifact_info(coordinates)
+        rescue KPM::NexusFacade::ArtifactMalformedException => e
+          raise StandardError.new("Invalid coordinates #{coordinate_map}")
+        rescue StandardError => e
           logger.warn("Unable to retrieve coordinates #{coordinate_map}")
           raise e
         end
@@ -219,7 +219,7 @@ module KPM
       end
 
       def pull_and_verify(logger, remote_sha1, coordinates, destination_dir, sha1_file, verify_sha1, overrides={}, ssl_verify=true)
-        info = nexus_remote(overrides, ssl_verify).pull_artifact(coordinates, destination_dir)
+        info = nexus_remote(overrides, ssl_verify, logger).pull_artifact(coordinates, destination_dir)
 
         # Always verify sha1 and if incorrect either throw or log when we are asked to bypass sha1 verification
         verified = verify(logger, coordinates, info[:file_path], remote_sha1)
@@ -274,6 +274,22 @@ module KPM
         # Probably a directory
         true
       end
+
+      def remove_old_default_bundles(coordinate_map, artifact_info, downloaded_artifact_info)
+        return unless coordinate_map[:artifact_id] == 'killbill-platform-osgi-bundles-defaultbundles'
+
+        downloaded_default_bundles = Utils.peek_tgz_file_names(downloaded_artifact_info[:file_path])
+        existing_default_bundles = Dir.glob("#{artifact_info[:dir_name]}/*")
+
+        existing_default_bundles.each do |bundle|
+          bundle_name = Utils.get_plugin_name_from_file_path(bundle)
+          is_downloaded = downloaded_default_bundles.index {|file_name| file_name.include? bundle_name}
+          unless is_downloaded.nil?
+            FileUtils.remove(bundle)
+          end
+        end
+
+      end
     end
   end
 end

data/lib/kpm/base_installer.rb

@@ -12,6 +12,7 @@ module KPM
       @logger = logger
       @nexus_config = nexus_config
       @nexus_ssl_verify = nexus_ssl_verify
+      @trace_logger = KPM::TraceLogger.new
     end
 
     def install_killbill_server(specified_group_id=nil, specified_artifact_id=nil, specified_packaging=nil, specified_classifier=nil, specified_version=nil, specified_webapp_path=nil,  bundles_dir=nil, force_download=false, verify_sha1=true)
@@ -24,8 +25,13 @@ module KPM
       bundles_dir = Pathname.new(bundles_dir || DEFAULT_BUNDLES_DIR).expand_path
       sha1_file = "#{bundles_dir}/#{SHA1_FILENAME}"
 
+      if version == LATEST_VERSION
+        latest_stable_version = KPM::Installer.get_kb_latest_stable_version
+        version = latest_stable_version unless latest_stable_version.nil?
+      end
+
       @logger.debug("Installing Kill Bill server: group_id=#{group_id} artifact_id=#{artifact_id} packaging=#{packaging} classifier=#{classifier} version=#{version} webapp_path=#{webapp_path}")
-      KPM::KillbillServerArtifact.pull(@logger,
+      artifact_info = KPM::KillbillServerArtifact.pull(@logger,
                                        group_id,
                                        artifact_id,
                                        packaging,
@@ -37,6 +43,10 @@ module KPM
                                        verify_sha1,
                                        @nexus_config,
                                        @nexus_ssl_verify)
+      # store trace info to be returned as JSON by the KPM::Installer.install method
+      @trace_logger.add('killbill',
+                           artifact_info.merge({'status'=> (artifact_info[:skipped] ? 'UP_TO_DATE': 'INSTALLED'),
+                            :group_id => group_id, :artifact_id => artifact_id, :packaging => packaging, :classifier => classifier}))
     end
 
     def install_kaui(specified_group_id=nil, specified_artifact_id=nil, specified_packaging=nil, specified_classifier=nil, specified_version=nil, specified_webapp_path=nil,  bundles_dir=nil, force_download=false, verify_sha1=true)
@@ -50,7 +60,7 @@ module KPM
       sha1_file = "#{bundles_dir}/#{SHA1_FILENAME}"
 
       @logger.debug("Installing Kaui: group_id=#{group_id} artifact_id=#{artifact_id} packaging=#{packaging} classifier=#{classifier} version=#{version} webapp_path=#{webapp_path}")
-      KPM::KauiArtifact.pull(@logger,
+      artifact_info = KPM::KauiArtifact.pull(@logger,
                              group_id,
                              artifact_id,
                              packaging,
@@ -62,6 +72,12 @@ module KPM
                              verify_sha1,
                              @nexus_config,
                              @nexus_ssl_verify)
+      # store trace info to be returned as JSON by the KPM::Installer.install method
+      @trace_logger.add('kaui',
+                           artifact_info.merge({'status'=> (artifact_info[:skipped] ? 'UP_TO_DATE': 'INSTALLED'),
+                            :group_id => group_id, :artifact_id => artifact_id, :packaging => packaging, :classifier => classifier}))
+
+
     end
 
     def install_plugin(plugin_key, raw_kb_version=nil, specified_group_id=nil, specified_artifact_id=nil, specified_packaging=nil, specified_classifier=nil, specified_version=nil, bundles_dir=nil, specified_type=nil, force_download=false, verify_sha1=true, verify_jruby_jar=false)
@@ -138,6 +154,10 @@ module KPM
                                                        verify_sha1,
                                                        @nexus_config,
                                                        @nexus_ssl_verify)
+      # store trace info to be returned as JSON by the KPM::Installer.install method
+      @trace_logger.add('plugins', plugin_key,
+                           artifact_info.merge({'status'=> (artifact_info[:skipped] ? 'UP_TO_DATE': 'INSTALLED'),
+                            :group_id => group_id, :artifact_id => artifact_id, :packaging => packaging, :classifier => classifier}))
 
       # Update with resolved version
       coordinate_map[:version] = artifact_info[:version]
@@ -154,8 +174,12 @@ module KPM
       bundles_dir = Pathname.new(bundles_dir || DEFAULT_BUNDLES_DIR).expand_path
       plugins_dir = bundles_dir.join('plugins')
 
+      if version.nil?
+        version = Utils.get_version_from_file_path(file_path)
+      end
+
       if type.to_s == 'java'
-        plugin_name = name.nil? ? Pathname.new(file_path).basename.to_s.split('-')[0] : name
+        plugin_name = name.nil? ? Utils.get_plugin_name_from_file_path(file_path) : name
         destination = plugins_dir.join('java').join(plugin_name).join(version)
       else
         destination = plugins_dir.join('ruby')
@@ -168,6 +192,10 @@ module KPM
 
       update_plugin_identifier(plugins_dir, plugin_key, type.to_s, nil, artifact_info)
 
+      # store trace info to be returned as JSON by the KPM::Installer.install method
+      @trace_logger.add('plugins', plugin_key,
+                           artifact_info.merge({'status'=>'INSTALLED'}))
+
       artifact_info
     end
 
@@ -218,6 +246,10 @@ module KPM
                                     @nexus_config,
                                     @nexus_ssl_verify)
 
+      @trace_logger.add('default_bundles',
+                        info.merge({'status'=> (info[:skipped] ? 'UP_TO_DATE': 'INSTALLED'),
+                         :group_id => group_id, :artifact_id => artifact_id, :packaging => packaging, :classifier => classifier}))
+
       # The special JRuby bundle needs to be called jruby.jar
       # TODO .first - code smell
       unless info[:skipped]

data/lib/kpm/diagnostic_file.rb

@@ -0,0 +1,187 @@
+require 'yaml'
+require 'tmpdir'
+require 'zip'
+require 'json'
+require 'fileutils'
+require 'date'
+
+
+module KPM
+
+    class DiagnosticFile
+
+      # Temporary directory
+      TMP_DIR_PREFIX  = 'killbill-diagnostics-'
+      TMP_DIR         = Dir.mktmpdir(TMP_DIR_PREFIX)
+      TMP_LOGS_DIR    = TMP_DIR + File::Separator + 'logs'
+
+      TENANT_FILE     = 'tenant_config.data'
+      SYSTEM_FILE     = 'system_configuration.data'
+      ACCOUNT_FILE    = 'account.data'
+
+      TODAY_DATE      = Date.today.strftime('%m-%d-%y')
+      ZIP_FILE        = 'killbill-diagnostics-' + TODAY_DATE + '.zip'
+      ZIP_LOG_FILE    = 'logs.zip'
+
+      def initialize(config_file = nil, killbill_api_credentials = nil, killbill_credentials = nil, killbill_url = nil,
+                     database_name = nil, database_credentials = nil, database_host = nil, kaui_web_path = nil,
+                     killbill_web_path = nil, logger = nil)
+        @killbill_api_credentials = killbill_api_credentials
+        @killbill_credentials = killbill_credentials
+        @killbill_url = killbill_url
+        @database_name = database_name
+        @database_credentials = database_credentials
+        @database_host = database_host
+        @config_file = config_file
+        @kaui_web_path = kaui_web_path;
+        @killbill_web_path = killbill_web_path;
+        @logger = logger
+        @original_logger_level = logger.level;
+        @catalina_base = nil
+      end
+
+      def export_data(account_id = nil, log_dir = nil)
+        set_config(@config_file)
+
+        tenant_export_file  = get_tenant_config
+        system_export_file  = get_system_config
+        account_export_file = get_account_data(account_id) unless account_id.nil?
+        log_files           = get_log_files(log_dir)
+
+        if File.exist?(system_export_file) && File.exist?(tenant_export_file)
+
+
+          zip_file_name = TMP_DIR + File::Separator + ZIP_FILE
+
+          Zip::File.open(zip_file_name, Zip::File::CREATE) do |zipFile|
+
+            zipFile.add(TENANT_FILE,  tenant_export_file)
+            zipFile.add(SYSTEM_FILE,  system_export_file)
+            zipFile.add(ACCOUNT_FILE, account_export_file) unless account_id.nil?
+            zipFile.add(ZIP_LOG_FILE, log_files)
+
+          end
+
+          @logger.info "\e[32mDiagnostic data exported under #{zip_file_name} \e[0m"
+
+        else
+          raise Interrupt, 'Account id or configuration file not found'
+        end
+
+      end
+
+      # Private methods
+
+      private
+
+      def get_tenant_config
+
+        @logger.info 'Retrieving tenant configuration'
+        # this suppress the message of where it put the account file, this is to avoid confusion
+        @logger.level = Logger::WARN
+
+        @killbill_api_credentials ||= [get_config('killbill', 'api_key'), get_config('killbill','api_secret')] unless @config_file.nil?
+        @killbill_credentials ||= [get_config('killbill', 'user'), get_config('killbill','password')] unless @config_file.nil?
+        @killbill_url ||= 'http://' + get_config('killbill', 'host').to_s + ':' + get_config('killbill','port').to_s unless @config_file.nil?
+
+        tenant_config = KPM::TenantConfig.new(@killbill_api_credentials,
+                                              @killbill_credentials, @killbill_url, @logger)
+        export_file = tenant_config.export
+
+        final = TMP_DIR + File::Separator + TENANT_FILE
+        FileUtils.move(export_file, final)
+        @logger.level = @original_logger_level
+
+        final
+      end
+
+      def get_system_config
+
+        @logger.info 'Retrieving system configuration'
+        system = KPM::System.new
+        export_data = system.information(nil, true, @config_file, @kaui_web_path, @killbill_web_path)
+
+        get_system_catalina_base(export_data)
+
+        export_file = TMP_DIR + File::SEPARATOR + SYSTEM_FILE
+        File.open(export_file, 'w') { |io| io.puts export_data }
+        export_file
+      end
+
+
+      def get_account_data(account_id)
+
+        @logger.info 'Retrieving account data for id: ' + account_id
+        # this suppress the message of where it put the account file, this is to avoid confusion
+        @logger.level = Logger::WARN
+
+        account = KPM::Account.new(@config_file, @killbill_api_credentials, @killbill_credentials,
+                                   @killbill_url, @database_name,
+                                   @database_credentials,@database_host,nil, @logger)
+        export_file = account.export_data(account_id)
+
+        final  = TMP_DIR + File::Separator + ACCOUNT_FILE
+        FileUtils.move(export_file, final)
+        @logger.level = @original_logger_level
+        final
+      end
+
+      def get_log_files(log_dir)
+
+        @logger.info 'Collecting log files'
+        log_base = log_dir || (@catalina_base + File::Separator + 'logs')
+        log_items = Dir.glob(log_base + File::Separator + '*')
+
+        zip_file_name = TMP_DIR + File::Separator + ZIP_LOG_FILE
+
+        Zip::File.open(zip_file_name, Zip::File::CREATE) do |zipFile|
+
+          log_items.each do |file|
+            name = file.split('/').last
+            zipFile.add(name, file)
+          end
+
+        end
+
+        zip_file_name
+      end
+
+      # Helpers
+
+      def get_system_catalina_base(export_data)
+        system_json = JSON.parse(export_data)
+        @catalina_base = system_json['java_system_information']['catalina.base']['value']
+
+      end
+
+      # Utils
+
+      def get_config(parent, child)
+        item = nil;
+
+        if not @config.nil?
+
+          config_parent = @config[parent]
+
+          if not config_parent.nil?
+            item =config_parent[child]
+          end
+
+        end
+
+        item
+      end
+
+      def set_config(config_file = nil)
+        @config = nil
+
+        if not config_file.nil?
+          if not Dir[config_file][0].nil?
+            @config = YAML::load_file(config_file)
+          end
+        end
+
+      end
+
+    end
+end

data/lib/kpm/installer.rb

@@ -16,6 +16,13 @@ module KPM
     end
 
     def self.build_default_config(all_kb_versions=nil)
+      latest_stable_version = get_kb_latest_stable_version(all_kb_versions)
+
+      # Note: we assume no unstable version of Kaui is published today
+      {'killbill' => {'version' => latest_stable_version.to_s, 'plugins' => {'ruby' => [{'name' => 'kpm'}]}}, 'kaui' => {'version' => 'LATEST'}}
+    end
+
+    def self.get_kb_latest_stable_version(all_kb_versions=nil)
       all_kb_versions ||= KillbillServerArtifact.versions(KillbillServerArtifact::KILLBILL_ARTIFACT_ID,
                                                           KillbillServerArtifact::KILLBILL_PACKAGING,
                                                           KillbillServerArtifact::KILLBILL_CLASSIFIER,
@@ -32,8 +39,7 @@ module KPM
         latest_stable_version = version if version > latest_stable_version
       end
 
-      # Note: we assume no unstable version of Kaui is published today
-      {'killbill' => {'version' => latest_stable_version.to_s, 'plugins' => {'ruby' => [{'name' => 'kpm'}]}}, 'kaui' => {'version' => 'LATEST'}}
+      latest_stable_version
     end
 
     def initialize(raw_config, logger=nil)
@@ -75,7 +81,8 @@ module KPM
         install_kaui(@kaui_config['group_id'], @kaui_config['artifact_id'], @kaui_config['packaging'], @kaui_config['classifier'], @kaui_config['version'], @kaui_config['webapp_path'], bundles_dir, force_download, verify_sha1)
       end
 
-      help
+      @trace_logger.add('help',help)
+      @trace_logger.to_json
     end
 
     private

data/lib/kpm/kaui_artifact.rb

@@ -11,7 +11,7 @@ module KPM
         coordinates = KPM::Coordinates.build_coordinates(coordinate_map)
         response    = REXML::Document.new nexus_remote(overrides, ssl_verify).search_for_artifacts(coordinates)
         versions    = SortedSet.new
-        response.elements.each('search-results/data/artifact/version') { |element| versions << element.text }
+        response.elements.each('searchNGResponse/data/artifact/version') { |element| versions << element.text }
         versions
       end
     end

data/lib/kpm/killbill_plugin_artifact.rb

@@ -16,7 +16,7 @@ module KPM
 
         [[:java, KPM::BaseArtifact::KILLBILL_JAVA_PLUGIN_GROUP_ID], [:ruby, KPM::BaseArtifact::KILLBILL_RUBY_PLUGIN_GROUP_ID]].each do |type_and_group_id|
           response = REXML::Document.new nexus.search_for_artifacts(type_and_group_id[1])
-          response.elements.each('search-results/data/artifact') do |element|
+          response.elements.each('searchNGResponse/data/artifact') do |element|
             artifact_id                                = element.elements['artifactId'].text
             plugins[type_and_group_id[0]][artifact_id] ||= SortedSet.new
             plugins[type_and_group_id[0]][artifact_id] << element.elements['version'].text

data/lib/kpm/killbill_server_artifact.rb

@@ -9,7 +9,7 @@ module KPM
         coordinates = KPM::Coordinates.build_coordinates(coordinate_map)
         response    = REXML::Document.new nexus_remote(overrides, ssl_verify).search_for_artifacts(coordinates)
         versions    = SortedSet.new
-        response.elements.each('search-results/data/artifact/version') { |element| versions << element.text }
+        response.elements.each('searchNGResponse/data/artifact/version') { |element| versions << element.text }
         versions
       end