cheffish 1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6069dfb9d003c9835d32584227f0db27ead80ffe
-  data.tar.gz: 76efdfb5364249fcb021c569c2ef5c6b07d4c1a6
+  metadata.gz: fd1d356ff0bdaa2531dbf85e2b390ed4396e6527
+  data.tar.gz: 0e7990d44ec9ac64be668886c2efd8973989339e
 SHA512:
-  metadata.gz: efffb6621cd8b3d4993a587bc099949b2bb7e8f19aaf66fb37d18a60c96149bf68d9ba829e7ec4a831ad917497c112403ee4797c1d4db50a8d740ca1ccdafc4b
-  data.tar.gz: 1b0e4bbf57b84a4f98eb223f8dd3993a733808a22ccb88bc553ad7e1d780265dc3563c8d71c5242bc9346e6af4bb4e7954bd645831fb102f071e7846f8f5fe3f
+  metadata.gz: a3d065506dc7daf38dee52868720169f0018af70343a51375d8271eb3c783a4006ce82104a2133806797e5a7af20e98cb77f24fb12f0e863fe94b8fbcb1842e2
+  data.tar.gz: 48c43f52ae0e79a2951640128d4f9040b8f8905b4c702380fb3690fe43399c2929a2177a1661af04b4200bcc8b40dc2b3fc78b70a975f119b880d04fd2d0cee9

data/README.md

@@ -1,4 +1,117 @@
-Cheffish
-========
+# Cheffish
 
-This library lets you manipulate Chef in Chef.
+This library provides a variety of convergent resources for interacting with the Chef Server; along the way, it happens to provide some very useful and sophisticated ways of running Chef resources as recipes in RSpec examples.
+
+**This document may have errors, but it should have enough pointers to get you oriented.**
+
+There are essentially 3 collections here:
+
+## Resource/Provider Pairs for Manipulating Chef Servers
+
+You'd use these in recipes/cookbooks. They are documented on the [main Chef docs site](https://docs.chef.io).
+
+- [chef_acl](https://docs.chef.io/resource_chef_acl.html)
+- [chef_client](https://docs.chef.io/resource_chef_client.html)
+- [chef_container](https://docs.chef.io/resource_chef_container.html)
+- [chef_data_bag](https://docs.chef.io/resource_chef_data_bag.html)
+- [chef_data_bag_item](https://docs.chef.io/resource_chef_data_bag_item.html)
+- [chef_environment](https://docs.chef.io/resource_chef_environment.html)
+- [chef_group](https://docs.chef.io/resource_chef_group.html)
+- [chef_mirror](https://docs.chef.io/resource_chef_mirror.html)
+- [chef_node](https://docs.chef.io/resource_chef_node.html)
+- [chef_organization](https://docs.chef.io/resource_chef_organization.html)
+- [chef_resolved_cookbooks](https://docs.chef.io/resource_chef_resolved_cookbooks.html)
+- [chef_role](https://docs.chef.io/resource_chef_role.html)
+- [chef_user](https://docs.chef.io/resource_chef_user.html)
+- [private_key](https://docs.chef.io/resource_private_key.html)
+- [public_key](https://docs.chef.io/resource_public_key.html)
+
+## Base/Helper Classes
+
+To support the resource/provider pairs.
+
+
+## RSpec Support
+
+Most of these RSpec...things were developed for testing the resource/provider pairs above; *however*, you can also `require cheffish/rspec/chef_run_support` for any RSpec `expect`s you'd like, as we do for `chef-provisioning` and its drivers (especially `chef-provisioning-aws`).
+
+The awesomeness here is that instead of instantiating a `run_context` and a `node` and a `resource` as Ruby objects, you can test your resources in an actual recipe:
+
+```ruby
+when_the_chef_12_server "exists", organization: 'some-org', server_scope: :context, port: 8900..9000 do
+  file "/tmp/something_important.json" do
+    content "A resource in its native environment."
+  end
+end
+```
+
+An enclosing context that spins up `chef-zero` (local mode) Chef servers as dictated by `server_scope`. `Chef::Config` will be set up with the appropriate server URLs (see the `with_*` operators below).
+
+`server_scope`:
+- `:context`
+- `:example` *[default?]*
+- ?
+
+`port`:
+- port number (8900 is the default)
+- port range (server will continue trying up this range until it finds a free port)
+
+```ruby
+expect_recipe {
+  # unquoted recipe DSL here.
+}.to be_truthy    # or write your own matchers.
+```
+
+Converges the recipe using `expect()` (parentheses), which tests for a value and **cannot** be used with `raise_error`.
+
+```ruby
+expect_converge {
+  # unquoted recipe DSL here.
+}.to raise_error(ArgumentException)
+```
+
+Converges the recipe using `expect{ }` (curly brackets), which wraps the block in a `begin..rescue..end` to detect when the block raises an exception; hence, this is **only** for `raise_error`.
+
+The blocks for the following appear to be mostly optional: what they actually do is set the `Chef::Config` variable in the name to the given value, and if you provide a block, the change is scoped to that block. Probably this would be clearer if it were aliased to (and preferring) `using` rather than `with`.
+
+- with_chef_server(server_url, options = {}, &block)
+- with_chef_local_server(options, &block)
+- with_chef_environment(name, &block)
+- with_chef_data_bag_item_encryption(encryption_options, &block)
+- with_chef_data_bag(name)
+  - Takes a block, though this is not noted in the method signature.
+
+
+
+get_private_key(name)
+
+
+### RSpec matchers
+
+These are used with `expect_recipe` or `expect_converge`:
+
+```ruby
+expect_recipe {
+  file "/tmp/a_file.json" do
+    content "Very important content."
+  end
+}.to be_idempotent.and emit_no_warnings_or_errors
+```
+
+`be_idempotent`
+
+- Runs the provided recipe *again* (`expect_(recipe|converge)` ran it the first time) and asks the Chef run if it updated anything (using `updated?`, which appears to be defined on `Chef::Resource` instead of `Chef::Client`, so there's some clarification to be done there); the matcher is satisfied if the answer is "no."
+
+
+`emit_no_warnings_or_errors`
+
+- Greps the Chef client run's log output for WARN/ERROR lines; matcher is satisfied if there aren't any.
+
+`have_updated`
+
+- Sifts the recipe's event stream(!) to determine if any resources were updated; matcher is satisfied is the answer is "yes."
+- This is *not* the opposite of `be_idempotent`.
+
+`partially_match`
+
+- TBD

data/lib/cheffish/chef_run_listener.rb

@@ -20,8 +20,10 @@ module Cheffish
 
     def disconnect
       # Stop the servers
-      node.run_context.cheffish.local_servers.each do |server|
-        server.stop
+      if node.run_context
+        node.run_context.cheffish.local_servers.each do |server|
+          server.stop
+        end
       end
     end
   end

data/lib/cheffish/version.rb

@@ -1,3 +1,3 @@
 module Cheffish
-  VERSION = '1.2'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheffish
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.2.1
 platform: ruby
 authors:
 - John Keiser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-02 00:00:00.000000000 Z
+date: 2015-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-zero
@@ -163,9 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: A library to manipulate Chef in Chef.
 test_files: []
-has_rdoc: