knife-artifactory 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57af63a2e4d97bd447477bd0ae1a3fe8dd4e10fff29f98e249a2c3945aa2b28
-  data.tar.gz: 9deb1ef44897e7c12fe6a0ec4e440809d55df05a70d662f1008d1734a45447e2
+  metadata.gz: 87c86116d7a6ea38d43bdef6c785a84a332195886cb5ae80bcdac8c22df38ae5
+  data.tar.gz: 72f5782c99a6684a147090c9e2bedc8623beefc715077d1cbb38d9097599e4a6
 SHA512:
-  metadata.gz: abff25d20f732130844ad178c00cf8a7149251220c3efd470405dd4111692812d8b31f6916a251978a7a772548beb3596244cf09b3fa5aba731aaed82fa01d8b
-  data.tar.gz: 11575c085633e4bfd13fecd9a39e00a4728dee1fed23a5107224b388afc7e33f9d6d4ab2baeb8bf5025d2d97c620e8706e8360c41e6f233fde41bfdf15e566af
+  metadata.gz: 50d717bf5443e36954f1109464ed7ba7b538cea20ca533c57768352ed17aeb9ce495af2461f65eec8dcd0ad7421cada25a213b9579268fde9eec960c1504acf5
+  data.tar.gz: 697352d1bc0e7b90c87146df58e10a7dec0cf5cf88d7a3e4ecde748844f54cd956a9228f11dac81e3b1bf0699f9d8e6fc4be042834182662f44727951f639251

data/lib/chef/knife/{knife_art_download.rb → artifactory_download.rb}

@@ -1,15 +1,15 @@
-# Overrides the default Chef::Knife::CookbookSiteShare to allow basic authentication against an Artifactory backend.
+# Overrides the default Chef::Knife::SupermarketShare to allow basic authentication against an Artifactory backend.
 # Ideally we would like to use a mechanism that allows injecting pluggable authentication middleware into the Chef::Http
 # REST clients, but in the interest of allowing not-only-newest knife client versions to work with Artifactory we chose
 # this solution for now.
 
-require 'chef/knife'
-require 'chef/knife/cookbook_site_download'
-require 'knife-artifactory/utils'
+require "chef/knife"
+require "chef/knife/cookbook_site_download"
+require "knife-artifactory/utils"
 
 class Chef
   class Knife
-    class ArtifactoryDownload < Knife::CookbookSiteDownload
+    class ArtifactoryDownload < Knife::SupermarketDownload
 
       dependency_loaders.concat(superclass.dependency_loaders)
       options.merge!(superclass.options)
@@ -32,7 +32,7 @@ class Chef
 
       def current_cookbook_data
         unless config[:artifactory_download]
-          Chef::Log.debug('[KNIFE-ART] ArtifactoryDownload::current_cookbook_data called without artifactory flag, delegating to super')
+          Chef::Log.debug("[KNIFE-ART] ArtifactoryDownload::current_cookbook_data called without artifactory flag, delegating to super")
           return orig_current_cookbook_data
         end
         @current_cookbook_data ||= begin
@@ -42,15 +42,15 @@ class Chef
 
       def desired_cookbook_data
         unless config[:artifactory_download]
-          Chef::Log.debug('[KNIFE-ART] ArtifactoryDownload::desired_cookbook_data called without artifactory flag, delegating to super')
+          Chef::Log.debug("[KNIFE-ART] ArtifactoryDownload::desired_cookbook_data called without artifactory flag, delegating to super")
           return orig_desired_cookbook_data
         end
         @desired_cookbook_data ||= begin
-                                     uri = if @name_args.length == 1
-                                              current_cookbook_data["latest_version"]
-                                           else
-                                              specific_cookbook_version_url
-                                           end
+          uri = if @name_args.length == 1
+                  current_cookbook_data["latest_version"]
+                else
+                  specific_cookbook_version_url
+                end
 
           noauth_rest.get(uri, auth_header)
         end
@@ -58,7 +58,7 @@ class Chef
 
       def download_cookbook
         unless config[:artifactory_download]
