chef-cli 4.0.0 → 5.3.0

data/lib/chef-cli/command/generator_commands/build_cookbook.rb

@@ -1,126 +0,0 @@
-#
-# Copyright:: Copyright (c) 2016-2019 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require_relative "base"
-require_relative "../../dist"
-
-module ChefCLI
-  module Command
-    module GeneratorCommands
-
-      class BuildCookbook < Base
-
-        banner "Usage: #{ChefCLI::Dist::EXEC} generate build-cookbook NAME [options]"
-
-        attr_reader :errors
-
-        attr_reader :cookbook_name_or_path
-
-        option :pipeline,
-          long: "--pipeline PIPELINE",
-          description: "Use PIPELINE to set target branch to something other than master for the build_cookbook",
-          default: "master"
-
-        options.merge!(SharedGeneratorOptions.options)
-
-        def initialize(params)
-          @params_valid = true
-          @cookbook_name = nil
-          super
-        end
-
-        def run
-          read_and_validate_params
-          if params_valid?
-            setup_context
-            chef_runner.converge
-            0
-          else
-            err(opt_parser)
-            1
-          end
-        rescue ChefCLI::ChefRunnerError => e
-          err("ERROR: #{e}")
-          1
-        end
-
-        def setup_context
-          super
-          Generator.add_attr_to_context(:workflow_project_dir, workflow_project_dir)
-
-          Generator.add_attr_to_context(:workflow_project_git_initialized, workflow_project_git_initialized?)
-          Generator.add_attr_to_context(:build_cookbook_parent_is_cookbook, build_cookbook_parent_is_cookbook?)
-
-          Generator.add_attr_to_context(:pipeline, pipeline)
-        end
-
-        def pipeline
-          config[:pipeline]
-        end
-
-        def recipe
-          "build_cookbook"
-        end
-
-        def build_cookbook_parent_is_cookbook?
-          metadata_json_path = File.join(workflow_project_dir, "metadata.json")
-          metadata_rb_path = File.join(workflow_project_dir, "metadata.rb")
-
-          File.exist?(metadata_json_path) || File.exist?(metadata_rb_path)
-        end
-
-        def workflow_project_dir
-          project_dir = File.expand_path(cookbook_name_or_path, Dir.pwd)
-          # Detect if we were invoked with arguments like
-          #
-          #     chef generate build-cookbook project/.delivery/build_cookbook
-          #
-          # If so, normalize paths so we don't make a directory structure like
-          # `.delivery/.delivery/build_cookbook`.
-          #
-          # Note that we don't check the name of the build cookbook the user
-          # asked for and we hard-code to naming it "build_cookbook". We also
-          # don't catch the case that the user requested something like
-          # `project/.delivery/build_cookbook/extra-thing-that-shouldn't-be-here`
-          Pathname.new(project_dir).ascend do |dir|
-            if File.basename(dir) == ".delivery"
-              project_dir = File.dirname(dir)
-            end
-          end
-          project_dir
-        end
-
-        def workflow_project_git_initialized?
-          File.exist?(File.join(workflow_project_dir, ".git"))
-        end
-
-        def read_and_validate_params
-          arguments = parse_options(params)
-          @cookbook_name_or_path = arguments[0]
-          unless @cookbook_name_or_path
-            @params_valid = false
-          end
-        end
-
-        def params_valid?
-          @params_valid
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,146 +0,0 @@
-# build_cookbook
-
-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 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 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 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:
-
-```
-kitchen test
-```
-
-## Recipes
-
-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 Workflow. As an example, we'll discuss a Chef Cookbook as the parent.
-
-First, create a new branch for the changes.
-
-```
-git checkout -b testing-build-cookbook
-```
-
-Next, increment the version in the metadata.rb. This should be in the _parent_, not in this, the build_cookbook. If this is not done, the verify phase will fail.
-
-```
-% git diff
-<SNIP>
--version '0.1.0'
-+version '0.1.1'
-```
-
-The change we'll use for an example is to install the `zsh` package. Write a failing ChefSpec in the cookbook project's `spec/unit/recipes/default_spec.rb`.
-
-```ruby
-require 'spec_helper'
-
-describe 'godzilla::default' do
-  context 'When all attributes are default, on Ubuntu 18.04' do
-    let(:chef_run) do
-      runner = ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '18.04')
-      runner.converge(described_recipe)
-    end
-
-    it 'installs zsh' do
-      expect(chef_run).to install_package('zsh')
-    end
-  end
-end
-```
-
-Commit the local changes as work in progress. The `delivery job` expects to use a clean git repository.
-
-```
-git add ../..
-git commit -m 'WIP: Testing changes'
-```
-
-From _this_ directory (`.delivery/build_cookbook`, relative to the parent cookbook project), run
-
-```
-cd .delivery/build_cookbook
-kitchen converge
-```
-
-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 ../../
-$EDITOR/recipes/default.rb
-```
-
-It should look like this:
-
-```
-package 'zsh'
-```
-
-Create another commit.
-
-```
-git add .
-git commit -m 'WIP: Install zsh in default recipe'
-```
-
-Now rerun kitchen from the build_cookbook.
-
-```
-cd .delivery/build_cookbook
-kitchen converge
-```
-
-This will take a while because it will now pass on the first VM and then create the second VM. We should have warned you this was a good time for a coffee break.
-
-```
-Recipe: test::default
-
-- execute HOME=/home/vagrant delivery job verify unit --server localhost --ent test --org kitchen
-  * execute[HOME=/home/vagrant delivery job verify lint --server localhost --ent test --org kitchen] action run
-    - execute HOME=/home/vagrant delivery job verify lint --server localhost --ent test --org kitchen
-
-    - execute HOME=/home/vagrant delivery job verify syntax --server localhost --ent test --org kitchen
-
-Running handlers:
-Running handlers complete
-Chef Infra Client finished, 3/32 resources updated in 54.665445968 seconds
-Finished converging <default-centos-8> (1m26.83s).
-```
-
-Victory is ours! Our verify phase passed on the build nodes.
-
-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 ../..
-delivery review
-```
-
-## FAQ
-
-### Why don't I just run rspec and cookstyle 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 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 Workflow with `delivery review --edit`. The latter won't modify the git commits, only the changeset in Workflow.
-
-### What do I do next?
-
-Make changes in the cookbook project as required for organizational goals and needs. Modify the `build_cookbook` as necessary for the pipeline phases that the cookbook should go through.
-
-### What if I get stuck?
-
-Contact Chef Support, or your Chef Customer Success team and they will help you get unstuck.

