CHANGELOG.md

CHANGELOG for ChefSpec

4.7.0 (May 13, 2016)

IMPROVEMENTS

• Support Chef Solo actually being local mode (per Chef RFC 31)

4.6.1 (March 29, 2016)

BUG FIXES

• Use the same Chef :file_cache_path in every ChefSpec converge to prevent large numbers of LWRP deprecation warnings
• Require Fauxhai ~3.2 to prevent ChefSpec spec failures
• Require Rake < 11.0 to prevent failures

4.6.0 (March 7, 2016)

IMPROVEMENTS

• Add support for adding berkshelf_options to the RSpec config
• Add chocolately_package matches
• Support do..end style syntax in block expectations
• Output a diff when multi-line resource parameters are unmatched

BUG FIXES

• Update tests to include better descriptions and feature names
• Add support for Policyfile workflow

4.5.0 (December 4, 2015)

IMPROVEMENTS

• Update Fauxhai dependency to 3.0 to bring in newly generated mocked Ohai data

4.4.0 (September 18, 2015)

BUG FIXES

• Documentation improvements (using regex in stubbed commands, chef 12+ custom matcher gotchas)
• Spec suite improvements (dsc resource specs, platform specific configurations)
• Chef 12+ platform specific resource loading related error

IMPROVEMENTS

• Support for policy files

4.3.0 (July 16, 2015)

BUG FIXES:

• Improved documentation
• Use TemplateContext's _extend_modules for passing on template helper modules to nested partial templates
• Only exit if the status is a failure [GH-565]
• Fix load order on Windows when using the rights attributes
• Improve testing matrix and remove deprecated Chef versions
• Suppress chef_gem compile_time warnings
• Fix exceptions on converge for Chef 12.1.0 masking
• Update Librarian Cheffile site URL to supermarket.chef.io
• Filter Windows and Unix paths for test coverage report with Berkshelf

IMPROVEMENTS:

• Added possibility to specify file_cache_path globally
• Added new capabilities for reboot resource
• Use Chef::Resource#declared_type first if available (Chef >= 12), otherwise fall back to Chef::Resource#resource_name (Chef <= 11)
• Extend render_file to yield the content as a block
• Add windows_service resource

4.2.0 (December 25, 2014)

BUG FIXES:

• Updated README grep examples
• Fix various typographical errors
• Improved error message when using a deprecated resource matcher

IMPROVEMENTS:

• Add support for Chef 12
• Added support for environments in Chef Solo
• Fix location definition for caching
• Allow passing Chef::Config[:file_cache_path] from outside
• Update support for Chef 12

4.1.1 (October 13, 2014)

BUG FIXES:

• Fix total fail on my part with deprecations and add test coverage
• Do not validate cookbooks on upload (speed)

4.1.0 (October 12, 2014)

BUG FIXES:

• Bump the minimum required version of Chef to 11.14
• Filter resources that have no source line in the coverage report - this is related to a bug in Chef where, when cloning a resource, both the clone and the original resource lose their metadata

IMPROVEMENTS:

• Allow multiple instances of a Chef Server instance
• Separate ChefSpec::Runner into ChefSpec::SoloRunner and ChefSpec::ServerRunner
• Preliminary support for Chef 12 alpha (not 100% complete)
• Add SoloRunner and ServerRunner .converge methods for quickly converging if you do not need to customize the runner object
• Create isolated Chef Server instances on a per-test or per-suite basis
• Deprecate ChefSpec::Runner.define_runner_method in favor of ChefSpec.define_matcher
• Deprecate ChefSpec::Runner.new - you should specify if you want a SoloRunner or ServerRunner
• Updated documentation

BREAKING CHANGES:

• Due to the new ServerRunner, the ChefSpec::Server singleton object has been deprecated. As much as I would like to provide a backwards-compatible interface, there is no way to do so (as the code now supports multiple Chef Server instances). Sorry :(.
• Remove old deprecations - this is not really a breaking change, but the v2.0.0 deprecations have been removed in favor of new ones

4.0.2 (August 13, 2014)

BUG FIXES:

• Fix a regression caused by a new version of Chef Zero in single_org mode

IMPROVEMENTS:

• Test against Chef 11.14.0 in the Travis matrix

4.0.1 (June 27, 2014)

BUG FIXES:

• Fix class comparisons
• Update ChefZero API to work again
• Use proper cookbook in the template_finder
• Fix Ruby deprecations
• Various documentation updates

4.0.0 (June 2, 2014)

BREAKING CHANGES:

• Upgraded to RSpec 3! RSpec 3 brings many new API changes and syntaxes
• Bump minimum required Chef version to 11.12! Without this change, Chef Zero will blow up

BUG FIXES:

• Gracefully fail if a resource does not report it's source line in the reporter
• Pull the correct cookbook folder from the stack on Windows (88bfc6)
• Cover resources in render_file matchers for reporting
• Cover resources in link_to matchers for reporting
• Cover resources in do_nothing matchers for reporting
• Fix memory leak in LWRP Resource classes
• Restore the original cookbook_path when using librarian-chef
• Documentation fixes
• Disable lazy loading of cached resources
• Fix a bug that will happen in later Chef versions because FreeBSD is evil (13ff143)
• Do not pass local file paths to preferred_filename_on_disk_location

FEATURES:

• Add runner methods for all the bash, csh, perl, etc resources
• Upgraded fauxhai dependency and specs
• Upgrade Chef Zero for multi-org support

IMPROVEMENTS:

• Improved documentation around the define_runner_method method
• Update badges to be all SVG
• Test on Ruby 2.1
• Use a randomly assigned port for Chef Zero
• Remove references to .stub from documentation

3.4.0 (March 16, 2014)

BUG FIXES:

• Restore Berkshelf 2 support (missing edge case)
• Add negative failure message for subscribes/notifies matchers

FEATURES:

• Added do_nothing matcher for asserting a resource performed no actions

IMPROVEMENTS:

• Increased spec coverage for matchers
• Support RSpec matchers in with_content

3.3.1 (March 11, 2014)

BUG FIXES:

• Various typographical fixes in the README
• Remove unused JSON report
• Restore coverage reporting for Berkshelf 2 users
• Minor formatting changes for errors

IMPROVEMENTS:

• Remove dependency on i18n and use native ERB instead
• Vendor Berkshelf/Librarian in a "cookbooks" directory so we can shorten the pathname during coverage reporting

3.3.0 (March 9, 2014)

BUG FIXES:

• Update documentation for setting automatic attributes
• Update documentation for stubbing data_bags
• Use a non-internal RSpec variable name for expecting exceptions
• Fix the airity of the stub_node method

IMPROVEMENTS:

• Better filtering protocols for resource coverage

3.2.0 (January 31, 2014)

BUG FIXES:

• Fix coverage calculation when there are no resources in the collection
• Fix misplaced quote in matcher output
• Include all files in generated gem
• Ensure compatibility with Chef HEAD

IMPROVEMENTS:

• Test Ruby 2.1 on Travis
• Miscellaneous README typos
• Add subscribe_to matchers
• Add documentation for the with matcher
• Add support for passing a node object directly to the server create_node method

3.1.4 (January 3, 2014)

BUG FIXES:

• Correctly expand the node's run_list in server mode
• Actually package i18n translations with the cookbook

IMPROVEMENTS:

• Document setting a node's role
• Add examples and features for stub_node

3.1.3 (January 2, 2014)

BUG FIXES:

• Fix broken deprecations module
• Update a broken test (@bknowles)

IMPROVEMENTS:

• Better gem description on GitHub and Rubygems
• Helper support for template rendering (Chef 11.4+) (@geraud)

3.1.2 (December 30, 2013)

BUG FIXES:

• Require i18n 0.6.9 or higher (but less than 1.0.0) (#289)

3.1.1 (December 29, 2013)

BUG FIXES:

• Handle duplicate resources in the coverage reporter

3.1.0 (December 29, 2013)

BUG FIXES:

• Only remove existing LWRP resources and providers when a new one is encountered (@student)
• Attempt to coerce dashes to underscores in LWRPs
• Various documentation fixes and typos

IMPROVEMENTS:

• Don't include deprecations module by default
• Add examples for stubbing commands across recipes
• Yield a block after cookbooks are compiled but before they are converged (@rteabeault)
• Add IRC Channel #chefspec
• Raise a nice error when cookbook_path cannot be determined (@ryotarai)

FEATURES:

• Add support for Librarian (@mlafeldt)
• Add Cacher module for caching runner results (@sethvargo & @DracoAter)
• Add Chef Zero (server) mode (@sethvargo)
• Add basic resource reporting (Chef recipe code coverage) (@sethvargo)
• Use i18n (internationalization) (@sethvargo)

3.0.2 (November 6, 2013)

BUG FIXES:

• Update links to point at new repository location
• Deleted relish docs to remove confusion
• Bump fauxhai dependency to 2.0 (removing the HTTParty transitive dependency)
• Convert resource names with dashes to underscores when stepping into them

IMPROVEMENTS:

• Added a "what people are saying" section to the README - if you have something cool to say about ChefSpec, let me know!
• Add a link to knife-spec
• Test against Chef 11.8
• New matcher: have_state_attrs for testing custom LWRP state attributes
• Run tests in a sandboxed parent instead of tmp (makes Travis happier)

3.0.1 (October 22, 2013)

BUG FIXES:

• Fix an issue where LWRPs were not properly stepped into when use_inline_resources was specified (#244)
• Coerce render_file @expected_content to a string before asserting if content is included (#243)

IMPROVEMENTS:

• Miscellaneous documentation fixes and additions (#245, #241, #238)

3.0.0 (October 20, 2013)

Breaking:

• Dropped support for Chef 9 & 10
• Renamed ChefSpec::ChefRunner to ChefSpec::Runner to better reflect what happens in Chef Core. Using ChefRunner will throw deprecation errors for now and will be removed in a future release.
• Removed MiniTest Chef Handler examples/matchers
• No longer load default cookbook paths:
  • vendor/cookbooks
  • test/cookbooks
  • test/integration (test kitchen)
  • spec/cookbooks
• Resource matchers all follow the pattern "(action)_(resource_name)". ChefSpec will warn you of these deprecations in 3.0. They will be removed in 4.0. However, some resources cannot be automatically converted - these resources will raise a deprecation exception of ChefSpec::NoConversionError. The following matchers have changed:
  • execute_command => run_execute
  • set_service_to_start_on_boot => enable_service
  • create_file_with_content => render_file
  • execute_(script) => run_(script)
  • execute_ruby_block => run_ruby_block
  • install_package_at_version => install_package().with(version: '')
  • *_python_pip => (removed - see "Packaging Custom LWRPs in the README")
• Remove dependency on Erubis
• Remove dependency on MiniTest Chef Handler
• Remove development dependency on Cucumber
• Remove development dependency on i18n
• Remove development dependency on simplecov
• Separate package matchers. In prior versions of ChefSpec, the package matcher would match on any kind of package and any kind of package action. However, some subclasses of the package resource do not support all actions. Each package provider now has it's own matcher with only the actions it supports. Prior specs that used the generic package matcher will no longer match on subclasses - you must use the specific subclass matcher.
• Separate file/cookbook_file/template matchers. In prior versions of ChefSpec, the file matcher would match on file, cookbook_file, and template. This is not ideal because it doesn't verify the correct message was sent. Now, file, cookbook_file, and template matchers will only match resources of that type. For generic file checking, please use the new render_file matcher.
• Guards are now evaluated by default. If a shell guard is executed, it must first be stubbed with the stub_command macro.
• Runner#resources converted from an Array to a Hash. This is to ensure that all resource actions are added (when multiple calls to run_action exist (#201)). This also drastically improves resource lookup times.
• Resource#actions is no longer maniuplated. Instead, a new method Resource#performed_actions now keeps track of the actions taken on a resource (as well as the phase in which they were taken), preserving the original state of the resource.

FEATURES:

• Added a new render_file action to replace create_file_with_content. This matcher will render the contents of any file to a string and then optionally compare the result if given a with chainable.
• All resources now accept a with chainable for matching specific resource attributes.
• Windows attributes are now testable on non-Windows systems (like inherits)
• Added batch resource matchers
• Added cookbook_file resource matchers
• Added deploy resource matchers
• Added erl_call resource matchers
• Added git resource matchers
• Added http_request resource matchers
• Added ifconfig resource matchers
• Normalized link resource matchers
• Added log resource matchers
• Added mdadm resource matchers
• Added mount resource matchers
• Added :immediate and :delayed notification matchers
• Added ohai resource matchers
• Added powershell_script matchers (Chef 11.6+)
• Added registry_key matchers
• Added remote_directory matchers
• Added route matchers
• Added subversion matchers
• Added stub_command macro (formerly on ChefSpec::ChefRunner) for stubbbing the results of shell commands. Because shell commands are evaluated by default, ChefSpec will raise an exception when encountering a shell command that has not been stubbed.
• Added stub_search macro for easily stubbing search calls. Like shell commands, ChefSpec will raise an exception when encountering a search call that has not been stubbed.
• Added stub_data_bag macro for easily stubbing data_bag calls. Like shell commands, ChefSpec will raise an exception when encountering a data_bag call that has not been stubbed.
• Added stub_data_bag_item macro for easily stubbing data_bag_item calls. Like shell commands, ChefSpec will raise an exception when encountering a data_bag_item call that has not been stubbed.
• Added stub_node helper for quickly generating a node object from Fauxhai data
• Added ChefSpec::Runner#apply command to mimic the behavior of chef-apply (use with caution)
• Share the ChefSpec::Runner object with the Node object
• Add chefspec/berkshelf for easily integrating specs with Berkshelf (2 & 3)
• Add .at_compile_time and .at_converge_time matchers for asserting which phase of the Chef run a resource should be run

IMPROVEMENTS:

• Move to inline documentation (Yard)
• Implement InProcess Aruba testing for ultra-fast tests
• Create "examples" directory for testing and demonstration
• Unified all failure_messages_for_should
• Use shared_examples for easily testing defined custom matchers
• Infer the cookbook_path from the calling spec
• Directly set node attributes with Fauxhai (formerly this was an O(n) operation)
• Refactored ExpectExpectation to work without stubbing
• Use Chef's resource_collection to identify resources instead of our own custom proxy

2.0.1 (August 28, 2013)

BUG FIXES:

• Add missing second optional parameter to Hash#respond_to? monkey patch

FEATURES

• Improve error message when using a regular express
• Improve documentation for Python packages

2.0.0 (August 22, 2013)

Breaking:

• Remove support for REE (@andrewgross for the CI)

BUG FIXES:

• Better failure message for create_remote_file (@tmatilai)
• Add cookbook_file as an accepted type to the create_file matchers (@dafyddcrosby)
• Ensure formatter is only registered once (@student)
• Signifant README updates (@phoolish)
• Fix described_recipe helper (S.R.Garcia)
• Refactor Chef 10/11 template rendering (@sethvargo)
• Fix CI (@sethvargo)
• Match File actions as an array (@sethvargo)

FEATURES:

• Extend ruby_block matcher to accept regular expressions (@ssimeonov)
• Add create_remote_file_if_missing matcher (@jimhopp)
• Extend execute matcher to accept regular expressions (@eliaslevy)
• Add ability to expect exceptions during a run (@student)
• Add regular expression support for resource names (@mapleoin)
• Add support for python_pip LWRP (@mapleoin)

1.3.1 (June 10, 2013)

BUG FIXES:

• Allow the user to override cookbook_path again

1.3.0 (June 6, 2013)

FEATURES:

• Added the ability to evaluate only_if and not_if conditional guards and support for stubbing shell guards (#142, #144).
• New described_recipe and described_cookbook helpers to keep your specs DRY (#140). Thanks Andrey Chernih.

BUG FIXES:

• Ensure that Ohai plugin reloader works with ChefSpec (#141). Thanks Andrey Chernih.

1.2.0 (May 16, 2013)

FEATURES:

• Add support for partial files (@RanjibDey)
• Automatically check certain directories for cookbooks (@sethvargo)

1.1.0 (May 10, 2013)

FEATURES:

• Upgrade to newest version of fauxhai (@tmatilai)
• Make find_resource a public method (@adamhjk)
• Add path support (from fauxhai) (@RanjibDey)
• Custom Chef formatter for ChefSpec (removes pesky output) (@sethvargo)

BUG FIXES:

• Remove pesky output from Chef 11

1.0.0 (April 22, 2013)

FEATURES:

• Add support for matching file content using Regular Expressions (@ketan)
• Add support for ruby_block matcher (Andrey Vorobiev)
• Use Fauxhai for node attributes (see 4529c10)
• Moved test and development into gemspec for transparency
• Improve message logging and testing (@tmatilai)
• Chef 11 compatibility (still Chef 10 compatible)
• Accept and document new RSpec "expect" syntax
• Attribute matchers for various providers (@bjoernalbers)
• Add execute_{bash,csh,perl,python,ruby}_script matchers (@mlafeldt)
• Add group and user resource matchers (@gildegoma)
• Add support for yum_package (Justin Witrick)
• Add ISSUES.md
• Add CONTRIBUTING.md
• Relax gemspec constraints (@juliandunn)
• Improve documentation and examples

BUG FIXES:

• Fix Rubygems/Bundler 2.0 compatibility issues
• Upgrade to newest RSpec
• Fix Chef 11 incompatibility
• Various documentation fixes

0.9.0 (November 10, 2012)

FEATURES:

• Support added for the user resource (#6). Thanks Ranjib Dey.
• Support for making assertions about notifications added (#49). Thanks to Ranjib Dey.
• New include_recipe matcher added (#50). Thanks Ranjib Dey.
• Support added for the Windows env resource (#51). Thanks Ranjib Dey.
• Convenience methods for common resources added to ChefRunner (#51). Thanks Ranjib Dey.
• Further resource convenience methods added (#60). Thanks to Ketan Padegaonkar.
• Support for the :disable action added to the service resource (#67). Thanks to Chris Lundquist.
• Add a matcher to assert that a service is not running on boot (#58). Thanks to Ketan Padegaonkar.
• Support added for the chef_gem resource (#74). Thanks to Jim Hopp.

BUG FIXES:

• Avoid failure if template path is not writable (#48). Thanks to Augusto Becciu and Jim Hopp.
• Style fix for the README (#55). Thanks Greg Karékinian.
• Ensure notification assertions work where the resource name contains brackets (#57). Thanks Sean Nolen.
• Unit tests updated to explicitly specify attribute precedence as required from Chef 11 (#70). Thanks Mathias Lafeldt.
• Documentation added to the README for the create_remote_file matcher (#71). Thanks Mathias Lafeldt.
• Clarify that create_file_with_content matches on partial content (#72). Thanks Mathias Lafeldt.

0.8.0 (September 14, 2012)

FEATURES:

• LWRP support added (#40). You can now make assertions about the resources created by a provider by telling chefspec to step into a provider implementation. Thanks to Augusto Becciu for implementing this feature.
• Updated for compatibility with Chef 10.14. Thanks Augusto Becciu.

BUG FIXES:

• Template paths are no longer hard-coded to live under default (#32). Thanks Augusto Becciu.

0.7.0 (August 27, 2012)

FEATURES:

• Cron resource support added (#33). Thanks Alexander Tamoykin.
• RSpec dependency bumped to 2.11 which has named subject support (#37). Thanks Doug Ireton.

BUG FIXES:

• Correctly infer the default cookbook_path on Windows (#38). Thanks Torben Knerr.

0.6.1 (June 21, 2012)

FEATURES:

• With the release of Chef 10.12.0 the Chef versioning scheme has changed to make use of the major version field. The constraint on chef is now optimistic. Thanks to Robert J. Berger of Runa.com for flagging this issue (#28).

0.6.0 (May 31, 2012)

FEATURES:

• Service matchers extended to add support for the :nothing and :enabled actions. Thanks to Steve Lum (#20).
• Added mock value for node['languages'] to prevent failure when loading cookbooks that expect this attribute to have been populated by OHAI. Thanks to Jim Hopp (#23).
• Matchers added for the link resource. Thanks to James Burgess (#25).
• Matchers added for the remote_file resource. Thanks to Matt Pruitt (#26).

0.5.0 (February 20, 2012)

FEATURES:

• Thanks to Chris Griego and Morgan Nelson for these improvements:
  • Support both arrays and raw symbols for actions in the file content matcher (#14).
  • Add support for cookbook_file resources (#14).
• Support added for gem_package resources. Thanks to Jim Hopp from Lookout (#16).

BUG FIXES:

• Set the client_key to nil so that Chef::Search::Query.new doesn't raise (#14). Thanks Chris Griego and Morgan Nelson.

0.4.0 (November 14, 2011)

FEATURES:

• Ruby 1.9.3 is now supported.
• The create_file_with_content matcher now matches on partial content (#13). This is an API behaviour change but sufficiently minor and unlikely to break existing specs that I'm not bumping the major version. Thanks Chris Griego and Morgan Nelson from getaroom.

BUG FIXES:

• Fixed a bug in the install_package_at_version matcher where it would error if the package action was not explicitly specified (#13). Thanks Chris Griego and Morgan Nelson from getaroom.

0.3.0 (October 2, 2011)

FEATURES:

• Added new matcher create_file_with_content for verifying Chef template resource generated content.
• Knife plugin added to generate placeholder examples.

0.2.1 (September 21, 2011)

BUG FIXES:

• Fixed typo in 0.2.0 botched release. Pro-tip: run your tests.

0.2.0 (September 21, 2011)

FEATURES:

• Significantly improved performance by not invoking OHAI.
• ChefRunner constructor now accepts a block to set node attributes.
• ChefRunner constructor now takes an options hash.
• Converge now returns a reference to the ChefRunner to support calling converge in a let block.

BUG FIXES:

• Removed LWRP redefinition warnings.
• Reset run_list between calls to converge.
• Readable to_s output for failed specs.

0.1.0 (August 9, 2011)

FEATURES:

• Support for Chef 0.1.x (#2)
• Support MRI 1.9.2 (#3)

BUG FIXES:

• Added specs.

0.0.2 (July 31, 2011)

BUG FIXES:

• Corrected gem dependencies.

0.0.1 (July 31, 2011)

Initial version.

---