-          Chef::Log.debug('[KNIFE-ART] ArtifactoryDownload::download_cookbook called without artifactory flag, delegating to super')
+          Chef::Log.debug("[KNIFE-ART] ArtifactoryDownload::download_cookbook called without artifactory flag, delegating to super")
           return orig_download_cookbook
         end
         ui.info "Downloading #{@name_args[0]} from Supermarket at version #{version} to #{download_location}"
@@ -70,7 +70,7 @@ class Chef
 
       def auth_header
         @auth_header ||= begin
-                            ::Knife::KnifeArt::KnifeArtUtils.auth_header_from(cookbooks_api_url)
+                           ::KnifeArtifactory::Utils.auth_header_from(cookbooks_api_url)
                          end
       end
 

data/lib/chef/knife/{knife_art_install.rb → artifactory_install.rb}

@@ -1,15 +1,14 @@
-# Overrides the default Chef::Knife::CookbookSiteInstall to allow basic authentication against an Artifactory backend.
+# Overrides the default Chef::Knife::SupermarketInstall to allow basic authentication against an Artifactory backend.
 # Ideally we would like to use a mechanism that allows injecting pluggable authentication middleware into the Chef::Http
 # REST clients, but in the interest of allowing not-only-newest knife client versions to work with Artifactory we chose
 # this solution for now.
 
-
-require 'chef/knife'
-require 'chef/knife/cookbook_site_install'
+require "chef/knife"
+require "chef/knife/cookbook_site_install"
 
 class Chef
   class Knife
-    class ArtifactoryInstall < Knife::CookbookSiteInstall
+    class ArtifactoryInstall < Knife::SupermarketInstall
 
       dependency_loaders.concat(superclass.dependency_loaders)
       options.merge!(superclass.options)
@@ -30,7 +29,7 @@ class Chef
 
       def download_cookbook_to(download_path)
         unless config[:artifactory_install]
-          Chef::Log.debug('[KNIFE-ART] ArtifactoryInstall::download_cookbook_to called without artifactory flag, delegating to super')
+          Chef::Log.debug("[KNIFE-ART] ArtifactoryInstall::download_cookbook_to called without artifactory flag, delegating to super")
           return orig_download_cookbook_to(download_path)
         end
         downloader = Chef::Knife::ArtifactoryDownload.new

data/lib/chef/knife/{knife_art_list.rb → artifactory_list.rb}

@@ -1,10 +1,10 @@
 
-require 'chef/knife'
-require 'chef/knife/cookbook_site_list'
+require "chef/knife"
+require "chef/knife/cookbook_site_list"
 
 class Chef
   class Knife
-    class ArtifactoryList < Knife::CookbookSiteList
+    class ArtifactoryList < Knife::SupermarketList
 
       dependency_loaders.concat(superclass.dependency_loaders)
       options.merge!(superclass.options)

data/lib/chef/knife/{knife_art_search.rb → artifactory_search.rb}

@@ -1,10 +1,10 @@
 
-require 'chef/knife'
-require 'chef/knife/cookbook_site_search'
+require "chef/knife"
+require "chef/knife/cookbook_site_search"
 
 class Chef
   class Knife
-    class ArtifactorySearch < Knife::CookbookSiteSearch
+    class ArtifactorySearch < Knife::SupermarketSearch
 
       dependency_loaders.concat(superclass.dependency_loaders)
       options.merge!(superclass.options)

data/lib/chef/knife/{knife_art_share.rb → artifactory_share.rb}

@@ -2,19 +2,18 @@
 # 1. allow passing flags to the super class so that the do_upload method of this
 #    class is called and that signing key verification is skipped by the underlying Chef::HTTP::Authenticator that's
 #    used with the rest client (see comment below).
-# 2. Override (monkey patch) the required methods in Chef::HTTP::Authenticator and Knife::CookbookSiteShare
+# 2. Override (monkey patch) the required methods in Chef::HTTP::Authenticator and Knife::SupermarketShare
 #    to allow inserting our own logic that deploys a cookbook to Artifactory.
 #
 # The Supermarket API is kept (post /api/v1/cookbooks/cookbook_name) by Artifactory although it does not currently
 # return a correct response (it simply returns 200) due to performance considerations.
 
