knife-github 0.0.6 → 0.0.7

data/lib/chef/knife/github_base.rb

@@ -95,10 +95,10 @@ class Chef
                 ui.info "INFO: New version (#{webversion.to_s}) of knife-github is available!"
                 ui.info "INFO: Turn off this message with --github_no_update or add knife[:github_no_update] = true to your configuration"
               end 
-              Chef::Log.debug("local_gem_version    : " + thisversion.to_s)
-              Chef::Log.debug("repo_gem_version     : " + webversion.to_s)
-              Chef::Log.debug("repo_downloads       : " + json['version_downloads'].to_s)
-              Chef::Log.debug("repo_total_downloads : " + json['downloads'].to_s)
+              Chef::Log.debug("gem_local_version    : " + thisversion.to_s)
+              Chef::Log.debug("gem_repo_version     : " + webversion.to_s)
+              Chef::Log.debug("gem_downloads        : " + json['version_downloads'].to_s)
+              Chef::Log.debug("gem_total_downloads  : " + json['downloads'].to_s)
  
             rescue
               ui.info "INFO: Cannot verify gem version information from rubygems.org"

data/lib/chef/knife/github_baselist.rb

@@ -57,10 +57,13 @@ class Chef
                  config[:fields].downcase.split(',').each { |n| object_list << ((v["#{n}".strip]).to_s || 'n/a') }
               else
                 color = :white
-                if config[:mismatch] && !match.empty? && !config[:all]
+                if !match.empty? && !config[:all]
                   matches = []; match.each { |m| matches << v[m].to_s }
-                  next if matches.uniq.count == 1 
-                  color = :yellow
+                  if matches.uniq.count == 1
+                    next if config[:mismatch]
+                  else
+                    color = :yellow 
+                  end
                 end
                 columns.each { |c|  r = c.split(","); object_list << ui.color((v["#{r.first}"]).to_s, color) || 'n/a' }
               end

data/lib/chef/knife/github_cleanup.rb

@@ -39,7 +39,7 @@ module KnifeGithubCleanup
       require 'chef/mixin/shell_out'
     end
     
-    banner "knife github cleanup [REPO] (options)"
+    banner "knife github cleanup [COOKBOOK] (options)"
     category "github"
 
     option :all,

data/lib/chef/knife/{github_download.rb → github_clone.rb}

@@ -21,7 +21,7 @@ require 'chef/knife'
 class Chef
   class Knife
 
-    class GithubDownload < Knife
+    class GithubClone < Knife
 
       deps do
         require 'chef/knife/github_base'
@@ -29,19 +29,19 @@ class Chef
         require 'chef/mixin/shell_out'
       end
       
-      banner "knife github download COOKBOOK (options)"
+      banner "knife github clone COOKBOOK (options)"
       category "github"
 
       option :all,
              :short => "-a",
              :long => "--all",
-             :description => "Download all cookbooks from github.",
+             :description => "Clone all repo's from github.",
              :boolean => true
 
       option :force,
              :short => "-f",
              :long => "--force",
-             :description => "Delete the existing cookbooks if exist.",
+             :description => "Delete the existing local repo if exist.",
              :boolean => true
 
       def run
@@ -65,17 +65,17 @@ class Chef
         @cookbook_name = name_args.first unless name_args.empty?
         if @cookbook_name
           repo = all_repos.select { |k,v| v["name"] == @cookbook_name }
-          repo_download(repo, @cookbook_name)
+          repo_clone(repo, @cookbook_name)
         elsif config[:all]
           cookbooks.each do |c,v|
-            repo_download(all_repos, c)
+            repo_clone(all_repos, c)
           end
         else
-          Chef::Log.error("Please specify a cookbook name")
+          Chef::Log.error("Please specify a repository name")
         end
       end
 
-      def repo_download(repo, cookbook)
+      def repo_clone(repo, cookbook)
         if repo.nil? || repo.empty?
           ui.info("Processing [?] #{cookbook}")
           Chef::Log.info("Cannot find the repository: #{cookbook} within github")

data/lib/chef/knife/github_compare.rb

@@ -20,7 +20,6 @@ require 'chef/knife'
 
 class Chef
   class Knife
-
     class GithubCompare < Knife
 
       deps do
@@ -68,8 +67,8 @@ class Chef
             }
           else
             cookbooks.each { |k,v|
-              get_all_repos[k].nil? || get_all_repos[k][git_link].nil? ? gh_url = ui.color("ERROR: Cannot find cookbook!", :red) : gh_url = get_all_repos[k][git_link]
-              get_all_repos[k].nil? || get_all_repos[k]['latest_tag'].nil? ? gh_tag = ui.color("ERROR: No tags!", :red) : gh_tag = get_all_repos[k]['latest_tag']
+              get_all_repos[k].nil? || get_all_repos[k][git_link].nil? ? gh_url = ui.color("Cannot find cookbook!", :red) : gh_url = get_all_repos[k][git_link]
+              get_all_repos[k].nil? || get_all_repos[k]['latest_tag'].nil? || get_all_repos[k]['latest_tag'].empty? ? gh_tag = ui.color("No tags!", :red) : gh_tag = get_all_repos[k]['latest_tag']
               all_repos[k] = { 'name' => k, 'latest_cb_tag' => v['versions'][0]['version'], 'git_url' => gh_url, 'latest_gh_tag' => gh_tag }
             }
           end
@@ -83,7 +82,7 @@ class Chef
           repos = all_repos 
         end
 
-        columns = [ 'name,Name', 'latest_cb_tag,Tag', 'git_url,Link', 'latest_gh_tag,Tag' ]
+        columns = [ 'name,Chef Store', 'latest_cb_tag,Tag', 'git_url,Github Store', 'latest_gh_tag,Tag' ]
         match = [ 'latest_cb_tag', 'latest_gh_tag' ]
 
         if repos.nil? || repos.empty?

data/lib/chef/knife/github_deploy.rb

@@ -1,67 +1,57 @@
-#
-# Author:: Sander Botman (<sbotman@schubergphilis.com>)
-# Copyright:: Copyright (c) 2013 Sander Botman.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-# ---------------------------------------------------------------------------- #
-# Abstract
-# ---------------------------------------------------------------------------- #
-# This code is specific to our company workflow
-# When a cookbook is released it is tagged to a specific version
-# This version should match the cookbook version (from the metadata)
-# This version is then pinned against specific environments
-#
-# This class expects you to have pushed all your changes to github
-# It will then do the rest
-#
-# All modes presume you have used github download to download a cookbook or
-# are creating a new cookbook
-#
-# There are two modes of operation
-# Development (default)
-#
-# This will take a cookbook name
-# Do some basic version checks (if the current cookbook is frozen) and
-# upload it
-#
-# If the cookbook is frozen it will force you to choose a new version
-# and update the metadata accordingly
-#
-# Final (-f)
-#
-# You will be forced to select a new version.
-# You can choose via the options whether to increment the Major/minor or patch
-# revision numbers
-# The version will be tagged
-# Uploaded to the Chef server and frozen
-#
-# Version numbers
-#
-# You can choose a specific version number by specifying it on the command
-# line.
-#
-# If you do not specify a version, the version will be the version in your
-# cookbook's metadata
-#
-# A warning is issued if the version is lower than the version in github
-# ---------------------------------------------------------------------------- #
 require 'chef/knife'
 
 class Chef
   class Knife
-
+    # Implements the knife github deploy function
+    # @author:: Ian Southam (<isoutham@schubergphilis.com>)
+    # Copyright:: Copyright (c) 2013 Ian Southam.
+    # This code is specific to our company workflow
+    #
+    # == Overview
+    # All modes presume you have used github download to download a cookbook or
+    # are creating a new cookbook
+    #
+    # === Examples
+    # Deploy a development version of cookbook to your chef server
+    #    knife github deploy cookbook_name 
+    #    
+    # Deploy a release version of cookbook to your chef server
+    #    knife github deploy cookbook_name -f
+    #
+    # === Options
+    # -f Operate in final release mode
+    # -p Update the patch component of the version
+    # -m Update the minor component of the version
+    # -M Update the minor component of the version
+    # 
+    # == Operation Modes
+    # Development (default)
+    #
+    # This will take a cookbook name
+    # Do some basic version checks (if the current cookbook is frozen) and
+    # upload it
+    #
+    # If the cookbook is frozen it will force you to choose a new version
+    # and update the metadata accordingly
+    #
+    # Release (-f)
+    #
+    # You will be forced to select a new version.
+    # You can choose via the options whether to increment the Major/minor or patch
+    # revision numbers
+    # The version will be tagged
+    # Uploaded to the Chef server and frozen
+    #
+    # == Version numbers
+    #
+    # You can choose a specific version number by specifying it on the command
+    # line.
+    #
+    # If you do not specify a version, the version will be the version in your
+    # cookbook's metadata
+    #
+    # A warning is issued if the version is lower than the version in github
+    #
     class GithubDeploy < Knife
       deps do
         require 'chef/knife/github_base'
@@ -102,11 +92,10 @@ class Chef
              :default => true
 
       def run
+        # Main run entry point for the class
 
-        # validate base options from base module.
         validate_base_options      
 
-        # Display information if debug mode is on.
         display_debug_info
 
         # Gather all repo information from github.
@@ -135,7 +124,7 @@ class Chef
         # is the cookbook in the cookbook_path?
         if cookbook_path_valid?(@cookbook_name, false).nil?
           Chef::Log.error("Cookbook is not in cookbook path")
-          ui.info("HINT:  knife github download #{@cookbook_name}")
+          ui.info("HINT:  knife github clone #{@cookbook_name}")
           exit 1
         end
 
@@ -161,6 +150,9 @@ class Chef
         if (config[:major] || config[:minor])
             config[:patch] = false
         end
+        if (config[:major] && config[:minor])
+            config[:minor] = false
+        end
 
         begin
             isFrozen = rest.get_rest("cookbooks/#{@cookbook_name}/#{cookbook_version}").frozen_version?
@@ -190,6 +182,7 @@ class Chef
                 set_cookbook_version(cookbook_version)
                 add_tag(cookbook_version)
             else
+                ui.confirm("Tag #{cookbook_version} exists - did you make this for this release?")
                 checkout_tag(cookbook_version)
                 set_cookbook_version(cookbook_version)
             end
@@ -210,12 +203,19 @@ class Chef
 
       end
 
+      # Ask user to increment current/desired version number
+      # Method will exit if the user chooses not to increment the version
+      #
+      # @param version [String] Version
+      # @return [String] New version number
+      #
       def up_version(version)
           while true do
                 ui.info("Trying to deploy version #{version}")
                 if @versions.include?(version)
                    ui.info("Version #{version} is already in chef")
-                   ui.confirm("Shall I bump the version (No to Cancel)")
+                   vt = choose_version(version)
+                   ui.confirm("Shall I bump the version to #{vt} (No to Cancel)")
                    version = choose_version(version)
                 else
                    break
@@ -224,10 +224,17 @@ class Chef
           version
       end
 
+      # Increment the current version according to the config
+      # options config[major] config[minor] config[patch]
+      # Method will exit if the user chooses not to increment the version
+      #
+      # @param version [String] Version
+      # @return [String] New version number
+      #
       def choose_version(version)
           if version =~ /(\d+)\.(\d+)\.(\d+)/
              major = $1
-             minor = $1
+             minor = $2
              patch = $3
              major = major.to_i + 1 if config[:major]
              minor = minor.to_i + 1 if config[:minor]
@@ -241,6 +248,8 @@ class Chef
           version
       end
 
+      # Upload the cookbook to chef server
+      # If mode is final, freeze the cookbook
       def cookbook_upload() 
           # Git meuk should not be uploaded use chefignore file instead
           # FileUtils.remove_entry("#{@github_tmp}/git/#{@cookbook_name}/.git")
@@ -254,6 +263,10 @@ class Chef
           upload.run
       end
 
+      # If a tag is available in github check it out
+      # Potentially quite dangerous as it could cause code to
+      # get rolled back
+      # @param version [String] Version
       def checkout_tag(version)
           ui.info "Checking out tag #{version}"
           cpath = get_cookbook_path(@cookbook_name)
@@ -265,6 +278,7 @@ class Chef
           end
       end
 
+      # Get a sorted array of version for the cookbook
       def get_cookbook_chef_versions ()
           cookbooks = rest.get_rest("/cookbooks/#{@cookbook_name}?num_version=all")
           cookbooks[@cookbook_name]['versions'].each do |v|
@@ -272,9 +286,8 @@ class Chef
           end
       end
 
-      # ---------------------------------------------------------------------- #
       # Get the version number in the git version of the cookbook
-      # ---------------------------------------------------------------------- #
+      # @param version [String] Version
       def get_cookbook_version()
           version = nil
           cpath = get_cookbook_path(@cookbook_name)
@@ -291,10 +304,17 @@ class Chef
           version
       end
 
