idlc-sdk-pfm 1.0.0.pre.2

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/build_cookbook/.kitchen.yml

@@ -0,0 +1,21 @@
+---
+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-16.04
+  - name: centos-7.3
+
+suites:
+  - name: default
+    run_list:
+      - recipe[test]
+    attributes:

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/build_cookbook/README.md

@@ -0,0 +1,146 @@
+# build_cookbook
+
+A build cookbook for running the parent project through Chef Delivery
+
+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.
+
+## .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.
+
+## 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.
+
+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 Delivery 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.
+
+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 16.04' do
+    let(:chef_run) do
+      runner = ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '16.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 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 awhile 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 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.
+
+```
+cd ../..
+delivery review
+```
+
+## FAQ
+
+### 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.
+
+### 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.
+
+### 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/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/build_cookbook/test-fixture-recipe.rb

@@ -0,0 +1,8 @@
+%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/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/chefignore

@@ -0,0 +1,107 @@
+# Put files/directories that should be ignored in this file when uploading
+# to a chef-server or supermarket.
+# Lines that start with '# ' are comments.
+
+# OS generated files #
+######################
+.DS_Store
+Icon?
+nohup.out
+ehthumbs.db
+Thumbs.db
+
+# SASS #
+########
+.sass-cache
+
+# EDITORS #
+###########
+\#*
+.#*
+*~
+*.sw[a-z]
+*.bak
+REVISION
+TAGS*
+tmtags
+*_flymake.*
+*_flymake
+*.tmproj
+.project
+.settings
+mkmf.log
+
+## COMPILED ##
+##############
+a.out
+*.o
+*.pyc
+*.so
+*.com
+*.class
+*.dll
+*.exe
+*/rdoc/
+
+# Testing #
+###########
+.watchr
+.rspec
+spec/*
+spec/fixtures/*
+test/*
+features/*
+examples/*
+Guardfile
+Procfile
+.kitchen*
+.rubocop.yml
+spec/*
+Rakefile
+.travis.yml
+.foodcritic
+.codeclimate.yml
+
+# SCM #
+#######
+.git
+*/.git
+.gitignore
+.gitmodules
+.gitconfig
+.gitattributes
+.svn
+*/.bzr/*
+*/.hg/*
+*/.svn/*
+
+# Berkshelf #
+#############
+Berksfile
+Berksfile.lock
+cookbooks/*
+tmp
+
+# Policyfile #
+##############
+Policyfile.rb
+Policyfile.lock.json
+
+# Cookbooks #
+#############
+CONTRIBUTING*
+CHANGELOG*
+TESTING*
+MAINTAINERS.toml
+
+# Strainer #
+############
+Colanderfile
+Strainerfile
+.colander
+.strainer
+
+# Vagrant #
+###########
+.vagrant
+Vagrantfile

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/cookbook_readmes/README-policy.md

@@ -0,0 +1,9 @@
+This directory typically contains Chef cookbooks. This repository was
+generated with the '--policy-only' option, which means you have chosen
+to use a workflow where each cookbook is treated as an independent
+software project. As a result, any cookbooks present in this directory
+are independent git projects, and the contents of this directory have
+been added to .gitignore.
+
+Love,
+Chef

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/cookbook_readmes/README.md

@@ -0,0 +1,54 @@
+This directory contains the cookbooks used to configure systems in your infrastructure with Chef - an example basic cookbook called `example` has been automatically created for you.
+
+Knife needs to be configured to know where the cookbooks are located with the `cookbook_path` setting. If this is not set, then several cookbook operations will fail to work properly.
+
+    cookbook_path ["./cookbooks"]
+
+This setting tells knife to look for the cookbooks directory in the present working directory. This means the knife cookbook subcommands need to be run in the `chef-repo` directory itself. To make sure that the cookbooks can be found elsewhere inside the repository, use an absolute path. This is a Ruby file, so something like the following can be used:
+
+    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`).
+
+Configure knife to use your preferred copyright holder, email contact and license. Add the following lines to `.chef/knife.rb`.
+
+    cookbook_copyright "Example, Com."
+    cookbook_email     "cookbooks@example.com"
+    cookbook_license   "apachev2"
+
+Supported values for `cookbook_license` are "apachev2", "mit","gplv2","gplv3",  or "none". These settings are used to prefill comments in the default recipe, and the corresponding values in the metadata.rb. You are free to change the the comments in those files.
+
+Create new cookbooks in this directory with Knife.
+
+    knife cookbook create COOKBOOK
+
+This will create all the cookbook directory components. You don't need to use them all, and can delete the ones you don't need. It also creates a README file, metadata.rb and default recipe.
+
+You can also download cookbooks directly from the Opscode Cookbook Site. There are two subcommands to help with this depending on what your preference is.
+
+The first and recommended method is to use a vendor branch if you're using Git. This is automatically handled with Knife.
+
+    knife cookbook site install COOKBOOK
+
+This will:
+
+* Download the cookbook tarball from the Chef Supermarket.
+* Ensure its on the git master branch.
+* Checks for an existing vendor branch, and creates if it doesn't.
+* Checks out the vendor branch (chef-vendor-COOKBOOK).
+* Removes the existing (old) version.
+* Untars the cookbook tarball it downloaded in the first step.
+* Adds the cookbook files to the git index and commits.
+* Creates a tag for the version downloaded.
+* Checks out the master branch again.
+* Merges the cookbook into master.
+* Repeats the above for all the cookbooks dependencies, downloading them from the community site
+
+The last step will ensure that any local changes or modifications you have made to the cookbook are preserved, so you can keep your changes through upstream updates.
+
+If you're not using Git, use the site download subcommand to download the tarball.
+
+    knife cookbook site download COOKBOOK
+
+This creates the COOKBOOK.tar.gz from in the current directory (e.g., `~/chef-repo`). We recommend following a workflow similar to the above for your version control tool.

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/delivery-config.json

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

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/delivery-project.toml

@@ -0,0 +1,36 @@
+# Delivery Prototype 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.
+#
+# 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/"
+lint = "chef exec cookstyle"
+# Foodcritic includes rules only appropriate for community cookbooks
+# uploaded to Supermarket. We turn off any rules tagged "supermarket"
+# by default. If you plan to share this cookbook you should remove
+# '-t ~supermarket' below to enable supermarket rules.
+syntax = "chef exec foodcritic . --exclude spec -f any -t ~supermarket"
+provision = "chef exec kitchen create"
+deploy = "chef exec kitchen converge"
+smoke = "chef exec kitchen verify"
+# The functional phase is optional, you can define it by uncommenting
+# the line below and running the command: `delivery local functional`
+# functional = ""
+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.
+#
+# remote_file = "https://url/project.toml"

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/gitignore

@@ -0,0 +1,21 @@
+.vagrant
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+
+# Bundler
+Gemfile.lock
+bin/*
+.bundle/*
+
+# test kitchen
+.kitchen/
+.kitchen.local.yml
+
+# Chef
+Berksfile.lock
+.zero-knife.rb
+Policyfile.lock.json

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/README.md

@@ -0,0 +1,24 @@
+# Overview
+
+Every Chef installation needs a Chef Repository. This is the place where cookbooks, roles, config files and other artifacts for managing systems with Chef will live. We strongly recommend storing this repository in a version control system such as Git and treat it like source code.
+
+While we prefer Git, and make this repository available via GitHub, you are welcome to download a tar or zip archive and use your favorite version control system to manage the code.
+
+# Repository Directories
+
+This repository contains several directories, and each directory contains a README file that describes what it is for in greater detail, and how to use it for managing your systems with Chef.
+
+- `cookbooks/` - Cookbooks you download or create.
+- `data_bags/` - Store data bags and items in .json in the repository.
+- `roles/` - Store roles in .rb or .json in the repository.
+- `environments/` - Store environments in .rb or .json in the repository.
+
+# Configuration
+
+The config file, `.chef/knife.rb` is a repository specific configuration file for knife. If you're using the Chef Platform, you can download one for your organization from the management console. If you're using the Open Source Chef Server, you can generate a new one with `knife configure`. For more information about configuring Knife, see the Knife documentation.
+
+<https://docs.chef.io/knife.html>
+
+# Next Steps
+
+Read the README file in each of the subdirectories for more information about what goes in those directories.

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/cookbooks/example/README.md

@@ -0,0 +1,27 @@
+# Example
+
+An example cookbook
+
+## Requirements
+
+### Platform:
+
+_No platforms defined_
+
+### Cookbooks:
+
+_No dependencies defined_
+
+## Attributes
+
+- `node['example']['name']` - Defaults to `Sam Doe`.
+
+## Recipes
+
+- example::default
+
+## License and Maintainer
+
+Maintainer:: (<>)
+
+License:: All rights reserved

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/cookbooks/example/attributes/default.rb

@@ -0,0 +1,7 @@
+# This is a Chef attributes file. It can be used to specify default and override
+# attributes to be applied to nodes that run this cookbook.
+
+# Set a default name
+default['example']['name'] = 'Sam Doe'
+
+# For further information, see the Chef documentation (https://docs.chef.io/essentials_cookbook_attribute_files.html).

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/cookbooks/example/metadata.rb

@@ -0,0 +1,6 @@
+name 'example'
+description 'An example cookbook'
+maintainer 'Example maintainer'
+maintainer_email 'maintainer@example.com'
+license 'Apache v2'
+version '1.0.0'

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/cookbooks/example/recipes/default.rb

@@ -0,0 +1,8 @@
+# This is a Chef recipe file. It can be used to specify resources which will
+# apply configuration to a server.
+
+log "Welcome to Chef, #{node['example']['name']}!" do
+  level :info
+end
+
+# For more information, see the documentation: https://docs.chef.io/recipes.html

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/data_bags/README.md

@@ -0,0 +1,56 @@
+# Data Bags
+
+This directory contains directories of the various data bags you create for your infrastructure. Each subdirectory corresponds to a data bag on the Chef Server, and contains JSON files of the items that go in the bag.
+
+For example, in this directory you'll find an example data bag directory called `example`, which contains an item definition called `example_item.json`
+
+Before uploading this item to the server, we must first create the data bag on the Chef Server.
+
+    knife data bag create example
+
+Then we can upload the items in the data bag's directory to the Chef Server.
+
+    knife data bag from file example example_item.json
+
+For more information on data bags, see the Chef wiki page:
+
+https://docs.chef.io/data_bags.html
+
+# Encrypted Data Bags
+
+Encrypted data bags allow you to encrypt the contents of your data bags. The content of attributes will no longer be searchable. To use encrypted data bags, first you must have or create a secret key.
+
+    openssl rand -base64 512 > secret_key
+
+You may use this secret_key to add items to a data bag during a create.
+
+    knife data bag create --secret-file secret_key passwords mysql
+
+You may also use it when adding ITEMs from files,
+
+    knife data bag create passwords
+    knife data bag from file passwords data_bags/passwords/mysql.json --secret-file secret_key
+
+The JSON for the ITEM must contain a key named "id" with a value equal to "ITEM" and the contents will be encrypted when uploaded. For example,
+
+    {
+      "id": "mysql",
+      "password": "abc123"
+    }
+
+Without the secret_key, the contents are encrypted.
+
+    knife data bag show passwords mysql
+    id:        mysql
+    password:  2I0XUUve1TXEojEyeGsjhw==
+
+Use the secret_key to view the contents.
+
+    knife data bag show passwords mysql --secret-file secret_key
+    id:        mysql
+    password:  abc123
+
+
+For more information on encrypted data bags, see the Chef wiki page:
+
+https://docs.chef.io/data_bags.html

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/data_bags/example/example_item.json

@@ -0,0 +1,4 @@
+{
+    "id": "example_item",
+    "key": "value"
+}

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/dot-chef-repo.txt

@@ -0,0 +1,6 @@
+.chef-repo.txt
+==============
+
+This file gives ChefDK's generators a hint that you are using a Chef Repo and
+this is the root directory of your Chef Repo. ChefDK's generators use this to
+generate code that is designed to work with the Chef Repo workflow.

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/environments/README.md

@@ -0,0 +1,9 @@
+Create environments here, in either the Role Ruby DSL (.rb) or JSON (.json) files. To install environments on the server, use knife.
+
+For example, in this directory you'll find an example environment file called `example.json` which can be uploaded to the Chef Server:
+
+    knife environment from file environments/example.json
+
+For more information on environments, see the Chef wiki page:
+
+https://docs.chef.io/environments.html

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/environments/example.json

@@ -0,0 +1,13 @@
+{
+    "name": "example",
+    "description": "This is an example environment defined as JSON",
+    "chef_type": "environment",
+    "json_class": "Chef::Environment",
+    "default_attributes": {
+    },
+    "override_attributes": {
+    },
+    "cookbook_versions": {
+        "example": "= 1.0.0"
+    }
+}

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/policies/README.md

@@ -0,0 +1,24 @@
+Create policyfiles here. When using a chef-repo, give your policyfiles
+the same filename as the name set in the policyfile itself, and use the
+`.rb` file extension.
+
+Compile the policy with a command like this:
+
+```
+chef install policies/my-app-frontend.rb
+```
+
+This will create a lockfile `policies/my-app-frontend.lock.json`.
+
+To update locked dependencies, run `chef update` like this:
+
+```
+chef update policies/my-app-frontend.rb
+```
+
+You can upload the policy (with associated cookbooks) to the server
+using a command like:
+
+```
+chef push staging policies/my-app-frontend.rb
+```

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/roles/README.md

@@ -0,0 +1,9 @@
+Create roles here, in either the Role Ruby DSL (.rb) or JSON (.json) files. To install roles on the server, use knife.
+
+For example, in this directory you'll find an example role file called `example.json` which can be uploaded to the Chef Server:
+
+    knife role from file roles/example.json
+
+For more information on roles, see the Chef wiki page:
+
+https://docs.chef.io/roles.html

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/repo/roles/example.json

@@ -0,0 +1,13 @@
+{
+    "name": "example",
+    "description": "This is an example role defined as JSON",
+    "chef_type": "role",
+    "json_class": "Chef::Role",
+    "default_attributes": {
+    },
+    "override_attributes": {
+    },
+    "run_list": [
+        "recipe[example]"
+    ]
+}

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'chefspec'
+require 'chefspec/berkshelf'

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/files/default/spec_helper_policyfile.rb

@@ -0,0 +1,2 @@
+require 'chefspec'
+require 'chefspec/policyfile'

data/lib/idlc-sdk-pfm/command/generator_commands/skeletons/code_generator/metadata.rb

@@ -0,0 +1,7 @@
+name             'code_generator'
+maintainer       'Chef Software, Inc.'
+maintainer_email 'dev@chef.io'
+license          'Apache 2 License'
+description      'Generates Chef code for Chef DK'
+long_description 'Generates Chef code for Chef DK'
+version          '0.1.0'