-
-require 'chef/knife'
-require 'chef/knife/cookbook_site_share'
+require "chef/knife"
+require "chef/knife/cookbook_site_share"
 
 class Chef
   class Knife
-    class ArtifactoryShare < Knife::CookbookSiteShare
+    class ArtifactoryShare < Knife::SupermarketShare
 
       dependency_loaders.concat(superclass.dependency_loaders)
       options.merge!(superclass.options)
@@ -22,34 +21,94 @@ class Chef
       banner "knife artifactory share COOKBOOK [CATEGORY] (options)"
       category "artifactory"
 
+      option :overwrite_cookbook,
+        long: "--[no-]overwrite-cookbook",
+        boolean: true,
+        default: true,
+        description: "Overwrite existing cookbook version if it already exists. Default is yes."
+
       alias_method :orig_run, :run
       alias_method :orig_get_category, :get_category
       alias_method :orig_do_upload, :do_upload
 
       def run
-        begin
         # I'm forced to use threadlocal until we find a better solution... can't really find a way to pass configuration
         # down to the Chef::CookbookUploader, Chef::ServerAPI, Chef::HTTP or Chef::HTTP::Authenticator
         # (which are created one after another starting) with CookbookUploader to make it skip the signing key verification.
         # Can make the authenticator skip by passing load_signing_key(nil, nil) and opts[:sign_request] => false
-        Thread.current[:artifactory_deploy] = 'yes'
+        Thread.current[:artifactory_deploy] = "yes"
         # Send artifactory deploy flag to super
         config[:artifactory_deploy] = true
         Chef::Log.debug("[KNIFE-ART] running site share with config: #{config}")
+
+        if !overwrite_cookbook? && cookbook_versions_in_artifactory.include?(cookbook_version)
+          ui.info("Cookbook version already exists, skipping upload.")
+          exit(0)
+        end
+
         orig_run
-        ensure
+      ensure
           # always cleanup threadlocal
-          Thread.current[:artifactory_deploy] = nil
+        Thread.current[:artifactory_deploy] = nil
+      end
+
+      #
+      # @example
+      #   cookbook_versions_in_artifactory #=> ["1.0.0", "1.0.1", "1.1.0", "1.2.0"]
+      #
+      # @return [Array<String>] versions in artifactory
+      #
+      def cookbook_versions_in_artifactory
+        return [] if cookbook_name.nil?
+
+        data = noauth_rest.get("#{supermarket_uri}/cookbooks/#{cookbook_name}")
+        data["metrics"]["downloads"]["versions"].keys
+      end
+
+      #
+      # @example
+      #   cookbook_version #=> 1.0.1
+      #
+      # @example
+      #   cookbook_version #=> 0.1.0
+      #
+      # @example
+      #   cookbook_version #=> nil
+      #
+      # @return [String, nil] version of cookbook present in cookbook path or nil if no
+      #   coobook versions exist locally.
+      #
+      def cookbook_version
+        cl = Chef::CookbookLoader.new(cookbook_path)
+        if cl.cookbook_exists?(cookbook_name)
+          cookbook = cl[cookbook_name]
+          cookbook.version
         end
       end
 
       private
 
+      def cookbook_name
+        @name_args[0] if @name_args.length >= 1
+      end
+
+      def cookbook_path
+        config[:cookbook_path] ||= Chef::Config[:cookbook_path]
+      end
+
+      def supermarket_uri
+        "#{config[:supermarket_site]}/api/v1"
+      end
+
+      def overwrite_cookbook?
+        config[:overwrite_cookbook]
+      end
+
       # Pretty much copy paste of the original, just with authentication on the rest client...
       def get_category(cookbook_name)
         # Use Artifactory deployment logic only if flag sent by Artifactory plugin
         unless config[:artifactory_deploy]
-          Chef::Log.debug('[KNIFE-ART] ArtifactoryShare::get_category called without artifactory flag, delegating to super')
+          Chef::Log.debug("[KNIFE-ART] ArtifactoryShare::get_category called without artifactory flag, delegating to super")
           return orig_get_category(cookbook_name)
         end
         begin
@@ -57,7 +116,7 @@ class Chef
           if data.nil?
             return data["category"]
           else
-            return 'Other'
+            return "Other"
           end
         rescue => e
           return "Other" if e.kind_of?(Net::HTTPServerException) && e.response.code == "404"
@@ -65,18 +124,17 @@ class Chef
           Chef::Log.debug("\n#{e.backtrace.join("\n")}")
           exit(1)
         end
-
       end
 
       def do_upload(cookbook_filename, cookbook_category, user_id, user_secret_filename)
         # Use Artifactory deployment logic only if flag sent by Artifactory plugin
         unless config[:artifactory_deploy]
-          Chef::Log.debug('[KNIFE-ART] ArtifactoryShare::do_upload called without artifactory flag, delegating to super')
+          Chef::Log.debug("[KNIFE-ART] ArtifactoryShare::do_upload called without artifactory flag, delegating to super")
           orig_do_upload(cookbook_filename, cookbook_category, user_id, user_secret_filename)
           return
         end
         # cookbook_filename is set as tempDir/cookbook_name in parent
-        cookbook_name = cookbook_filename.split('/')[-1]
+        cookbook_name = cookbook_filename.split("/")[-1]
         uri = "#{config[:supermarket_site]}/api/v1/cookbooks/#{cookbook_name}"
         uri += "?category=#{cookbook_category}" if cookbook_category
         Chef::Log.debug("[KNIFE-ART] Deploying cookbook #{cookbook_name} to Artifactory url at #{uri}")
@@ -85,7 +143,7 @@ class Chef
         # debug log will be able to show the response Artifactory returned in case of errors.
         file_contents = File.open(cookbook_filename, "rb") { |f| f.read }
         # no need to send auth header here, 'normal' HTTP client uses url with credentials from config
-        rest.post(uri, file_contents, {"content-type" => "application/x-binary"})
+        rest.post(uri, file_contents, { "content-type" => "application/x-binary" })
       end
 
     end
@@ -101,11 +159,11 @@ class Chef
 
       def load_signing_key(key_file, raw_key = nil)
         Chef::Log.debug("[KNIFE-ART] global var: #{Thread.current[:artifactory_deploy]}")
-        if Thread.current.key?(:artifactory_deploy) and Thread.current[:artifactory_deploy].eql? 'yes'
-          Chef::Log.debug('[KNIFE-ART] Artifactory plugin substituting for Chef::Http::Authenticator --> omitting signing key usage')
+        if Thread.current.key?(:artifactory_deploy) && Thread.current[:artifactory_deploy].eql?("yes")
+          Chef::Log.debug("[KNIFE-ART] Artifactory plugin substituting for Chef::Http::Authenticator --> omitting signing key usage")
           @sign_request = false
-          @raw_key = ''
-          @key = ''
+          @raw_key = ""
+          @key = ""
         else
           # Artifactory flag not present, call original implementation
           orig_load_signing_key(key_file, raw_key)

data/lib/chef/knife/artifactory_show.rb

@@ -1,10 +1,10 @@
 
-require 'chef/knife'
-require 'chef/knife/cookbook_site_show'
+require "chef/knife"
+require "chef/knife/cookbook_site_show"
 
 class Chef
   class Knife
-    class ArtifactoryShow < Knife::CookbookSiteShow
+    class ArtifactoryShow < Knife::SupermarketShow
 
       dependency_loaders.concat(superclass.dependency_loaders)
       options.merge!(superclass.options)

data/lib/chef/knife/{knife_art_unshare.rb → artifactory_unshare.rb}

@@ -1,7 +1,7 @@
 # More or less copy-pasted from cookbook_site_unshare because the http call happens inside the run method, not much
 # sense in extending it
 
-require 'chef/knife'
+require "chef/knife"
 
 class Chef
   class Knife
@@ -15,11 +15,11 @@ class Chef
       category "artifactory"
 
       option :supermarket_site,
