stove 1.1.2 → 2.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb680ed6abba285ad793a197007f945ff29c3325
-  data.tar.gz: 3eb82731cdbdd0f27ad30f5cc1eb0afe05480a41
+  metadata.gz: 9e3e8effc89249cc85ef1bbb409edc1b17ae623b
+  data.tar.gz: a01bd5570bc5651d738a5e31c36ed032e3ce1c75
 SHA512:
-  metadata.gz: 3d9ca773a3064120898b78d89c96c195bdaee6a687261238d3f813dafba37507c704199e0d15ff146403ab4f750db8c33971c6e844987bfba16d0ca91e74e343
-  data.tar.gz: f410e99c3a7de4ed4684840fc42889b708d997c9d3cf7ea4649042c201fe13544ef475adf3488b2a137821ed767dad76c64ffc1794f63e944b3216473681d38c
+  metadata.gz: 2cae616ad8cd9526e80365f4590640152afa2c411eac9a5c3b0c6028afcb7a710e3cf6549947b0e19ffd18eb16872cec997a3cdafbab172c2d79ff69ba0f0a6c
+  data.tar.gz: ef5adf673f387952bba98a73d5ea8875fb1bb9610feb9841c15d02b431934fff20124b82cbcd845995aa940589de110c6f1de3b9f8aaad23a3838842b6792c69

data/.travis.yml

@@ -1,8 +1,7 @@
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 before_script:
   - git config --global user.email "ci@traivs-ci.org"
   - git config --global user.name "Travis CI"
-script:
-  - bundle exec cucumber --color --format progress --strict

data/CHANGELOG.md

@@ -2,6 +2,22 @@ Stove CHANGELOG
 ===============
 This is the Changelog for the Stove gem.
 
+v2.0.0 (unreleased)
+-------------------
+- Completely refactor the runner for speed optimizations
+- Introduce a new configuration file format
+- Add i18n support
+- Add Filters and validations that execute before any commands are run
+- Autoload plugins and actions
+- Improve help output by grouping options
+- Trap Signal interrupts cleanly
+- Remove formatters
+- Switch to log4r
+- Introduce significantly more logging and log levels
+- Remove HTTParty & Jiralicious in favor or Faraday
+- Improve rake task to automatically perfom a minor bump when no version if given
+- Persist data across the cookbook object
+- Use singleton classes to save memory and loadtime
 
 v1.1.0
 ------

data/README.md

@@ -33,36 +33,38 @@ Alternatively, you may install it as a gem:
 
     $ gem install stove
 
-Create a special JIRA credentials file at '~/.stove' that has the following JSON:
+The use of some plugins (such as GitHub and JIRA) require a Stove configuration file. The Stove config is a JSON file stored at `~/.stove` on your local hard drive. The schema looks like this:
 
 ```javascript
 {
-  "jira_username": "JIRA_USERNAME",
-  "jira_password": "JIRA_PASSWORD",
-  "opscode_username": "OPSCODE_USERNAME",
-  "opscode_pem_file": "OPSCODE_PEM_FILE",
-  "github_access_token": "PERSONAL_API_TOKEN"
+  "field": {
+    "option": "value"
+  }
 }
 ```
 
-- `jira_username` - The username used to login to Opscode's JIRA
-- `jira_password` - The password used to login to Opscode's JIRA
-- `opscode_username` - The username used to login to Opscode's Community Site
-- `opscode_password` - The password used to login to Opscode's Community Site
-- `github_access_token` - Your personal access token for the GitHub API
-
-For example:
+For example, my local Stove configuration looks like this:
 
 ```javascript
 {
-  "jira_username": "sethvargo",
-  "jira_password": "bAc0ñ",
-  "opscode_username": "sethvargo",
-  "opscode_pem_file": "~/.chef/sethvargo.pem",
-  "github_access_token": "abcdefg1234567"
+  "community": {
+    "username": "sethvargo",
+    "key": "~/.chef/sethvargo.pem"
+  },
+  "github": {
+    "access_token": "..."
+  },
+  "jira": {
+    "username": "sethvargo",
+    "password": "..."
+  }
 }
 ```
 
+If you are using Stove 1.0, you need to update your configuration file syntax.
+
+**It is recommended that the permissions on this file be 0600 to prevent unauthorized reading!**
+
 
 Usage
 -----
@@ -70,19 +72,29 @@ The gem is packaged as a binary. It should be run from _inside the cookbook to r
 
     (~/cookbooks/bacon) $ bake 1.2.3
 
