knife-essentials 0.1

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.rdoc

@@ -0,0 +1,114 @@
+== Knife Essentials
+
+= DESCRIPTION:
+
+knife-essentials provides a number of useful knife commands that allow you
+to manipulate Chef using a common set of verbs that work on *everything*
+that is stored in the Chef server.
+
+   knife diff cookbooks/*apache*
+   knife list data_bags/users
+   knife show roles/*base*
+
+The plugin is in early days: more verbs will be added as time goes by, including
++edit+, +delete+, +upload+ and +download+.
+
+= PRINCIPLES
+
+* Unified commands that work on everything
+
+knife-essentials thinks verbs come first.  There are only a few things you need to do with
+pretty much everything in the system: you upload them, download them, look at
+them, edit them, list them, diff them, and delete then.
+
+knife-essentials provides a number of verb commands: +knife diff roles+ and +knife list roles+
+among them.  These commands work on all types of objects, as well.  You can type
++knife diff roles+, or +knife diff data_bags/users/jkeiser.json+.
+
+* Treat the Chef server is like your filesystem
+
+knife-essentials treats the Chef server like a mirror of a Chef repository.  Most of the
+stuff you do with the Chef Server is based on your local repository--a set of files
+in directories like +roles+, +data_bags+, +cookbooks+, etc.  The Chef Server has
+objects that match them--in fact, you can upload and download the files on your
+filesystem to change the file server.
+
+This makes learning the knife commands easy, and makes important commands like
+diff, upload and download extremely simple to do and easy to understand.
+
+* Take context into account
+
+When you're in the +roles+ directory, the system knows that's what you are
+working with.  Just type +knife show base.json+ and it will show you the base
+role from the server.  knife-essentials knows.
+
+= INSTALLATION:
+
+This plugin builds a Ruby Gem (but has not yet been released to RubyGems).  To install it, run:
+
+    rake install
+
+= KNIFE PLUGINS
+
+chef_fs installs a number of useful knife verbs, including:
+
+    knife diff [pattern1 pattern2 ...]
+    knife list [pattern1 pattern2 ...]
+    knife show [pattern2 pattern2 ...]
+
+These commands will list data on the server, exactly mirroring
+the data in a local Chef repository. So if you type +knife diff data_bags/*s+,
+it will diff all data bags that end with +s+.
+
+The commands are also context-sensitive. If you are in the ++roles++ directory
+and type +knife show *base*+, you will get the current Chef server contents of all
+roles that contain the word +base+ in them.
+
+The Knife commands generally run off file patterns (globs you can type on the
+command line).  Patterns can include *, ?, ** and character matchers like
+[a-z045].
+
+== Prerequisites
+
+To run the knife plugin functionality, install a version of Chef > 0.10.10:
+
+    gem install chef
+
+== knife diff
+
+    knife diff [pattern1 pattern2 ...]
+
+Diffs objects on the server against files in the local repository.  Output is similar to
++git diff+.
+
+== knife list
+
+    knife list [pattern1 pattern2 ...]
+
+Works just like 'ls', except it lists files on the server.
+
+== knife show
+
+    knife show [pattern1 pattern2 ...]
+
+Works just like +knife node show+, +knife role show+, etc. except there is One Verb To Rule
+Them All.
+
+== NOTE
+
+Since these patterns are also interpreted by the shell in Unix,
+you will need to backslash them if you want these knife commands to actually
+look at the server.  For example, if you want to list all data bags starting
+with "a" on the server, you can do
+
+    knife list data_bags/a\*
+
+If you do this instead, the shell will expand the pattern before passing it to knife:
+
+    knife list data_bags/a*
+
+Expands to the list of data bags on your local filesystem:
+
+    knife list data_bags/aardvarks data_bags/anagrams
+
+But this means that if the server has a data bag named +arp_tables+, you won't see it.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler'
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+gem_spec = eval(File.read("knife-essentials.gemspec"))
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "chef_fs #{gem_spec.version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/chef/knife/diff.rb

@@ -0,0 +1,28 @@
+require 'chef_fs/knife'
+require 'chef_fs/command_line'
+
+class Chef
+  class Knife
+    class Diff < ChefFS::Knife
+      banner "diff PATTERNS"
+
+      option :recurse,
+        :long => '--[no-]recurse',
+        :boolean => true,
+        :default => true,
+        :description => "List directories recursively."
+
+      def run
+        patterns = pattern_args_from(name_args.length > 0 ? name_args : [ "" ])
+
+        # Get the matches (recursively)
+        patterns.each do |pattern|
+          ChefFS::CommandLine.diff(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1) do |diff|
+            puts diff
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/chef/knife/list.rb

@@ -0,0 +1,107 @@
+require 'chef_fs/knife'
+require 'chef_fs/file_system'
+
+class Chef
+  class Knife
+    class List < ChefFS::Knife
+      banner "list [-dR] [PATTERN1 ... PATTERNn]"
+
+      option :recursive,
+        :short => '-R',
+        :boolean => true,
+        :description => "List directories recursively."
+      option :bare_directories,
+        :short => '-d',
+        :boolean => true,
+        :description => "When directories match the pattern, do not show the directories' children."
+
+      def run
+        patterns = name_args.length == 0 ? [""] : name_args
+
+        # Get the matches (recursively)
+        results = []
+        dir_results = []
+        pattern_args_from(patterns).each do |pattern|
+          ChefFS::FileSystem.list(chef_fs, pattern) do |result|
+            if result.dir? && !config[:bare_directories]
+              dir_results += add_dir_result(result)
+            elsif result.exists?
+              results << result
+            elsif pattern.exact_path
+              STDERR.puts "#{format_path(result.path)}: No such file or directory"
+            end
+          end
+        end
+
+        results = results.sort_by { |result| result.path }
+        dir_results = dir_results.sort_by { |result| result[0].path }
+
+        if results.length == 0 && dir_results.length == 1
+          results = dir_results[0][1]
+          dir_results = []
+        end
+
+        print_result_paths results
+        dir_results.each do |result, children|
+          puts ""
+          puts "#{format_path(result.path)}:"
+          print_results(children.map { |result| result.name }.sort, "")
+        end
+      end
+
+      def add_dir_result(result)
+        begin
+          children = result.children.sort_by { |child| child.name }
+        rescue ChefFS::FileSystem::NotFoundException
+          STDERR.puts "#{format_path(result.path)}: No such file or directory"
+          return []
+        end
+
+        result = [ [ result, children ] ]
+        if config[:recursive]
+          children.each do |child|
+            if child.dir?
+              result += add_dir_result(child)
+            end
+          end
+        end
+        result
+      end
+
+      def list_dirs_recursive(children)
+        results = children.select { |child| child.dir? }.to_a
+        results.each do |child|
+          results += list_dirs_recursive(child.children)
+        end
+        results
+      end
+
+      def print_result_paths(results, indent = "")
+        print_results(results.map { |result| format_path(result.path) }, indent)
+      end
+
+      def print_results(results, indent)
+        return if results.length == 0
+
+        print_space = results.map { |result| result.length }.max + 2
+        # TODO: tput cols is not cross platform
+        columns = $stdout.isatty ? Integer(`tput cols`) : 0
+        current_column = 0
+        results.each do |result|
+          if current_column != 0 && current_column + print_space > columns
+            puts ""
+            current_column = 0
+          end
+          if current_column == 0
+            print indent
+            current_column += indent.length
+          end
+          print result + (' ' * (print_space - result.length))
+          current_column += print_space
+        end
+        puts ""
+      end
+    end
+  end
+end
+