-             :short => "-m SUPERMARKET_SITE",
-             :long => "--supermarket-site SUPERMARKET_SITE",
-             :description => "Supermarket Site",
-             :default => "https://supermarket.chef.io",
-             :proc => Proc.new { |supermarket| Chef::Config[:knife][:supermarket_site] = supermarket }
+             short: "-m SUPERMARKET_SITE",
+             long: "--supermarket-site SUPERMARKET_SITE",
+             description: "Supermarket Site",
+             default: "https://supermarket.chef.io",
+             proc: Proc.new { |supermarket| Chef::Config[:knife][:supermarket_site] = supermarket }
 
       def run
         @cookbook_name = @name_args[0]
@@ -41,7 +41,7 @@ class Chef
           url = "#{cookbooks_api_url}/#{@cookbook_name}/#{@cookbook_version}"
           noauth_rest.delete(url, auth_header)
         rescue Net::HTTPServerException => e
-          raise e unless (e.message =~ /Forbidden/ || e.message =~ /Unauthorized/)
+          raise e unless e.message =~ /Forbidden/ || e.message =~ /Unauthorized/
           ui.error "Forbidden: You must have delete permissions on the target repo to delete #{@cookbook_name}."
           exit 1
         end
@@ -57,7 +57,7 @@ class Chef
 
       def auth_header
         @auth_header ||= begin
-          ::Knife::KnifeArt::KnifeArtUtils.auth_header_from(cookbooks_api_url)
+          ::KnifeArtifactory::Utils.auth_header_from(cookbooks_api_url)
         end
       end
 

data/lib/knife-artifactory/utils.rb

@@ -1,4 +1,4 @@
-require 'base64'
+require "base64"
 
 module KnifeArtifactory
   class Utils
@@ -6,14 +6,14 @@ module KnifeArtifactory
     def self.auth_header_from(uri)
       Chef::Log.debug("[KNIFE-ART] in util, got url: #{uri}")
       begin
-      url = URI.parse(uri.gsub(%r{/+$}, ""))
-      Chef::Log.debug("[KNIFE-ART] in util, parsed url: #{uri}")
-      if url.user and url.password
-        user = URI.unescape(url.user)
-        password = URI.unescape(url.password)
-        return {"Authorization" => "Basic " + Base64.strict_encode64("#{user}:#{password}")}
-      end
-      {}
+        url = URI.parse(uri.gsub(%r{/+$}, ""))
+        Chef::Log.debug("[KNIFE-ART] in util, parsed url: #{uri}")
+        if url.user && url.password
+          user = URI.unescape(url.user)
+          password = URI.unescape(url.password)
+          return { "Authorization" => "Basic " + Base64.strict_encode64("#{user}:#{password}") }
+        end
+        {}
       end
     rescue Exception => e
       Chef::Log.warn("[KNIFE-ART] Unable to parse url: #{uri} --> #{e.message}")

data/lib/knife-artifactory/version.rb

@@ -1,3 +1,3 @@
 module KnifeArtifactory
-  VERSION = '0.1.0'
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-artifactory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dan Feldman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies: []
 description: Enables basic authentication support for share and upload operations
   to Artifactory when it serves as a Supermarket.
@@ -18,13 +18,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/chef/knife/artifactory_download.rb
+- lib/chef/knife/artifactory_install.rb
+- lib/chef/knife/artifactory_list.rb
+- lib/chef/knife/artifactory_search.rb
+- lib/chef/knife/artifactory_share.rb
 - lib/chef/knife/artifactory_show.rb
-- lib/chef/knife/knife_art_download.rb
-- lib/chef/knife/knife_art_install.rb
-- lib/chef/knife/knife_art_list.rb
-- lib/chef/knife/knife_art_search.rb
-- lib/chef/knife/knife_art_share.rb
-- lib/chef/knife/knife_art_unshare.rb
+- lib/chef/knife/artifactory_unshare.rb
 - lib/knife-artifactory/utils.rb
 - lib/knife-artifactory/version.rb
 homepage: https://github.com/jasonwbarnett/knife-artifactory