+You can always use the `--help` flag to get information:
+
 ```text
 Usage: bake x.y.z
-    -l, --log-level [LEVEL]          Ruby log level
-    -c, --category [CATEGORY]        The category for the cookbook (optional for existing cookbooks)
-    -p, --path [PATH]                The path to the cookbook to release (default: PWD)
-        --[no-]git                   Automatically tag and push to git (default: true)
-        --[no-]github                Automatically release to GitHub (default: true)
-    -r, --remote                     The name of the git remote to push to
-    -b, --branch                     The name of the git branch to push to
-        --[no-]devodd                Automatically bump the metadata for devodd releases
-        --[no-]jira                  Automatically populate the CHANGELOG from JIRA tickets and close them (default: false)
-        --[no-]upload                Upload the cookbook to the Opscode Community Site (default: true)
-        --[no-]changelog             Automatically generate a CHANGELOG (default: true)
+
+Actions:
+        --no-bump                    Perform a version bump the local version automatically
+        --no-changelog               Generate and prompt for a CHANGELOG
+        --no-dev                     Bump a minor version release for development purposes
+        --no-upload                  Upload the cookbook to the community site
+
+Plugins:
+        --no-git                     Tag and push to a git remote
+        --no-github                  Publish the release to GitHub
+        --no-jira                    Resolve JIRA issues
+
+Global Options:
+        --locale [LANGUAGE]          Change the language to output messages
+        --log-level [LEVEL]          Set the log verbosity
+        --category [CATEGORY]        Set category for the cookbook
+        --path [PATH]                Change the path to a cookbook
+        --remote [REMOTE]            The name of the git remote to push to
+        --branch [BRANCH]            The name of the git branch to push to
     -h, --help                       Show this message
     -v, --version                    Show version
 ```

data/Rakefile

@@ -1 +1,16 @@
 require 'bundler/gem_tasks'
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:acceptance) do |t|
+  t.cucumber_opts = [].tap do |a|
+    a.push('--color')
+    a.push('--format progress')
+    a.push('--strict')
+    a.push('--tags ~@wip')
+  end.join(' ')
+end
+
+desc 'Run all tests'
+task :test => [:acceptance]
+
+task :default => [:test]

data/bin/bake

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
 
-$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
-require 'stove/cli'
+require 'stove'
 Stove::Cli.new(ARGV.dup).execute!

data/features/actions/bump.feature

@@ -0,0 +1,22 @@
+Feature: Bump
+  Background:
+    * the Stove config is empty
+    * the CLI options are all off
+    * I have a cookbook named "bacon" at version "1.0.0"
+
+  Scenario: When the version has not changed
+    * I run `bake 1.0.0 --bump`
+    * it should fail with "version you are trying to bump already exists"
+
+  Scenario: When the version is not greater than the current
+    * I run `bake 0.1.0 --bump`
+    * it should fail with "bump to is less than the existing version"
+
+  Scenario: In isolation
+    * I successfully run `bake 2.0.0 --bump`
+    * the file "metadata.rb" should contain "2.0.0"
+
+  Scenario: With the git plugin
+    * I have a cookbook named "bacon" with git support
+    * I successfully run `bake 1.0.0 --bump --git`
+    * the git remote should have the commit "Version bump to 1.0.0"

data/features/actions/changelog.feature

@@ -0,0 +1,45 @@
+Feature: Changelog
+  Background:
+    * the Stove config is empty
+    * the CLI options are all off
+    * I have a cookbook named "bacon"
+
+  Scenario: When the Changelog does not exist
+    * I remove the file "CHANGELOG.md"
+    * I run `bake --changelog`
+    * it should fail with "There is no `CHANGELOG.md' found"
+
+  Scenario: When the Changelog is not a proper format
+    * I write to "CHANGELOG.md" with:
+      """
+      This can't possibly be a valid Changelog
+      """
+    * I run `bake --changelog`
+    * it should fail with "does not appear to be a valid format"
+
+  Scenario: When the $EDITOR is not set
+    * the environment variable "EDITOR" is unset
+    * I run `bake --changelog`
+    * it should fail with "The `$EDITOR' environment variable is not set"
+
+  Scenario: In isolation
+    * the environment variable "EDITOR" is "cat"
+    * I successfully run `bake --changelog`
+    * the file "CHANGELOG.md" should contain "v0.0.0"
+
+  Scenario: With bump
+    * the environment variable "EDITOR" is "cat"
+    * I successfully run `bake 1.0.0 --changelog --bump`
+    * the file "CHANGELOG.md" should contain "v1.0.0"
+
+  Scenario: With the git plugin
+    * I have a cookbook named "bacon" with git support
+    * the environment variable "EDITOR" is "cat"
+    * I successfully run `bake --changelog --git`
+    * the git remote should have the commit "Publish 0.0.0 Changelog"
+
+  @wip
+  Scenario: With the GitHub plugin
+
+  @wip
+  Scenario: With the JIRA plugin

