chef-dk 2.6.2 → 3.0.36

data/lib/chef-dk/skeletons/code_generator/recipes/attribute.rb

@@ -1,13 +1,13 @@
-# frozen_string_literal: true
-
-context = ChefDK::Generator.context
-cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
-attribute_dir = File.join(cookbook_dir, 'attributes')
-attribute_path = File.join(cookbook_dir, 'attributes', "#{context.new_file_basename}.rb")
-
-directory attribute_dir
-
-template attribute_path do
-  source 'attribute.rb.erb'
-  helpers(ChefDK::Generator::TemplateHelper)
-end
+# frozen_string_literal: true
+
+context = ChefDK::Generator.context
+cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
+attribute_dir = File.join(cookbook_dir, 'attributes')
+attribute_path = File.join(cookbook_dir, 'attributes', "#{context.new_file_basename}.rb")
+
+directory attribute_dir
+
+template attribute_path do
+  source 'attribute.rb.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+end

data/lib/chef-dk/skeletons/code_generator/recipes/build_cookbook.rb

@@ -1,177 +1,177 @@
-# frozen_string_literal: true
-
-context = ChefDK::Generator.context
-delivery_project_dir = context.delivery_project_dir
-pipeline = context.pipeline
-dot_delivery_dir = File.join(delivery_project_dir, '.delivery')
-config_json = File.join(dot_delivery_dir, 'config.json')
-project_toml = File.join(dot_delivery_dir, 'project.toml')
-
-generator_desc('Ensuring delivery configuration')
-
-directory dot_delivery_dir
-
-cookbook_file config_json do
-  source 'delivery-config.json'
-  not_if { File.exist?(config_json) }
-end
-
-# Adding a new prototype file for delivery-cli local commands
-cookbook_file project_toml do
-  source 'delivery-project.toml'
-  not_if { File.exist?(project_toml) }
-end
-
-generator_desc('Ensuring correct delivery build cookbook content')
-
-build_cookbook_dir = File.join(dot_delivery_dir, 'build_cookbook')
-
-# cookbook root dir
-directory build_cookbook_dir
-
-# metadata.rb
-template "#{build_cookbook_dir}/metadata.rb" do
-  source 'build_cookbook/metadata.rb.erb'
-  helpers(ChefDK::Generator::TemplateHelper)
-  action :create_if_missing
-end
-
-# README
-cookbook_file "#{build_cookbook_dir}/README.md" do
-  source 'build_cookbook/README.md'
-  action :create_if_missing
-end
-
-# LICENSE
-template "#{build_cookbook_dir}/LICENSE" do
-  source "LICENSE.#{context.license}.erb"
-  helpers(ChefDK::Generator::TemplateHelper)
-  action :create_if_missing
-end
-
-# chefignore
-cookbook_file "#{build_cookbook_dir}/chefignore"
-
-# Berksfile
-template "#{build_cookbook_dir}/Berksfile" do
-  source 'build_cookbook/Berksfile.erb'
-  helpers(ChefDK::Generator::TemplateHelper)
-  action :create_if_missing
-end
-
-# Recipes
-directory "#{build_cookbook_dir}/recipes"
-
-%w(default deploy functional lint provision publish quality security smoke syntax unit).each do |phase|
-  template "#{build_cookbook_dir}/recipes/#{phase}.rb" do
-    source 'build_cookbook/recipe.rb.erb'
-    helpers(ChefDK::Generator::TemplateHelper)
-    variables phase: phase
-    action :create_if_missing
-  end
-end
-
-# Test Kitchen build node
-cookbook_file "#{build_cookbook_dir}/.kitchen.yml" do
-  source 'build_cookbook/.kitchen.yml'
-end
-
-directory "#{build_cookbook_dir}/data_bags/keys" do
-  recursive true
-end
-
-file "#{build_cookbook_dir}/data_bags/keys/delivery_builder_keys.json" do
-  content '{"id": "delivery_builder_keys"}'
-end
-
-directory "#{build_cookbook_dir}/secrets"
-
-file "#{build_cookbook_dir}/secrets/fakey-mcfakerton"
-
-directory "#{build_cookbook_dir}/test/fixtures/cookbooks/test/recipes" do
-  recursive true
-end
-
-file "#{build_cookbook_dir}/test/fixtures/cookbooks/test/metadata.rb" do
-  content %(name 'test'
-version '0.1.0')
-end
-
-cookbook_file "#{build_cookbook_dir}/test/fixtures/cookbooks/test/recipes/default.rb" do
-  source 'build_cookbook/test-fixture-recipe.rb'
-end
-
-# Construct git history as if we did all the work in a feature branch which we
-# merged into master at the end, which looks like this:
-#
-# ```
-# git log --graph --oneline
-# *   5fec5bd Merge branch 'add-delivery-configuration'
-# |\
-# | * 967bb9f Add generated delivery build cookbook
-# | * 1558e0a Add generated delivery configuration
-# |/
-# * db22790 Add generated cookbook content
-# ```
-#
-if context.have_git && context.delivery_project_git_initialized && !context.skip_git_init
-
-  generator_desc('Adding delivery configuration to feature branch')
-
-  execute('git-create-feature-branch') do
-    command('git checkout -t -b add-delivery-configuration')
-    cwd delivery_project_dir
-    not_if { shell_out('git branch', cwd: delivery_project_dir).stdout.match(/add-delivery-configuration/) }
-  end
-
-  execute('git-add-delivery-config-json') do
-    command('git add .delivery/config.json')
-    cwd delivery_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(%r{.delivery/config.json}) }
-  end
-
-  # Adding the new prototype file to the feature branch
-  # so it gets checked in with the delivery config commit
-  execute('git-add-delivery-project-toml') do
-    command('git add .delivery/project.toml')
-    cwd delivery_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(%r{.delivery/project.toml}) }
-  end
-
-  execute('git-commit-delivery-config') do
-    command('git commit -m "Add generated delivery configuration"')
-    cwd delivery_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(/config\.json|project\.toml/) }
-  end
-
-  generator_desc('Adding build cookbook to feature branch')
-
-  execute('git-add-delivery-build-cookbook-files') do
-    command('git add .delivery')
-    cwd delivery_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(/\.delivery/) }
-  end
-
-  execute('git-commit-delivery-build-cookbook') do
-    command('git commit -m "Add generated delivery build cookbook"')
-    cwd delivery_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(/\.delivery/) }
-  end
-
-  execute("git-return-to-#{pipeline}-branch") do
-    command("git checkout #{pipeline}")
-    cwd delivery_project_dir
-  end
-
-  generator_desc('Merging delivery content feature branch to master')
-
-  execute('git-merge-delivery-config-branch') do
-    command('git merge --no-ff add-delivery-configuration')
-    cwd delivery_project_dir
-  end
-
-  execute('git-remove-delivery-config-branch') do
-    command('git branch -D add-delivery-configuration')
-    cwd delivery_project_dir
-  end
-end
+# frozen_string_literal: true
+
+context = ChefDK::Generator.context
+delivery_project_dir = context.delivery_project_dir
+pipeline = context.pipeline
+dot_delivery_dir = File.join(delivery_project_dir, '.delivery')
+config_json = File.join(dot_delivery_dir, 'config.json')
+project_toml = File.join(dot_delivery_dir, 'project.toml')
+
+generator_desc('Ensuring delivery configuration')
+
+directory dot_delivery_dir
+
+cookbook_file config_json do
+  source 'delivery-config.json'
+  not_if { File.exist?(config_json) }
+end
+
+# Adding a new prototype file for delivery-cli local commands
+cookbook_file project_toml do
+  source 'delivery-project.toml'
+  not_if { File.exist?(project_toml) }
+end
+
+generator_desc('Ensuring correct delivery build cookbook content')
+
+build_cookbook_dir = File.join(dot_delivery_dir, 'build_cookbook')
+
+# cookbook root dir
+directory build_cookbook_dir
+
+# metadata.rb
+template "#{build_cookbook_dir}/metadata.rb" do
+  source 'build_cookbook/metadata.rb.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# README
+cookbook_file "#{build_cookbook_dir}/README.md" do
+  source 'build_cookbook/README.md'
+  action :create_if_missing
+end
+
+# LICENSE
+template "#{build_cookbook_dir}/LICENSE" do
+  source "LICENSE.#{context.license}.erb"
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# chefignore
+cookbook_file "#{build_cookbook_dir}/chefignore"
+
+# Berksfile
+template "#{build_cookbook_dir}/Berksfile" do
+  source 'build_cookbook/Berksfile.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# Recipes
+directory "#{build_cookbook_dir}/recipes"
+
+%w(default deploy functional lint provision publish quality security smoke syntax unit).each do |phase|
+  template "#{build_cookbook_dir}/recipes/#{phase}.rb" do
+    source 'build_cookbook/recipe.rb.erb'
+    helpers(ChefDK::Generator::TemplateHelper)
+    variables phase: phase
+    action :create_if_missing
+  end
+end
+
+# Test Kitchen build node
+cookbook_file "#{build_cookbook_dir}/.kitchen.yml" do
+  source 'build_cookbook/.kitchen.yml'
+end
+
+directory "#{build_cookbook_dir}/data_bags/keys" do
+  recursive true
+end
+
+file "#{build_cookbook_dir}/data_bags/keys/delivery_builder_keys.json" do
+  content '{"id": "delivery_builder_keys"}'
+end
+
+directory "#{build_cookbook_dir}/secrets"
+
+file "#{build_cookbook_dir}/secrets/fakey-mcfakerton"
+
+directory "#{build_cookbook_dir}/test/fixtures/cookbooks/test/recipes" do
+  recursive true
+end
+
+file "#{build_cookbook_dir}/test/fixtures/cookbooks/test/metadata.rb" do
+  content %(name 'test'
+version '0.1.0')
+end
+
+cookbook_file "#{build_cookbook_dir}/test/fixtures/cookbooks/test/recipes/default.rb" do
+  source 'build_cookbook/test-fixture-recipe.rb'
+end
+
+# Construct git history as if we did all the work in a feature branch which we
+# merged into master at the end, which looks like this:
+#
+# ```
+# git log --graph --oneline
+# *   5fec5bd Merge branch 'add-delivery-configuration'
+# |\
+# | * 967bb9f Add generated delivery build cookbook
+# | * 1558e0a Add generated delivery configuration
+# |/
+# * db22790 Add generated cookbook content
+# ```
+#
+if context.have_git && context.delivery_project_git_initialized && !context.skip_git_init
+
+  generator_desc('Adding delivery configuration to feature branch')
+
+  execute('git-create-feature-branch') do
+    command('git checkout -t -b add-delivery-configuration')
+    cwd delivery_project_dir
+    not_if { shell_out('git branch', cwd: delivery_project_dir).stdout.match(/add-delivery-configuration/) }
+  end
+
+  execute('git-add-delivery-config-json') do
+    command('git add .delivery/config.json')
+    cwd delivery_project_dir
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(%r{.delivery/config.json}) }
+  end
+
+  # Adding the new prototype file to the feature branch
+  # so it gets checked in with the delivery config commit
+  execute('git-add-delivery-project-toml') do
+    command('git add .delivery/project.toml')
+    cwd delivery_project_dir
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(%r{.delivery/project.toml}) }
+  end
+
+  execute('git-commit-delivery-config') do
+    command('git commit -m "Add generated delivery configuration"')
+    cwd delivery_project_dir
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(/config\.json|project\.toml/) }
+  end
+
+  generator_desc('Adding build cookbook to feature branch')
+
+  execute('git-add-delivery-build-cookbook-files') do
+    command('git add .delivery')
+    cwd delivery_project_dir
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(/\.delivery/) }
+  end
+
+  execute('git-commit-delivery-build-cookbook') do
+    command('git commit -m "Add generated delivery build cookbook"')
+    cwd delivery_project_dir
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(/\.delivery/) }
+  end
+
+  execute("git-return-to-#{pipeline}-branch") do
+    command("git checkout #{pipeline}")
+    cwd delivery_project_dir
+  end
+
+  generator_desc('Merging delivery content feature branch to master')
+
+  execute('git-merge-delivery-config-branch') do
+    command('git merge --no-ff add-delivery-configuration')
+    cwd delivery_project_dir
+  end
+
+  execute('git-remove-delivery-config-branch') do
+    command('git branch -D add-delivery-configuration')
+    cwd delivery_project_dir
+  end
+end