+      # Determine if the current cookbook path is valid and that there
+      # is a cookbook of the correct name in there
+      # @param cookbook [String] cookbook name
+      # @return [String] Path to cookbook
       def get_cookbook_path(cookbook) 
           return cookbook_path_valid?(cookbook, false)
       end
 
+      # Commit changes in git
+      # @param version [String] cookbook version
+      # @param push [Bool] true is the cookbook should also be pushed
       def do_commit(version, push)
           cpath = get_cookbook_path(@cookbook_name)
           Dir.chdir("#{cpath}")
@@ -318,6 +338,8 @@ class Chef
       end
 
 
+      # Set the version in metadata.rb
+      # @param version [String] cookbook version
       def set_cookbook_version(version)
           return  unless get_cookbook_version() != version
           contents = ''

data/lib/chef/knife/github_diff.rb

@@ -22,6 +22,15 @@ class Chef
   class Knife
 
     class GithubDiff < Knife
+    # Implements a diff function between your downloaded copy from git and what is in the Chef Server
+    # 
+    # By default, it expects that you have already done knife github download COOKBOOK
+    #
+    # knife github diff cookbook_name [Version]
+    # 
+    # You can also diff a cookbook against the github version bu using the -g option
+    # 
+    # You can also optionally give a version on the command line
 
       deps do
         require 'chef/knife/github_base'
@@ -32,13 +41,15 @@ class Chef
       banner "knife github diff COOKBOOK [version] (options)"
       category "github"
 
-      option :all,
-             :short => "-a",
-             :long => "--all",
-             :description => "Diff all cookbooks from chef against github.",
-             :boolean => true
+      option :github,
+             :short => "-g",
+             :long => "--github",
+             :description => "Diff against version in github",
+             :boolean => true,
+             :default => false
 
       def run
+      # The run method.  The entry point into the class
 
         # validate base options from base module.
         validate_base_options      
@@ -73,27 +84,46 @@ class Chef
           Chef::Log.error("Cannot find the link for the repository with the name: #{@cookbook_name}")
           exit 1
         end
-        puts github_link
-	get_clone(github_link, @cookbook_name)
-	version = get_cookbook_copy(@cookbook_name, cookbook_version)
-	do_diff(@cookbook_name, version)
+
+        if config[:github]
+	        get_clone(github_link, @cookbook_name)
+        else # Copy downloaded version to #{@github_tmp}/git
+            cpath = cookbook_path_valid?(@cookbook_name, false)
+            if cpath.nil?
+              Chef::Log.error("Cannot find any local repository with the name: #{@cookbook_name}")
+              Chef::Log.error("Please use the option -g if you want to diff the github repository")
+              exit 1
+            end
+            tpath = "#{@github_tmp}/git"
+            if ! File.exists?(tpath)
+                FileUtils.makedirs(tpath)
+            end
+            FileUtils.cp_r cpath, tpath
+        end
+
+	    version = get_cookbook_copy(@cookbook_name, cookbook_version)
+
+	    do_diff(@cookbook_name, version)
         FileUtils.remove_entry(@github_tmp)
       end
 
       def do_diff(name, version)
         # Check to see if there is a tag matching the version
         Dir.chdir("#{@github_tmp}/git/#{name}")
-        if `git tag`.split("\n").include?(version)
-          ui.info("Tag version #{version} found, checking that out for diff")
-          # Tag found so checkout that tag
-          `git checkout -b #{version}`
-          if !$?.exitstatus == 0
-            ui.error("Failed to checkout branch #{version}")
-            exit 1
-          end
-        else
-          ui.info("Version #{version} of #{name} has no tag, using latest for diff")
-	end
+        # Only checkout in github mode
+        if config[:github]
+            if `git tag`.split("\n").include?(version)
+              ui.info("Tag version #{version} found, checking that out for diff")
+              # Tag found so checkout that tag
+              `git checkout -b #{version}`
+              if !$?.exitstatus == 0
+                ui.error("Failed to checkout branch #{version}")
+                exit 1
+              end
+            else
+              ui.info("Version #{version} of #{name} has no tag, using latest for diff")
+            end
+        end
 
         FileUtils.remove_entry("#{@github_tmp}/git/#{name}/.git")
         output = `git diff --color #{@github_tmp}/git/#{name} #{@github_tmp}/cb/#{name}-#{version} 2>&1`