knife-server 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ac23ba3967334f48e3bad6406358d0653812228
-  data.tar.gz: b1a1d3dd1f2616444e7a9fbe1bd3dde52a696091
+  metadata.gz: 27f50b0e90320e91ee8aa88d87c08dbf570f856e
+  data.tar.gz: deabf7cb66885f2566953221cfa843753e6b7aad
 SHA512:
-  metadata.gz: 9a19382e580ef0d6336bb74f5bef965641785c6f81c327a84d459195e82a67783181805cb6d4e2f9dc34077b13eb2ce2e504d5718e35380a7173cd770a2b171a
-  data.tar.gz: bb62f7d5d3c90f81e071aa975abfa9fc9be7625c6b9e1af375978a5cd689bc57e03400559a37e00785b074e35ea06c38f476e57e442679c3e8c11b3244e68a93
+  metadata.gz: ae51fa3de1500febc09772c79edc354db518afb0e42b5c649db0fc7e2e5e3c50517b48c7499c1f5677044c6580ba8319d694f9dfe9cd10a92ef029262efa3962
+  data.tar.gz: 21b67c8ca3a1e0ce7f54bd600d9a8c9999a711ccfa23c660515403434608efdf73b423b06acf717f0879c20a6987c16ede9da701bd3a5b376df126f50e183a82

data/.cane

@@ -0,0 +1 @@
+--abc-exclude Knife::Server::SSH#exec_ssh

data/.rspec

@@ -1 +1,2 @@
 --color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Style/FileName:
+  Exclude:
+    - lib/knife-server.rb

data/.travis.yml

@@ -1,15 +1,19 @@
 language: ruby
+
 rvm:
-- 1.9.3
-- 2.0.0
-- 1.9.2
-- ruby-head
+  - 2.1
+  - 2.0.0
+  - 1.9.3
+  - ruby-head
 
 env:
-- "CHEF_VERSION=11.4.0"
-- "CHEF_VERSION=10.24.0"
-- "CHEF_VERSION=0.10.10"
+  - "CHEF_VERSION="
+  - "CHEF_VERSION='~> 11.14.2'"
+  - "CHEF_VERSION='~> 11.4.4'"
+  - "CHEF_VERSION='~> 10.26'"
+
+bundler_args: --without guard
 
 matrix:
   allow_failures:
