chake 0.3.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d523425d937bc7cfeb8017d94a2b10507bff58b
-  data.tar.gz: 7899635fb153bb5f7323c24fae6c202f7d3ff9e3
+  metadata.gz: e7488361bba23f010e6873f567d922653ed2dcb3
+  data.tar.gz: e2166babc9c279160a4bd291418131d02fac9cfb
 SHA512:
-  metadata.gz: f517d8708ecb17ef33c41253dfeb9d033a9496a71df84b0e39fbcd492f078844deaca407e3d2810bedd3f9e662df1e41b867402a9ead70509add89b86d3269ca
-  data.tar.gz: 4d8fe56cf9dd8ba52b7467fc863c3c5d44c2d36cccd2da3c98b6179b575fcf1086f0ef038e37b5c4838c2a5c8c92112bda2c5dca643541b023c7bf22d59c5c30
+  metadata.gz: a6a910451f2f1cd6c342441f2267fa75b1db5228ccb6be1d2580d9673f3a316b8dcc5ce6e8842129d5136b04d352d629df3a2b358f7a1cc3f9a1c56f61360dcb
+  data.tar.gz: dd3c5e2644fcff4aeffe72a858a102f5a23b453c7d9162f54e9594cfdd91812725cb5e5987b0ef2f36aa19d4586d63bb606ef7b4536c724852bb6e33594b681d

data/ChangeLog.md

@@ -1,3 +1,18 @@
+# 0.4.0
+
+* Redesign build of RPM package
+* Output of command run on nodes is now aligned
+* Change storage of temporary files from .tmp to tmp/chake
+* The JSON node attributes files generated in tmp/chake are not readable
+* SSH config file can now be controlled with the `$CHAKE_SSH_CONFIG`
+  environment variable
+* Extra options for rsync can now be passed in the `$CHAKE_RSYNC_OPTIONS`
+  environment variable
+* Chake::VERSION is now available in Rakefiles
+* update test suite to use new rspec syntax instead the old one which is
+  obsolete in rspec 3.
+  * Thanks to Athos Ribeiro.
+
 # 0.3.3
 
 * rsync: exclude cache/ to work with the version of rsync in OSX

data/README.md

@@ -8,14 +8,6 @@ Simple host management with chef and rake. No chef server required.
 
 ## Creating the repository
 
