cornucopia 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df8ca3046295b778c73f4422cddec24ecdc92e11
-  data.tar.gz: 1a1e0632e7bf439078e67e06a083401bd3861e01
+  metadata.gz: 9cf8a5c84e2193e81d2b67d64375ada9f2007cba
+  data.tar.gz: 030766d5cd61bcb39200514aa0d58cd1e3fd5dd5
 SHA512:
-  metadata.gz: 4b96c1ee70f6264b86871f8afe5662c2ce1bff0a4e47b207105b6618f93718d9c50367933b2dcde212b807cc7dbc39019b253908811336b441419ec0bed7763d
-  data.tar.gz: 37b84256e2d5ede37af744e73eb0c5d223f4e414d9f947f29470d4ac2b6a9e0abbff6db8e0a4533e602ce81b5f55306194e217da075add1cd299ff96f06efe70
+  metadata.gz: 38dd4f0575e88f87850a1fbf0a94609048f2e371933206108cdf46b55d8b55857ec11c389a6f206e89854bde464d584022c256b0c94e11acd2ab33193f8d0896
+  data.tar.gz: 602703301a74c5f70bfe1c45201805a72e670af12b96c91a437b32dc635c88df517045651511c6b8ce16ff0b26eb7f83f9824b8dcccd72548b2f5e741cc9fa0b

data/README.md

@@ -313,6 +313,11 @@ The configuration class contains the various configurations that are used by the
 
     Indicates if the `Cornucopia::Util::LogCapture` class will capture any log files or not.
 
+* **backup_logs_on_failure**
+
+    Indicates if the `Cornucopia::Util::LogCapture` class will backup the full log file at the end of the test suite 
+    if there is an error.
+
 * **user_log_files**
 
     Returns a list of the log files which will be captures.  Changing the returned value will not affect log

data/lib/cornucopia/util/configuration.rb

@@ -19,6 +19,7 @@ module Cornucopia
         configurations.user_log_files                  = {}
         configurations.default_num_lines               = 500
         configurations.grab_logs                       = true
+        configurations.backup_logs_on_failure          = true
         configurations.print_timeout_min               = 10
         configurations.selenium_cache_retry_count      = 5
         configurations.analyze_find_exceptions         = true
@@ -405,6 +406,29 @@ module Cornucopia
           Cornucopia::Util::Configuration.instance.configurations.grab_logs
         end
 
+        # backup_logs_on_failure causes the system to copy the log files at the end of the report cycle if there were
+        # any errors during the creation of the report system.
+        #
+        # The system will try to grab the following log files:
+        #   * Rails.env.log
+        #   * any user specified logs
+        #
+        # The log capture is done with a simple file copy.
+        #
+        # Related options:
+        #   user_log_files
+        #   num_lines
+        #   add_log_file
+        #   remove_log_file
+        #   grab_logs
+        def backup_logs_on_failure=(value)
+          Cornucopia::Util::Configuration.instance.configurations.backup_logs_on_failure = value
+        end
+
+        def backup_logs_on_failure
+          Cornucopia::Util::Configuration.instance.configurations.backup_logs_on_failure
+        end
+
         # user_log_files returns a hash of all of the log files which
         # the user has specified are to be grabbed.
         #

data/lib/cornucopia/util/log_capture.rb

@@ -7,6 +7,42 @@ module Cornucopia
       class << self
         TAIL_BUF_LENGTH = 1 << 16
 
+        def backup_log_files(backup_folder)
+          if Object.const_defined?("Rails")
+            log_folder = Rails.root.to_s
+            if (log_folder =~ /\/features\/?$/ || log_folder =~ /\/spec\/?$/)
+              log_folder = File.join(log_folder, "../")
+            end
+
+            default_log_file = "log/#{Rails.env.to_s}.log"
+
+            copy_log_file backup_folder, File.join(log_folder, default_log_file)
+          else
+            log_folder = FileUtils.pwd
+          end
+
+          Cornucopia::Util::Configuration.user_log_files.each do |relative_log_file, options|
+            copy_log_file backup_folder, File.join(log_folder, relative_log_file)
+          end
+        end
+
+        def copy_log_file(dest_folder, source_file)
+          extension = File.extname(source_file)
+          file_name = File.basename(source_file, extension)
+          dest_name = File.join(dest_folder, "#{file_name}#{extension}")
+          index     = 0
+
+          while File.exists?(dest_name)
+            index     += 1
+            dest_name = File.join(dest_folder, "#{file_name}_#{index}#{extension}")
+          end
+
+          if File.exists?(source_file)
+            FileUtils.mkdir_p File.dirname(dest_name)
+            FileUtils.cp source_file, dest_name
+          end
+        end
+
         # This function will capture the logs and output them to the report
         def capture_logs(report_table)
           if report_table

