extra Logging on cypress fail (#9)

Author: grantspeelman

CHANGELOG.md

@@ -1,3 +1,6 @@
+### Tasks
+* adding additional log failure logging
+
 ## 1.1.1
 ### Fixed
 * smart factory wrapper can handle when factory files get deleted

lib/generators/cypress_dev/templates/spec/cypress/app_commands/clean.rb

@@ -6,3 +6,5 @@
   logger.warn "add database_cleaner or update clean_db"
   Post.delete_all if defined?(Post)
 end
+
+Rails.logger.info "APPCLEANED" # used by log_fail.rb

lib/generators/cypress_dev/templates/spec/cypress/app_commands/log_fail.rb

@@ -0,0 +1,24 @@
+# This file is called when a cypress spec fails and allows for extra logging to be captured
+filename = command_options.fetch('runnable_full_title', 'no title').gsub(/[^[:print:]]/, '')
+
+# grab last lines until "APPCLEANED" (Make sure in clean.rb to log the text "APPCLEANED")
+system "tail -n 10000 -r log/#{Rails.env}.log | sed \"/APPCLEANED/ q\" | sed 'x;1!H;$!d;x' > 'log/#{filename}.log'"
+
+# create a json debug file for server debugging
+json_result = {}
+json_result['error'] = command_options.fetch('error_message', 'no error message')
+
+if defined?(ActiveRecord::Base)
+  json_result['records'] =
+    ActiveRecord::Base.descendants.each_with_object({}) do |record_class, records|
+      begin
+        records[record_class.to_s] = record_class.limit(100).map(&:attributes)
+      rescue
+      end
+    end
+end
+
+filename = command_options.fetch('runnable_full_title', 'no title').gsub(/[^[:print:]]/, '')
+File.open("#{Rails.root}/log/#{filename}.json", "w+") do |file|
+  file << JSON.pretty_generate(json_result)
+end

lib/generators/cypress_dev/templates/spec/cypress/integration/rails_examples/using_scenarios_spec.js

@@ -15,12 +15,16 @@ describe('Rails using scenarios examples', function() {
     })
   })
 
-  // uncomment these if you want to see what happens
-  // it('example of missing scenario failure', function() {
-  //   cy.appScenario('missing')
-  // })
-  //
-  // it('example of missing app failure', function() {
-  //   cy.app('run_me')
-  // })
+
+  it('example of missing scenario failure', function() {
+    cy.visit('/')
+    cy.appScenario('basic')
+    // cy.appScenario('missing') // uncomment these if you want to see what happens
+  })
+
+  it('example of missing app failure', function() {
+    cy.visit('/')
+    cy.appScenario('basic')
+    // cy.app('run_me') // uncomment these if you want to see what happens
+  })
 })

lib/generators/cypress_dev/templates/spec/cypress/support/on-rails.js

@@ -34,4 +34,17 @@ Cypress.Commands.add('appFixtures', function (options) {
 // The next is optional
 // beforeEach(() => {
 //  cy.app('clean') // have a look at cypress/app_commands/clean.rb
-// });
+// });
+
+// comment this out if you do not want to attempt to log additional info on test fail
+Cypress.on('fail', (err, runnable) => {
+  // allow app to generate additional logging data
+  Cypress.$.ajax({
+    url: '/__cypress__/command',
+    data: JSON.stringify({name: 'log_fail', options: {error_message: err.message, runnable_full_title: runnable.fullTitle() }}),
+    async: false,
+    method: 'POST'
+  });
+
+  throw err;
+});

spec/integrations/rails_3_2/config/application.rb

@@ -64,6 +64,5 @@ class Application < Rails::Application
 
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
-    config.logger = Logger.new(STDOUT)
   end
 end

spec/integrations/rails_3_2/log/.keep

@@ -28,6 +28,5 @@ class Application < Rails::Application
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
-    config.logger = Logger.new(STDOUT)
   end
 end

spec/integrations/rails_4_2/config/application.rb

@@ -29,9 +29,5 @@ class Application < Rails::Application
 
     # Don't generate system test files.
     config.generators.system_tests = nil
-
-    logger           = ActiveSupport::Logger.new(STDOUT)
-    logger.formatter = config.log_formatter
-    config.logger    = ActiveSupport::TaggedLogging.new(logger)
   end
 end