kpm 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0168b3fb22a6c364cce6ce9e235a0025627da27
-  data.tar.gz: 48cf7c666cb75d59208598a99b955c52eeb9800e
+  metadata.gz: 7d305f7283e154bd4021da4ed116009e87a2b126
+  data.tar.gz: bf57217f06ec10a49ceb65cf496853dbe92a23cb
 SHA512:
-  metadata.gz: 52f9ff4a9a13d224c448da33c5ad909bcf6d25edd393aca71551dae61832b539dfa5d050f15b8f4807c956145a26cfbba2a8c62ab9590f4044d990cecd9c9573
-  data.tar.gz: d1706d3f53df62ec452bf7791317525406b8409341474c5334ca24c070e4e30cabe453af216cd90a0687e7e22af312e66204eba6aa8bae601b3096ab2ee13898
+  metadata.gz: d4c8a285f34065509b140cacdef262f2cfd7abe37778dc3176ae550c3fcc0c900c9e91cf53ee023f2b0e354b7b60e431bac32cf720e44563d46edda4bf4b6e18
+  data.tar.gz: 6a93e71899e8a8b94b9357e6aaa6af1d996e78dd4751aa0bba2cada0e93dd165bb5ffd689097c7e6865f40cfda668c873b503176658d72c7996a04d403a7a9b2

data/README.md

@@ -1,19 +1,16 @@
-KPM: the Kill Bill Package Manager
-==================================
+# KPM: the Kill Bill Package Manager
 
 The goal of KPM is to facilitate the installation of Kill Bill and its plugins.
 
 kpm can be used interactively to search and download individual artifacts (Kill Bill war, plugins, etc.) or to perform an automatic Kill Bill installation using a configuration file.
 
-Installation
-------------
+## Installation
 
     gem install kpm
 
 Ruby 2.1+ or JRuby 1.7.11+ is recommended.
 
-Quick start
------------
+## Quick start
 
 Create a kpm.yml file as follows:
 
@@ -47,4 +44,23 @@ To help you with discovery of plugins, you can run
 
 This will list available (official) plugins. We maintain a list of recommended versions to use at https://github.com/killbill/killbill-cloud/blob/master/kpm/lib/kpm/plugins_directory.yml.
 
-There are more advanced commands and options available, just run `kpm --help` for details.
+## Internals and Advanced Commands
+
+
+### Caching
+
+KPM relies on the kpm.yml file to know what to install, and as it installs the pieces it keeps track of what was installed so that if it is invoked again, it does not download again the same binaries:
+* For the kilbill artifact itself, kpm will first extract the sha1 from the remote repository and compare with the cuurent sha1 installed under the default `webapp_path`; if those are the same, the file is not downloaded again.
+* For the plugins, since those are downloaded as an archive (*.tgz) and then decompressed/expanded, kpm will use an internal file, `<plugins_dir>/sha1.yml` to keep track of the sha1 archive. If there is an entry and the sha1 matches, then the file is not downloaded again.
+
+Note that you can override that behavior with the `--force-download` switch.
+
+### Custom Downloads
+
+Note that you can also download specific versions/artifacts directly with the followinhg commands -- bypassing the kpm.yml file:
+* `kpm pull_kaui_war <version>`
+* `kpm pull_kb_server_war <version>`
+* `kpm pull_ruby_plugin <artifact_id>`
+
+For more details see `kpm --help`.
+

data/lib/kpm/base_artifact.rb

@@ -35,9 +35,9 @@ module KPM
     KAUI_CLASSIFIER  = nil
 
     class << self
-      def pull(logger, group_id, artifact_id, packaging='jar', classifier=nil, version='LATEST', destination_path=nil, sha1_file=nil, force_download=false,  overrides={}, ssl_verify=true)
+      def pull(logger, group_id, artifact_id, packaging='jar', classifier=nil, version='LATEST', destination_path=nil, sha1_file=nil, force_download=false, verify_sha1=true, overrides={}, ssl_verify=true)
         coordinates = build_coordinates(group_id, artifact_id, packaging, classifier, version)