data/lib/cornucopia/util/report_builder.rb

@@ -63,8 +63,9 @@ module Cornucopia
               format_value = value.to_s if value.is_a?(Array)
 
               if format_sub_items
-                Cornucopia::Util::ReportBuilder.pretty_format(format_value).rstrip
+                Cornucopia::Util::ReportBuilder.pretty_format(format_value, in_pretty_print: true).rstrip
               else
+                # "".html_safe + format_value
                 format_value
               end
             end.join("\n").html_safe
@@ -78,7 +79,7 @@ module Cornucopia
         # either the class prints quickly, or we kill it and try something else.
         #
         # If the something else doesn't work, we just give up...
-        def pretty_object(value)
+        def pretty_object(value, options = {})
           timed_out    = false
           return_value = nil
 
@@ -94,7 +95,7 @@ module Cornucopia
                 if value.is_a?(String)
                   return_value = value
                 elsif value.is_a?(Array)
-                  return_value = Cornucopia::Util::ReportBuilder.pretty_array(value, false)
+                  return_value = Cornucopia::Util::ReportBuilder.pretty_array(value, !options[:in_pretty_print])
                 elsif value.respond_to?(:pretty_inspect)
                   return_value = value.pretty_inspect
                 else
@@ -124,10 +125,10 @@ module Cornucopia
           return_value
         end
 
-        def pretty_format(value)
+        def pretty_format(value, options = {})
           pretty_text = value
 
-          pretty_text = Cornucopia::Util::ReportBuilder.pretty_object(pretty_text)
+          pretty_text = Cornucopia::Util::ReportBuilder.pretty_object(pretty_text, options)
           pretty_text = Cornucopia::Util::ReportBuilder.escape_string(pretty_text)
           pretty_text = Cornucopia::Util::PrettyFormatter.format_string(pretty_text)
           pretty_text = Cornucopia::Util::ReportBuilder.format_code_refs(pretty_text)
@@ -222,6 +223,10 @@ module Cornucopia
         end
 
         if File.exists?(report_base_page_name)
+          if Cornucopia::Util::Configuration.backup_logs_on_failure
+            backup_log_files
+          end
+
           if Cornucopia::Util::Configuration.open_report_after_generation(@base_folder_name)
             # `open #{report_base_page_name}` rescue nil
             system("open #{report_base_page_name}") rescue nil
@@ -434,17 +439,23 @@ module Cornucopia
         FileAsset.asset("cornucopia.css").add_file(File.join(support_folder_name, "cornucopia.css"))
       end
 
+      def body_list_item(name, path)
+        body_list_item = "<li>\n".html_safe
+        body_list_item += "<a class=\"coruncopia-report-link\" href=\"#{path}\" target=\"_blank\">".html_safe
+        body_list_item += name
+        body_list_item += "</a>\n".html_safe
+        body_list_item += "</li>\n".html_safe
+
+        body_list_item
+      end
+
       def test_list_item
         if @test_list_item
           nil
         else
           folder_name = File.basename(report_test_folder_name)
 
-          @test_list_item = "<li>\n".html_safe
-          @test_list_item += "<a class=\"coruncopia-report-link\" href=\"#{folder_name}/index.html\" target=\"_blank\">".html_safe
-          @test_list_item += @test_name
-          @test_list_item += "</a>\n".html_safe
-          @test_list_item += "</li>\n".html_safe
+          @test_list_item = body_list_item(@test_name, File.join(folder_name, "index.html"))
 
           @test_list_item
         end
@@ -628,14 +639,16 @@ module Cornucopia
         padded_val << "</div>".html_safe
       end
 
-      def unique_file_name(file_base_name)
+      def unique_file_name(file_base_name, base_folder = nil)
         file_parts = file_base_name.split(".")
         base_name  = file_parts[0..-2].join(".")
         extension  = file_parts[-1]
 
+        base_folder ||= report_test_folder_name
+
         unique_num = 1
         num_string = ""
-        while File.exists?(File.join(report_test_folder_name, "#{base_name}#{num_string}.#{extension}"))
+        while File.exists?(File.join(base_folder, "#{base_name}#{num_string}.#{extension}"))
           num_string = "_#{unique_num}"
           unique_num += 1
         end
@@ -643,16 +656,32 @@ module Cornucopia
         "#{base_name}#{num_string}.#{extension}"
       end
 
