stove 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41d8bc6c0ecbe6769abf2fbaeb7c79101eb7dc1b
-  data.tar.gz: 5ca0ecb5f7ba581eeb4e9fbff9677e3fc19b449a
+  metadata.gz: b2054d6ff1813a9e732d90f9758cee5f45b39a5b
+  data.tar.gz: 680226a4dd39d13ceac6e78d8811e69206f7f3b4
 SHA512:
-  metadata.gz: f9fd20c6488ceebac425c6f6e326209edc1e834af8d05a750a42ac42bb4788f77855c00936a745e4f1857aa8f747058078e8ea79a78a4313e7d2a722af0f0dc9
-  data.tar.gz: 074a33d4bebce2fb0528a0f498e4b0da2bf785fabac835ab739b0b0d440210146be57a29c93ca9117a70cc5fcb0d0e24cb481faf863763ad67fb310a9ed0f1e0
+  metadata.gz: 3ea199748cab9c2d639c4c12acee0bf5e36334cfe7fcc77850ff60fed204798061901f0ec9fb70cbbeaaaf4d8d701da62b4a3e7ba29328a85d37e943370d0b67
+  data.tar.gz: 42e80c8bae4b0166a71c5709bb9ebd4c1411de9fe58fcd09dc5600cdf65615c82607c76aa78b4cc710a4df949ded7dfe6b86bd9711360de3ef16ea6199462be2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rspec

data/.travis.yml

@@ -1,7 +1,12 @@
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
+
+bundler_args: --jobs 7
+
 before_script:
   - git config --global user.email "ci@traivs-ci.org"
   - git config --global user.name "Travis CI"
+
+script: bundle exec rake

data/CHANGELOG.md

@@ -2,6 +2,26 @@ Stove CHANGELOG
 ===============
 This is the Changelog for the Stove gem.
 
+v3.0.0 (2014-07-07)
+-------------------
+- Add support for signed git tags
+- Require Ruby 1.9+
+- Remove i18n in favor of ERB
+- Remove solve gem
+- Remove GitHub functionality
+- Remove JIRA functionality
+- Remove bump and devodd functionality
+- Clear up confusion on Gemfile vs not Gemfile
+- Always read tarball objects as binary
+- End tempfiles in the correct extension (needed to detect mime_types)
+- Bump required version of ChefAPI gem
+- Remove unused errors and code
+- Improved documentation
+- Remove editor files (`.swp`, etc) before packaging
+- Upgrade to RSpec 3
+- Improve test coverage
+- Publish to Supermarket by default
+
 v2.0.0 (2014-04-04)
 -------------------
 - Completely refactor the runner for speed optimizations

data/README.md

@@ -14,111 +14,68 @@ Stove
 
 A utility for releasing and managing Chef Cookbooks. It will:
 
-- Edit the `metadata.rb` and insert the proper version
-- Create a CHANGELOG from JIRA tickets
-- Commit and push these changes to git
-- Create a git tag and push those changes to git
-- Publish a release to GitHub releases
-- Upload the cookbook to the Opscode Community Site
-- Resolve (close) the JIRA tickets
+- Tag and push a new release to git
+- Upload the cookbook to a cookbook share (such as Supermarket)
 
 
 Why?
 ----