-        pull_and_put_in_place(logger, coordinates, destination_path, is_ruby_plugin_and_should_skip_top_dir(group_id, artifact_id), sha1_file, force_download, overrides, ssl_verify)
+        pull_and_put_in_place(logger, coordinates, destination_path, is_ruby_plugin_and_should_skip_top_dir(group_id, artifact_id), sha1_file, force_download, verify_sha1, overrides, ssl_verify)
       end
 
       def nexus_remote(overrides={}, ssl_verify=true)
@@ -53,7 +53,7 @@ module KPM
 
       protected
 
-      def pull_and_put_in_place(logger, coordinates, destination_path=nil, skip_top_dir=true, sha1_file=nil, force_download=false, overrides={}, ssl_verify=true)
+      def pull_and_put_in_place(logger, coordinates, destination_path=nil, skip_top_dir=true, sha1_file=nil, force_download=false, verify_sha1=true, overrides={}, ssl_verify=true)
         destination_path = KPM::root if destination_path.nil?
 
         # Create the destination directory
@@ -76,7 +76,7 @@ module KPM
         Dir.mktmpdir do |tmp_destination_dir|
           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, overrides, ssl_verify)
+          downloaded_artifact_info  = pull_and_verify(logger, artifact_info[:sha1], coordinates, tmp_destination_dir, sha1_file, verify_sha1, overrides, ssl_verify)
           if artifact_info[:is_tgz]
             Utils.unpack_tgz(downloaded_artifact_info[:file_path], destination_path, skip_top_dir)
             FileUtils.rm downloaded_artifact_info[:file_path]
@@ -140,9 +140,13 @@ module KPM
       end
 
 
-      def pull_and_verify(logger, remote_sha1, coordinates, destination_dir, sha1_file, overrides={}, ssl_verify=true)
+      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)
-        raise ArtifactCorruptedException unless verify(logger, info[:file_path], remote_sha1)
+        if verify_sha1
+          raise ArtifactCorruptedException unless verify(logger, coordinates, info[:file_path], remote_sha1)
+        else
+          logger.warn("Skip sha1 verification for  #{coordinates}")
+        end
 
         if sha1_file
           sha1_checker = Sha1Checker.from_file(sha1_file)
@@ -152,15 +156,19 @@ module KPM
         info
       end
 
-      def verify(logger, file_path, remote_sha1)
+      def verify(logger, coordinates, file_path, remote_sha1)
         # Can't check :(
         if remote_sha1.nil?
-          logger.warn("Unable to verify sha1 for #{coordinates}. Artifact info: #{artifact_info.inspect}")
+          logger.warn("Unable to verify sha1 for #{coordinates}")
           return true
         end
 
         local_sha1 = Digest::SHA1.file(file_path).hexdigest
-        local_sha1 == remote_sha1
+        res = local_sha1 == remote_sha1
+        if !res
+          logger.warn("Sha1 verification failed for #{coordinates} : local_sha1 = #{local_sha1}, remote_sha1 = #{remote_sha1}")
+        end
+        res
       end
 
       def build_coordinates(group_id, artifact_id, packaging, classifier, version=nil)

data/lib/kpm/installer.rb

@@ -26,8 +26,9 @@ module KPM
       @nexus_ssl_verify = !@nexus_config.nil? ? @nexus_config['ssl_verify'] : true
     end
 
-    def install(force_download=false)
+    def install(force_download=false, verify_sha1=true)
       @force_download = force_download
+      @verify_sha1 = verify_sha1
       @bundles_dir = @config['plugins_dir']
       @sha1_file = "#{@bundles_dir}/#{SHA1_FILENAME}"
 
@@ -51,7 +52,7 @@ module KPM
       version     = @config['version'] || LATEST_VERSION
       webapp_path = @config['webapp_path'] || KPM::root
 
-      KPM::KillbillServerArtifact.pull(@logger, group_id, artifact_id, packaging, classifier, version, webapp_path, nil, @force_download, @nexus_config, @nexus_ssl_verify)
+      KPM::KillbillServerArtifact.pull(@logger, group_id, artifact_id, packaging, classifier, version, webapp_path, nil, @force_download, @verify_sha1, @nexus_config, @nexus_ssl_verify)
     end
 
     def install_plugins