-      def unique_folder_name(folder_base_name)
+      def unique_folder_name(folder_base_name, base_folder = nil)
         unique_num = 1
         num_string = ""
-        while File.exists?(File.join(report_test_folder_name, "#{folder_base_name}#{num_string}"))
+
+        base_folder ||= report_test_folder_name
+
+        while File.exists?(File.join(base_folder, "#{folder_base_name}#{num_string}"))
           num_string = "_#{unique_num}"
           unique_num += 1
         end
 
         "#{folder_base_name}#{num_string}"
       end
+
+      def backup_log_files
+        log_folder = unique_folder_name "log_files", report_folder_name
+
+        Cornucopia::Util::LogCapture.backup_log_files File.join(report_folder_name, log_folder)
+
+        log_files = Dir[File.join(report_folder_name, log_folder, "**", "*")]
+        log_files.each do |log_file|
+          @report_body += body_list_item(File.basename(log_file), log_file[report_folder_name.length..-1])
+        end
+
+        rebuild_report_holder_page
+      end
     end
   end
 end

data/lib/cornucopia/version.rb

@@ -1,3 +1,3 @@
 module Cornucopia
-  VERSION = "0.1.21"
+  VERSION = "0.1.22"
 end

data/spec/lib/util/configuration_spec.rb

@@ -76,7 +76,7 @@ describe "Cornucopia::Util::Configuration" do
       expect(Cornucopia::Util::Configuration.grab_logs).to be_truthy
     end
 
-    it "can set the seed value" do
+    it "can set the grab_logs value" do
       begin
         Cornucopia::Util::Configuration.grab_logs = false
 
@@ -86,6 +86,20 @@ describe "Cornucopia::Util::Configuration" do
       end
     end
 
+    it "backs up logs on failure by default" do
+      expect(Cornucopia::Util::Configuration.backup_logs_on_failure).to be_truthy
+    end
+
+    it "can set the backup_logs_on_failure value" do
+      begin
+        Cornucopia::Util::Configuration.backup_logs_on_failure = false
+
+        expect(Cornucopia::Util::Configuration.backup_logs_on_failure).to be_falsey
+      ensure
+        Cornucopia::Util::Configuration.backup_logs_on_failure = true
+      end
+    end
+
     it "has no custom files by default" do
       expect(Cornucopia::Util::Configuration.user_log_files).to be == {}
     end

data/spec/lib/util/log_capture_spec.rb