data/features/actions/dev.feature

@@ -0,0 +1,18 @@
+Feature: Dev
+  Background:
+    * the Stove config is empty
+    * the CLI options are all off
+    * I have a cookbook named "bacon" at version "1.0.0"
+
+  Scenario: In isolation
+    * I successfully run `bake --dev`
+    * the file "metadata.rb" should contain "1.0.1"
+
+  Scenario: With bump
+    * I successfully run `bake 2.0.0 --bump --dev`
+    * the file "metadata.rb" should contain "2.0.1"
+
+  Scenario: With the git plugin
+    * I have a cookbook named "bacon" with git support
+    * I successfully run `bake --dev --git`
+    * the git remote should have the commit "Version bump to 0.0.1 (for development)"

data/features/actions/upload.feature

@@ -0,0 +1,48 @@
+Feature: Upload
+  Background:
+    * the Stove config is empty
+    * the CLI options are all off
+    * I have a cookbook named "bacon"
+    * I am using the community server
+
+  Scenario: When the configuration does not exist
+    * I run `bake --upload`
+    * it should fail with "configuration for the Chef community site does not exist"
+
+  Scenario: When the username does not exist
+    * the Stove config at "community._" is ""
+    * I run `bake --upload`
+    * it should fail with "does not contain a username"
+
+  Scenario: When the key does not exist
+    * the Stove config at "community.username" is "bobo"
+    * I run `bake --upload`
+    * it should fail with "does not contain a key"
+
+  Scenario: When the category does not exist
+    * the Stove config at "community.username" is "bobo"
+    * the Stove config at "community.key" is "../../features/support/stove.pem"
+    * I run `bake --upload`
+    * it should fail with "You did not specify a category"
+
+  Scenario: In isolation
+    * the Stove config at "community.username" is "bobo"
+    * the Stove config at "community.key" is "../../features/support/stove.pem"
+    * the community server has the cookbook:
+      | bacon | 1.2.3 | Application |
+    * I successfully run `bake --upload`
+
+  Scenario: With the git plugin
+    * I have a cookbook named "bacon" with git support
+    * the Stove config at "community.username" is "bobo"
+    * the Stove config at "community.key" is "../../features/support/stove.pem"
+    * the community server has the cookbook:
+      | bacon | 1.2.3 | Application |
+    * I successfully run `bake --git --upload`
+    * the git remote should have the tag "v0.0.0"
+
+  @wip
+  Scenario: With the GitHub plugin
+
+  @wip
+  Scenario: With the JIRA plugin

data/features/plugins/git.feature

@@ -0,0 +1,24 @@
+Feature: git Plugin
+  Background:
+    * the Stove config is empty
+    * the CLI options are all off
+    * I have a cookbook named "bacon"
+
+  Scenario: When the directory is not a git repository
+    * I run `bake --git`
+    * it should fail with "does not appear to be a valid git repository"
+
+  Scenario: When the directory is dirty
+    * I have a cookbook named "bacon" with git support
+    * I write to "new" with:
+     """
+     This is new content
+     """
+    * I run `bake --git`
+    * it should fail with "has untracked files"
+
+  Scenario: When the local is out of date with the remote
+    * I have a cookbook named "bacon" with git support
+    * the remote repository has additional commits
+    * I run `bake --git`
+    * it should fail with "out of sync with the remote repository"

data/features/rake.feature

@@ -1,4 +1,3 @@
-@spawn
 Feature: Rake Task
   Background:
     * I have a cookbook named "bacon"
@@ -12,5 +11,5 @@ Feature: Rake Task
     * I successfully run `rake -T`
     * the output should contain:
       """
-      rake publish  # Publish this cookbook
+      rake publish[version]  # Publish this cookbook
       """

data/features/step_definitions/cli_steps.rb

@@ -1,29 +1,3 @@
-Given /^the environment variable (.+) is "(.+)"$/ do |variable, value|
-  set_env(variable, value)
-end
-
-Then /^the exit status will be "(.+)"$/ do |error|
-  # Ruby 1.9.3 sucks
-  klass = error.split('::').inject(Stove) { |c, n| c.const_get(n) }
-  assert_exit_status(klass.exit_code)
-end
-
 When /^the CLI options are all off$/ do
