chef-dk 3.11.3 → 3.12.0

data/lib/chef-dk/generator.rb

@@ -24,7 +24,7 @@ module ChefDK
       def self.add_attr(name)
         @attributes ||= [ ]
 
-        if !@attributes.include?(name)
+        unless @attributes.include?(name)
           @attributes << name
           attr_accessor(name)
         end

data/lib/chef-dk/helpers.rb

@@ -136,7 +136,8 @@ module ChefDK
 
     def omnibus_expand_path(*paths)
       dir = File.expand_path(File.join(paths))
-      raise OmnibusInstallNotFound.new() unless dir && File.directory?(dir)
+      raise OmnibusInstallNotFound.new unless dir && File.directory?(dir)
+
       dir
     end
 

data/lib/chef-dk/policyfile_compiler.rb

@@ -39,7 +39,7 @@ module ChefDK
     DEFAULT_DEMAND_CONSTRAINT = ">= 0.0.0".freeze
 
     # Cookbooks from these sources lock that cookbook to exactly one version
-    SOURCE_TYPES_WITH_FIXED_VERSIONS = [:git, :path].freeze
+    SOURCE_TYPES_WITH_FIXED_VERSIONS = %i{git path}.freeze
 
     def self.evaluate(policyfile_string, policyfile_filename, ui: nil, chef_config: nil)
       compiler = new(ui: ui, chef_config: chef_config)
@@ -225,6 +225,7 @@ module ChefDK
 
     def graph_solution
       return @solution if @solution
+
       cache_fixed_version_cookbooks
       @solution = Solve.it!(graph, graph_demands)
     end
@@ -515,7 +516,8 @@ module ChefDK
             false
           end
         end
-        conflicting_source_messages << "#{source_b.desc} sets a preferred for cookbook(s) #{conflicting_preferences.join(', ')}. This conflicts with an included policy."
+
+        conflicting_source_messages << "#{source_b.desc} sets a preferred for cookbook(s) #{conflicting_preferences.join(", ")}. This conflicts with an included policy."
       end
       unless conflicting_source_messages.empty?
         msg = "You may not override the cookbook sources for any cookbooks required by included policies.\n"

data/lib/chef-dk/policyfile_lock.rb

@@ -324,6 +324,7 @@ module ChefDK
       unless attributes.kind_of?(Hash)
         raise "Top level attributes must be a Hash (you gave: #{attributes})"
       end
+
       canonicalize_elements(attributes)
     end
 
@@ -355,6 +356,7 @@ module ChefDK
         unless item.finite?
           raise InvalidPolicyfileAttribute, "Floating point numbers cannot be infinite or NaN. You gave #{item.inspect}"
         end
+
         # Support for floats assumes that any implementation of our JSON
         # canonicalization routine will use IEEE-754 doubles. In decimal terms,
         # doubles give 15-17 digits of precision, so we err on the safe side

data/lib/chef-dk/skeletons/code_generator/files/default/Berksfile

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 source 'https://supermarket.chef.io'
 
 metadata

data/lib/chef-dk/skeletons/code_generator/files/default/build_cookbook/README.md

@@ -1,18 +1,18 @@
 # build_cookbook
 
-A build cookbook for running the parent project through Chef Delivery
+A build cookbook for running the parent project through Chef Workflow
 
-This build cookbook should be customized to suit the needs of the parent project. Using this cookbook can be done outside of Chef Delivery, too. If the parent project is a Chef cookbook, we've detected that and "wrapped" [delivery-truck](https://github.com/chef-cookbooks/delivery-truck). That means it is a dependency, and each of its pipeline phase recipes is included in the appropriate phase recipes in this cookbook. If the parent project is not a cookbook, it's left as an exercise to the reader to customize the recipes as needed for each phase in the pipeline.
+This build cookbook should be customized to suit the needs of the parent project. Using this cookbook can be done outside of Chef Workflow, too. If the parent project is a Chef cookbook, we've detected that and "wrapped" [delivery-truck](https://github.com/chef-cookbooks/delivery-truck). That means it is a dependency, and each of its pipeline phase recipes is included in the appropriate phase recipes in this cookbook. If the parent project is not a cookbook, it's left as an exercise to the reader to customize the recipes as needed for each phase in the pipeline.
 
 ## .delivery/config.json
 