@@ -3,12 +3,16 @@ require ::File.expand_path("../../../lib/cornucopia/util/log_capture", File.dirn
 
 describe Cornucopia::Util::LogCapture do
   let(:file_name) { Rails.root.join("sample_log.log") }
+  let(:dest_folder) { Rails.root.join("fake_logs/") }
 
   around(:each) do |example|
+    pwd = FileUtils.pwd
+
     expect(File.directory?(Rails.root.join("cornucopia_report/"))).to be_falsey
     expect(File.directory?(Rails.root.join("spec/cornucopia_report/"))).to be_falsey
     expect(File.directory?(Rails.root.join("features/cornucopia_report/"))).to be_falsey
     expect(File.exists?(file_name)).to be_falsey
+    expect(File.directory?(dest_folder)).to be_falsey
 
     begin
       example.run
@@ -22,6 +26,13 @@ describe Cornucopia::Util::LogCapture do
       FileUtils.rm_rf Rails.root.join("features/cornucopia_report/")
       FileUtils.rm_rf Rails.root.join("features") if Dir[Rails.root.join("features/*")].empty?
       FileUtils.rm_rf file_name
+      FileUtils.rm_rf dest_folder
+
+      Dir[File.join(dest_folder, "sample_log*.log")].each do |file_name|
+        FileUtils.rm_rf file_name
+      end
+
+      FileUtils.cd pwd
     end
   end
 
@@ -88,6 +99,69 @@ describe Cornucopia::Util::LogCapture do
     end
   end
 
+  describe "#backup_log_files" do
+    before(:each) do
+      FileUtils.mkdir_p dest_folder
+      Cornucopia::Util::FileAsset.asset("report.js").add_file(file_name)
+    end
+
+    after(:each) do
+      Cornucopia::Util::Configuration.remove_log_file("sample_log.log")
+    end
+
+    it "goes up one level if you are in spec or features" do
+      Cornucopia::Util::Configuration.add_log_file("sample_log.log")
+
+      expect(File.exists?(file_name)).to be_truthy
+      expect(File.exists?(File.join(dest_folder, "sample_log.log"))).to be_falsey
+
+      new_root = Rails.root.join(%w(features spec).sample).to_s
+      expect(Rails).to receive(:root).at_least(1).and_return(new_root)
+
+      Cornucopia::Util::LogCapture.backup_log_files(dest_folder)
+
+      expect(File.exists?(File.join(dest_folder, "sample_log.log"))).to be_truthy
+    end
+
+    it "resolves file conflicts" do
+      file_num = rand(1..5)
+      Cornucopia::Util::Configuration.add_log_file("sample_log.log")
+
+      expect(File.exists?(file_name)).to be_truthy
+      FileUtils.cp file_name, File.join(dest_folder, "sample_log.log")
+      expect(File.exists?(File.join(dest_folder, "sample_log.log"))).to be_truthy
+
+      index = 1
+      while index < file_num
+        FileUtils.cp file_name, File.join(dest_folder, "sample_log_#{index}.log")
+        expect(File.exists?(File.join(dest_folder, "sample_log_#{index}.log"))).to be_truthy
+        index += 1
+      end
+      expect(File.exists?(File.join(dest_folder, "sample_log_#{file_num}.log"))).to be_falsey
+
+      new_root = Rails.root.join(%w(features spec).sample).to_s
+      expect(Rails).to receive(:root).at_least(1).and_return(new_root)
+
+      Cornucopia::Util::LogCapture.backup_log_files(dest_folder)
+
+      expect(File.exists?(File.join(dest_folder, "sample_log_#{file_num}.log"))).to be_truthy
+    end
+
+    it "does not require Rails" do
+      Cornucopia::Util::Configuration.add_log_file("sample_log.log")
+
+      expect(File.exists?(file_name)).to be_truthy
+      expect(File.exists?(File.join(dest_folder, "sample_log.log"))).to be_falsey
+
+      FileUtils.cd Rails.root.to_s
+      expect(Object).to receive(:const_defined?).at_least(1).with("Rails").and_return(false)
+
+      Cornucopia::Util::LogCapture.backup_log_files(dest_folder)
+
+      expect(File.exists?(File.join(dest_folder, "sample_log.log"))).to be_truthy
+    end
+  end
+
   describe "#capture_logs" do
     after(:each) do
       Cornucopia::Util::Configuration.remove_log_file("sample_log.log")
@@ -120,7 +194,7 @@ describe Cornucopia::Util::LogCapture do
         write_file.write(lines.join("\n"))
       end
 
-      new_root = Rails.root.join(%w(features features).sample).to_s
+      new_root = Rails.root.join(%w(features spec).sample).to_s
       expect(Rails).to receive(:root).at_least(1).and_return(new_root)
       Cornucopia::Util::LogCapture.capture_logs(nil)
 

data/spec/lib/util/report_builder_spec.rb

@@ -163,7 +163,13 @@ describe Cornucopia::Util::ReportBuilder do
     end
 
     it "calls #pretty_format on a sub-array after it is converted to a string" do
-      expect(Cornucopia::Util::ReportBuilder).to receive(:pretty_format).exactly(4).and_call_original
+      expect(Cornucopia::Util::ReportBuilder).
+          to receive(:pretty_format).
+                 with(anything, in_pretty_print: true).
+                 exactly(4).
+                 times.
+                 and_call_original
+
       array_values << [1, 2, 3]
 
       formatted_code = Cornucopia::Util::ReportBuilder.pretty_array(array_values)
@@ -171,6 +177,17 @@ describe Cornucopia::Util::ReportBuilder do
       expect(formatted_code).to be_html_safe
       expect(formatted_code).to be == "Turner &amp;amp; Hooch\nBarney Rubble\nHarvey\n[1, 2, 3]"
     end
+
+    it "doesn't call #pretty_format on values if told not to" do
+      expect(Cornucopia::Util::ReportBuilder).not_to receive(:pretty_format)
+
+      array_values << [1, 2, 3]
+
+      formatted_code = Cornucopia::Util::ReportBuilder.pretty_array(array_values, false)
+
+      expect(formatted_code).to be_html_safe
+      expect(formatted_code).to be == "Turner &amp; Hooch\nBarney Rubble\nHarvey\n[1, 2, 3]"
+    end
   end
 
   describe "#pretty_object" do
@@ -1051,9 +1068,11 @@ describe Cornucopia::Util::ReportBuilder do
 
           report_page = Capybara::Node::Simple.new(File.read(current_report.report_base_page_name))
 
-          expect(report_page.all(".coruncopia-report-link").length).to eq 1
+          expect(report_page.all(".coruncopia-report-link").length).to eq 2
           expect(report_page.all(".coruncopia-report-link")[0].text).to eq test_names[0]
           expect(report_page.all(".coruncopia-report-link")[0]["href"]).to eq "test_1/index.html"
+          expect(report_page.all(".coruncopia-report-link")[1].text).to eq "test.log"
+          expect(report_page.all(".coruncopia-report-link")[1]["href"]).to eq "log_files/test.log"
         end
 
         it "doesn't output anything if nothing is written to a section or table" do
@@ -1087,12 +1106,14 @@ describe Cornucopia::Util::ReportBuilder do
 
           report_page = Capybara::Node::Simple.new(File.read(current_report.report_base_page_name))
 
-          expect(report_page.all(".coruncopia-report-link").length).to eq test_names.length
+          expect(report_page.all(".coruncopia-report-link").length).to eq (test_names.length + 1)
 
           test_names.each_with_index do |test_name, test_index|
             expect(report_page.all(".coruncopia-report-link")[test_index].text).to eq test_name
             expect(report_page.all(".coruncopia-report-link")[test_index]["href"]).to eq "test_#{test_index + 1}/index.html"
           end
+          expect(report_page.all(".coruncopia-report-link")[-1].text).to eq "test.log"
+          expect(report_page.all(".coruncopia-report-link")[-1]["href"]).to eq "log_files/test.log"
         end
 
         it "handles a test within a test as an independent test" do
@@ -1117,11 +1138,13 @@ describe Cornucopia::Util::ReportBuilder do
 
           report_page = Capybara::Node::Simple.new(File.read(current_report.report_base_page_name))
 
-          expect(report_page.all(".coruncopia-report-link").length).to eq 2
+          expect(report_page.all(".coruncopia-report-link").length).to eq 3
           expect(report_page.all(".coruncopia-report-link")[0].text).to eq test_names[0]
           expect(report_page.all(".coruncopia-report-link")[0]["href"]).to eq "test_1/index.html"
           expect(report_page.all(".coruncopia-report-link")[1].text).to eq test_names[1]
           expect(report_page.all(".coruncopia-report-link")[1]["href"]).to eq "test_2/index.html"
+          expect(report_page.all(".coruncopia-report-link")[2].text).to eq "test.log"
+          expect(report_page.all(".coruncopia-report-link")[2]["href"]).to eq "log_files/test.log"
 
           report_page = Capybara::Node::Simple.new(File.read(File.join(current_report.report_folder_name, "test_1/report_contents.html")))
           expect(report_page.all(".cornucopia-section-label").length).to eq 1
@@ -1160,11 +1183,13 @@ describe Cornucopia::Util::ReportBuilder do
 
           report_page = Capybara::Node::Simple.new(File.read(current_report.report_base_page_name))
 
-          expect(report_page.all(".coruncopia-report-link").length).to eq 2
+          expect(report_page.all(".coruncopia-report-link").length).to eq 3
           expect(report_page.all(".coruncopia-report-link")[0].text).to eq test_names[0]
           expect(report_page.all(".coruncopia-report-link")[0]["href"]).to eq "test_1/index.html"
           expect(report_page.all(".coruncopia-report-link")[1].text).to eq test_names[1]
           expect(report_page.all(".coruncopia-report-link")[1]["href"]).to eq "test_2/index.html"
+          expect(report_page.all(".coruncopia-report-link")[2].text).to eq "test.log"
+          expect(report_page.all(".coruncopia-report-link")[2]["href"]).to eq "log_files/test.log"
 
           report_page = Capybara::Node::Simple.new(File.read(File.join(current_report.report_folder_name, "test_1/report_contents.html")))
           expect(report_page.all(".cornucopia-section-label").length).to eq 2
@@ -1191,12 +1216,14 @@ describe Cornucopia::Util::ReportBuilder do
 
           report_page = Capybara::Node::Simple.new(File.read(current_report.report_base_page_name))
 
-          expect(report_page.all(".coruncopia-report-link").length).to eq 2
+          expect(report_page.all(".coruncopia-report-link").length).to eq 3
 
           expect(report_page.all(".coruncopia-report-link")[0].text).to eq test_names[0]
           expect(report_page.all(".coruncopia-report-link")[0]["href"]).to eq "test_1/index.html"
           expect(report_page.all(".coruncopia-report-link")[1].text).to eq test_names[-1]
           expect(report_page.all(".coruncopia-report-link")[1]["href"]).to eq "test_2/index.html"
+          expect(report_page.all(".coruncopia-report-link")[2].text).to eq "test.log"
+          expect(report_page.all(".coruncopia-report-link")[2]["href"]).to eq "log_files/test.log"
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cornucopia
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - RealNobody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2015-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails