kpm 0.0.15 → 0.1.0

data/lib/kpm/installer.rb

@@ -1,133 +1,99 @@
 require 'logger'
+require 'pathname'
 require 'yaml'
 
 module KPM
-  class Installer
-    LATEST_VERSION = 'LATEST'
-    SHA1_FILENAME = 'sha1.yml'
+  class Installer < BaseInstaller
 
-    def self.from_file(config_path, logger=nil)
-      Installer.new(YAML::load_file(config_path), logger)
+    def self.from_file(config_path=nil, logger=nil)
+      if config_path.nil?
+        # Install Kill Bill, Kaui and the KPM plugin by default
+        config = {'killbill' => {'version' => 'LATEST', 'plugins' => {'ruby' => [{'name' => 'kpm'}]}}, 'kaui' => {'version' => 'LATEST'}}
+      else
+        config = YAML::load_file(config_path)
+      end
+      Installer.new(config, logger)
     end
 
     def initialize(raw_config, logger=nil)
-
-      raise(ArgumentError, 'killbill or kaui section must be specified') if raw_config['killbill'].nil? and raw_config['kaui'].nil?
-      @config      = raw_config['killbill']
+      @config = raw_config['killbill']
       @kaui_config = raw_config['kaui']
 
       if logger.nil?
-        @logger       = Logger.new(STDOUT)
-        @logger.level = Logger::INFO
-      else
-        @logger = logger
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::INFO
       end
 
-      @nexus_config     = !@config.nil? ? @config['nexus'] : @kaui_config['nexus']
-      @nexus_ssl_verify = !@nexus_config.nil? ? @nexus_config['ssl_verify'] : true
+      nexus_config = !@config.nil? ? @config['nexus'] : (!@kaui_config.nil? ? @kaui_config['nexus'] : nil)
+      nexus_ssl_verify = !nexus_config.nil? ? nexus_config['ssl_verify'] : true
+
+      super(logger, nexus_config, nexus_ssl_verify)
     end
 
     def install(force_download=false, verify_sha1=true)
-      @force_download = force_download
-      @verify_sha1 = verify_sha1
-
+      help = nil
       unless @config.nil?
-        @bundles_dir = @config['plugins_dir']
-        @sha1_file = "#{@bundles_dir}/#{SHA1_FILENAME}"
-
-        install_killbill_server
-        install_plugins
-        install_default_bundles
+        help = install_tomcat if @config['webapp_path'].nil?
+        install_killbill_server(@config['group_id'], @config['artifact_id'], @config['packaging'], @config['classifier'], @config['version'], @config['webapp_path'], force_download, verify_sha1)
+        install_plugins(force_download, verify_sha1)
+        unless @config['default_bundles'] == false
+          install_default_bundles(@config['plugins_dir'], @config['default_bundles_version'], @config['version'], force_download, verify_sha1)
+        end
       end
+
       unless @kaui_config.nil?
-        install_kaui
+        if @kaui_config['webapp_path'].nil?
+          @logger.warn('No webapp_path specified for Kaui, aborting installation')
+          return
+        end
+
+        install_kaui(@kaui_config['group_id'], @kaui_config['artifact_id'], @kaui_config['packaging'], @kaui_config['classifier'], @kaui_config['version'], @kaui_config['webapp_path'], force_download, verify_sha1)
       end
+
+      help
     end
 
     private
 
-    def install_killbill_server
-      group_id    = @config['group_id'] || KPM::BaseArtifact::KILLBILL_GROUP_ID
-      artifact_id = @config['artifact_id'] || KPM::BaseArtifact::KILLBILL_ARTIFACT_ID
-      packaging   = @config['packaging'] || KPM::BaseArtifact::KILLBILL_PACKAGING
-      classifier  = @config['classifier'] || KPM::BaseArtifact::KILLBILL_CLASSIFIER
-      version     = @config['version'] || LATEST_VERSION
-      webapp_path = @config['webapp_path'] || KPM::root
+    def install_tomcat(dir=Dir.pwd)
+      # Download and unpack Tomcat
+      manager = KPM::TomcatManager.new(dir, @logger)
+      manager.download
+
+      # Update main config
+      root_war_path = manager.setup
+      @config['webapp_path'] = root_war_path
+      @kaui_config['webapp_path'] = Pathname.new(File.dirname(root_war_path)).join('kaui.war').to_s
 
-      KPM::KillbillServerArtifact.pull(@logger, group_id, artifact_id, packaging, classifier, version, webapp_path, nil, @force_download, @verify_sha1, @nexus_config, @nexus_ssl_verify)
+      # Help message
+      manager.help
     end
 
-    def install_plugins
-      install_java_plugins
-      install_ruby_plugins
+    def install_plugins(force_download, verify_sha1)
+      install_java_plugins(force_download, verify_sha1)
+      install_ruby_plugins(force_download, verify_sha1)
     end
 
-    def install_java_plugins
+    def install_java_plugins(force_download, verify_sha1)
       return if @config['plugins'].nil? or @config['plugins']['java'].nil?
 
       infos = []
       @config['plugins']['java'].each do |plugin|
-        group_id    = plugin['group_id'] || KPM::BaseArtifact::KILLBILL_JAVA_PLUGIN_GROUP_ID
-        artifact_id = plugin['artifact_id'] || plugin['name']
-        packaging   = plugin['packaging'] || KPM::BaseArtifact::KILLBILL_JAVA_PLUGIN_PACKAGING
-        classifier  = plugin['classifier'] || KPM::BaseArtifact::KILLBILL_JAVA_PLUGIN_CLASSIFIER
-        version     = plugin['version'] || LATEST_VERSION
-        destination = "#{@bundles_dir}/plugins/java/#{artifact_id}/#{version}"
-
-        infos << KPM::KillbillPluginArtifact.pull(@logger, group_id, artifact_id, packaging, classifier, version, destination, @sha1_file, @force_download, @verify_sha1, @nexus_config, @nexus_ssl_verify)
+        infos << install_plugin(plugin['group_id'], plugin['artifact_id'] || plugin['name'], plugin['packaging'], plugin['classifier'], plugin['version'], @config['plugins_dir'], 'java', force_download, verify_sha1)
       end
 
       infos
     end
 
-    def install_ruby_plugins
+    def install_ruby_plugins(force_download, verify_sha1)
       return if @config['plugins'].nil? or @config['plugins']['ruby'].nil?
 
       infos = []
       @config['plugins']['ruby'].each do |plugin|
-        group_id    = plugin['group_id'] || KPM::BaseArtifact::KILLBILL_RUBY_PLUGIN_GROUP_ID
-        artifact_id = plugin['artifact_id'] || plugin['name']
-        packaging   = plugin['packaging'] || KPM::BaseArtifact::KILLBILL_RUBY_PLUGIN_PACKAGING
-        classifier  = plugin['classifier'] || KPM::BaseArtifact::KILLBILL_RUBY_PLUGIN_CLASSIFIER
-        version     = plugin['version'] || LATEST_VERSION
-        destination = "#{@bundles_dir}/plugins/ruby"
-
-        infos << KPM::KillbillPluginArtifact.pull(@logger, group_id, artifact_id, packaging, classifier, version, destination, @sha1_file, @force_download, @verify_sha1, @nexus_config, @nexus_ssl_verify)
+        infos << install_plugin(plugin['group_id'], plugin['artifact_id'] || plugin['name'], plugin['packaging'], plugin['classifier'], plugin['version'], @config['plugins_dir'], 'ruby', force_download, verify_sha1)
       end
 
       infos
     end
-
-    def install_default_bundles
-      return if @config['default_bundles'] == false
-
-      group_id    = 'org.kill-bill.billing'
-      artifact_id = 'killbill-platform-osgi-bundles-defaultbundles'
-      packaging   = 'tar.gz'
-      classifier  = nil
-      version     = @config['default_bundles_version'] || LATEST_VERSION
-      destination = "#{@config['plugins_dir']}/platform"
-
-      info = KPM::BaseArtifact.pull(@logger, group_id, artifact_id, packaging, classifier, version, destination, @sha1_file, @force_download, @verify_sha1, @nexus_config, @nexus_ssl_verify)
-
-      # The special JRuby bundle needs to be called jruby.jar
-      # TODO .first - code smell
-      if  !info[:skipped]
-        File.rename Dir.glob("#{destination}/killbill-platform-osgi-bundles-jruby-*.jar").first, "#{destination}/jruby.jar"
-      end
-
-      info
-    end
-
-    def install_kaui
-      group_id    = @kaui_config['group_id'] || KPM::BaseArtifact::KAUI_GROUP_ID
-      artifact_id = @kaui_config['artifact_id'] || KPM::BaseArtifact::KAUI_ARTIFACT_ID
-      packaging   = @kaui_config['packaging'] || KPM::BaseArtifact::KAUI_PACKAGING
-      classifier  = @kaui_config['classifier'] || KPM::BaseArtifact::KAUI_CLASSIFIER
-      version     = @kaui_config['version'] || LATEST_VERSION
-      webapp_path = @kaui_config['webapp_path'] || KPM::root
-
-      KPM::KauiArtifact.pull(@logger, group_id, artifact_id, packaging, classifier, version, webapp_path, nil, @force_download, @verify_sha1, @nexus_config, @nexus_ssl_verify)
-    end
   end
 end

