knife-tagbatch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b45ebbcc76cffffe8e71e6506442bd0b904cbea2
+  data.tar.gz: 64b35eda0fd8513169ee0b7fa32d0f60b72417a7
+SHA512:
+  metadata.gz: 95dce0967f599d5d680af7e6eabce2850369da6047fa3a9d8d3639f87df2c216df6440c5cb0a54a5609709fe1bd818f7a9999f6b4e170def2946230d905f51d1
+  data.tar.gz: e83dbbeb662b44aa6e1f5dd589005c18f26eb1608438c4ffecf038dcab1d8078149d106a2961a0403b36218671b299b82651a6aa518d80366c477e00b5f84892

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knife-tagbatch.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1 @@
+GNU General Public License (GPL>=3)

data/README.md

@@ -0,0 +1,36 @@
+# Knife::Tagbatch
+
+Tagbatch is a plugin for the Chef Knife tool (https://docs.chef.io/knife.html). It adds search functionality to knife tag and allows the execution of multiple tag additions or removals in one statement. There is a flag for logging and dry-run execution.
+
+## Installation
+
+Gem installation:
+  `gem install knife-tagbatch`
+
+Manual installation:
+  Clone https://github.com/nkaravias/knife-tagbatch.git
+  Create ~/.chef/knife/plugins
+  Copy lib/chef/knife/tagbatch.rb to plugins
+
+
+## Usage
+
+knife tag batch <operation> <tag string> <knife search regexp> | -l | -d 
+
+Allowed operations are add | remove for creating and removing Chef tags
+
+e.g Add the 'webserver' tag to all nodes that have the web-server role on environment x.
+knife tag add webserver 'role:web-server AND chef_environment=x'
+
+Optional arguments:
+
+-l (Logging): Knife will write the output of the tag operation per node on tagBatch.log in the current working directory
+-d (dry run): Knife will execute the operation but will not save the results (tag creation / removal) on the node
+
+## Contributing
+
+1. Fork it ( https://github.com/nkaravias/knife-tagbatch/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/knife-tagbatch.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require 'knife-tagbatch/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "knife-tagbatch"
+  gem.version       = CustomChef::KnifeTagBatch::VERSION
+  gem.authors       = ["Nikolas Karavias"]
+  gem.email         = ["nikolas.karavias@oracle.com"]
+  gem.licenses = ["GPL-3"]
+  gem.summary       = %q{Add search functionality to the knife tag command}
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/nkaravias/knife-tagbatch"
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+  gem.add_runtime_dependency "chef"
+end

data/lib/chef/knife/tagbatch.rb

@@ -0,0 +1,95 @@
+require "knife-tagbatch/version"
+
+module CustomChef
+  module KnifeTagBatch
+  class TagBatch < Chef::Knife
+    deps do
+      require 'chef/node'
+      require 'chef/search/query'
+    end
+# Don't save the changes to the node object
+option :dry_run,
+  :short => "-d",
+  :long => "--dry-run",
+  :description => "Don't save the node changes",
+  :boolean => true | false,
+  :default => false
+
+# Log tagging log to ./batch-tag.log
+option :batch_log,
+  :short => "-l",
+  :long => "--batch-log",
+  :description => "Write batch results to $CWD/tagBatch.log",
+  :boolean => true | false,
+  :default => false
+
+  banner "knife tag batch add|remove TAG SEARCH_QUERY"
+  
+  def run
+    @command = validate_arg(@name_args[0], 'command', /^add$|^remove$/)
+    @tag = validate_arg(@name_args[1],'tag',/[\w-]*/)
+    @search_query = validate_arg(@name_args[2], 'search', /[\w]*:[\w*-]*(\sAND\s|\sOR\s|\sNOT\s)*/)
+    @query_nodes = Chef::Search::Query.new.search('node', @search_query)
+    ui.msg "Search returned #{@query_nodes.last} node(s)"
+    if @query_nodes.last > 0
+			ui.confirm("Execute command \"#{@command}\" with tag #{@tag} on #{@query_nodes.last} node(s)?", append_instructions=true)
+    elsif @query_nodes.last == 0
+      ui.warn('No nodes returned from search')
+    else
+      ui.fatal('Invalid return from search')
+    end
+
+    @query_nodes[0].each do |node|    
+      self.send("#{@command}_tag",node,@tag)
+    end 
+    ui.msg('Operation completed')
+  end
+
+  def add_tag(node, tag)
+    if node.tags.include?(tag)
+      log	= "#{Time.now.getutc}:#{node.name} already has tag \"#{@tag}\""
+    else
+      node.tags << tag
+      unless config[:dry_run]
+        node.save      			
+      end
+      log = "#{Time.now.getutc}:Created tag \"#{@tag}\" on #{node.name}"
+    end
+    if config[:batch_log] 
+      log_node(log) 
+    end  	
+  end
+
+    def remove_tag(node, tag)
+      if node.tags.include?(tag)    	
+    	  node.tags.delete(tag)
+        unless config[:dry_run]
+      	  node.save      			
+        end
+        log = "#{Time.now.getutc}:Removed tag \"#{@tag}\" on #{node.name}"    
+      else
+        log = "#{Time.now.getutc}:The tag \"#{@tag}\" does not exist on #{node.name}"  
+      end	
+      	if config[:batch_log] 
+      		log_node(log) 
+      	end  	      
+    end
+
+    def log_node(str)
+    	log_filename = 'tagBatch.log'
+      File.open(log_filename, 'a') do |file|
+      	file.puts str
+  		end
+    end    
+
+    def validate_arg(arg, type, pattern)
+    	unless arg =~ pattern
+    		show_usage
+    		ui.fatal "Argument #{type}:#{arg} is not valid"
+    		exit 1
+    	end
+    	arg
+    end
+  end
+  end
+end

data/lib/knife-tagbatch/version.rb

@@ -0,0 +1,5 @@
+module CustomChef
+  module KnifeTagBatch
+  VERSION = "0.1.0"
+  end
+end

data/spec/chef/knife/tagbatch_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Knife::Tagbatch do
+  it 'has a version number' do
+    expect(Knife::Tagbatch::VERSION).not_to be nil
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'chef/knife/tagbatch'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: knife-tagbatch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikolas Karavias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add search functionality to the knife tag command
+email:
+- nikolas.karavias@oracle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- knife-tagbatch.gemspec
+- lib/chef/knife/tagbatch.rb
+- lib/knife-tagbatch/version.rb
+- spec/chef/knife/tagbatch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nkaravias/knife-tagbatch
+licenses:
+- GPL-3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Add search functionality to the knife tag command
+test_files:
+- spec/chef/knife/tagbatch_spec.rb
+- spec/spec_helper.rb