stackadmin 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0be32008f934bc0cd785a217a37345c10f635774
-  data.tar.gz: ca65a7a9f88ffedaec11f93f3c51aecb603b0388
+  metadata.gz: ff7b29f7a0a1d1de8c0f8dee4a92d4871815ce65
+  data.tar.gz: b3472c1a8c7f0b2884e688ef076c8ab07ff5e088
 SHA512:
-  metadata.gz: 94be1cf2827ce0ea981d2d0cd5880e7639082f22281b3d715b976814d17ae034fd704a817d66174b93e25c6f8cc166f20298d58ee80686a37603e985e9420c9d
-  data.tar.gz: a4b15558c9613d81dbd7af5bd69196153e8469a7a85e02040a8c7920d69f8b09df3a3c7ea4534e186418193937f63ed268a13fe701f4567ee559e421ff63e3a2
+  metadata.gz: 0ebbbec1bb8949ea298d94b4b3807237d9c88c2fc691e7f9f297870c5155b6397a5749b13c77e8a97fee90efbdb2b7664a5e811bb86c53ad9356b1e794a95397
+  data.tar.gz: 70f7ade17b8cfedcaf30efc9343a9f006a6ba10a47212495dcb20e8ecbca3de815e00f66b8cd295fbfa4882ed3cefa7d91f896915697ead76955d90d681af77d

data/CHANGELOG

@@ -1,4 +1,25 @@
-0.2.0 (2011-03-13)
+1.0.0 (2015-03-16)
+==================
+
+New
+---
+- Full cluster reporting
+- Download reports as tarballs
+- Return path to report as string with ::report
+- Debug output for ::report
+
+Changes
+-------
+- Refactored method prototype for ::report
+- Refactored tests
+
+Fix
+---
+- Typos in CHANGELOG
+- Typo in ::decompress_report docs
+
+
+0.2.0 (2015-03-13)
 ==================
 
 New
@@ -6,7 +27,7 @@ New
 - Basic support for kato report
 
 
-0.1.1 (2011-03-11)
+0.1.1 (2015-03-11)
 ==================
 
 New

data/lib/stackadmin/log.rb

@@ -11,21 +11,52 @@ require_relative 'net-ssh'
 
 class Stackadmin
   # Retrieve a report from the targeted Stackato
-  # @param destination [String] where to save the report
-  def report(destination = '.')
-    tarball = nil
-    Net::SSH.start(@id, 'stackato', port: @port) do |ssh|
-      location = ssh.exec_sc!('kato report')[:stdout].match(/^Report generated at (.+)\. /)[1]
+  # @option args [Symbol] :tarball retrieve report as a tarball
+  # @option args [Symbol] :cluster retrieve full cluster report
+  # @option args [String] :destination where to save the report
+  # @return [String] path to the report
+  def report(*args)
+    opts = (args.last.class == Hash) ? args.pop : Hash.new
+    opts[:destination] = '.' unless opts.has_key?(:destination)
+
+    cmd = 'kato report'
+    query = /^Report generated at (.+)\. /
+    output = nil
+
+    if args.include?(:cluster)
+      cmd += ' --cluster'
+      query = /^Your cluster 'kato report' is available at (.+)\.$/
+    end
+
+    log "Generating #{'cluster ' if args.include?(:cluster)}report at #{@id}"
+    ssh = Net::SSH.start(@id, 'stackato', port: @port)
+    location = ssh.exec_sc!(cmd)[:stdout].match(query)[1]
+    log "Report located at: #{@id}:#{location}"
+
+    if args.include?(:tarball)
+      filename = location.split('/').last
+      output = File.expand_path(File.join(opts[:destination], filename))
+
+      log "Downloading tarball to: #{output}"
+      ssh.scp.download!(location, opts[:destination])
+    else
+      log 'Downloading report'
       tarball = StringIO.new(ssh.scp.download!(location))
+
+      log "Decompressing report to: #{opts[:destination]}"
+      decompress_report(tarball, opts[:destination])
+      output = File.expand_path(opts[:destination])
+      output = File.join(output, 'stackato-report') unless args.include?(:cluster)
     end
 
-    decompress_report(tarball, destination)
+    ssh.close
+    output
   end
 
   private
 
   # Decompresses a report tarball to a specified location
-  # @param report [StringIO] in-memory buffer of the report tarball
+  # @param tarball [StringIO] in-memory buffer of the report tarball
   # @param destination [String] where to decompress the report
   # @see http://old.thoughtsincomputation.com/posts/tar-and-a-few-feathers-in-ruby Yanked from TiC
   def decompress_report(tarball, destination)
@@ -45,6 +76,7 @@ class Stackadmin
           destination_directory = File.dirname(destination_file)
           FileUtils.mkdir_p(destination_directory) unless File.directory?(destination_directory)
           File.open(destination_file, 'wb') do |f|
+            log "Extracting #{destination_file}"
             f.print tarfile.read
           end
         end

data/lib/stackadmin/version.rb

@@ -2,5 +2,5 @@
 
 class Stackadmin
   # Gem version
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/test/stackadmin_test.rb

@@ -44,10 +44,35 @@ describe Stackadmin do
     describe 'report' do
       it 'downloads a report to the current directory by default' do
         Dir.chdir(TEMP_DIR) do
-          subject.report
-          assert File.directory?(File.join(TEMP_DIR, 'stackato-report'))
+          path = File.join(TEMP_DIR, 'stackato-report')
+          subject.report.must_equal path
+          assert File.directory?(path)
         end
       end
+
+      it 'downloads a report to a specified directory' do
+        path = File.join(TEMP_DIR, 'stackato-report')
+        subject.report(destination: TEMP_DIR).must_equal path
+        assert File.directory?(path)
+      end
+
+      it 'downloads the report as a tarball' do
+        path = File.join(TEMP_DIR, 'stackato-report.tgz')
+        subject.report(:tarball, destination: TEMP_DIR).must_equal path
+        assert File.file?(path)
+      end
+
+      it 'generates a full cluster report' do
+        subject.report(:cluster, destination: TEMP_DIR).must_equal TEMP_DIR
+        assert File.directory?(File.join(TEMP_DIR, '10.0.2.15'))
+        assert File.file?(File.join(TEMP_DIR, 'node_list.txt'))
+      end
+
+      it 'generates a full cluster report as a tarball' do
+        path = File.join(TEMP_DIR, 'stackato-cluster-report.tgz')
+        subject.report(:cluster, :tarball, destination: TEMP_DIR).must_equal path
+        assert File.file?(path)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackadmin
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andres Rojas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-scp