-Require chake on your `Rakefile`:
-
-```ruby
-require 'chake'
-```
-
-Initializing the repository:
-
 ```
 $ chake init
 [create] nodes.yaml
@@ -28,8 +20,8 @@ $ chake init
 
 A brief explanation of the created files:
 
-| File | Description |
-|-----+-------|
+|File|Description|
+|----|-----------|
 | `nodes.yaml`  | where you will list the hosts you will be managing, and what recipes to apply to each of them. |
 | `config.rb` | contains the chef-solo configuration. You can modify it, but usually you won't need to. |
 | `config/roles` | directory is where you can put your role definitions. |
@@ -158,8 +150,9 @@ of the configuration.
 ### repository-local SSH configuration
 
 If you need special SSH configuration parameters, you can create a file called
-`.ssh_config` in at the root of your repository, and chake will use it when
-calling `ssh`.
+`.ssh_config` (or whatever name you have in the `$CHAKE_SSH_CONFIG` environment
+variable, see below for details) in at the root of your repository, and chake
+will use it when calling `ssh`.
 
 ### Converging local host
 
@@ -190,6 +183,13 @@ local://laptop:
 When you run `rake converge` on `desktop`, `laptop` will be skipped, and
 vice-versa.
 
+### Environment variables
+
+|Variable|Meaning|Default value|
+|--------|-------|-------------|
+| `$CHAKE_SSH_CONFIG` | local SSH configuration file | `.ssh_config` |
+| `$CHAKE_RSYNC_OPTIONS` | extra options to pass to `rsync`. Useful to e.g. exclude large files from being upload to each server | _none_ |
+
 ## Contributing
 
 1. Fork it ( http://github.com/terceiro/chake/fork )

data/Rakefile

@@ -6,25 +6,33 @@ end
 
 pkg = Gem::Specification.load('chake.gemspec')
 
-task :build do
+task 'build:tarball' => [:build] do
   chdir 'pkg' do
     sh 'gem2tgz', "#{pkg.name}-#{pkg.version}.gem"
   end
 end
 
 desc 'Create Debian source package'
-task 'build:debsrc' => [:build] do
+task 'build:debsrc' => ['build:tarball'] do
   dirname = "#{pkg.name}-#{pkg.version}"
   chdir 'pkg' do
-    sh 'gem2deb', '--no-wnpp-check', '-s', '-p', pkg.name, "#{dirname}.gem"
+    sh 'gem2deb', '--no-wnpp-check', '-s', '-p', pkg.name, "#{dirname}.tar.gz"
     chdir dirname do
       sh 'dpkg-buildpackage', '-S', '-us', '-uc'
     end
   end
 end
 
+desc 'Builds and installs Debian package'
+task 'deb:install' => 'build:debsrc'do
+  chdir "pkg/#{pkg.name}-#{pkg.version}" do
+    sh 'fakeroot debian/rules binary'
+  end
+  sh 'sudo', 'dpkg', '-i', "pkg/#{pkg.name}_#{pkg.version}-1_all.deb"
+end
+
 desc 'Create source RPM package'
-task 'build:rpmsrc' => [:build, 'pkg/chake.spec']
+task 'build:rpmsrc' => ['build:tarball', 'pkg/chake.spec']
 
 file 'pkg/chake.spec' => ['chake.spec.erb', 'lib/chake/version.rb'] do |t|
   require 'erb'
@@ -80,6 +88,13 @@ task :changelog do
   sh 'git', 'shortlog', last_tag + '..'
 end
 
+task :check_tag do
+  last_tag = `git tag | sort -V`.split.last
+  if last_tag == "v#{pkg.version}"
+    fail "Version #{pkg.version} was already released!"
+  end
+end
+
 desc 'checks if the latest release is properly documented in ChangeLog.md'
 task :check_changelog do
   begin
@@ -90,6 +105,6 @@ task :check_changelog do
   end
 end
 
-task :release => [:check_changelog, :test, :obs]
+task :release => [:check_tag, :check_changelog, :test, :obs]
 
 task :default => :test

data/chake.spec.erb

@@ -33,7 +33,7 @@ Requires: ruby, rubygem-rake
 mkdir -p %{gembuilddir}
 sed -i -e 's#spec.files\s*=.*#spec.files = Dir.glob("**/*")#' %{name}.gemspec
 rake build
-gem install --local --install-dir %{gembuilddir} --force pkg/*.gem
+gem install --local --install-dir %{gembuilddir} --force pkg/%{name}-%{version}.gem
 mkdir -p %{buildroot}/%{_bindir}
 mv %{gembuilddir}/bin/* %{buildroot}/%{_bindir}
 rmdir %{gembuilddir}/bin

data/lib/chake.rb

@@ -5,12 +5,14 @@ require 'json'
 require 'tmpdir'
 require 'readline'
 
+require 'chake/version'
 require 'chake/node'
 
 nodes_file = ENV['NODES'] || 'nodes.yaml'
 node_data = File.exists?(nodes_file) && YAML.load_file(nodes_file) || {}
 $nodes = node_data.map { |node,data| Chake::Node.new(node, data) }.reject(&:skip?).uniq(&:hostname)
-
+$chake_tmpdir = 'tmp/chake'
+FileUtils.mkdir_p($chake_tmpdir)
 
 desc "Initializes current directory with sample structure"
 task :init do
@@ -85,7 +87,7 @@ def if_files_changed(node, group_name, files)
     return
   end
   hash = IO.popen(['sha1sum', *files]).read
-  hash_file = File.join('.tmp', node + '.' + group_name + '.sha1sum')
+  hash_file = File.join($chake_tmpdir, node + '.' + group_name + '.sha1sum')
   if !File.exists?(hash_file) || File.read(hash_file) != hash
     yield
   end
@@ -97,7 +99,7 @@ end
 
 def write_json_file(file, data)
   File.open(file, 'w') do |f|
-    f.write(JSON.dump(data))
+    f.write(JSON.pretty_generate(data))
     f.write("\n")
   end
 end
@@ -107,7 +109,7 @@ platforms = Dir.glob(File.expand_path('chake/bootstrap/*.sh', File.dirname(__FIL
 $nodes.each do |node|
 
   hostname = node.hostname
-  bootstrap_script = '.tmp/bootstrap-' + hostname
+  bootstrap_script = File.join($chake_tmpdir, 'bootstrap-' + hostname)
 
   file bootstrap_script => platforms do |t|
     mkdir_p(File.dirname(bootstrap_script))
@@ -125,8 +127,7 @@ $nodes.each do |node|
 
   desc "bootstrap #{hostname}"
   task "bootstrap:#{hostname}" => bootstrap_script do
-    mkdir_p '.tmp', :verbose => false
-    config = '.tmp/' + hostname + '.json'
+    config = File.join($chake_tmpdir, hostname + '.json')
 
     if File.exists?(config)
       # already bootstrapped, just overwrite
@@ -150,8 +151,10 @@ $nodes.each do |node|
   task "upload:#{hostname}" do
     encrypted = encrypted_for(hostname)
     rsync_excludes = (encrypted.values + encrypted.keys).map { |f| ["--exclude", f] }.flatten
+    rsync_excludes << "--exclude" << ".git/"
+    rsync_excludes << "--exclude" << "cache/"
 
-    rsync = node.rsync + ["-avp", "--exclude", ".git/", "--exclude", "cache/"]
+    rsync = node.rsync + ["-avp"] + ENV.fetch('CHAKE_RSYNC_OPTIONS', '').split
     rsync_logging = Rake.application.options.silent && '--quiet' || '--verbose'
 
     files = Dir.glob("**/*").select { |f| !File.directory?(f) } - encrypted.keys - encrypted.values
@@ -174,7 +177,7 @@ $nodes.each do |node|
   desc "converge #{hostname}"
   task "converge:#{hostname}" => ["bootstrap:#{hostname}", "upload:#{hostname}"] do
     chef_logging = Rake.application.options.silent && '-l fatal' || ''
-    node.run_as_root "chef-solo -c #{node.path}/config.rb #{chef_logging} -j #{node.path}/.tmp/#{hostname}.json"
+    node.run_as_root "chef-solo -c #{node.path}/config.rb #{chef_logging} -j #{node.path}/#{$chake_tmpdir}/#{hostname}.json"
   end
 
   desc "run a command on #{hostname}"

data/lib/chake/backend.rb

@@ -22,10 +22,10 @@ module Chake
     end
 
     def run(cmd)
-      puts "#{node.hostname}: $ #{cmd}"
+      printf "%#{Node.max_node_name_length}s: $ %s\n", node.hostname, cmd
       output = IO.popen(command_runner + [cmd])
       output.each_line do |line|
-        puts [node.hostname, line.strip].join(': ')
+        printf "%#{Node.max_node_name_length}s: %s\n", node.hostname, line.strip
       end
       output.close
       if $?

data/lib/chake/backend/ssh.rb

@@ -27,11 +27,15 @@ module Chake
       private
 
       def rsync_ssh
-        File.exist?('.ssh_config') && ['-e', 'ssh -F .ssh_config'] || []
+        File.exist?(ssh_config_file) && ['-e', 'ssh -F ' + ssh_config_file ] || []
       end
 
       def ssh_config
-        File.exist?('.ssh_config') && ['-F' '.ssh_config'] || []
+        File.exist?(ssh_config_file) && ['-F', ssh_config_file] || []
+      end
+
+      def ssh_config_file
+        @ssh_config_file ||= ENV.fetch('CHAKE_SSH_CONFIG', '.ssh_config')
       end
 
       def ssh_target

data/lib/chake/node.rb

@@ -15,6 +15,13 @@ module Chake
     attr_reader :path
     attr_reader :data
 
+    def self.max_node_name_length
+      @max_node_name_length ||= 0
+    end
+    def self.max_node_name_length=(value)
+      @max_node_name_length = value
+    end
+
     def initialize(hostname, data = {})
       uri = URI.parse(hostname)
       if !uri.scheme && !uri.host && uri.path
@@ -30,6 +37,10 @@ module Chake
       @username = uri.user || Etc.getpwuid.name
       @path = uri.path || "/var/tmp/chef.#{username}"
       @data = data
+
+      if @hostname.length > self.class.max_node_name_length
+        self.class.max_node_name_length = @hostname.length
+      end
     end
 
     def backend

data/lib/chake/version.rb

@@ -1,3 +1,3 @@
 module Chake
-  VERSION = "0.3.3"
+  VERSION = "0.4"
 end

data/spec/chake/backend/local_spec.rb

@@ -11,7 +11,7 @@ describe Chake::Backend::Local do
   it('rsyncs locally') { expect(backend.rsync_dest).to eq('/srv/chef/') }
 
   it('skips if hostname is not the local hostname') do
-    Socket.stub(:gethostname).and_return('otherhost')
+    allow(Socket).to receive(:gethostname).and_return('otherhost')
     expect(node.skip?).to eq(true)
   end
 end

data/spec/chake/node_spec.rb

@@ -4,8 +4,8 @@ describe Chake::Node do
 
   before do
     ent = double
-    ent.stub(:name).and_return('jonhdoe')
-    Etc.stub(:getpwuid).and_return(ent)
+    allow(ent).to receive(:name).and_return('jonhdoe')
+    allow(Etc).to receive(:getpwuid).and_return(ent)
   end
 
   let(:simple) { Chake::Node.new('hostname') }
@@ -40,9 +40,9 @@ describe Chake::Node do
 
       backend = double
       args = Object.new
-      node.stub(:backend).and_return(backend)
+      allow(node).to receive(:backend).and_return(backend)
 
-      backend.should_receive(method).with(args)
+      expect(backend).to receive(method).with(args)
       node.send(method, args)
     end
   end

data/spec/spec_helper.rb

@@ -13,21 +13,21 @@ shared_examples "Chake::Backend" do |backend_class|
 
   it('runs commands') do
     io = StringIO.new("line 1\nline 2\n")
-    IO.should_receive(:popen).with(backend.command_runner + ['something']).and_return(io)
-    backend.should_receive(:puts).with("myhost: $ something")
-    backend.should_receive(:puts).with("myhost: line 1")
-    backend.should_receive(:puts).with("myhost: line 2")
+    expect(IO).to receive(:popen).with(backend.command_runner + ['something']).and_return(io)
+    expect(backend).to receive(:printf).with(anything, "myhost", "something")
+    expect(backend).to receive(:printf).with(anything, "myhost", "line 1")
+    expect(backend).to receive(:printf).with(anything, "myhost", "line 2")
     backend.run('something')
   end
 
   it('runs as root') do
-    backend.should_receive(:run).with('sudo sh -c "something"')
+    expect(backend).to receive(:run).with('sudo sh -c "something"')
     backend.run_as_root('something')
   end
 
   it('does not use sudo if already root') do
-    backend.node.stub(:username).and_return('root')
-    backend.should_receive(:run).with('something')
+    allow(backend.node).to receive(:username).and_return('root')
+    expect(backend).to receive(:run).with('something')
     backend.run_as_root('something')
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chake
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: '0.4'
 platform: ruby
 authors:
 - Antonio Terceiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler