chef-flavor-flay 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 312ca9891aec8e1d22c7152b2b724da2fff7fe51
-  data.tar.gz: 23c89bbd5d72452143c9816d9ec40f2f36f08070
+  metadata.gz: 1d4b88000fcba519db2b2cdbeaa9fbf9e7b5cff6
+  data.tar.gz: b3ab490cb4ca32b39224719afdd80275a32b78e3
 SHA512:
-  metadata.gz: 1fc58324e14fca32555fc35d976845cb7e073e18219b2412c730a10b62c9185b298bae005867412e119f4b74f480dd6f32033b9b6397cc5582ed71def2db4195
-  data.tar.gz: e0437f1a756f0021b89cdf2d02d9131d4f0900077240de72baf2f06189351566ebb592c08f313ddc3efa2555b3ea2bfdc754b7893109602973a88f44c025798b
+  metadata.gz: 122d01ba1d27fbf5fa90f30963d5e7d3384b9f821e9e011ff15dcf0e21af2021cac61642528a1cceafc784a29d938a9d42d8982b5bc08566aac1d7ef61ce6245
+  data.tar.gz: 36c895f4e86bc37ee158be8be4910d2b14fa46fa03f29fc7d6f4b090039a3400806703845be88876c74a03cbe0d2e4d6560cfe73a68af9007d29533092b3f0a1

data/Gemfile

@@ -6,6 +6,7 @@ group :development, :test do
   gem "bundler", "~> 1.11"
   gem "chef-dk", "~> 0.0"
   gem "coveralls", require: false
+  gem "foodcritic", "~> 5.0"
   gem "pry-byebug", "~> 3.0"
   gem "rake", "~> 10.0"
   gem "rspec", "~> 3.0"

data/README.md