-Existing tools to package cookbooks (such as [Knife Community](https://github.com/miketheman/knife-community) and `knife cookbook site share`) require a dependency on Chef. Because of thier dependency on Chef, they enforce the use of a "cookbook repo". Especially with the evolution of [Berkshelf](https://github.com/RiotGames/berkshelf), cookbooks are individualized artifacts and are often contained in their own repositories. [stove](https://github.com/sethvargo/stove) is **cookbook-centric, rather than Chef-centric**. Since all commands are run from inside the cookbook, it's safe to include stove in your cookbooks `Gemfile`.
+Existing tools to package cookbooks (such as [Knife Community](https://github.com/miketheman/knife-community) and `knife cookbook site share`) require a dependency on Chef. Because of thier dependency on Chef, they enforce the use of a "cookbook repo". Especially with the evolution of [Berkshelf](https://github.com/RiotGames/berkshelf), cookbooks are individualized artifacts and are often contained in their own repositories. [stove](https://github.com/sethvargo/stove) is **cookbook-centric, rather than Chef-centric**.
 
 
 Installation
 ------------
-It is highly recommended that you include `stove` in your cookbook's Gemfile:
+1. Add Stove to your project's Gemfile:
 
-```ruby
-gem 'stove'
-```
+        gem 'stove'
 
-Alternatively, you may install it as a gem:
+2. Run the `bundle` command to install:
 
-    $ gem install stove
+        $ bundle install --binstubs
 
-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
-{
-  "field": {
-    "option": "value"
-  }
-}
-```
+Configuration
+-------------
+Stove requires your username and private key to upload a cookbook. You can pass these to each command call, or you can set them Stove:
 
-For example, my local Stove configuration looks like this:
-
-```javascript
-{
-  "community": {
-    "username": "sethvargo",
-    "key": "~/.chef/sethvargo.pem"
-  },
-  "github": {
-    "access_token": "..."
-  },
-  "jira": {
-    "username": "sethvargo",
-    "password": "..."
-  }
-}
+```bash
+$ stove login --username sethvargo --key ~/.chef/sethvargo.pem
 ```
 
-If you are using Stove 1.0, you need to update your configuration file syntax.
+These values will be saved in Stove's configuration file and persisted across your workstation.
 
-**It is recommended that the permissions on this file be 0600 to prevent unauthorized reading!**
+The default publishing endpoint is the [Chef Supermarket](https://supermarket.getchef.com), but this is configurable. If you want to publish to an internal community site, you can specify the `--endpoint` value:
+
+```bash
+$ stove --endpoint https://internal-cookbook-store.example.com
+```
 
 
 Usage
 -----
-The gem is packaged as a binary. It should be run from _inside the cookbook to release_:
+There are two ways to use Stove. You can either use the `stove` command directly or use the embedded rake task.
 
-    (~/cookbooks/bacon) $ bake 1.2.3
+### Command
+Execute the `stove` command from inside the root of a cookbook:
 
-You can always use the `--help` flag to get information:
-
-```text
-Usage: bake x.y.z
-
-Actions:
-        --[no-]bump                  [Don't] Perform a version bump the local version automatically
-        --[no-]changelog             [Don't] Generate and prompt for a CHANGELOG
-        --[no-]dev                   [Don't] Bump a minor version release for development purposes
-        --[no-]upload                [Don't] Execute upload stages of enabled plugins
-
-Plugins:
-        --[no-]community             [Don't] Upload to the community site
-        --[no-]git                   [Don't] Tag and push to a git remote
-        --[no-]github                [Don't] Publish the release to GitHub
-        --[no-]jira                  [Don't] 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
+```bash
+$ bin/stove
 ```
 
+This will package (as a tarball) the cookbook in the current working directory, tag a new version, push to git, and publish to a cookbook share.
 
-Rake Task
----------
-Stove also includes a Rake task you can include in your Rakefile:
+### Rake task
+If you are familiar with the Bundler approach to publishing Ruby gems, this approach will feel very familiar. Simply add the following to your `Rakefile`:
 
 ```ruby
 require 'stove/rake_task'
+Stove::RakeTask.new
+```
 
-Stove::RakeTask.new do |stove|
-  stove.git = true
-  stove.devodd = true
-end
+And then use rake to publish the cookbook:
+
+```bash
+$ bin/rake publish
 ```
 
 
@@ -130,9 +87,6 @@ Contributing
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-TODO:
-- Secure the authentication file
-
 
 See Also
 --------
@@ -145,8 +99,8 @@ License & Authors
 - Author: Seth Vargo (sethvargo@gmail.com)
 
 ```text
-Copyright 2013 Seth Vargo <sethvargo@gmail.com>
-Copyright 2013 Opscode, Inc
+Copyright 2013-2014 Seth Vargo <sethvargo@gmail.com>
+Copyright 2013-2014 Chef Software, Inc
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,5 +1,13 @@
 require 'bundler/gem_tasks'
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:unit) do |t|
+  t.rspec_opts = [].tap do |a|
+    a.push('--color')
+    a.push('--format progress')
+  end.join(' ')
+end
+
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:acceptance) do |t|
   t.cucumber_opts = [].tap do |a|
@@ -11,6 +19,6 @@ Cucumber::Rake::Task.new(:acceptance) do |t|
 end
 
 desc 'Run all tests'
-task :test => [:acceptance]
+task :test => [:unit, :acceptance]
 
 task :default => [:test]

data/bin/bake

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
 
+$stderr.puts "The `bake' command is deprecated. Please use `stove' instead!"
+
 require 'stove'
 Stove::Cli.new(ARGV.dup).execute!

data/bin/stove

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'stove'
+Stove::Cli.new(ARGV.dup).execute!

data/features/plugins/community.feature

@@ -1,40 +1,25 @@
 Feature: Community
   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 --community`
-    * 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 --community`
-    * it should fail with "does not contain a username"
+    * the Stove config at "username" is unset
+    * I run `stove --no-git`
+    * it should fail with "requires a username"
 
   Scenario: When the key does not exist
-    * the Stove config at "community.username" is "bobo"
-    * I run `bake --upload --community`
-    * it should fail with "does not contain a key"
+    * the Stove config at "key" is unset
+    * I run `stove --no-git`
+    * it should fail with "requires a private 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 --community`
+    * I run `stove --no-git`
     * 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"
+  Scenario: With the default parameters
     * the community server has the cookbook:
       | bacon | 1.2.3 | Application |
-    * I successfully run `bake --upload --community`
-
-  Scenario: When the community plugin is explicitly disabled
-    * the Stove config at "community.username" is "bobo"
-    * the Stove config at "community.key" is "../../features/support/stove.pem"
-    * I successfully run `bake --upload --no-community`
-    * the community server will not have the cookbook:
-      | bacon | | |
+    * I successfully run `stove --no-git`
+    * the community server will have the cookbooks:
+      | bacon | 0.0.0 | Application |

data/features/plugins/git.feature

@@ -1,11 +1,11 @@
 Feature: git Plugin
   Background:
-    * the Stove config is empty
-    * the CLI options are all off
     * I have a cookbook named "bacon"
+    * the community server has the cookbooks:
+      | bacon | 1.0.0 | Application |
 
   Scenario: When the directory is not a git repository
-    * I run `bake --git`
+    * I run `stove`
     * it should fail with "does not appear to be a valid git repository"
 
   Scenario: When the directory is dirty
@@ -14,16 +14,27 @@ Feature: git Plugin
      """
      This is new content
      """
-    * I run `bake --git`
+    * I run `stove`
     * 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`
+    * I run `stove -l debug`
     * it should fail with "out of sync with the remote repository"
 
   Scenario: When a git upload should be done
     * I have a cookbook named "bacon" with git support
-    * I successfully run `bake --upload --git`
+    * I successfully run `stove`
     * the git remote should have the tag "v0.0.0"
+
+  Scenario: When using signed tags
+    * I have a cookbook named "bacon" with git support
+    * a GPG key exists
+    * I successfully run `stove --sign`
+    * the git remote should have the signed tag "v0.0.0"
+
+  Scenario: With the git plugin disabled
+    * I have a cookbook named "bacon" with git support
+    * I successfully run `stove --no-git`
+    * the git remote should not have the tag "v0.0.0"

data/features/step_definitions/community_steps.rb

@@ -1,5 +1,7 @@
 Given /^I am using the community server$/ do
-  set_env('COMMUNITY_URL', CommunityZero::RSpec.url)
+  set_env('STOVE_ENDPOINT', CommunityZero::RSpec.url)
+  set_env('STOVE_CLIENT', 'stove')
+  set_env('STOVE_KEY', File.expand_path('../../support/stove.pem', __FILE__))
 end
 
 Given /^the community server has the cookbooks?:$/ do |table|

data/features/step_definitions/config_steps.rb

@@ -1,24 +1,7 @@
-Given /^the Stove config is empty$/ do
-  path = File.join(tmp_path, '_config.rb')
-
-  write_file(path, '{}')
-  set_env('STOVE_CONFIG', path)
+Given /^the Stove config at "(.+)" is "(.+)"/ do |variable, value|
+  Stove::Config.__set__(variable, value)
 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)) }
+Given /^the Stove config at "(.+)" is unset/ do |variable|
+  Stove::Config.__unset__(variable)
 end

data/features/step_definitions/git_steps.rb

@@ -9,6 +9,42 @@ Given /^the remote repository has additional commits/ do
   %x|#{cmd}|
 end
 
+Given /^a GPG key exists/ do
+  gpg_home = File.join(scratch_dir, '.gnupg')
+  set_env('GNUPGHOME', gpg_home)
+  Dir.mkdir(gpg_home)
+  File.chmod(0700, gpg_home)
+  batch_path = File.join(gpg_home, 'batch')
+  File.write(batch_path, <<-EOH)
+%pubring #{File.join(gpg_home, 'keyring')}
+%secring #{File.join(gpg_home, 'keyring.sec')}
+Key-Type: DSA
+Key-Length: 832
+Subkey-Type: ELG-E
+Subkey-Length: 800
+Name-Real: Alan Smithee
+Name-Email: asmithee@example.com
+Expire-Date: 0
+%commit
+EOH
+  gpg_wrapper = File.join(gpg_home, 'gpg_wrapper')
+  File.write(gpg_wrapper, <<-EOH)
+#!/bin/sh
+gpg "--keyring=#{File.join(gpg_home, 'keyring')}" "--secret-keyring=#{File.join(gpg_home, 'keyring.sec')}" "$@"
+EOH
+  File.chmod(0755, gpg_wrapper)
+
+  cmd = [
+    "cd \"#{current_dir}\"",
+    "git config gpg.program #{gpg_wrapper}",
+    'git config user.signingkey asmithee@example.com',
+    "gpg --quiet --batch --gen-key #{batch_path}",
+  ].join(' && ')
+
+  %x|#{cmd}|
+end
+
+
 Then /^the git remote should( not)? have the commit "(.+)"$/ do |negate, message|
   commits = git_commits(fake_git_remote)
 
@@ -19,12 +55,13 @@ Then /^the git remote should( not)? have the commit "(.+)"$/ do |negate, message
   end
 end
 
-Then /^the git remote should( not)? have the tag "(.+)"$/ do |negate, tag|
+Then /^the git remote should( not)? have the( signed)? tag "(.+)"$/ do |negate, signed, tag|
   tags = git_tags(fake_git_remote)
 
   if negate
     expect(tags).to_not include(tag)
   else
     expect(tags).to include(tag)
+    expect(git_tag_signature?(fake_git_remote, tag)).to be_truthy if signed
   end
 end

data/features/support/env.rb

@@ -1,27 +1,33 @@
-require 'bundler/setup'
+require 'stove'
 
-require 'aruba/api'
+require 'aruba'
 require 'aruba/cucumber'
-require 'cucumber/rspec/doubles'
-require 'rspec/expectations'
+require 'aruba/in_process'
+
+Aruba::InProcess.main_class = Stove::Cli
+Aruba.process = Aruba::InProcess
 
 require 'community_zero/rspec'
 CommunityZero::RSpec.start
 Before { CommunityZero::RSpec.reset! }
 
-require 'stove'
-
 require File.expand_path('../stove/git', __FILE__)
 
 World(Aruba::Api)
 World(Stove::Git)
 
 Before do
-  FileUtils.rm_rf(tmp_path)
-  @aruba_timeout_seconds = 15
+  Stove::Config.endpoint = CommunityZero::RSpec.url
+  Stove::Config.username = 'stove'
+  Stove::Config.key      = File.expand_path('../stove.pem', __FILE__)
+end
+
+Before do
+  FileUtils.rm_rf(scratch_dir)
+  FileUtils.mkdir_p(scratch_dir)
 end
 
-# The path to Aruba's "stuff"
-def tmp_path
-  File.expand_path(@dirs.first.to_s)
+# The scratch directory
+def scratch_dir
+  @scratch_dir ||= File.expand_path('tmp/aruba/scratch')
 end

data/features/support/stove/git.rb

@@ -4,7 +4,6 @@ module Stove
   module Git
     def git_init(path = Dir.pwd)
       cmd = [
-        'cd "' + path + '"',
         'git init .',
         'git add --all',
         'git commit --message "Initial commit"',
@@ -12,37 +11,58 @@ module Stove
         'git push --quiet --force origin master',
       ].join(' && ')
 
-      %x|#{cmd}|
+      Dir.chdir(path) do
+        %x|#{cmd}|
+      end
     end
 
     def fake_git_remote
-      path = File.expand_path(File.join(tmp_path, 'remote.git'))
+      path = File.expand_path(File.join(remotes_path, 'remote.git'))
       return path if File.exists?(path)
 
       FileUtils.mkdir_p(path)
       cmd = [
-        'cd "' + path + '"',
         'git init .',
         'git config receive.denyCurrentBranch ignore',
         'git config receive.denyNonFastforwards true',
         'git config core.sharedrepository 1',
       ].join(' && ')
 
-      %x|#{cmd}|
+      Dir.chdir(path) do
+        %x|#{cmd}|
+      end
 
       path
     end
 
     def git_shas(path)
-      %x|cd "#{path}" && git log --oneline|.split("\n").map { |line| line.split(/\s+/, 2).first.strip } rescue []
+      Dir.chdir(path) do
+        %x|git log --oneline|.split("\n").map { |line| line.split(/\s+/, 2).first.strip } rescue []
+      end
     end
 
     def git_commits(path)
-      %x|cd "#{path}" && git log --oneline|.split("\n").map { |line| line.split(/\s+/, 2).last.strip } rescue []
+      Dir.chdir(path) do
+        %x|git log --oneline|.split("\n").map { |line| line.split(/\s+/, 2).last.strip } rescue []
+      end
     end
 
     def git_tags(path)
-      %x|cd "#{path}" && git tag --list|.split("\n").map(&:strip) rescue []
+      Dir.chdir(path) do
+        %x|git tag --list|.split("\n").map(&:strip) rescue []
+      end
+    end
+
+    def git_tag_signature?(path, tag)
+      Dir.chdir(path) do
+        %x|git show --show-signature #{tag}|.include?('BEGIN PGP SIGNATURE') rescue false
+      end
+    end
+
+    private
+
+    def remotes_path
+      @remotes_path ||= File.join(scratch_dir, 'remotes')
     end
   end
 end