@@ -71,7 +72,7 @@ module KPM
         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, @nexus_config, @nexus_ssl_verify)
+        infos << KPM::KillbillPluginArtifact.pull(@logger, group_id, artifact_id, packaging, classifier, version, destination, @sha1_file, @force_download, @verify_sha1, @nexus_config, @nexus_ssl_verify)
       end
 
       infos
@@ -89,7 +90,7 @@ module KPM
         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, @nexus_config, @nexus_ssl_verify)
+        infos << KPM::KillbillPluginArtifact.pull(@logger, group_id, artifact_id, packaging, classifier, version, destination, @sha1_file, @force_download, @verify_sha1, @nexus_config, @nexus_ssl_verify)
       end
 
       infos
@@ -105,7 +106,7 @@ module KPM
       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, @nexus_config, @nexus_ssl_verify)
+      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
@@ -124,7 +125,7 @@ module KPM
       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, @nexus_config, @nexus_ssl_verify)
+      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/plugins_directory.yml

@@ -31,4 +31,12 @@
   :artifact_id: stripe-plugin
   :stable_version: 0.2.1
   :require:
-  - :api_secret_key
+  - :api_secret_key
+:braintree_blue:
+  :type: :ruby
+  :artifact_id: braintree_blue-plugin
+  :stable_version: 0.0.1
+  :require:
+  - :merchant_id
+  - :public_key
+  - :private_key

data/lib/kpm/tasks.rb

@@ -24,8 +24,12 @@ module KPM
                       :type    => :boolean,
                       :default => false,
                       :desc    => 'Force download of the artifact even if it exists'
+        method_option :verify_sha1,
+                      :type    => :boolean,
+                      :default => true,
+                      :desc    => 'Validates sha1 sum'
         def install(config_file)
-          Installer.from_file(config_file).install(options[:force_download])
+          Installer.from_file(config_file).install(options[:force_download], options[:verify_sha1])
         end
 
         method_option :destination,
@@ -36,6 +40,10 @@ module KPM
                       :type    => :boolean,
                       :default => false,
                       :desc    => 'Force download of the artifact even if it exists'
+        method_option :verify_sha1,
+                      :type    => :boolean,
+                      :default => true,
+                      :desc    => 'Validates sha1 sum'
         desc 'pull_kb_server_war version', 'Pulls Kill Bill server war from Sonatype and places it on your machine.'
         def pull_kb_server_war(version='LATEST')
           response = KillbillServerArtifact.pull(logger,
@@ -47,6 +55,7 @@ module KPM
                                                  options[:destination],
                                                  nil,
                                                  options[:force_download],
+                                                 options[:verify_sha1],
                                                  options[:overrides],
                                                  options[:ssl_verify])
           say "Artifact has been retrieved and can be found at path: #{response[:file_path]}", :green
@@ -69,6 +78,10 @@ module KPM
                       :type    => :boolean,
                       :default => false,
                       :desc    => 'Force download of the artifact even if it exists'
+        method_option :verify_sha1,
+                      :type    => :boolean,
+                      :default => true,
+                      :desc    => 'Validates sha1 sum'
         desc 'pull_kp_server_war version', 'Pulls Kill Pay server war from Sonatype and places it on your machine.'
         def pull_kp_server_war(version='LATEST')
           response = KillbillServerArtifact.pull(logger,
@@ -80,6 +93,7 @@ module KPM
                                                  options[:destination],
                                                  nil,
                                                  options[:force_download],
+                                                 options[:verify_sha1],
                                                  options[:overrides],
                                                  options[:ssl_verify])
           say "Artifact has been retrieved and can be found at path: #{response[:file_path]}", :green
@@ -106,6 +120,10 @@ module KPM
                       :type    => :string,
                       :default => nil,
                       :desc    => 'Location of the sha1 file'
