Version bump v1.4.0 -> v2.0.0

- Removes mono-repo support from Rakefile libs
- Handles dependency management in Berksfile for metadata.rb
- Explicitly requires 'paint' everywhere it's used

Author: TheLonelyGhost

.rubocop.yml

@@ -10,7 +10,7 @@ Lint/HandleExceptions:
     - '**/*.rake'
 
 Metrics/AbcSize:
-  Max: 30
+  Max: 35
 
 Metrics/BlockLength:
   Exclude:
@@ -48,3 +48,10 @@ Style/FormatStringToken:
 
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+# Currently this rule is buggy, so we'll just skip it
+Style/Next:
+  Enabled: false
+
+Style/StderrPuts:
+  Enabled: false

CHANGELOG.md

@@ -3,6 +3,12 @@
 We follow [Semantic Versioning](http://semver.org/) as a way of measuring stability of an update. This
 means we will never make a backwards-incompatible change within a major version of the project.
 
+## v2.0.0 (2018-09-17)
+
+- [BREAKING] Removes support for mono-repo Rakefile
+- Alters `gramsay` command to not need a subject anymore (given no mono-repo support)
+- Adds dependency management helpers for deterministic builds in wrapper cookbooks
+
 ## v1.4.0 (2018-09-15)
 
 - Adds Simplecov for measuring test coverage

README.md

@@ -72,29 +72,38 @@ You will need to include this in your Rakefile located in each recipe directory.
 this will be a full test, but there are options to use only a smaller set of tests if you
 choose.
 
-### Full cookbook testing (usually what you want as this is the gate to production)
+### Everything (usually what you want)
 
 For an individual cookbook repository, include a Rakefile with the following contents:
 
 ```ruby
+require 'rordan_gramsay/chef_tasks/dependencies'
 require 'rordan_gramsay/chef_tasks/lint'
 require 'rordan_gramsay/chef_tasks/kitchen'
 require 'rordan_gramsay/chef_tasks/test'
 
-task default: ['test:all']
+task default: ['lint:all']
 ```
 
-This will provide the following testing options from the command line:
+This will provide the following testing and dependency management options from the command line:
 
 ```
 $ rake -T
 
-  rake kitchen  # Runs integration tests using Test Kitchen
-  rake lint     # Lints cookbook using all tools
-  rake test     # Runs all linting and integration tests
+  rake dependency:check    # Check if version pinning is done correctly
+  rake dependency:clean    # Remove pinned dependencies from metadata.rb
+  rake dependency:migrate  # [EXPERIMENTAL] Migrate cookbook dependencies from metadata.rb to Berksfile (for use with dependency:pin task)
+  rake dependency:pin      # Pin dependencies
+  rake dependency:update   # Update dependency graph
+  rake kitchen             # Runs integration tests using Test Kitchen
+  rake lint                # Lints cookbook using all tools
+  rake test                # Runs all linting and integration tests
 ```
 
-For a monolithic repo style of cookbook tracking, see the **Recursive testing** section below.
+Rather than copy-paste, if you have this gem installed you may also run `gramsay init` in the base
+of the cookbook project directory and it will lay down a Rakefile with those contents for you.
+
+### Cookbook testing
 
 ### Lint testing only
 
@@ -114,29 +123,41 @@ $ rake -T
   rake lint  # Lints cookbook using all tools
 ```
 
-### Recursive testing
+### Dependency management
+
+Long story short, Berkshelf has a much richer ecosystem for handling cookbook dependencies with more
+nuance than the built-in Chef dependency resolver. To facilitate deterministic builds with a wrapper-cookbook
+approach, we have a set of rake tasks to handle pinning to exact versions of all dependencies.
 
-For a monolithic repository situation, where multiple cookbooks are stored in the
-`cookbooks/` directory relative to the project root, there is a set of rake tasks to
-handle this mass testing. Add the following to a Rakefile in the monolithic repo root
-directory:
+Pinning a dependency A that depends on B which, in turn, depends on C makes it so that you only need to
+declare the dependency on A to have the metadata reflect the resolved versions of A, B, and C in the
+`metadata.rb`. This way we can resolve the dependency graph ahead of time and leave the executing of those
+cookbooks to `chef-client` at runtime.
+
+Cookbooks that have their name starting with `role_` or `wrapper_` will be treated as a wrapper cookbook
+and be subject to these deterministic builds (e.g., `depends 'cats', '= 1.2.3'`). All other cookbooks will
+be treated like library cookbooks and have the pessimistic version constraint operator (`~>`). This ensures
+their dependencies always remain in the same major version, so `depends 'cats', '~> 3.0'` ensures a cookbook
+matching both `>= 3.0.0` and `< 4.0.0`.
 
 ```ruby
-require 'rordan_gramsay/chef_tasks/master_repo'
+require 'rordan_gramsay/chef_tasks/dependencies'
+
+task default: ['dependency:check']
 ```
 
 This will provide the following testing options from the command line:
 
 ```
 $ rake -T
 
-  rake lint  # Runs linting, style checks, and overall formatting checks for each cookbook
-  rake test  # Runs all linting and tests on all cookbooks
+  rake dependency:check    # Check if version pinning is done correctly
+  rake dependency:clean    # Remove pinned dependencies from metadata.rb
+  rake dependency:migrate  # [EXPERIMENTAL] Migrate cookbook dependencies from metadata.rb to Berksfile (for use with dependency:pin task)
+  rake dependency:pin      # Pin dependencies
+  rake dependency:update   # Update dependency graph
 ```
 
-In order to make use of this, each cookbook repo must also implement the tasks defined
-in the cookbook Rakefiles.
-
 ## Contributing
 
 See [CONTRIBUTING.md](/CONTRIBUTING.md).

lib/rordan_gramsay/chef_tasks/dependencies.rb

@@ -0,0 +1,59 @@
+require 'paint'
+require_relative '../dependencies'
+
+# rubocop:disable Lint/UnneededCopDisableDirective
+
+file 'Berksfile.lock' do
+  `berks install`
+end
+
+task dependency: ['dependency:check']
+
+namespace :dependency do
+  desc 'Check if version pinning has been done correctly'
+  task :check do
+    $stdout.puts(Paint['Inspecting version constraints for errors', :yellow, :bold])
+    obj = RordanGramsay::Dependencies::Pinning.new
+    obj.check
+    abort if obj.failure?
+  end
+
+  desc 'Remove pinned dependencies from metadata.rb'
+  task :clean do
+    $stdout.puts(Paint['Removing dependency entries from metadata.rb', :yellow, :bold])
+    obj = RordanGramsay::Dependencies::Pinning.new
+    obj.clean
+    abort if obj.failure?
+  end
+
+  desc '[EXPERIMENTAL] Migrate cookbook dependencies from metadata.rb to Berksfile (for use with dependency:pin task)'
+  task :migrate do
+    $stdout.puts(Paint['Attempting to migrate dependencies from metadata.rb to Berksfile', :yellow, :bold])
+    obj = RordanGramsay::Dependencies::Pinning.new
+    obj.migrate
+    abort if obj.failure?
+    $stdout.puts(Paint['  This may or may not have worked. Please audit the dependencies in Berksfile', :yellow, :bold])
+    $stdout.puts(Paint % ['  to ensure they look correct, then run %{cmd}', :yellow, :bold, cmd: Paint['rake dependency:update', :white, :bold]])
+  end
+
+  desc 'Update dependency graph'
+  task :update do
+    $stdout.puts(Paint['Updating Berksfile.lock', :yellow, :bold])
+    `berks update`
+
+    $stdout.puts(Paint['Pinning dependencies from Berksfile to metadata.rb', :yellow, :bold])
+    obj = RordanGramsay::Dependencies::Pinning.new
+    obj.call
+    abort if obj.failure?
+  end
+
+  desc 'Pin dependencies'
+  task :pin do
+    $stdout.puts(Paint['Pinning dependencies from Berksfile to metadata.rb', :yellow, :bold])
+    obj = RordanGramsay::Dependencies::Pinning.new
+    obj.call
+    abort if obj.failure?
+  end
+end
+
+# rubocop:enable Lint/UnneededCopDisableDirective

lib/rordan_gramsay/chef_tasks/lint/comments.rb

@@ -1,4 +1,5 @@
 require 'rake'
+require 'paint'
 require_relative '../../lint/cookbook_comments_checker'
 
 namespace :lint do

lib/rordan_gramsay/chef_tasks/master_repo.rb

@@ -5,7 +5,7 @@
 
   task slow: ['kitchen:test']
 
-  task quick: ['lint:all']
+  task quick: ['dependency:check', 'lint:all']
 end
 desc 'Runs all linting and integration tests'
 task test: ['test:all']