data/lib/chef-dk/skeletons/code_generator/recipes/cookbook.rb

@@ -1,152 +1,158 @@
-# frozen_string_literal: true
-
-context = ChefDK::Generator.context
-cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
-
-silence_chef_formatter unless context.verbose
-
-generator_desc('Ensuring correct cookbook file content')
-
-# cookbook root dir
-directory cookbook_dir
-
-# metadata.rb
-spdx_license =  case context.license
-                when 'apachev2'
-                  'Apache-2.0'
-                when 'mit'
-                  'MIT'
-                when 'gplv2'
-                  'GPL-2.0'
-                when 'gplv3'
-                  'GPL-3.0'
-                else
-                  'All Rights Reserved'
-                end
-
-template "#{cookbook_dir}/metadata.rb" do
-  helpers(ChefDK::Generator::TemplateHelper)
-  variables(
-    spdx_license: spdx_license
-  )
-  action :create_if_missing
-end
-
-# README
-template "#{cookbook_dir}/README.md" do
-  helpers(ChefDK::Generator::TemplateHelper)
-  action :create_if_missing
-end
-
-# chefignore
-cookbook_file "#{cookbook_dir}/chefignore"
-
-if context.use_berkshelf
-
-  # Berks
-  cookbook_file "#{cookbook_dir}/Berksfile" do
-    action :create_if_missing
-  end
-else
-
-  # Policyfile
-  template "#{cookbook_dir}/Policyfile.rb" do
-    source 'Policyfile.rb.erb'
-    helpers(ChefDK::Generator::TemplateHelper)
-  end
-
-end
-
-# LICENSE
-template "#{cookbook_dir}/LICENSE" do
-  helpers(ChefDK::Generator::TemplateHelper)
-  source "LICENSE.#{context.license}.erb"
-  action :create_if_missing
-end
-
-# Test Kitchen
-template "#{cookbook_dir}/.kitchen.yml" do
-  if context.use_berkshelf
-    source 'kitchen.yml.erb'
-  else
-    source 'kitchen_policyfile.yml.erb'
-  end
-
-  helpers(ChefDK::Generator::TemplateHelper)
-  action :create_if_missing
-end
-
-# Inspec
-directory "#{cookbook_dir}/test/integration/default" do
-  recursive true
-end
-
-template "#{cookbook_dir}/test/integration/default/default_test.rb" do
-  source 'inspec_default_test.rb.erb'
-  helpers(ChefDK::Generator::TemplateHelper)
-  action :create_if_missing
-end
-
-# Chefspec
-directory "#{cookbook_dir}/spec/unit/recipes" do
-  recursive true
-end
-
-cookbook_file "#{cookbook_dir}/spec/spec_helper.rb" do
-  if context.use_berkshelf
-    source 'spec_helper.rb'
-  else
-    source 'spec_helper_policyfile.rb'
-  end
-
-  action :create_if_missing
-end
-
-template "#{cookbook_dir}/spec/unit/recipes/default_spec.rb" do
-  source 'recipe_spec.rb.erb'
-  helpers(ChefDK::Generator::TemplateHelper)
-  action :create_if_missing
-end
-
-# Recipes
-
-directory "#{cookbook_dir}/recipes"
-
-template "#{cookbook_dir}/recipes/default.rb" do
-  source 'recipe.rb.erb'
-  helpers(ChefDK::Generator::TemplateHelper)
-  action :create_if_missing
-end
-
-# git
-if context.have_git
-  unless context.skip_git_init
-
-    generator_desc('Committing cookbook files to git')
-
-    execute('initialize-git') do
-      command('git init .')
-      cwd cookbook_dir
-    end
-
-  end
-
-  cookbook_file "#{cookbook_dir}/.gitignore" do
-    source 'gitignore'
-  end
-
-  unless context.skip_git_init
-
-    execute('git-add-new-files') do
-      command('git add .')
-      cwd cookbook_dir
-    end
-
-    execute('git-commit-new-files') do
-      command('git commit -m "Add generated cookbook content"')
-      cwd cookbook_dir
-    end
-  end
-end
-
-include_recipe '::build_cookbook' if context.enable_delivery
+# frozen_string_literal: true
+
+context = ChefDK::Generator.context
+cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
+
+silence_chef_formatter unless context.verbose
+
+generator_desc('Ensuring correct cookbook file content')
+
+# cookbook root dir
+directory cookbook_dir
+
+# metadata.rb
+spdx_license =  case context.license
+                when 'apachev2'
+                  'Apache-2.0'
+                when 'mit'
+                  'MIT'
+                when 'gplv2'
+                  'GPL-2.0'
+                when 'gplv3'
+                  'GPL-3.0'
+                else
+                  'All Rights Reserved'
+                end
+
+template "#{cookbook_dir}/metadata.rb" do
+  helpers(ChefDK::Generator::TemplateHelper)
+  variables(
+    spdx_license: spdx_license
+  )
+  action :create_if_missing
+end
+
+# README
+template "#{cookbook_dir}/README.md" do
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# CHANGELOG
+template "#{cookbook_dir}/CHANGELOG.md" do
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# chefignore
+cookbook_file "#{cookbook_dir}/chefignore"
+
+if context.use_berkshelf
+
+  # Berks
+  cookbook_file "#{cookbook_dir}/Berksfile" do
+    action :create_if_missing
+  end
+else
+
+  # Policyfile
+  template "#{cookbook_dir}/Policyfile.rb" do
+    source 'Policyfile.rb.erb'
+    helpers(ChefDK::Generator::TemplateHelper)
+  end
+
+end
+
+# LICENSE
+template "#{cookbook_dir}/LICENSE" do
+  helpers(ChefDK::Generator::TemplateHelper)
+  source "LICENSE.#{context.license}.erb"
+  action :create_if_missing
+end
+
+# Test Kitchen
+template "#{cookbook_dir}/.kitchen.yml" do
+  if context.use_berkshelf
+    source 'kitchen.yml.erb'
+  else
+    source 'kitchen_policyfile.yml.erb'
+  end
+
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# Inspec
+directory "#{cookbook_dir}/test/integration/default" do
+  recursive true
+end
+
+template "#{cookbook_dir}/test/integration/default/default_test.rb" do
+  source 'inspec_default_test.rb.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# Chefspec
+directory "#{cookbook_dir}/spec/unit/recipes" do
+  recursive true
+end
+
+cookbook_file "#{cookbook_dir}/spec/spec_helper.rb" do
+  if context.use_berkshelf
+    source 'spec_helper.rb'
+  else
+    source 'spec_helper_policyfile.rb'
+  end
+
+  action :create_if_missing
+end
+
+template "#{cookbook_dir}/spec/unit/recipes/default_spec.rb" do
+  source 'recipe_spec.rb.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# Recipes
+
+directory "#{cookbook_dir}/recipes"
+
+template "#{cookbook_dir}/recipes/default.rb" do
+  source 'recipe.rb.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# git
+if context.have_git
+  unless context.skip_git_init
+
+    generator_desc('Committing cookbook files to git')
+
+    execute('initialize-git') do
+      command('git init .')
+      cwd cookbook_dir
+    end
+
+  end
+
+  cookbook_file "#{cookbook_dir}/.gitignore" do
+    source 'gitignore'
+  end
+
+  unless context.skip_git_init
+
+    execute('git-add-new-files') do
+      command('git add .')
+      cwd cookbook_dir
+    end
+
+    execute('git-commit-new-files') do
+      command('git commit -m "Add generated cookbook content"')
+      cwd cookbook_dir
+    end
+  end
+end
+
+include_recipe '::build_cookbook' if context.enable_delivery