data/lib/chef-cli/skeletons/code_generator/files/default/build_cookbook/kitchen.yml

@@ -1,21 +0,0 @@
----
-driver:
-  name: vagrant
-  synced_folders:
-    - [<%= File.join(ENV['PWD'], '..', '..')%>, '/tmp/repo-data']
-
-provisioner:
-  name: chef_zero
-  encrypted_data_bag_secret_key_path: 'secrets/fakey-mcfakerton'
-  data_bags_path: './data_bags'
-  product_name: chefdk
-
-platforms:
-  - name: ubuntu-20.04
-  - name: centos-8
-
-suites:
-  - name: default
-    run_list:
-      - recipe[test]
-    attributes:

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

@@ -1,8 +0,0 @@
-%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
-    cwd '/tmp/repo-data'
-    user 'vagrant'
-    environment('GIT_DISCOVERY_ACROSS_FILESYSTEM' => '1')
-  end
-end

data/lib/chef-cli/skeletons/code_generator/files/default/delivery-config.json

@@ -1,17 +0,0 @@
-{
-  "version": "2",
-  "build_cookbook": {
-    "name": "build_cookbook",
-    "path": ".delivery/build_cookbook"
-  },
-  "delivery-truck": {
-    "lint": {
-      "enable_cookstyle": true
-    }
-  },
-  "skip_phases": [],
-  "job_dispatch": {
-    "version": "v2"
-  },
-  "dependencies": []
-}

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

@@ -1,175 +0,0 @@
-context = ChefCLI::Generator.context
-workflow_project_dir = context.workflow_project_dir
-pipeline = context.pipeline
-dot_delivery_dir = File.join(workflow_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 CLI configuration')
-
-directory dot_delivery_dir
-
-cookbook_file config_json do
-  source 'delivery-config.json'
-  not_if { ::File.exist?(config_json) }
-end
-
-# Adding the delivery local-mode config
-cookbook_file project_toml do
-  source 'delivery-project.toml'
-  not_if { ::File.exist?(project_toml) }
-end
-
-generator_desc('Ensuring correct Workflow (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(ChefCLI::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(ChefCLI::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(ChefCLI::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(ChefCLI::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.workflow_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 workflow_project_dir
-    not_if { shell_out('git branch', cwd: workflow_project_dir).stdout.match(/add-delivery-configuration/) }
-  end
-
-  execute('git-add-delivery-config-json') do
-    command('git add .delivery/config.json')
-    cwd workflow_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: workflow_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 workflow_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: workflow_project_dir).stdout.match(%r{.delivery/project.toml}) }
-  end
-
-  execute('git-commit-delivery-config') do
-    command('git commit -m "Add generated delivery configuration"')
-    cwd workflow_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: workflow_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 workflow_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: workflow_project_dir).stdout.match(/\.delivery/) }
-  end
-
-  execute('git-commit-delivery-build-cookbook') do
-    command('git commit -m "Add generated delivery build cookbook"')
-    cwd workflow_project_dir
-    only_if { shell_out('git status -u --porcelain', cwd: workflow_project_dir).stdout.match(/\.delivery/) }
-  end
-
-  execute("git-return-to-#{pipeline}-branch") do
-    command("git checkout #{pipeline}")
-    cwd workflow_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 workflow_project_dir
-  end
-
-  execute('git-remove-delivery-config-branch') do
-    command('git branch -D add-delivery-configuration')
-    cwd workflow_project_dir
-  end
-end