+        method_option :verify_sha1,
+                      :type    => :boolean,
+                      :default => true,
+                      :desc    => 'Validates sha1 sum'
         desc 'pull_java_plugin artifact_id', 'Pulls a java plugin from Sonatype and places it on your machine.'
         def pull_java_plugin(artifact_id, version='LATEST')
           response = KillbillPluginArtifact.pull(logger,
@@ -117,6 +135,7 @@ module KPM
                                                  options[:destination],
                                                  options[:sha1_file],
                                                  options[:force_download],
+                                                 options[:verify_sha1],
                                                  options[:overrides],
                                                  options[:ssl_verify])
           say "Artifact has been retrieved and can be found at path: #{response[:file_path]}", :green
@@ -134,6 +153,10 @@ module KPM
                       :type    => :string,
                       :default => nil,
                       :desc    => 'Location of the sha1 file'
+        method_option :verify_sha1,
+                      :type    => :boolean,
+                      :default => true,
+                      :desc    => 'Validates sha1 sum'
         desc 'pull_ruby_plugin artifact_id', 'Pulls a ruby plugin from Sonatype and places it on your machine.'
         def pull_ruby_plugin(artifact_id, version='LATEST')
           response = KillbillPluginArtifact.pull(logger,
@@ -145,6 +168,7 @@ module KPM
                                                  options[:destination],
                                                  options[:sha1_file],
                                                  options[:force_download],
+                                                 options[:verify_sha1],
                                                  options[:overrides],
                                                  options[:ssl_verify])
           say "Artifact has been retrieved and can be found at path: #{response[:file_path]}", :green
@@ -177,6 +201,10 @@ module KPM
                       :type    => :string,
                       :default => nil,
                       :desc    => 'Location of the sha1 file'
+        method_option :verify_sha1,
+                      :type    => :boolean,
+                      :default => true,
+                      :desc    => 'Validates sha1 sum'
         desc 'pull_kaui_war version', 'Pulls Kaui war from Sonatype and places it on your machine.'
         def pull_kaui_war(version='LATEST')
           response = KauiArtifact.pull(logger,
@@ -188,6 +216,7 @@ module KPM
                                        options[:destination],
                                        options[:sha1_file],
                                        options[:force_download],
+                                       options[:verify_sha1],
                                        options[:overrides],
                                        options[:ssl_verify])
           say "Artifact has been retrieved and can be found at path: #{response[:file_path]}", :green

data/lib/kpm/version.rb

@@ -1,3 +1,3 @@
 module KPM
-  VERSION = '0.0.13'
+  VERSION = '0.0.14'
 end

data/spec/kpm/remote/base_artifact_spec.rb

@@ -70,7 +70,8 @@ describe KPM::BaseArtifact do
 
   def test_download(dir, filename=nil, verify_is_skipped=false, force_download=false)
     path = filename.nil? ? dir : dir + '/' + filename
-    info = KPM::BaseArtifact.pull(@logger, 'org.kill-bill.billing', 'killbill-oss-parent', 'pom', nil, 'LATEST', path, nil, force_download, {}, true)
+
+    info = KPM::BaseArtifact.pull(@logger, 'org.kill-bill.billing', 'killbill-oss-parent', 'pom', nil, 'LATEST', path, nil, force_download, true, {}, true)
     info[:file_name].should == (filename.nil? ? "killbill-oss-parent-#{info[:version]}.pom" : filename)
     info[:skipped].should == verify_is_skipped
     if !info[:skipped]

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: kpm
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Kill Bill core team
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.21
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.21
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: nexus_cli
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.0
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.0
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: thor
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.19.1
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.19.1
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.0.0
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 10.0.0
-  prerelease: false
-  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.0
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.0
-  prerelease: false
-  type: :development
 description: A package manager for Kill Bill.
 email: killbilling-users@googlegroups.com
 executables:
@@ -87,8 +87,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gemrelease
-- .gitignore
+- ".gemrelease"
+- ".gitignore"
 - Gemfile
 - README.md
 - Rakefile
@@ -120,26 +120,26 @@ homepage: http://kill-bill.org
 licenses:
 - Apache License (2.0)
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options:
-- --exclude
-- .
+- "--exclude"
+- "."
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
+rubyforge_project: 
 rubygems_version: 2.2.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Kill Bill package manager.
 test_files: