knife-spork 1.7.2 → 1.7.3

data/plugins/Jabber.md

@@ -1,61 +0,0 @@
-Jabber
-=======
-Jabber posts messages to a designated Jabber group chat room.
-
-Gem Requirements
-----------------
-This plugin requires the following gems:
-
-```ruby
-gem 'xmpp4r'
-```
-
-Hooks
------
-- `after_upload`
-- `after_promote`
-
-Configuration
--------------
-```yaml
-plugins:
-  jabber:
-    username: YOURUSER
-    password: YOURPASSWORD
-    nickname: Chef Bot
-    server_name: your.jabberserver.com
-    server_port: 5222
-    rooms:
-      - engineering@your.conference.com/spork
-      - systems@your.conference.com/spork
-```
-
-#### username
-Your Jabber username.
-
-- Type: `String`
-
-#### password
-Your Jabber password.
-
-- Type: `String`
-
-#### nickname
-A nickname to use in the conference room when making announcements.
-
-- Type: `String`
-
-#### server_name
-Your Jabber server name.
-
-- Type: `String`
-
-#### server_port
-Your Jabber server port number. Default: 5222
-
-- Type: `String`
-
-#### rooms
-The list of rooms to post to.
-
-- Type: `Array`

data/plugins/README.md

@@ -1,70 +0,0 @@
-Plugins Directory
-=================
-This folder contains relevant documentation for each KnifeSpork plugin. For more information, usage, and options for an particular plugin, click on the assoicated markdown file in the tree above.
-
-Creating a Plugin
------------------
-To create a plugin, start with the following basic boiler template:
-
-```ruby
-require 'knife-spork/plugins/plugin'
-
-module KnifeSpork
-  module Plugins
-    class MyPlugin < Plugin
-      name :my_plugin
-
-      def perform
-        # your plugin code here
-      end
-    end
-  end
-end
-```
-
-**Don't forget to update the class name and the `name` at the very top of the class!**
-
-Helpers
--------
-The following "helpers" or "methods" are exposed:
-
-#### safe_require
-This method allows you to safely require a gem. This is helpful when your plugin requires an external plugin. It will output a nice error message if the gem cannot be loaded and stop executing.
-
-#### current_user
-This method tries to get the current user's name in the following manner:
-
-1. From the git configuration
-2. From the `ENV`
-
-#### config
-This method returns the config associated with the current plugin. For example, if a `spork-config.yml` file looked like this:
-
-```yaml
-plugins:
-  my_plugin:
-    option_1: my_value
-    option_2: other_value
-```
-
-then
-
-```text
-config.option_1   #=> 'my_value'
-config.option_2   #=> 'other_value'
-```
-
-This uses `app_conf`, so you access the keys are methods, not `[]`.
-
-#### cookbooks
-This returns an array of `Chef::CookbookVersion` objects corresponding to the cookbooks that are being changed/altered in the hook. For more information on the methods avaliable, see the [file in the Chef repo](https://github.com/opscode/chef/blob/master/chef/lib/chef/cookbook_version.rb).
-
-#### environments
-This returns an array of `Chef::Environment` objects corresponding to the environments that are being changed/altered in the hook. For more information on the methods avaliable, see the [file in the Chef repo](https://github.com/opscode/chef/blob/master/chef/lib/chef/environment.rb).
-
-#### environment_diffs
-This returns a Hash of Hash objects containing a diff between local and remote environment for each environment changed/altered in the hook. Currently, this will only be populated during the promotea action. 
-
-
-#### ui
-This returns a `Chef::Knife::UI` element for outputting to the console. For more information on the methods avaliable, see the [file in the Chef repo](https://github.com/opscode/chef/blob/master/chef/lib/chef/knife/core/ui.rb).

data/plugins/Rubocop.md

@@ -1,110 +0,0 @@
-Rubocop
-==========
-Automatically runs rubocop (or [cookstyle](https://github.com/chef/cookstyle) - its chef-focused brother) against your cookbooks on check and upload.
-This is entirely based off of the Foodcritic plugin.
-
-Gem Requirements
-----------------
-This plugin requires the following gems:
-
-```ruby
-gem 'rubocop'
-gem 'cookstyle' # if you wish to use cookstyle behaviour
-```
-
-Hooks
------
-- `after_check`
-- `before_upload`
-
-Configuration
--------------
-```yaml
-plugins:
-  rubocop:
-    epic_fail: true
-    show_name: false
-    autocorrect: false
-    out_file: <file>
-    sev_level: <C|W|E>
-    lint: false
-    use_cookstyle: true
-```
-
-#### epic_fail:
-If set to true, `epic_fail` will prevent you from uploading a cookbook or further checks from running until rubocop passes.
-- Type: `Boolean`
-- Default: `true`
-
-#### The following options are passing command line options to rubocop.  See rubocop --help for more details
-#### show_name:
-- Type: `Boolean`
-- Default: `false`
-- Rubocop command line equivilant: "-D"
-Shows the name of the offending rule as well as the decription and line reference.
-
-#### autocorrect:
-- Type: `Boolean`
-- Default: `false`
-- Rubocop command line equivilant: "--auto-correct"
-Automatically correct some offenses.
-
-#### out_file:
-- Type: `String` - file name
-- Default: nil
-- Rubocop command line equivilant: "--out <file>"
-Redirects the rubocop output to a file instead of STDOUT.
-
-#### sev_level:
-- Type: `String`
-- Default: nil
-- Rubocop command line equivilant: "--fail-level [C|W|E]"
-Set the severity level at which Rubocop will fail (see rubocop --help for more).
-
-#### lint:
-- Type: `Boolean`
-- Default: `false`
-- Rubocop command line equivilant: "--lint"
-Only run linting rules.
-
-#### use_cookstyle:
-- Type: `Boolean`
-- Default: `false`
-- Rubocop command line equivilant: none, use `cookstyle` command instead of `rubocop` command
-Cookstyle is a set of rubocop configurations that are specific to cookbooks.
-
-#### Example
-``` ruby
-chef_workstation01$ knife spork check chef-client
-Checking versions for cookbook chef-client...
-
-Local Version:
-  3.3.3
-
-Remote Versions: (* indicates frozen)
-  3.3.3
-  3.2.0
-
-ERROR: The version 3.3.3 exists on the server and is not frozen. Uploading will overwrite!
-Running rubocop against chef-client@3.3.3...
-/home/chef-repo/cookbooks/chef-client
-Inspecting 25 files
-....CCCCC.CWCCCCCWCCCWCCC
-
-Offenses:
-
-chef-client/files/default/tests/minitest/config_test.rb:22:53: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.
-    file(File.join(node['chef_client']['conf_dir'], "client.rb")).must_exist
-                                                    ^^^^^^^^^^^
-chef-client/libraries/helpers.rb:35:72: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.
-          Chef::Log.debug("Node has Chef Server Recipe? #{node.recipe?("chef-server")}")
-                                                                       ^^^^^^^^^^^^^
-chef-client/libraries/helpers.rb:36:70: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.
-          Chef::Log.debug("Node has Chef Server Executable? #{system("which chef-server > /dev/null 2>&1")}")
-                                                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-chef-client/libraries/helpers.rb:37:74: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.
-          Chef::Log.debug("Node has Chef Server Ctl Executable? #{system("which chef-server-ctl > /dev/null 2>&1")}")
-                                                                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-...
-
-```

data/plugins/Slack.md

@@ -1,48 +0,0 @@
-Slack
-=======
-Slack posts messages to your Slack client.
-
-Gem Requirements
-----------------
-This plugin requires the following gems:
-
-```ruby
-gem 'slack-notifier'
-```
-
-Hooks
------
-- `after_upload`
-- `after_promote`
-
-Configuration
--------------
-```yaml
-plugins:
-  slack:
-    webhook_url: https://hooks.slack.com/services/AABBCC
-    channel: "#operations"
-    teamname: myteam
-    username: knife
-```
-
-#### api_token
-Your Slack Webhook URL.
-
-- Type: `String`
-
-#### channel
-The channel to post to.
-
-- Type: `String`
-
-
-#### username
-The username to post as.
-
-- Type: `String`
-
-#### icon_url
-The url for icon. ex. https://example.com/image.jpg, default: nil
-
-- Type: `String`

data/plugins/StatusNet.md

@@ -1,41 +0,0 @@
-StatusNet
-=======
-StatusNet posts messages to a your StatusNet instance
-
-Gem Requirements
-----------------
-This plugin requires the following gems:
-
-```ruby
-gem 'curb'
-```
-
-Hooks
------
-- `after_upload`
-- `after_promote`
-
-Configuration
--------------
-```yaml
-plugins:
-  statusnet:
-    url: YOUR INSTANCE API URL
-    username: YOURUSER
-    password: YOURPASSWORD
-```
-
-#### url
-Your StatusNet instance API url, usually server url + /api/statuses/update.xml
-
-- Type: `Srtring`
-
-#### username
-Your StatusNet username.
-
-- Type: `String`
-
-#### password
-Your StatusNet password.
-
-- Type: `String`

data/plugins/Template.md

@@ -1,34 +0,0 @@
-Plugin Name
-===========
-Here is an optional, short description about your plugin.
-
-Gem Requirements
-----------------
-This plugin requires the following gems:
-
-```ruby
-gem 'my_gem', '~> 1.4.5'
-gem 'other_gem', '>= 5.0.1'
-```
-
-Hooks
------
-- `after_promote`
-
-Configuration
--------------
-```yaml
-plugins:
-  plugin_name:
-    option_1: true
-    option_2:
-      - a
-      - b
-      - c
-```
-
-#### option_1
-This is a description of the option.
-
-- Type: `String`
-- Default: `ABC`

data/spec/spec_helper.rb

@@ -1,10 +0,0 @@
-require 'test_helpers'
-
-RSpec.configure do |c|
-  c.include TestHelpers
-  c.expect_with :rspec do |config|
-    config.syntax = [:should, :expect]
-  end
-  c.filter_run :focus => true
-  c.run_all_when_everything_filtered = true
-end

data/spec/test_helpers.rb

@@ -1,46 +0,0 @@
-require 'fileutils'
-require 'tmpdir'
-
-module TestHelpers
-  def tempdir
-    @tmpdir ||= Dir.mktmpdir("knife-spork")
-    File.realpath(@tmpdir)
-  end
-
-  def fixtures_path
-    File.expand_path(File.dirname(__FILE__) + "/unit/fixtures/")
-  end
-
-  def cookbook_path
-    File.expand_path('cookbooks', tempdir)
-  end
-
-  def environment_path
-    File.expand_path('environments', tempdir)
-  end
-
-  def stdout
-    stdout_io.string
-  end
-
-  def set_chef_config
-    knife.config[:chef_repo_path] = tempdir
-    knife.config[:cookbook_path] = File.join(tempdir, 'cookbooks')
-    knife.config[:environment_path] = File.join(tempdir, 'environments')
-    knife.config[:chef_server_url] = "http://localhost:4000"
-    knife.config[:client_key] = File.join(tempdir, 'test_client.pem')
-    knife.config[:client_name] = "test-client"
-    knife.config[:node_name] = "test-node"
-    knife.config[:cache_type] = 'BasicFile'
-    knife.config[:cache_options] = {:path =>  File.join(tempdir, 'checksums')}
-  end
-
-
-  def copy_test_data
-    FileUtils.cp_r "#{fixtures_path}/.", tempdir
-  end
-
-  def cleanup_test_data
-    FileUtils.rm_r Dir.glob("#{tempdir}/*")
-  end
-end

data/spec/unit/fixtures/config/spork-config.yml

@@ -1 +0,0 @@
-plugins:

data/spec/unit/fixtures/cookbooks/example/metadata.rb

@@ -1,8 +0,0 @@
-name             "example"
-maintainer       "Jon Cowie"
-maintainer_email "jonlives@gmail.com"
-license          "All rights reserved"
-description      "Test cookbook for knife-spork"
-long_description "Test cookbook for knife-spork"
-version "0.0.1"
-

data/spec/unit/fixtures/environments/example.json

@@ -1,12 +0,0 @@
-{
-  "name": "example",
-  "description": "This is an example environment",
-  "cookbook_versions": {
-  },
-  "json_class": "Chef::Environment",
-  "chef_type": "environment",
-  "default_attributes": {
-  },
-  "override_attributes": {
-  }
-}