Test fixtures and install generator updates (#6)

* separate rails examples by group
* Add support to load Rails fixtures
* Update README

Author: grantspeelman

README.md

@@ -12,6 +12,12 @@ Do things like:
 * use factory_bot to setup data
 * create scenario files used for specific tests
 
+Has examples of setting up state with:
+* factory_bot
+* rails test fixtures
+* scenarios
+* custom commands
+
 This gem is based off https://github.com/konvenit/cypress-on-rails
 
 ## Getting started
@@ -64,66 +70,94 @@ cd spec
 yarn run cypress open
 ```
 
-### Example of using scenarios
-
-Scenarios are named `before` blocks that you can reference in your test.
+### Example of using factory bot
+You can run your [factory_bot](https://github.com/thoughtbot/factory_bot) directly as well
 
-You define a scenario in the `spec/cypress/app_commands/scenarios` directory:
 ```ruby
 # spec/cypress/app_commands/scenarios/basic.rb
-Profile.create name: "Cypress Hill"
+require 'cypress_dev/smart_factory_wrapper'
 
-# or if you have factory_bot enabled in your cypress_helper
-CypressDev::SmartFactoryWrapper.create(:profile, name: "Cypress Hill") 
+CypressDev::SmartFactoryWrapper.configure(
+    always_reload: !Rails.configuration.cache_classes,
+    factory: FactoryBot,
+    files: Dir['./spec/factories/**/*.rb']
+) 
 ```
 
-Then reference the scenario in your test:
 ```js
-// spec/cypress/integrations/scenario_example_spec.js
+// spec/cypress/integrations/simple_spec.js
 describe('My First Test', function() {
   it('visit root', function() {
     // This calls to the backend to prepare the application state
-    cy.appScenario('basic')
+    cy.appFactories([
+      ['create_list', 'post', 10],
+      ['create', 'post', {title: 'Hello World'} ]
+    ])
 
-    cy.visit('/profiles')
+    // Visit the application under test
+    cy.visit('/')
 
-    cy.contains("Cypress Hill")
+    cy.contains("Hello World")
   })
 })
 ```
 
-### Example of using factory bot
-You can run your [factory_bot](https://github.com/thoughtbot/factory_bot) directly as well
-
+### Example of loading rails test fixtures
 ```ruby
-# spec/cypress/app_commands/scenarios/basic.rb
-require 'cypress_dev/smart_factory_wrapper'
+# spec/cypress/app_commands/activerecord_fixtures.rb
+require "active_record/fixtures"
 
-CypressDev::SmartFactoryWrapper.configure(
-    always_reload: !Rails.configuration.cache_classes,
-    factory: FactoryBot,
-    files: Dir['./spec/factories/**/*.rb']
-) 
+fixtures_dir = ActiveRecord::Tasks::DatabaseTasks.fixtures_path
+fixture_files = Dir["#{fixtures_dir}/**/*.yml"].map { |f| f[(fixtures_dir.size + 1)..-5] }
+
+logger.debug "loading fixtures: { dir: #{fixtures_dir}, files: #{fixture_files} }"
+ActiveRecord::FixtureSet.reset_cache
+ActiveRecord::FixtureSet.create_fixtures(fixtures_dir, fixture_files)
 ```
 
 ```js
 // spec/cypress/integrations/simple_spec.js
 describe('My First Test', function() {
   it('visit root', function() {
     // This calls to the backend to prepare the application state
-    cy.appFactories([
-      ['create_list', 'post', 10],
-      ['create', 'post', {title: 'Hello World'} ]
-    ])
+    cy.appFixtures()
 
-    // The application unter test is available at SERVER_PORT
+    // Visit the application under test
     cy.visit('/')
 
     cy.contains("Hello World")
   })
 })
 ```
 
+### Example of using scenarios
+
+Scenarios are named `before` blocks that you can reference in your test.
+
+You define a scenario in the `spec/cypress/app_commands/scenarios` directory:
+```ruby
+# spec/cypress/app_commands/scenarios/basic.rb
+Profile.create name: "Cypress Hill"
+
+# or if you have factory_bot enabled in your cypress_helper
+CypressDev::SmartFactoryWrapper.create(:profile, name: "Cypress Hill") 
+```
+
+Then reference the scenario in your test:
+```js
+// spec/cypress/integrations/scenario_example_spec.js
+describe('My First Test', function() {
+  it('visit root', function() {
+    // This calls to the backend to prepare the application state
+    cy.appScenario('basic')
+
+    cy.visit('/profiles')
+
+    cy.contains("Cypress Hill")
+  })
+})
+```
+
 ### Example of using app commands
 
 create a ruby file in `spec/cypress/app_commands` directory:

lib/generators/cypress_dev/install_generator.rb

@@ -33,12 +33,9 @@ def install_cypress
     def add_initial_files
       template "config/initializers/cypress_dev.rb.erb", "config/initializers/cypress_dev.rb"
       copy_file "spec/cypress/cypress_helper.rb", "#{options.cypress_folder}/cypress_helper.rb"
-      copy_file "spec/cypress/integration/on_rails_spec.js", "#{options.cypress_folder}/integration/on_rails_spec.js"
       copy_file "spec/cypress/support/on-rails.js", "#{options.cypress_folder}/support/on-rails.js"
-      copy_file "spec/cypress/app_commands/scenarios/basic.rb", "#{options.cypress_folder}/app_commands/scenarios/basic.rb"
-      copy_file "spec/cypress/app_commands/clean.rb", "#{options.cypress_folder}/app_commands/clean.rb"
-      copy_file "spec/cypress/app_commands/eval.rb", "#{options.cypress_folder}/app_commands/eval.rb"
-      copy_file "spec/cypress/app_commands/factory_bot.rb", "#{options.cypress_folder}/app_commands/factory_bot.rb"
+      directory 'spec/cypress/app_commands', "#{options.cypress_folder}/app_commands"
+      directory 'spec/cypress/integration/rails_examples', "#{options.cypress_folder}/integration/rails_examples"
     end
 
     def update_files

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

@@ -0,0 +1,21 @@
+# you can delete this file if you don't use Rails Test Fixtures
+
+fixtures_dir = command_options.try(:[], 'fixtures_dir')
+fixture_files = command_options.try(:[], 'fixtures')
+
+if defined?(ActiveRecord)
+  require "active_record/fixtures"
+
+  fixtures_dir ||= ActiveRecord::Tasks::DatabaseTasks.fixtures_path
+  fixture_files ||= Dir["#{fixtures_dir}/**/*.yml"].map { |f| f[(fixtures_dir.size + 1)..-5] }
+
+  logger.debug "loading fixtures: { dir: #{fixtures_dir}, files: #{fixture_files} }"
+  ActiveRecord::FixtureSet.reset_cache
+  ActiveRecord::FixtureSet.create_fixtures(fixtures_dir, fixture_files)
+else # this else part can be removed
+  logger.error "Looks like activerecord_fixtures has to be modified to suite your need"
+  Post.create(title: 'MyCypressFixtures')
+  Post.create(title: 'MyCypressFixtures2')
+  Post.create(title: 'MyRailsFixtures')
+  Post.create(title: 'MyRailsFixtures2')
+end

lib/generators/cypress_dev/templates/spec/cypress/integration/on_rails_spec.js

@@ -0,0 +1,25 @@
+describe('Rails Other examples', function() {
+  it('cypress eval', function() {
+    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+    cy.appEval("Post.create(title: 'Hello Eval')")
+
+    cy.visit('/')
+    cy.get('table').find('tbody').should(($tbody) => {
+      expect($tbody).not.to.contain('Multi Command')
+      expect($tbody).to.contain('Hello Eval')
+    })
+  })
+
+  it('runs multiple commands', function() {
+    cy.appCommands([{ name: 'clean' },
+                    { name: 'scenarios/basic' },
+                    { name: 'eval', options: "Post.create(title: 'Multi Command')" }])
+    cy.visit('/')
+
+    cy.get('table').find('tbody').should(($tbody) => {
+      expect($tbody).not.to.contain('Hello Eval')
+      expect($tbody).to.contain('Multi Command')
+      expect($tbody).to.contain('I am a Postman')
+    })
+  })
+})

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

@@ -0,0 +1,31 @@
+describe('Rails using factory bot examples', function() {
+  beforeEach(() => {
+    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+  })
+
+  it('using single factory bot', function() {
+    cy.appFactories([
+      ['create', 'post', {title: 'Good bye Mars'} ]
+    ])
+    cy.visit('/')
+    cy.get('table').find('tbody').should(($tbody) => {
+      // clean should of removed these from other tests
+      expect($tbody).not.to.contain('Hello World')
+
+      expect($tbody).to.contain('Good bye Mars')
+    })
+  })
+
+  it('using multiple factory bot', function() {
+    cy.appFactories([
+      ['create_list', 'post', 10],
+      ['create', 'post', {title: 'Hello World'} ]
+    ])
+    cy.visit('/')
+    cy.get('table').find('tbody').should(($tbody) => {
+      // clean should of removed these from other tests
+      expect($tbody).to.contain('Hello World')
+      expect($tbody).not.to.contain('Good bye Mars')
+    })
+  })
+})

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

@@ -0,0 +1,33 @@
+describe('Rails using rails fixtures examples', function() {
+  beforeEach(() => {
+    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+  })
+
+  it('loading all fixtures', function() {
+    cy.appFixtures()
+    cy.visit('/')
+    cy.get('table').find('tbody').should(($tbody) => {
+      expect($tbody).to.contain('MyRailsFixtures')
+      expect($tbody).to.contain('MyRailsFixtures2')
+    })
+  })
+
+  it('using single rails fixtures', function() {
+    cy.appFixtures({fixtures: ['posts']})
+    cy.visit('/')
+    cy.get('table').find('tbody').should(($tbody) => {
+      expect($tbody).to.contain('MyRailsFixtures')
+      expect($tbody).to.contain('MyRailsFixtures2')
+    })
+  })
+
+  it('loading another folder of fixtures', function() {
+    cy.appFixtures({fixtures_dir: 'test/cypress_fixtures' })
+    cy.visit('/')
+    cy.get('table').find('tbody').should(($tbody) => {
+      expect($tbody).to.contain('MyCypressFixtures')
+      expect($tbody).to.contain('MyCypressFixtures2')
+    })
+  })
+})
+

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

@@ -0,0 +1,26 @@
+describe('Rails using scenarios examples', function() {
+  beforeEach(() => {
+    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+  })
+
+  it('setup basic scenario', function() {
+    cy.appScenario('basic')
+    cy.visit('/')
+    cy.get('table').find('tbody').should(($tbody) => {
+      // clean should of removed these from other tests
+      expect($tbody).not.to.contain('Good bye Mars')
+      expect($tbody).not.to.contain('Hello World')
+
+      expect($tbody).to.contain('I am a Postman')
+    })
+  })
+
+  // 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')
+  // })
+})

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

@@ -25,6 +25,10 @@ Cypress.Commands.add('appEval', function (code) {
 Cypress.Commands.add('appFactories', function (options) {
   cy.app('factory_bot', options)
 });
+
+Cypress.Commands.add('appFixtures', function (options) {
+  cy.app('activerecord_fixtures', options)
+});
 // CypressDev: end
 
 // The next is optional