data/lib/kpm/killbill_server_artifact.rb

@@ -11,6 +11,57 @@ module KPM
         response.elements.each('search-results/data/artifact/version') { |element| versions << element.text }
         versions
       end
+
+      def info(version='LATEST', overrides={}, ssl_verify=true)
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::ERROR
+
+        versions = {}
+        Dir.mktmpdir do |dir|
+          # Retrieve the main Kill Bill pom
+          kb_pom_info = pull(logger,
+                             KPM::BaseArtifact::KILLBILL_GROUP_ID,
+                             'killbill',
+                             'pom',
+                             nil,
+                             version,
+                             dir,
+                             nil,
+                             false,
+                             true,
+                             overrides,
+                             ssl_verify)
+
+          # Extract the killbill-oss-parent version
+          pom = REXML::Document.new(File.new(kb_pom_info[:file_path]))
+          oss_parent_version = pom.root.elements['parent/version'].text
+          kb_version = pom.root.elements['version'].text
+
+          versions['killbill'] = kb_version
+          versions['killbill-oss-parent'] = oss_parent_version
+
+          # Retrieve the killbill-oss-parent pom
+          oss_pom_info = pull(logger,
+                              KPM::BaseArtifact::KILLBILL_GROUP_ID,
+                              'killbill-oss-parent',
+                              'pom',
+                              nil,
+                              oss_parent_version,
+                              dir,
+                              nil,
+                              false,
+                              true,
+                              overrides,
+                              ssl_verify)
+
+          pom = REXML::Document.new(File.new(oss_pom_info[:file_path]))
+          properties_element = pom.root.elements['properties']
+          %w(killbill-api killbill-plugin-api killbill-commons killbill-platform).each do |property|
+            versions[property] = properties_element.elements["#{property}.version"].text
+          end
+        end
+        versions
+      end
     end
   end
 end

data/lib/kpm/plugins_directory.rb

@@ -14,20 +14,34 @@ module KPM
       end
     end
 
-    def self.lookup(plugin_name, latest=false)
-      plugin = all(latest)[plugin_name.to_s.downcase.to_sym]
+    # Note: this API is used in Docker images (see kpm_generator.rb, careful when changing it!)
+    def self.lookup(raw_plugin_name, latest=false, raw_kb_version=nil)
+      plugin_name = raw_plugin_name.to_s.downcase
+      plugin = all(latest)[plugin_name.to_sym]
       return nil if plugin.nil?
 
       type = plugin[:type]
       is_ruby = type == :ruby
 
       group_id    = plugin[:group_id] || (is_ruby ? KPM::BaseArtifact::KILLBILL_RUBY_PLUGIN_GROUP_ID : KPM::BaseArtifact::KILLBILL_JAVA_PLUGIN_GROUP_ID)
-      artifact_id = plugin[:artifact_id] || "#{plugin.to_s}-plugin"
+      artifact_id = plugin[:artifact_id] || "#{plugin_name}-plugin"
       packaging   = plugin[:packaging] || (is_ruby ? KPM::BaseArtifact::KILLBILL_RUBY_PLUGIN_PACKAGING : KPM::BaseArtifact::KILLBILL_JAVA_PLUGIN_PACKAGING)
       classifier  = plugin[:classifier] || (is_ruby ? KPM::BaseArtifact::KILLBILL_RUBY_PLUGIN_CLASSIFIER : KPM::BaseArtifact::KILLBILL_JAVA_PLUGIN_CLASSIFIER)
-      version     = plugin[:stable_version] || 'LATEST'
+
+      if raw_kb_version == 'LATEST'
+        version = 'LATEST'
+      else
+        # Keep supporting the deprecated key :stable_version for now
+        captures = raw_kb_version.nil? ? [] : raw_kb_version.scan(/(\d+\.\d+)(\.\d)?/)
+        if captures.empty? || captures.first.nil? || captures.first.first.nil?
+          version = plugin[:stable_version] || 'LATEST'
+        else
+          kb_version = captures.first.first
+          version = (plugin[:versions] || {})[kb_version.to_sym] || 'LATEST'
+        end
+      end
 
       [group_id, artifact_id, packaging, classifier, version, type]
     end
   end
-end
+end

data/lib/kpm/plugins_directory.yml