-  - rvm: ruby-head
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## 1.2.0 / 2014-09-13
+
+### Upstream changes
+
+* Pull request [#48][], issue [#50][]: Fix issue affecting newer Knife/Chef versions dealing with nil default options. ([@dldinternet][], [@fnichol][])
+* Patch specific versions of Chef to fix `knife configure` bug. ([@fnichol][])
+
+### New features
+
+* Pull request [#51][]: Add OpenStack support to knife-server command. ([@johnbellone][])
+* Re-use existing private user key for omnibus bootstraps. ([@fnichol][])
+* Add support for downloading packages from a URL using the `--url` flag. ([@fnichol][])
+
+### Improvements
+
+* Pull request [#43][]: Enable ssh on firewall. ([@taylor][])
+* Add output when backing up and writing keys locally. ([@fnichol][])
+* Issue [#28][]: Shunt stderr/ioctl warnings to a tmp log file for knife configure. ([@fnichol][])
+* Issue [#9][], issue [#10][]: Validate that node_name & client_key are set when running plugins, giving the user a hint that their local knife.rb is not currently set up correctly. ([@fnichol][])
+* Update download URL for Omnibus packages. ([@fnichol][])
+* Update testing dependencies, upgrade to RSpec 3.x, freshen TravisCI build matrix, add style and complexity support. ([@fnichol][])
+
+
 ## 1.1.0 / 2013-07-26
 
 ### New features
@@ -161,18 +184,26 @@ The initial release.
 [#11]: https://github.com/fnichol/knife-server/issues/11
 [#13]: https://github.com/fnichol/knife-server/issues/13
 [#15]: https://github.com/fnichol/knife-server/issues/15
+[#28]: https://github.com/fnichol/knife-server/issues/28
 [#29]: https://github.com/fnichol/knife-server/issues/29
 [#34]: https://github.com/fnichol/knife-server/issues/34
 [#35]: https://github.com/fnichol/knife-server/issues/35
 [#41]: https://github.com/fnichol/knife-server/issues/41
 [#42]: https://github.com/fnichol/knife-server/issues/42
+[#43]: https://github.com/fnichol/knife-server/issues/43
+[#48]: https://github.com/fnichol/knife-server/issues/48
+[#50]: https://github.com/fnichol/knife-server/issues/50
+[#51]: https://github.com/fnichol/knife-server/issues/51
 [@danryan]: https://github.com/danryan
+[@dldinternet]: https://github.com/dldinternet
 [@erikh]: https://github.com/erikh
 [@fnichol]: https://github.com/fnichol
 [@iafonov]: https://github.com/iafonov
+[@johnbellone]: https://github.com/johnbellone
 [@jssjr]: https://github.com/jssjr
 [@ranjib]: https://github.com/ranjib
 [@sawanoboly]: https://github.com/sawanoboly
 [@stormsilver]: https://github.com/stormsilver
+[@taylor]: https://github.com/taylor
 [@wpeterson]: https://github.com/wpeterson
-[@xdissent]: https://github.com/xdissent
+[@xdissent]: https://github.com/xdissent

data/Gemfile

@@ -1,11 +1,16 @@
-source 'https://rubygems.org'
+# -*- encoding: utf-8 -*-
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in knife-server.gemspec
 gemspec
 
-group :test do
-  gem 'rake', '~> 0.9'
+group :guard do
+  gem "guard-rspec"
+  gem "guard-rubocop"
+  gem "guard-cane"
+end
 
+group :test do
   # allow CI to override the version of Chef for matrix testing
-  gem 'chef', (ENV['CHEF_VERSION'] || '>= 0.10.10')
+  gem "chef", (ENV["CHEF_VERSION"] || ">= 0.10.10")
 end

data/Guardfile

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+ignore %r{^\.gem/}
+
+def rspec_opts
+  { :cmd => "bundle exec rspec" }
+end
+
+def rubocop_opts
+  { :all_on_start => false, :keep_failed => false, :cli => "-r finstyle -D" }
+end
+
+group :red_green_refactor, :halt_on_fail => true do
+  guard :rspec, rspec_opts do
+    watch(%r{^spec/(.*)_spec\.rb})
+    watch(%r{^lib/(.*)([^/]+)\.rb})   { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+    watch(%r{^spec/spec_helper\.rb})  { "spec" }
+  end
+
+  guard :cane do
+    watch(%r{.*\.rb})
+    watch(".cane")
+  end
+
+  guard :rubocop, rubocop_opts do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -20,7 +20,7 @@ $ knife server bootstrap ec2 \
   --aws-secret-access-key $AWS_SECRET_ACCESS_KEY \
   --region us-east-1 \
   --availability-zone us-east-1b \
-  --image ami-de0d9eb7 \
+  --image ami-d017b2b8 \
   --ssh-user ubuntu \
   --flavor m1.small \
   --ssh-key id_rsa-aws \
@@ -46,7 +46,19 @@ knife server bootstrap linode \
   --linode-api-key $LINODE_API_KEY \
   --linode-datacenter 3 \
   --linode-flavor 1 \
-  --linode-image 99 \
+  --linode-image 126 \
+  --ssh-password 'testing1234'
+```
+
+To spin up your Chef Server on [OpenStack][openstack]:
+
+```bash
+knife server bootstrap openstack \
+  --node-name openstack.example.com \
+  --openstack-node-name openstack \
+  --openstack-username $OS_USERNAME \
+  --openstack-password $OS_PASSWORD \
+  --openstack-auth-url $OS_AUTH_URL \
   --ssh-password 'testing1234'
 ```
 
@@ -159,12 +171,12 @@ that if you do not explicitly set `client_key` and `validation_key`, the
 
 For example, you could add lines similar to the following in your user's
 `~/.chef/knife.rb` or your project's `.chef/knife.rb` file (assuming you
-have a directory `"$HOME/.chef.d"` created with `mkdir -p $HOME/.chef.d`):
+have a directory `"$HOME/.chef"` created with `mkdir -p $HOME/.chef`):
 
 ```ruby
 node_name       "gramsay"
-client_key      "#{ENV['HOME']}/.chef.d/gramsay.pem"
-validation_key  "#{ENV['HOME']}/.chef.d/chef-validator.pem"
+client_key      "#{ENV['HOME']}/.chef/gramsay.pem"
+validation_key  "#{ENV['HOME']}/.chef/chef-validator.pem"
 ```
 
 Most options can be passed to the knife subcommands explicitly but this
@@ -403,6 +415,15 @@ to make future cloud adapter support easier to add.
 Provisions a Linode instance and sets up an Open Source Chef Server as
 described [above](#knife-server-bootstrap).
 
+### <a name="knife-server-bootstrap-openstack"></a> knife server bootstrap openstack
+
+**Note:** You must install the [knife-openstack gem][knife-openstack] to use this
+subcommand. This was done to keep the dependencies of this library lighter and
+to make future cloud adapter support easier to add.
+
+Provisions a Openstack instance and sets up an Open Source Chef Server as
+described [above](#knife-server-bootstrap).
+
 #### Configuration
 
 This subcommand imports all relavent options from the knife-linode gem. For
@@ -622,5 +643,7 @@ Apache License, Version 2.0 (see [LICENSE][license])
 [install_chef]:             http://www.opscode.com/chef/install/
 [knife-ec2]:                https://github.com/opscode/knife-ec2
 [knife-linode]:             https://github.com/opscode/knife-linode
+[knife-openstack]:          https://github.com/opscode/knife-openstack
 [stevendanna]:              https://github.com/stevendanna
 [vagrant_site]:             http://vagrantup.com/
+[openstack]:    http://openstack.org

data/Rakefile

@@ -1,16 +1,37 @@
-#!/usr/bin/env rake
+# -*- encoding: utf-8 -*-
+
 require "bundler/gem_tasks"
 
-begin
-  require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
 
-  task :default => :spec
+desc "Run all test suites"
+task :test => [:spec]
 
-  desc "Run all specs in spec directory"
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.pattern = 'spec/**/*_spec.rb'
-  end
+require "finstyle"
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:style) do |task|
+  task.options << "--display-cop-names"
+end
 
-rescue LoadError
-  STDERR.puts "\n*** RSpec not available. (sudo) gem install rspec to run unit tests. ***\n\n"
+require "cane/rake_task"
+desc "Run cane to check quality metrics"
+Cane::RakeTask.new do |cane|
+  cane.canefile = "./.cane"
 end
+
+desc "Display LOC stats"
+task :stats do
+  puts "\n## Production Code Stats"
+  sh "countloc -r lib"
+  puts "\n## Test Code Stats"
+  sh "countloc -r spec"
+end
+
+desc "Run all quality tasks"
+task :quality => [:cane, :style, :stats]
+
+task :default => [:test, :quality]

data/knife-server.gemspec

@@ -1,30 +1,40 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/knife/server/version', __FILE__)
+require File.expand_path("../lib/knife/server/version", __FILE__)
+require "English"
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Fletcher Nichol"]
   gem.email         = ["fnichol@nichol.ca"]
-  gem.summary       = %q{Chef Knife plugin to bootstrap Chef Servers}
+  gem.summary       = "Chef Knife plugin to bootstrap Chef Servers"
   gem.description   = gem.summary
   gem.homepage      = "http://fnichol.github.com/knife-server"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "knife-server"
   gem.require_paths = ["lib"]
   gem.version       = Knife::Server::VERSION
 
-  gem.required_ruby_version = ">= 1.9.2"
+  gem.required_ruby_version = ">= 1.9.3"
 
-  gem.add_dependency "fog",       "~> 1.3"
+  gem.add_dependency "fog"
   gem.add_dependency "net-ssh"
   gem.add_dependency "chef",      ">= 0.10.10"
 
+  gem.add_development_dependency "rake"
   gem.add_development_dependency "knife-ec2", ">= 0.5.12"
   gem.add_development_dependency "knife-linode"
+  gem.add_development_dependency "knife-openstack"
 
-  gem.add_development_dependency "rspec", "~> 2.13.0"
-  gem.add_development_dependency "fakefs", "~> 0.4.0"
+  gem.add_development_dependency "rspec", "~> 3.0"
+  gem.add_development_dependency "fakefs", "~> 0.4"
   gem.add_development_dependency "timecop", "~> 0.3"
+  gem.add_development_dependency "countloc",  "~> 0.4"
+
+  # style and complexity libraries are tightly version pinned as newer releases
+  # may introduce new and undesireable style choices which would be immediately
+  # enforced in CI
+  gem.add_development_dependency "finstyle",  "1.2.0"
+  gem.add_development_dependency "cane",      "2.6.2"
 end

data/lib/chef/knife/bootstrap/_omnibus.sh

@@ -5,12 +5,16 @@
 #
 
 package_url() {
-  local base="http://www.opscode.com/chef/download-server"
-  if [ -n "$version" ] ; then
-    local v="&v=${version}"
-  fi
+  if [ -n "$url" ] ; then
+    echo "$url"
+  else
+    local base="http://www.getchef.com/chef/download-server"
+    if [ -n "$version" ] ; then
+      local v="&v=${version}"
+    fi
 
-  echo "${base}?p=${platform}&pv=${platform_version}&m=${machine}&prerelease=${prerelease}${v}"
+    echo "${base}?p=${platform}&pv=${platform_version}&m=${machine}&prerelease=${prerelease}${v}"
+  fi
 }
 
 # Set the filename for a deb, based on version and machine
@@ -36,6 +40,16 @@ failed_download() {
   exit 5
 }
 
+is_server_installed() {
+  if [ -f "/opt/chef-server/bin/chef-server-ctl" ] ; then
+    return 0
+  elif [ -f "/opt/opscode/bin/chef-server-ctl" ] ; then
+    return 0
+  else
+    return 1
+  fi
+}
+
 perform_download() {
   case "$1" in
     wget)
@@ -48,8 +62,8 @@ perform_download() {
 }
 
 download_package() {
-  if [ -f "/opt/chef-server/bin/chef-server-ctl" ] ; then
-    info "Chef Server detected in /opt/chef-server, skipping download"
+  if is_server_installed ; then
+    info "Chef Server detected, skipping download"
     return 0
   fi
 
@@ -72,8 +86,8 @@ download_package() {
 }
 
 install_package() {
-  if [ -f "/opt/chef-server/bin/chef-server-ctl" ] ; then
-    info "Chef Server detected in /opt/chef-server, skipping installation"
+  if is_server_installed ; then
+    info "Chef Server detected, skipping installation"
     return 0
   fi
 
@@ -90,6 +104,43 @@ install_package() {
   banner "Package installed"
 }
 
+detect_info() {
+  if [ -f "/opt/chef-server/bin/chef-server-ctl" ] ; then
+    server_root="/opt/chef-server"
+  elif [ -f "/opt/opscode/bin/chef-server-ctl" ] ; then
+    server_root="/opt/opscode"
+  fi
+
+  info "Chef Server detected in $server_root"
+}
+
+patch_knife_code() {
+  local check="((Gem::Version.new(Chef::VERSION) <= Gem::Version.new(\"11.12.2\")) || (Gem::Version.new(Chef::VERSION) >= Gem::Version.new(\"11.6.0\"))) ? exit(0) : exit(1)"
+  local gems="$server_root/embedded/lib/ruby/gems/1.9.1/gems"
+  local patched="$gems/.patched"
+
+  if [ -f "$patched" ]; then
+    info "Patched knife configure detected, skipping"
+  elif echo "$script" | $server_root/embedded/bin/ruby -r chef/version; then
+    info "Patching knife configure bug (CHEF-5211)"
+    (cd $gems/chef-11.* && cat <<PATCH | tr "#" "\047" | patch -p1)
+diff --git a/lib/chef/knife/configure.rb b/lib/chef/knife/configure.rb
+index 6af3d4e..2c77bf1 100644
+--- a/lib/chef/knife/configure.rb
++++ b/lib/chef/knife/configure.rb
+@@ -153,6 +153,7 @@ EOH
+
+       def guess_servername
+         o = Ohai::System.new
++        o.load_plugins
+         o.require_plugin #os#
+         o.require_plugin #hostname#
+         o[:fqdn] || #localhost#
+PATCH
+    touch "$patched"
+  fi
+}
+
 prepare_chef_server_rb() {
   local config_file="/etc/chef-server/chef-server.rb"
 
@@ -112,7 +163,7 @@ CHEF_SERVER
 symlink_binaries() {
   for bin in chef-client chef-solo chef-apply knife ohai ; do
     banner "Updating /usr/bin/$bin symlink"
-    ln -snf /opt/chef-server/embedded/bin/$bin /usr/bin/$bin
+    ln -snf $server_root/embedded/bin/$bin /usr/bin/$bin
   done ; unset bin
 }
 
@@ -132,5 +183,7 @@ configure_firewall() {
   if [ -x "/usr/sbin/lokkit" ] ; then
     banner "Opening TCP port 443"
     /usr/sbin/lokkit -p 443:tcp
+    banner "Opening SSH port 22"
+    /usr/sbin/lokkit -p 22:tcp
   fi
 }