-In the parent directory to this build_cookbook, the `config.json` can be modified as necessary. For example, phases can be skipped, publishing information can be added, and so on. Refer to customer support or the Chef Delivery documentation for assistance on what options are available for this configuration.
+In the parent directory to this build_cookbook, the `config.json` can be modified as necessary. For example, phases can be skipped, publishing information can be added, and so on. Refer to customer support or the Chef Workflow documentation for assistance on what options are available for this configuration.
 
 ## Test Kitchen - Local Verify Testing
 
-This cookbook also has a `.kitchen.yml` which can be used to create local build nodes with Test Kitchen to perform the verification phases, `unit`, `syntax`, and `lint`. When running `kitchen converge`, the instances will be set up like Chef Delivery "build nodes" with the [delivery_build cookbook](https://github.com/chef-cookbooks/delivery_build). The reason for this is to make sure that the same exact kind of nodes are used by this build cookbook are run on the local workstation as would run Delivery. It will run `delivery job verify PHASE` for the parent project.
+This cookbook also has a `kitchen.yml` which can be used to create local build nodes with Test Kitchen to perform the verification phases, `unit`, `syntax`, and `lint`. When running `kitchen converge`, the instances will be set up like Chef Workflow "build nodes" with the [delivery_build cookbook](https://github.com/chef-cookbooks/delivery_build). The reason for this is to make sure that the same exact kind of nodes are used by this build cookbook are run on the local workstation as would run Workflow. It will run `delivery job verify PHASE` for the parent project.
 
-Modify the `.kitchen.yml` if necessary to change the platforms or other configuration to run the verify phases. After making changes in the parent project, `cd` into this directory (`.delivery/build_cookbook`), and run:
+Modify the `kitchen.yml` if necessary to change the platforms or other configuration to run the verify phases. After making changes in the parent project, `cd` into this directory (`.delivery/build_cookbook`), and run:
 
 ```
 kitchen test
@@ -20,11 +20,11 @@ kitchen test
 
 ## Recipes
 
-Each of the recipes in this build_cookbook are run in the named phase during the Chef Delivery pipeline. The `unit`, `syntax`, and `lint` recipes are additionally run when using Test Kitchen for local testing as noted in the above section.
+Each of the recipes in this build_cookbook are run in the named phase during the Chef Workflow pipeline. The `unit`, `syntax`, and `lint` recipes are additionally run when using Test Kitchen for local testing as noted in the above section.
 
 ## Making Changes - Cookbook Example
 
-When making changes in the parent project (that which lives in `../..` from this directory), or in the recipes in this build cookbook, there is a bespoke workflow for Chef Delivery. As an example, we'll discuss a Chef Cookbook as the parent.
+When making changes in the parent project (that which lives in `../..` from this directory), or in the recipes in this build cookbook, there is a bespoke workflow for Chef Workflow. As an example, we'll discuss a Chef Cookbook as the parent.
 
 First, create a new branch for the changes.
 
@@ -47,9 +47,9 @@ The change we'll use for an example is to install the `zsh` package. Write a fai
 require 'spec_helper'
 
 describe 'godzilla::default' do
-  context 'When all attributes are default, on Ubuntu 16.04' do
+  context 'When all attributes are default, on Ubuntu 18.04' do
     let(:chef_run) do
-      runner = ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '16.04')
+      runner = ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '18.04')
       runner.converge(described_recipe)
     end
 
@@ -74,7 +74,7 @@ cd .delivery/build_cookbook
 kitchen converge
 ```
 
-This will take some time at first, because the VMs need to be created, Chef installed, the Delivery CLI installed, etc. Later runs will be faster until they are destroyed. It will also fail on the first VM, as expected, because we wrote the test first. Now edit the parent cookbook project's default recipe to install `zsh`.
+This will take some time at first, because the VMs need to be created, Chef Infra Client installed, the Delivery CLI installed, etc. Later runs will be faster until they are destroyed. It will also fail on the first VM, as expected, because we wrote the test first. Now edit the parent cookbook project's default recipe to install `zsh`.
 
 ```
 cd ../../
@@ -114,13 +114,13 @@ Recipe: test::default
 
 Running handlers:
 Running handlers complete
-Chef Client finished, 3/32 resources updated in 54.665445968 seconds
+Chef Infra Client finished, 3/32 resources updated in 54.665445968 seconds
 Finished converging <default-centos-71> (1m26.83s).
 ```
 
 Victory is ours! Our verify phase passed on the build nodes.
 
-We are ready to run this through our Delivery pipeline. Simply run `delivery review` on the local system from the parent project, and it will open a browser window up to the change we just added.
+We are ready to run this through our Workflow pipeline. Simply run `delivery review` on the local system from the parent project, and it will open a browser window up to the change we just added.
 
 ```
 cd ../..
@@ -131,11 +131,11 @@ delivery review
 
 ### Why don't I just run rspec and foodcritic/rubocop on my local system?
 
-An objection to the Test Kitchen approach is that it is much faster to run the unit, lint, and syntax commands for the project on the local system. That is totally true, and also totally valid. Do that for the really fast feedback loop. However, the dance we do with Test Kitchen brings a much higher degree of confidence in the changes we're making, that everything will run on the build nodes in Chef Delivery. We strongly encourage this approach before actually pushing the changes to Delivery.
+An objection to the Test Kitchen approach is that it is much faster to run the unit, lint, and syntax commands for the project on the local system. That is totally true, and also totally valid. Do that for the really fast feedback loop. However, the dance we do with Test Kitchen brings a much higher degree of confidence in the changes we're making, that everything will run on the build nodes in Chef Workflow. We strongly encourage this approach before actually pushing the changes to Workflow.
 
 ### Why do I have to make a commit every time?
 
-When running `delivery job`, it expects to merge the commit for the changeset against the clean master branch. If we don't save our progress by making a commit, our local changes aren't run through `delivery job` in the Test Kitchen build instances. We can always perform an interactive rebase, and modify the original changeset message in Delivery with `delivery review --edit`. The latter won't modify the git commits, only the changeset in Delivery.
+When running `delivery job`, it expects to merge the commit for the changeset against the clean master branch. If we don't save our progress by making a commit, our local changes aren't run through `delivery job` in the Test Kitchen build instances. We can always perform an interactive rebase, and modify the original changeset message in Workflow with `delivery review --edit`. The latter won't modify the git commits, only the changeset in Workflow.
 
 ### What do I do next?
 

data/lib/chef-dk/skeletons/code_generator/files/default/build_cookbook/test-fixture-recipe.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 %w(unit lint syntax).each do |phase|
   # TODO: This works on Linux/Unix. Not Windows.
   execute "HOME=/home/vagrant delivery job verify #{phase} --server localhost --ent test --org kitchen" do

data/lib/chef-dk/skeletons/code_generator/files/default/chefignore

@@ -1,13 +1,13 @@
 # Put files/directories that should be ignored in this file when uploading
-# to a chef-server or supermarket.
+# to a Chef Infra Server or Supermarket.
 # Lines that start with '# ' are comments.
 
 # OS generated files #
 ######################
 .DS_Store
+ehthumbs.db
 Icon?
 nohup.out
-ehthumbs.db
 Thumbs.db
 
 # SASS #
@@ -16,63 +16,66 @@ Thumbs.db
 
 # EDITORS #
 ###########
-\#*
 .#*
-*~
-*.sw[a-z]
+.project
+.settings
+*_flymake
+*_flymake.*
 *.bak
+*.sw[a-z]
+*.tmproj
+*~
+\#*
+mkmf.log
 REVISION
 TAGS*
 tmtags
-*_flymake.*
-*_flymake
-*.tmproj
-.project
-.settings
-mkmf.log
 
 ## COMPILED ##
 ##############
-a.out
-*.o
-*.pyc
-*.so
-*.com
 *.class
+*.com
 *.dll
 *.exe
+*.o
+*.pyc
+*.so
 */rdoc/
+a.out
 
 # Testing #
 ###########
-.watchr
+.circleci/*
+.codeclimate.yml
+.foodcritic
+.kitchen*
 .rspec
-spec/*
-spec/fixtures/*
-test/*
-features/*
+.rubocop.yml
+.travis.yml
+.watchr
+azure-pipelines.yml
 examples/*
+features/*
 Guardfile
-Procfile
-.kitchen*
 kitchen.yml*
-.rubocop.yml
-spec/*
+Procfile
 Rakefile
-.travis.yml
-.foodcritic
-.codeclimate.yml
+spec/*
+spec/*
+spec/fixtures/*
+test/*
 
 # SCM #
 #######
 .git
-*/.git
+.gitattributes
+.gitconfig
+.github/*
 .gitignore
 .gitmodules
-.gitconfig
-.gitattributes
 .svn
 */.bzr/*
+*/.git
 */.hg/*
 */.svn/*
 
@@ -86,6 +89,8 @@ tmp
 # Bundler #
 ###########
 vendor/*
+Gemfile
+Gemfile.lock
 
 # Policyfile #
 ##############
@@ -94,9 +99,10 @@ Policyfile.lock.json
 
 # Cookbooks #
 #############
-CONTRIBUTING*
 CHANGELOG*
+CONTRIBUTING*
 TESTING*
+CODE_OF_CONDUCT*
 
 # Vagrant #
 ###########

data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README.md

@@ -13,9 +13,9 @@ current_dir = File.dirname(__FILE__)
 cookbook_path ["#{current_dir}/../cookbooks"]
 ```
 
-Which will set `current_dir` to the location of the knife.rb file itself (e.g. `~/chef-repo/.chef/knife.rb`).
+Which will set `current_dir` to the location of the config.rb (previously knife.rb) file itself (e.g. `~/chef-repo/.chef/config.rb`).
 
-Configure knife to use your preferred copyright holder, email contact and license. Add the following lines to `.chef/knife.rb`.
+Configure knife to use your preferred copyright holder, email contact and license. Add the following lines to `.chef/config.rb`.
 
 ```
 cookbook_copyright "Example, Com."

data/lib/chef-dk/skeletons/code_generator/files/default/delivery-project.toml

@@ -1,15 +1,12 @@
-# Delivery Prototype for Local Phases Execution
+# Delivery for Local Phases Execution
 #
-# The purpose of this file is to prototype a new way to execute
-# phases locally on your workstation. The delivery-cli will read
-# this file and execute the command(s) that are configured for
-# each phase. You can customize them by just modifying the phase
-# key on this file.
+# This file allows you to execute test phases locally on a workstation or
+# in a CI pipeline. The delivery-cli will read this file and execute the
+# command(s) that are configured for each phase. You can customize them
+# by just modifying the phase key on this file.
 #
 # By default these phases are configured for Cookbook Workflow only
 #
-# As this is still a prototype we are not modifying the current
-# config.json file and it will continue working as usual.
 
 [local_phases]
 unit = "chef exec rspec spec/"
@@ -29,8 +26,9 @@ cleanup = "chef exec kitchen destroy"
 
 # Remote project.toml file
 #
-# Specify a remote URI location for the `project.toml` file.
-# This is useful for teams that wish to centrally manage the behavior
-# of the `delivery local` command across many different projects.
+# Instead of the local phases above, you may specify a remote URI location for
+# the `project.toml` file. This is useful for teams that wish to centrally
+# manage the behavior of the `delivery local` command across many different
+# projects.
 #
 # remote_file = "https://url/project.toml"