@@ -1,42 +1,146 @@
 ---
+:accertify:
+  :type: :java
+  :versions:
+    :0.14: 0.1.0
+  :require:
+    - :org.killbill.billing.plugin.accertify.url
+    - :org.killbill.billing.plugin.accertify.username
+    - :org.killbill.billing.plugin.accertify.password
+:adyen:
+  :type: :java
+  :versions:
+    :0.14: 0.1.0
+    :0.15: 0.2.1
+  :require:
+    - :org.killbill.billing.plugin.adyen.merchantAccount
+    - :org.killbill.billing.plugin.adyen.username
+    - :org.killbill.billing.plugin.adyen.password
+    - :org.killbill.billing.plugin.adyen.paymentUrl
+:analytics:
+  :type: :java
+  :versions:
+    :0.14: 1.0.3
+    :0.15: 2.0.1
+  :stable_version: 2.0.2
+:avatax:
+  :type: :java
+  :versions:
+    :0.14: 0.1.0
+    :0.15: 0.2.0
+  :stable_version: 0.2.0
+  :require:
+    - :org.killbill.billing.plugin.avatax.url
+    - :org.killbill.billing.plugin.avatax.accountNumber
+    - :org.killbill.billing.plugin.avatax.licenseKey
 :bitpay:
   :type: :ruby
-  :artifact_id: bitpay-plugin
+  :versions:
+    :0.14: 0.0.1
   :stable_version: 0.0.1
+  :require:
+    - :api_key
+:braintree_blue:
+  :type: :ruby
+  :versions:
+    :0.14: 0.0.1
+  :stable_version: 0.1.0
+  :require:
+    - :merchant_id
+    - :public_key
+    - :private_key
 :coinbase:
   :type: :ruby
-  :artifact_id: coinbase-plugin
+  :versions:
   :stable_version: 0.0.1
+  :require:
+    - :btc_address
+    - :api_key
+:currency:
+  :type: :ruby
+  :artifact_id: killbill-currency-plugin
+  :versions:
 :cybersource:
   :type: :ruby
-  :artifact_id: cybersource-plugin
+  :versions:
+    :0.14: 1.0.0
+    :0.15: 3.0.0
   :stable_version: 0.0.4
   :require:
-  - :login
-  - :password
+    - :login
+    - :password
+:email-notifications:
+  :type: :java
+  :artifact_id: killbill-email-notifications-plugin
+  :versions:
+    :0.14: 0.1.0
+  :stable_version: 0.1.0
+:forte:
+  :type: :java
+  :versions:
+    :0.14: 0.1.0
+  :require:
+    - :org.killbill.billing.plugin.forte.merchantId
+    - :org.killbill.billing.plugin.forte.password
+    - :org.killbill.billing.plugin.forte.host
+    - :org.killbill.billing.plugin.forte.port
+    - :org.killbill.billing.plugin.forte.apiLoginId
+    - :org.killbill.billing.plugin.forte.secureTransactionKey
+:kpm:
+  :type: :ruby
+  :versions:
+    :0.15: 0.0.1
 :litle:
   :type: :ruby
-  :artifact_id: litle-plugin
+  :versions:
+    :0.14: 2.0.0
   :stable_version: 1.10.0
+  :require:
+    - :account_id
+    - :merchant_id
+    - :username
+    - :password
+    - :secure_page_url
+    - :paypage_id
+:logging:
+  :type: :ruby
+  :versions:
+    :0.14: 1.7.0
+    :0.15: 2.0.0
 :paypal:
   :type: :ruby
   :artifact_id: paypal-express-plugin
-  :stable_version: 1.8.1
+  :versions:
+    :0.14: 2.0.0
+    :0.15: 3.0.0
+  :stable_version: 2.0.0
   :require:
   - :signature
   - :login
   - :password
+:payu_latam:
+  :type: :ruby
+  :artifact_id: payu-latam-plugin
+  :versions:
+    :0.14: 0.1.0
+  :require:
+  - :api_login
+  - :api_key
+  - :country_account_id
+  - :merchant_id
 :stripe:
   :type: :ruby
-  :artifact_id: stripe-plugin
-  :stable_version: 0.2.1
+  :versions:
+    :0.14: 1.0.0
+    :0.15: 2.0.0
+  :stable_version: 2.0.0
   :require:
   - :api_secret_key
-:braintree_blue:
+:zendesk:
   :type: :ruby
-  :artifact_id: braintree_blue-plugin
-  :stable_version: 0.0.1
+  :versions:
+    :0.14: 1.3.0
   :require:
-  - :merchant_id
-  - :public_key
-  - :private_key
+  - :subdomain
+  - :username
+  - :password

data/lib/kpm/plugins_manager.rb

@@ -0,0 +1,110 @@
+require 'pathname'
+
+module KPM
+  class PluginsManager
+
+    def initialize(plugins_dir, logger)
+      @plugins_dir = Pathname.new(plugins_dir)
+      @logger = logger
+    end
+
+    def set_active(plugin_name_or_path, plugin_version=nil)
+      if plugin_name_or_path.nil?
+        @logger.warn('Unable to mark a plugin as active: no name or path specified')
+        return
+      end
+
+      if plugin_version.nil?
+        # Full path specified, with version
+        link = Pathname.new(plugin_name_or_path).join('../ACTIVE')
+        FileUtils.rm_f(link)
+        FileUtils.ln_s(plugin_name_or_path, link, :force => true)
+      else
+        # Plugin name (fs directory) specified
+        plugin_dir_glob = @plugins_dir.join('*').join(plugin_name_or_path)
+        # Only one should match (java or ruby plugin)
+        Dir.glob(plugin_dir_glob).each do |plugin_dir_path|
+          plugin_dir = Pathname.new(plugin_dir_path)
+          link = plugin_dir.join('ACTIVE')
+          FileUtils.rm_f(link)
+          FileUtils.ln_s(plugin_dir.join(plugin_version), link, :force => true)
+        end
+      end
+
+      update_fs(plugin_name_or_path, plugin_version) do |tmp_dir|
+        FileUtils.rm_f(tmp_dir.join('stop.txt'))
+        FileUtils.rm_f(tmp_dir.join('restart.txt'))
+      end
+    end
+
+    def uninstall(plugin_name_or_path, plugin_version=nil)
+      update_fs(plugin_name_or_path, plugin_version) do |tmp_dir|
+        FileUtils.rm_f(tmp_dir.join('restart.txt'))
+        # Be safe, keep the code, just never start it
+        FileUtils.touch(tmp_dir.join('stop.txt'))
+      end
+    end
+
+    def restart(plugin_name_or_path, plugin_version=nil)
+      update_fs(plugin_name_or_path, plugin_version) do |tmp_dir|
+        # Remove stop.txt so that the plugin is started if it was stopped
+        FileUtils.rm_f(tmp_dir.join('stop.txt'))
+        FileUtils.touch(tmp_dir.join('restart.txt'))
+      end
+    end
+
+    def guess_plugin_name(artifact_id)
+      return nil if artifact_id.nil?
+      captures = artifact_id.scan(/(.*)-plugin/)
+      if captures.empty? || captures.first.nil? || captures.first.first.nil?
+        short_name = artifact_id
+      else
+        # 'analytics-plugin' or 'stripe-plugin' passed
+        short_name = captures.first.first
+      end
+      Dir.glob(@plugins_dir.join('*').join('*')).each do |plugin_path|
+        plugin_name = File.basename(plugin_path)
+        if plugin_name == short_name ||
+            plugin_name == artifact_id ||
+            !plugin_name.scan(/-#{short_name}/).empty? ||
+            !plugin_name.scan(/#{short_name}-/).empty?
+          return plugin_name
+        end
+      end
+      nil
+    end
+
+    private
+
+    # Note: the plugin name here is the directory name on the filesystem
+    def update_fs(plugin_name_or_path, plugin_version=nil, &block)
+      if plugin_name_or_path.nil?
+        @logger.warn('Unable to update the filesystem: no name or path specified')
+        return
+      end
+
+      p = plugin_version.nil? ? plugin_name_or_path : @plugins_dir.join('*').join(plugin_name_or_path).join(plugin_version == :all ? '*' : plugin_version)
+
+      modified = []
+      Dir.glob(p).each do |plugin_dir_path|
+        plugin_dir = Pathname.new(plugin_dir_path)
+        tmp_dir = plugin_dir.join('tmp')
+        FileUtils.mkdir_p(tmp_dir)
+
+        yield(tmp_dir) if block_given?
+
+        modified << plugin_dir
+      end
+
+      if modified.empty?
+        if plugin_version.nil?
+          @logger.warn("No plugin found with name #{plugin_name_or_path}. Installed plugins: #{Dir.glob(@plugins_dir.join('*').join('*'))}")
+        else
+          @logger.warn("No plugin found with name #{plugin_name_or_path} and version #{plugin_version}. Installed plugins: #{Dir.glob(@plugins_dir.join('*').join('*').join('*'))}")
+        end
+      end
+
+      modified
+    end
+  end
+end