knife-syntax-check 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd958ad4bc92747d2898c277d05f993f0567e2a2
+  data.tar.gz: 99f7083bdd67246c0c47e6e946c701f80dae7d9b
+SHA512:
+  metadata.gz: 8dec8d8f4962ef0c244f80fbcfbc2455e9954965f4dce7ccb62a1d56871773ccc18fbc9fd6b4276e0b1ff44ccab26a585a191a0c4e47479b51a3aab98614a603
+  data.tar.gz: a9e45c9a83e45bbf0f725b3ba2ad80b5ca641a9c5bee8fafdf17fd30b66fb5dd4084801c54d8cf53b2bc3f2c4e91dc6a27e9d55cdfc44d8e14dab100088b361f

data/README.md

@@ -0,0 +1,51 @@
+knife-syntax-check
+==============
+
+A small knife plugin to allow you to easily syntax check your ruby and/or json code for your cookbooks, roles, environments, databags, and nodes. 
+
+Usage
+=====
+
+<pre>
+$ knife syntax-check --help
+knife syntax-check
+    -a, --all                        Test syntax of all roles, environments, nodes, databags and cookbooks
+    -c, --cookbooks                  Test only cookbook syntax
+    -D, --databags                   Test only databag syntax
+    -e, --environments               Test only environment syntax
+    -n, --nodes                      Test only node syntax
+    -r, --roles                      Test only role syntax
+</pre>
+
+Installation
+============
+
+Simply copy the syntax-check.rb [script to your .chef/plugins/knife/ folder](http://wiki.opscode.com/display/chef/Knife+Plugins).
+Depends on the ['yajl-ruby' gem](https://github.com/brianmario/yajl-ruby) for json syntax checking.
+
+How it works
+============
+
+Basically this plugin just piggy backs on existing knife commands when checking cookbooks.
+
+However for nodes, environments, roles, and databags, syntax is checked as follows:
+* JSON - checked using the yajl-ruby gem
+* Ruby - checked using the 'ruby -c' command
+
+Disclaimer
+==========
+
+This has ONLY been tested against hosted chef.  Bugs may and probably do exist.  If you find a bug or want a feature, please feel free to contact me or fork the repo, fix it yourself and issue a pull request.
+
+License
+=======
+
+MIT
+
+Copyright (C) 2013 Chris Doughty cdoughty77@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/knife-syntax-check.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name         = 'knife-syntax-check'
+  s.version      = '0.0.1'
+  s.authors      = ['Chris Doughty']
+  s.email        = ['cdoughty77@gmail.com']
+  s.homepage     = 'https://github.com/cdoughty77/knife-syntax-check'
+  s.summary      = %q{Chef Knife plugin to check Ruby file syntax}
+  s.description  = s.summary
+  s.license      = 'MIT/BSD'
+
+  s.files        = `git ls-files`.split("\n")
+
+  s.add_dependency 'yajl-ruby', '~> 1.2.0'
+
+  s.require_paths = ['lib']
+end
+
+

data/lib/chef/knife/syntax-check.rb

@@ -0,0 +1,107 @@
+require 'chef/knife'
+
+module KnifePlugin
+  class SyntaxCheck < Chef::Knife
+
+    banner "knife syntax-check"
+
+    option :environments,
+      :short => '-e',
+      :long => '--environments',
+      :boolean => true,
+      :description => "Test only environment syntax"
+    option :roles,
+      :short => '-r',
+      :long => '--roles',
+      :boolean => true,
+      :description => "Test only role syntax"
+    option :nodes,
+      :short => '-n',
+      :long => '--nodes',
+      :boolean => true,
+      :description => "Test only node syntax"
+    option :databags,
+      :short => '-D',
+      :long => '--databags',
+      :boolean => true,
+      :description => "Test only databag syntax"
+    option :cookbooks,
+      :short => '-c',
+      :long => '--cookbooks',
+      :boolean => true,
+      :description => "Test only cookbook syntax"
+    option :all,
+      :short => '-a',
+      :long => '--all',
+      :boolean => true,
+      :description => "Test syntax of all roles, environments, nodes, databags and cookbooks"
+
+    deps do
+      require 'yajl'
+      require 'pathname'
+    end
+
+    def run 
+      if config[:roles] 
+        test_object("roles/*", "role")
+      elsif config[:environments]
+        test_object("environments/*", "environment")
+      elsif config[:nodes]
+        test_object("nodes/*", "node")
+      elsif config[:databags]
+        test_databag("data_bags/*", "data bag")
+      elsif config[:cookbooks]
+        test_cookbooks()
+      elsif config[:all]
+        test_object("roles/*", "role")
+        test_object("environments/*", "environment")
+        test_object("nodes/*", "node")
+        test_databag("data_bags/*", "data bag")
+        test_cookbooks()
+      else
+        ui.msg("Usage: knife syntax-check --help")
+      end 
+    end 
+
+    # Test all cookbooks
+    def test_cookbooks()
+      ui.msg("Testing all cookbooks...")
+      result = `knife cookbook test --all`
+      ui.msg(result)
+    end
+
+    # Test object syntax
+    def test_object(dirname,type)
+      ui.msg("Finding type #{type} to test from #{dirname}")
+      check_syntax(dirname,nil,type)
+    end 
+
+    # Test databag syntax
+    def test_databag(dirname, type)
+      ui.msg("Finding type #{type} to test from #{dirname}")
+      dirs = Dir.glob(dirname).select { |d| File.directory?(d) }
+      dirs.each do |directory|
+        dir = Pathname.new(directory).basename
+        check_syntax("#{directory}/*", dir, type)
+      end 
+    end
+
+    # Common method to test file syntax
+    def check_syntax(dirpath, dir = nil, type)
+      files = Dir.glob("#{dirpath}").select { |f| File.file?(f) }
+      files.each do |file|
+        fname = Pathname.new(file).basename
+        if ("#{fname}".end_with?('.json'))
+          ui.msg("Testing file #{file}")
+          json = File.new(file, 'r')
+          parser = Yajl::Parser.new
+          hash = parser.parse(json)
+        elsif("#{fname}".end_with?('.rb'))
+          ui.msg("Testing file #{file}")
+          result = `ruby -c #{file}`
+        end 
+      end 
+    end
+
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: knife-syntax-check
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Doughty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Chef Knife plugin to check Ruby file syntax
+email:
+- cdoughty77@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- knife-syntax-check.gemspec
+- lib/chef/knife/syntax-check.rb
+homepage: https://github.com/cdoughty77/knife-syntax-check
+licenses:
+- MIT/BSD
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Chef Knife plugin to check Ruby file syntax
+test_files: []