-  class Stove::Cli
-    private
-      def options
-        @options ||= {
-          path:      Dir.pwd,
-          git:       false,
-          github:    false,
-          devodd:    false,
-          remote:    'origin',
-          branch:    'master',
-          jira:      false,
-          upload:    false,
-          changelog: false,
-          log_level: :fatal,
-        }
-      end
-  end
+  set_env('CLI_DEFAULT', 'false')
 end

data/features/step_definitions/{community_site_steps.rb → community_steps.rb}

@@ -1,19 +1,23 @@
-Given /^the Community Site has the cookbooks?:$/ do |table|
+Given /^I am using the community server$/ do
+  set_env('COMMUNITY_URL', CommunityZero::RSpec.url)
+end
+
+Given /^the community server has the cookbooks?:$/ do |table|
   table.raw.each do |name, version, category|
     version  ||= '0.0.0'
     category ||= 'Other'
 
-    CommunityZero::Cookbook.create({
+    CommunityZero::RSpec.store.add(CommunityZero::Cookbook.new(
       name:     name,
       version:  version,
       category: category,
-    })
+    ))
   end
 end
 
-Then /^the Community Site will( not)? have the cookbooks?:$/ do |negate, table|
+Then /^the community server will( not)? have the cookbooks?:$/ do |negate, table|
   table.raw.each do |name, version, category|
-    cookbook = CommunityZero::Store.find(name, version)
+    cookbook = CommunityZero::RSpec.store.find(name, version)
 
     if negate
       expect(cookbook).to be_nil

data/features/step_definitions/config_steps.rb

@@ -0,0 +1,24 @@
+Given /^the Stove config is empty$/ do
+  path = File.join(tmp_path, '_config.rb')
+
+  write_file(path, '{}')
+  set_env('STOVE_CONFIG', path)
+end
+
+Given /^the Stove config at "(.+)" is "(.*)"$/ do |path, value|
+  parts   = path.split('.').map(&:to_sym)
+  parents = parts[0...-1]
+
+  path = ENV['STOVE_CONFIG']
+  config = JSON.parse(File.read(path), symbolize_names: true)
+
+  # Vivify the hash
+  parent = parents.inject(config) do |config, parent|
+    config[parent] ||= {}
+    config[parent]
+  end
+
+  parent[parts.last] = value
+
+  File.open(path, 'w') { |f| f.write(JSON.generate(config)) }
+end

data/features/step_definitions/cookbook_steps.rb

@@ -1,23 +1,45 @@
-Given /^I have a cookbook named "(.+)"(?: (?:at|with) version "(.+)")?$/ do |name, version|
+Given /^I have a cookbook named "(\w+)" at version "([\d\.]+)"$/ do |name, version|
   create_cookbook(name, version)
 end
 
-Given /^I have a cookbook named "(.+)"(?: (?:at|with) version "(.+)")? with git support$/ do |name, version|
-  create_cookbook(name, version, git: true)
+Given /^I have a cookbook named "(\w+)"$/ do |name|
+  create_cookbook(name, '0.0.0')
+end
+
+Given /^I have a cookbook named "(\w+)" with git support$/ do |name|
+  create_cookbook(name, '0.0.0', git: true)
 end
 
 
+#
 # Create a new cookbook with the given name and version.
 #
 # @param [String] name
 # @param [String] version (default: 0.0.0.0)
 # @param [Hash] options
+#
 def create_cookbook(name, version, options = {})
   create_dir(name)
   cd(name)
-  write_file('CHANGELOG.md', "#{name} Cookbook CHANGELOG\n=====\n\nv0.0.0\n-----")
-  write_file('README.md', 'This is a README')
-  write_file('metadata.rb', "name '#{name}'\nversion '#{version || '0.0.0'}'")
+
+  write_file('CHANGELOG.md', <<-EOH.gsub(/^ {4}/, ''))
+    Changelog
+    =========
+
+    v#{version} (#{Time.now.to_date})
+    ----------------------------
+    - This is an entry
+    - This is another entry
+  EOH
+
+  write_file('README.md', <<-EOH.gsub(/^ {4}/, ''))
+    This is the README for #{name}
+  EOH
+
+  write_file('metadata.rb', <<-EOH.gsub(/^ {4}/, ''))
+    name    '#{name}'
+    version '#{version}'
+  EOH
 
   if options[:git]
     git_init(current_dir)