@@ -5,10 +5,9 @@
 [![Coverage Status](https://coveralls.io/repos/sweeperio/flay/badge.svg?branch=master&service=github)](https://coveralls.io/github/sweeperio/flay?branch=master)
 
 This repo is a custom cookbook/recipe template for use with the [ChefDK]. It uses [chef-gen-flavors] to create a custom
-template that can be used with `chef generate [cookbook|recipe]` commands. 
+template that can be used with `chef generate [cookbook|recipe]` commands.
 
-It's pretty opinionated, but you could easily modify it to suit your needs, by modifying things in the 
-`shared/flavor/flay` directory.
+It's very opinionated and works with the sweeperio infrastructure specifically.
 
 [ChefDK]: https://downloads.chef.io/chef-dk/
 [chef-gen-flavors]: https://github.com/jf647/chef-gen-flavors
@@ -22,12 +21,12 @@ It's pretty opinionated, but you could easily modify it to suit your needs, by m
 ## What?
 
 * Normal setup in place...[Berkshelf], [ChefSpec], [Test Kitchen], etc.
-* Only ubuntu is supported and setup in ChefSpec and Test Kitchen (I said it was opinionated)
-* Adds [core] cookbook to the Berksfile
+* _**Only ubuntu**_ is supported and setup in ChefSpec and Test Kitchen (I said it was opinionated)
+* Sets up berks to use our berks api
+* Adds [core] cookbook to metadata.rb
 * Adds [rubocop] with some updated (opinionated) settings
 * Updates all templates to pass `bundle exec rubocop && bundle exec rspec`
-* Adds a travis file for CI that will cache it's bundle for #webscale
-* Ensures `berks`, `chef`, `chefspec` and `rubocop` are in the Gemfile (pessimistically locked to current major version)
+* Adds a travis file for CI that will use the chefdk to run tests
 * Creates a single `test` directory rather than spec/unit and test/integration
 * Adds a _dummy_ `encrypted_data_bag_secret` file for [Test Kitchen]
 * Adds `encrypt_data_bag` rake task for working with encrypted data bags in [Test Kitchen] (see note below)

data/lib/flay/version.rb

@@ -1,3 +1,3 @@
 module Flay
-  VERSION = "0.3.2".freeze
+  VERSION = "0.4.0".freeze
 end

data/shared/flavor/flay/files/default/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at david.muto@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/shared/flavor/flay/files/default/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing
+
+First off, glad you're here and want to contribute! :heart:
+
+## Getting Started
+
+You'll need to have the [chefdk] and [vagrant] installed to work on this repo. For installation and setup details,
+check out the links.
+
+## Making Changes
+
+* If necessary, [fork this repo]
+* Create a branch off of master
+* Make focused commits with descriptive messages
+* Add tests that will fail without your code, and pass with it
+* Push your branch and submit a pull request indicating the problem you're addressing and the solution you're proposing
+* **Ping someone on the PR!** - Most of us only get notifications if we're pinged directly
+
+### Running Tests
+
+* Style (rubocop/foodcritic) - `chef exec rake style`
+* RSpec/ChefSpec - `chef exec rake rspec`
+* Style and Specs - `chef exec rake`
+* Integration Tests (Test Kitchen) - `chef exec kitchen test`
+
+Generally, during development, it's faster to run `chef exec kitchen converge && chef exec kitchen verify` after each 
+change. That's totally cool, just be sure to run a clean test with `chef exec kitchen test` before submitting a PR.
+
+#### Tip
+
+If you get sick of typing `chef exec` in front of these commands, you can run `eval "$(chef shell-init SHELL)"` to 
+update your current shell to use the [chefdk] by default (you can remove `chef exec` from all these).
+
+[chefdk]: https://downloads.chef.io/chef-dk/
+[vagrant]: https://www.vagrantup.com/
+[fork this repo]: https://help.github.com/articles/fork-a-repo

data/shared/flavor/flay/files/default/Rakefile

@@ -1,6 +1,9 @@
-require "bundler/setup"
 require "chef"
+require "foodcritic"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
+# Data Bag Helpers
 SECRET_FILE        = "./test/integration/encrypted_data_bag_secret".freeze
 INPUT_PATH_FORMAT  = "./test/integration/data_bags/%s/%s.plaintext.json".freeze
 OUTPUT_PATH_FORMAT = "./test/integration/data_bags/%s/%s.json".freeze
@@ -12,6 +15,15 @@ def raw_bag_item(args)
   Chef::DataBagItem.from_hash(hash)
 end
 
+RSpec::Core::RakeTask.new { |rspec| rspec.rspec_opts = File.read("./.rspec").split("\n") }
+
+RuboCop::RakeTask.new { |rubocop| rubocop.options = %w(-D) }
+
+FoodCritic::Rake::LintTask.new do |foodcritic|
+  foodcritic.options[:progress]  = true
+  foodcritic.options[:fail_tags] = "any"
+end
+
 desc "encrypts a data bag item for integration tests"
 task :encrypt_data_bag, [:bag, :item] do |_, args|
   data_bag_item   = raw_bag_item(args)
@@ -24,3 +36,11 @@ task :encrypt_data_bag, [:bag, :item] do |_, args|
 
   puts format("encrypted test data bag: %s", output_path)
 end
+
+desc "Run Rubocop and Foodcritic style checks"
+task style: [:rubocop, :foodcritic]
+
+desc "Run all style checks and unit tests"
+task test: [:style, :spec]
+
+task default: :test

data/shared/flavor/flay/files/default/rspec

@@ -1,3 +1,4 @@
+--pattern test/unit/**/*_spec.rb
 --default-path test/unit
 --order rand
 --color

data/shared/flavor/flay/files/default/test/chef/knife.rb

@@ -0,0 +1,4 @@
+current_dir = File.dirname(__FILE__)
+node_name "travis"
+client_key "#{current_dir}/client.pem"
+chef_server_url "https://chef.sweeper.io/organizations/sweeper"

data/shared/flavor/flay/files/default/travis.yml

@@ -1,9 +1,22 @@
 ---
-language: ruby
-cache: bundler
-rvm:
-  - 2.2.3
+addons:
+  apt:
+    sources:
+      - chef-current-precise
+    packages:
+      - chefdk
+
+install: echo "skipping bundle install"
+
+before_script:
+  - eval "$(/opt/chefdk/bin/chef shell-init bash)"
+  - cp -r test/chef .chef
+  - openssl enc -d -aes-256-cbc -k $CLIENT_PASSPHRASE -in .chef/client.enc -out .chef/client.pem
 
 script:
-  - bundle exec rubocop
-  - bundle exec rspec
+  - chef --version
+  - rubocop --version
+  - foodcritic --version
+  - rspec --version
+  - rake --version
+  - rake

data/shared/flavor/flay/recipes/cookbook.rb

@@ -1,5 +1,6 @@
 context      = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
+kitchen_dir  = File.join(cookbook_dir, "test", "integration")
 
 # Common Cookbook Things
 directory cookbook_dir
@@ -10,43 +11,56 @@ cookbook_file("#{cookbook_dir}/.gitignore") { source "gitignore" }
 cookbook_file("#{cookbook_dir}/.rubocop.yml") { source "rubocop.yml" }
 cookbook_file("#{cookbook_dir}/Berksfile") { action :create_if_missing }
 cookbook_file "#{cookbook_dir}/chefignore"
-cookbook_file "#{cookbook_dir}/Gemfile"
+cookbook_file "#{cookbook_dir}/CODE_OF_CONDUCT.md"
+cookbook_file "#{cookbook_dir}/CONTRIBUTING.md"
 cookbook_file "#{cookbook_dir}/Rakefile"
 
 flay_template "#{cookbook_dir}/metadata.rb"
 flay_template "#{cookbook_dir}/README.md"
+flay_template "#{cookbook_dir}/LICENSE"
 
 # ChefSpec
+directory("#{cookbook_dir}/test/chef") { recursive true }
 directory("#{cookbook_dir}/test/unit/recipes") { recursive true }
 
+cookbook_file("#{cookbook_dir}/.rspec") { source "rspec" }
+cookbook_file("#{cookbook_dir}/.travis.yml") { source "travis.yml" }
+cookbook_file("#{cookbook_dir}/test/chef/client.enc") { source "test/chef/client.enc" }
+cookbook_file("#{cookbook_dir}/test/chef/knife.rb") { source "test/chef/knife.rb" }
+
 cookbook_file "#{cookbook_dir}/test/unit/spec_helper.rb" do
-  source "spec_helper.rb"
+  source "test/unit/spec_helper.rb"
   action :create_if_missing
 end
 
-cookbook_file("#{cookbook_dir}/.rspec") { source "rspec" }
-cookbook_file("#{cookbook_dir}/.travis.yml") { source "travis.yml" }
-
 flay_template("#{cookbook_dir}/recipes/default.rb") { source "recipe.rb.erb" }
 flay_template("#{cookbook_dir}/test/unit/recipes/default_spec.rb") { source "recipe_spec.rb.erb" }
 
 # Test Kitchen
-directory("#{cookbook_dir}/test/integration/data_bags/ejson") { recursive true }
-directory("#{cookbook_dir}/test/integration/default/serverspec") { recursive true }
-directory("#{cookbook_dir}/test/integration/helpers/serverspec") { recursive true }
+directory("#{kitchen_dir}/data_bags/ejson") { recursive true }
+directory("#{kitchen_dir}/default/serverspec") { recursive true }
+directory("#{kitchen_dir}/helpers/serverspec") { recursive true }
 
-cookbook_file("#{cookbook_dir}/test/integration/encrypted_data_bag_secret") { source "encrypted_data_bag_secret" }
-cookbook_file("#{cookbook_dir}/test/integration/data_bags/ejson/keys.json") { source "keys.json" }
-cookbook_file("#{cookbook_dir}/test/integration/data_bags/ejson/keys.plaintext.json") { source "keys.plaintext.json" }
+cookbook_file("#{kitchen_dir}/encrypted_data_bag_secret") do
+  source "test/integration/encrypted_data_bag_secret"
+end
+
+cookbook_file("#{kitchen_dir}/data_bags/ejson/keys.json") do
+  source "test/integration/data_bags/ejson/keys.json"
+end
+
+cookbook_file("#{kitchen_dir}/data_bags/ejson/keys.plaintext.json") do
+  source "test/integration/data_bags/ejson/keys.plaintext.json"
+end
 
-cookbook_file "#{cookbook_dir}/test/integration/helpers/serverspec/spec_helper.rb" do
-  source "serverspec_spec_helper.rb"
+cookbook_file "#{kitchen_dir}/helpers/serverspec/spec_helper.rb" do
+  source "test/integration/helpers/serverspec/spec_helper.rb"
   action :create_if_missing
 end
 
 flay_template("#{cookbook_dir}/.kitchen.yml") { source "kitchen.yml.erb" }
 
-flay_template "#{cookbook_dir}/test/integration/default/serverspec/default_spec.rb" do
+flay_template "#{kitchen_dir}/default/serverspec/default_spec.rb" do
   source "serverspec_default_spec.rb.erb"
 end
 

data/shared/flavor/flay/recipes/recipe.rb

@@ -7,7 +7,7 @@ spec_path        = File.join(cookbook_dir, "test", "unit", "recipes", "#{context
 directory("#{cookbook_dir}/test/unit/recipes") { recursive true }
 
 cookbook_file spec_helper_path do
-  source "spec_helper.rb"
+  source "test/unit/spec_helper.rb"
   action :create_if_missing
 end
 

data/shared/flavor/flay/templates/default/LICENSE.erb

@@ -0,0 +1 @@
+<%= license_description("#").rstrip %>

data/shared/flavor/flay/templates/default/README.md.erb

@@ -1,3 +1,31 @@
 # <%= sanitized_cookbook_name %>
 
-TODO: Enter the cookbook description here.
+[![Build Status](https://travis-ci.org/sweeperio/<%= cookbook_name %>.svg?branch=master)](https://travis-ci.org/sweeperio/<%= cookbook_name %>)
+
+Install/configure <%= sanitized_cookbook_name %>
+
+## What This Does
+
+* Thing 1
+* Thing 2
+
+* Add the cookbook description here.
+* Add status badge once travis is setup
+
+## Attributes
+
+| attribute | description | default |
+|-----------|-------------|---------|
+| `node["<%= sanitized_cookbook_name %>"]["value"]` | some description | `""` |
+
+## Recipes
+
+### <%= sanitized_cookbook_name %>::default
+
+TODO: description
+
+**Usage:** add `recipe[<%= sanitized_cookbook_name %>]` to your run list.
+
+## License
+
+<%= license_description.rstrip %>

data/shared/flavor/flay/templates/default/metadata.rb.erb

@@ -4,7 +4,7 @@ maintainer       "<%= copyright_holder %>"
 maintainer_email "<%= email %>"
 license          "<%= license %>"
 description      "Installs/Configures <%= sanitized_cookbook_name %>"
-long_description "Installs/Configures <%= sanitized_cookbook_name %>"
+long_description IO.read(File.join(File.dirname(__FILE__), "README.md"))
 version          "0.1.0"
 # rubocop:enable Style/SingleSpaceBeforeFirstArg
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-flavor-flay
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - pseudomuto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-gen-flavors
@@ -70,22 +70,26 @@ files:
 - lib/flay/helpers.rb
 - lib/flay/version.rb
 - shared/flavor/flay/files/default/Berksfile
-- shared/flavor/flay/files/default/Gemfile
+- shared/flavor/flay/files/default/CODE_OF_CONDUCT.md
+- shared/flavor/flay/files/default/CONTRIBUTING.md
 - shared/flavor/flay/files/default/Rakefile
 - shared/flavor/flay/files/default/chefignore
-- shared/flavor/flay/files/default/encrypted_data_bag_secret
 - shared/flavor/flay/files/default/gitignore
-- shared/flavor/flay/files/default/keys.json
-- shared/flavor/flay/files/default/keys.plaintext.json
 - shared/flavor/flay/files/default/rspec
 - shared/flavor/flay/files/default/rubocop.yml
-- shared/flavor/flay/files/default/serverspec_spec_helper.rb
-- shared/flavor/flay/files/default/spec_helper.rb
+- shared/flavor/flay/files/default/test/chef/client.enc
+- shared/flavor/flay/files/default/test/chef/knife.rb
+- shared/flavor/flay/files/default/test/integration/data_bags/ejson/keys.json
+- shared/flavor/flay/files/default/test/integration/data_bags/ejson/keys.plaintext.json
+- shared/flavor/flay/files/default/test/integration/encrypted_data_bag_secret
+- shared/flavor/flay/files/default/test/integration/helpers/serverspec/spec_helper.rb
+- shared/flavor/flay/files/default/test/unit/spec_helper.rb
 - shared/flavor/flay/files/default/travis.yml
 - shared/flavor/flay/metadata.rb
 - shared/flavor/flay/recipes/cookbook.rb
 - shared/flavor/flay/recipes/recipe.rb
 - shared/flavor/flay/resources/template.rb
+- shared/flavor/flay/templates/default/LICENSE.erb
 - shared/flavor/flay/templates/default/README.md.erb
 - shared/flavor/flay/templates/default/kitchen.yml.erb
 - shared/flavor/flay/templates/default/metadata.rb.erb

data/shared/flavor/flay/files/default/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gem "berkshelf", "~> 4.0"
-gem "chef", "~> 12.0"
-gem "chefspec", "~> 4.0"
-gem "rubocop", "~> 0.0"