cypress-on-rails 1.11.0 → 1.13.0

data/lib/cypress_on_rails/version.rb

@@ -1,3 +1,3 @@
 module CypressOnRails
-  VERSION = '1.11.0'.freeze
+  VERSION = '1.13.0'.freeze
 end

data/lib/generators/cypress_on_rails/install_generator.rb

@@ -3,42 +3,36 @@ module CypressOnRails
     class_option :cypress_folder, type: :string, default: 'cypress'
     class_option :install_cypress, type: :boolean, default: true
     class_option :install_cypress_with, type: :string, default: 'yarn'
-    class_option :install_cypress_examples, type: :boolean, default: false
+    class_option :experimental, type: :boolean, default: false
     source_root File.expand_path('../templates', __FILE__)
 
     def install_cypress
-      if !Dir.exists?(options.cypress_folder) || Dir["#{options.cypress_folder}/*"].empty?
-        directories = options.cypress_folder.split('/')
-        directories.pop
-        install_dir = "#{Dir.pwd}/#{directories.join('/')}"
-        command = nil
-        if options.install_cypress
-          if options.install_cypress_with == 'yarn'
-            command = "yarn --cwd=#{install_dir} add cypress --dev"
-          elsif options.install_cypress_with == 'npm'
-            command = "cd #{install_dir}; npm install cypress --save-dev"
-          end
-          if command
-            say command
-            fail 'failed to install cypress' unless system(command)
-          end
+      directories = options.cypress_folder.split('/')
+      directories.pop
+      install_dir = "#{Dir.pwd}/#{directories.join('/')}"
+      command = nil
+      if options.install_cypress
+        if options.install_cypress_with == 'yarn'
+          command = "yarn --cwd=#{install_dir} add cypress --dev"
+        elsif options.install_cypress_with == 'npm'
+          command = "cd #{install_dir}; npm install cypress --save-dev"
         end
-        if options.install_cypress_examples
-          directory 'spec/cypress/integration/examples', "#{options.cypress_folder}/integration/examples"
-          directory 'spec/cypress/fixtures', "#{options.cypress_folder}/fixtures"
+        if command
+          say command
+          fail 'failed to install cypress' unless system(command)
         end
-        copy_file "spec/cypress/support/index.js", "#{options.cypress_folder}/support/index.js"
-        copy_file "spec/cypress/support/commands.js", "#{options.cypress_folder}/support/commands.js"
-        copy_file "spec/cypress.json", "#{options.cypress_folder}/../cypress.json"
       end
+      template "spec/cypress/support/index.js.erb", "#{options.cypress_folder}/support/index.js"
+      copy_file "spec/cypress/support/commands.js", "#{options.cypress_folder}/support/commands.js"
+      copy_file "spec/cypress.config.js", "#{options.cypress_folder}/../cypress.config.js"
     end
 
     def add_initial_files
       template "config/initializers/cypress_on_rails.rb.erb", "config/initializers/cypress_on_rails.rb"
-      copy_file "spec/cypress/cypress_helper.rb", "#{options.cypress_folder}/cypress_helper.rb"
+      template "spec/cypress/cypress_helper.rb.erb", "#{options.cypress_folder}/cypress_helper.rb"
       copy_file "spec/cypress/support/on-rails.js", "#{options.cypress_folder}/support/on-rails.js"
       directory 'spec/cypress/app_commands', "#{options.cypress_folder}/app_commands"
-      directory 'spec/cypress/integration/rails_examples', "#{options.cypress_folder}/integration/rails_examples"
+      directory 'spec/cypress/e2e/rails_examples', "#{options.cypress_folder}/e2e/rails_examples"
     end
 
     def update_files

data/lib/generators/cypress_on_rails/templates/config/initializers/cypress_on_rails.rb.erb

@@ -4,6 +4,7 @@ if defined?(CypressOnRails)
     # WARNING!! CypressOnRails can execute arbitrary ruby code
     # please use with extra caution if enabling on hosted servers or starting your local server on 0.0.0.0
     c.use_middleware = !Rails.env.production?
+    <% unless options.experimental %># <% end %> c.use_vcr_middleware = !Rails.env.production?
     c.logger = Rails.logger
   end
 

data/lib/generators/cypress_on_rails/templates/spec/cypress/app_commands/clean.rb

@@ -7,4 +7,12 @@ else
   Post.delete_all if defined?(Post)
 end
 
+CypressOnRails::SmartFactoryWrapper.reload
+
+if defined?(VCR)
+  VCR.eject_cassette # make sure we no cassette inserted before the next test starts
+  VCR.turn_off!
+  WebMock.disable! if defined?(WebMock)
+end
+
 Rails.logger.info "APPCLEANED" # used by log_fail.rb

data/lib/generators/cypress_on_rails/templates/spec/cypress/app_commands/log_fail.rb

@@ -3,6 +3,8 @@ filename = command_options.fetch('runnable_full_title', 'no title').gsub(/[^[:pr
 
 # 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'"
+# Alternative command if the above does not work
+# system "tail -n 10000 log/#{Rails.env}.log | tac | sed \"/APPCLEANED/ q\" | sed 'x;1!H;$!d;x' > 'log/#{filename}.log'"
 
 # create a json debug file for server debugging
 json_result = {}

data/lib/generators/cypress_on_rails/templates/spec/cypress/{cypress_helper.rb → cypress_helper.rb.erb}

@@ -29,10 +29,15 @@ factory = FactoryBot if defined?(FactoryBot)
 factory = FactoryGirl if defined?(FactoryGirl)
 
 CypressOnRails::SmartFactoryWrapper.configure(
-    always_reload: !Rails.configuration.cache_classes,
+    always_reload: false,
     factory: factory,
     files: [
       Rails.root.join('spec', 'factories.rb'),
       Rails.root.join('spec', 'factories', '**', '*.rb')
     ]
 )
+
+<% unless options.experimental %># <% end %>require 'vcr'
+<% unless options.experimental %># <% end %>VCR.configure do |config|
+<% unless options.experimental %># <% end %>  config.hook_into :webmock
+<% unless options.experimental %># <% end %>end

data/lib/generators/cypress_on_rails/templates/spec/cypress/e2e/rails_examples/using_vcr.cy.js

@@ -0,0 +1,24 @@
+describe('Rails Other examples', function() {
+  it('Inserting a cassette', function() {
+    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+
+    cy.vcr_insert_cassette('cats', { record: "new_episodes" })
+    cy.visit('/using_vcr/index')
+
+    cy.get('a').contains('Cats').click()
+    cy.contains('Record from Cats API');
+
+    cy.vcr_eject_cassette();
+  })
+
+  it('Using previous a cassette', function() {
+    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+
+    cy.vcr_insert_cassette('cats')
+    cy.visit('/using_vcr/index')
+    cy.get('a').contains('Cats').click()
+    cy.contains('Record from Cats API');
+
+    cy.vcr_eject_cassette();
+  })
+})

data/lib/generators/cypress_on_rails/templates/spec/cypress/support/{index.js → index.js.erb}

@@ -14,6 +14,7 @@
 // ***********************************************************
 
 // Import commands.js using ES2015 syntax:
+<% unless options.experimental %>// <% end %>import 'cypress-on-rails/support/index'
 import './commands'
 import './on-rails'
 

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

@@ -11,7 +11,7 @@ Cypress.Commands.add('appCommands', function (body) {
   }).then((response) => {
     log.end();
     if (response.status !== 201) {
-      expect(response.body.message).to.be.empty
+      expect(response.body.message).to.equal('')
       expect(response.status).to.be.equal(201)
     }
     return response.body

data/lib/generators/cypress_on_rails/templates/spec/cypress.config.js

@@ -0,0 +1,9 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  e2e: {
+    baseUrl: "http://localhost:5017",
+    defaultCommandTimeout: 10000,
+    supportFile: "cypress/support/index.js",
+  }
+})

data/plugin/.gitignore

@@ -0,0 +1 @@
+node_modules

data/plugin/cypress/plugins/index.js

@@ -0,0 +1,4 @@
+// export a function
+module.exports = (on, config) => {
+  // configure plugins here
+}

data/plugin/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "cypress-on-rails",
+  "version": "0.1.0",
+  "description": "Integrates cypress with rails or rack applications",
+  "main": "cypress/index.js",
+  "directories": {
+    "src": "cypress"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shakacode/cypress-on-rails.git"
+  },
+  "keywords": [
+    "cypress",
+    "ruby",
+    "rails"
+  ],
+  "author": "Grant Petersen-Speelman",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/shakacode/cypress-on-rails/issues"
+  },
+  "homepage": "https://github.com/shakacode/cypress-on-rails#readme",
+  "dependencies": {
+    "cypress": "*"
+  }
+}

data/plugin/support/index.js

@@ -0,0 +1,37 @@
+Cypress.Commands.add("vcr_insert_cassette", (cassette_name, options) => {
+  if (!options) options = {};
+
+  Object.keys(options).forEach(key => options[key] === undefined ? delete options[key] : {});
+  const log = Cypress.log({ name: "VCR Insert", message: cassette_name, autoEnd: false })
+  return cy.request({
+    method: 'POST',
+    url: "/__cypress__/vcr/insert",
+    body: JSON.stringify([cassette_name,options]),
+    log: false,
+    failOnStatusCode: false
+  }).then((response) => {
+    log.end();
+    if (response.status !== 201) {
+      expect(response.body.message).to.equal('')
+      expect(response.status).to.be.equal(201)
+    }
+    return response.body
+  });
+});
+
+Cypress.Commands.add("vcr_eject_cassette", () => {
+  const log = Cypress.log({ name: "VCR Eject", autoEnd: false })
+  return cy.request({
+    method: 'POST',
+    url: "/__cypress__/vcr/eject",
+    log: false,
+    failOnStatusCode: false
+  }).then((response) => {
+    log.end();
+    if (response.status !== 201) {
+      expect(response.body.message).to.equal('')
+      expect(response.status).to.be.equal(201)
+    }
+    return response.body
+  });
+});

data/spec/cypress_on_rails/middleware_spec.rb

@@ -17,14 +17,14 @@ RSpec.describe CypressOnRails::Middleware do
   context '/__cypress__/command' do
     before do
       allow(command_executor).to receive(:perform).and_return({ id: 1, title: 'some result' })
-      allow(file).to receive(:exists?)
+      allow(file).to receive(:exist?)
       env['PATH_INFO'] = '/__cypress__/command'
     end
 
-    it 'command file exists' do
+    it 'command file exist' do
       allow(command_executor).to receive(:perform).and_return({ id: 1, title: 'some result' })
       env['rack.input'] = rack_input(name: 'seed')
-      allow(file).to receive(:exists?).with('spec/cypress/app_commands/seed.rb').and_return(true)
+      allow(file).to receive(:exist?).with('spec/cypress/app_commands/seed.rb').and_return(true)
 
       aggregate_failures do
         expect(response).to eq([201,
@@ -34,9 +34,9 @@ RSpec.describe CypressOnRails::Middleware do
       end
     end
 
-    it 'command file exists with options' do
+    it 'command file exist with options' do
       env['rack.input'] = rack_input(name: 'seed', options: ['my_options'])
-      allow(file).to receive(:exists?).with('spec/cypress/app_commands/seed.rb').and_return(true)
+      allow(file).to receive(:exist?).with('spec/cypress/app_commands/seed.rb').and_return(true)
 
       aggregate_failures do
         expect(response).to eq([201,
@@ -46,11 +46,11 @@ RSpec.describe CypressOnRails::Middleware do
       end
     end
 
-    it 'command file does not exists' do
+    it 'command file does not exist' do
       object = BasicObject.new
       allow(command_executor).to receive(:perform).and_return(object)
       env['rack.input'] = rack_input(name: 'seed')
-      allow(file).to receive(:exists?).with('spec/cypress/app_commands/seed.rb').and_return(true)
+      allow(file).to receive(:exist?).with('spec/cypress/app_commands/seed.rb').and_return(true)
 
       aggregate_failures do
         expect(response).to eq([201,
@@ -62,7 +62,7 @@ RSpec.describe CypressOnRails::Middleware do
 
     it 'command result does not respond to to_json' do
       env['rack.input'] = rack_input(name: 'seed')
-      allow(file).to receive(:exists?).with('spec/cypress/app_commands/seed.rb').and_return(true)
+      allow(file).to receive(:exist?).with('spec/cypress/app_commands/seed.rb').and_return(true)
 
       aggregate_failures do
         expect(response).to eq([201,
@@ -75,8 +75,8 @@ RSpec.describe CypressOnRails::Middleware do
     it 'running multiple commands' do
       env['rack.input'] = rack_input([{name: 'load_user'},
                                       {name: 'load_sample', options: {'all' => 'true'}}])
-      allow(file).to receive(:exists?).with('spec/cypress/app_commands/load_user.rb').and_return(true)
-      allow(file).to receive(:exists?).with('spec/cypress/app_commands/load_sample.rb').and_return(true)
+      allow(file).to receive(:exist?).with('spec/cypress/app_commands/load_user.rb').and_return(true)
+      allow(file).to receive(:exist?).with('spec/cypress/app_commands/load_sample.rb').and_return(true)
 
       aggregate_failures do
         expect(response).to eq([201,
@@ -89,11 +89,13 @@ RSpec.describe CypressOnRails::Middleware do
 
     it 'running multiple commands but one missing' do
       env['rack.input'] = rack_input([{name: 'load_user'}, {name: 'load_sample'}])
-      allow(file).to receive(:exists?).with('spec/cypress/app_commands/load_user.rb').and_return(true)
-      allow(file).to receive(:exists?).with('spec/cypress/app_commands/load_sample.rb').and_return(false)
+      allow(file).to receive(:exist?).with('spec/cypress/app_commands/load_user.rb').and_return(true)
+      allow(file).to receive(:exist?).with('spec/cypress/app_commands/load_sample.rb').and_return(false)
 
       aggregate_failures do
-        expect(response).to eq([404, {}, ['could not find command file: spec/cypress/app_commands/load_sample.rb']])
+        expect(response).to eq([404, 
+                                {"Content-Type"=>"application/json"}, 
+                                ["{\"message\":\"could not find command file: spec/cypress/app_commands/load_sample.rb\"}"]])
         expect(command_executor).to_not have_received(:perform)
       end
     end

data/spec/cypress_on_rails/smart_factory_wrapper_spec.rb

@@ -140,6 +140,13 @@ RSpec.describe CypressOnRails::SmartFactoryWrapper do
     expect(kernel_double).to have_received(:load).with('file2.rb').twice
   end
 
+  it 'can manually reload' do
+    subject.reload
+    expect(factory_double).to have_received(:reload)
+    expect(kernel_double).to have_received(:load).with('file1.rb')
+    expect(kernel_double).to have_received(:load).with('file2.rb')
+  end
+
   context 'files is a string' do
     let(:files) { 'file*.rb' }
 

data/spec/cypress_on_rails/vcr_middleware_spec.rb

@@ -0,0 +1,119 @@
+require 'cypress_on_rails/vcr_middleware'
+require 'vcr'
+require 'active_support/core_ext/hash' unless Hash.new.respond_to?(:symbolize_keys)
+
+module CypressOnRails
+  RSpec.describe VCRMiddleware do
+    let(:app) { ->(env) { [200, {}, ["app did #{env['PATH_INFO']}"]] } }
+    let(:vcr) { class_double(VCR, turn_on!: true, turn_off!: true, insert_cassette: true, eject_cassette: true) }
+    subject { described_class.new(app, vcr) }
+
+    let(:env) { {} }
+
+    let(:response) { subject.call(env) }
+
+    def rack_input(json_value)
+      StringIO.new(JSON.generate(json_value))
+    end
+
+    describe '/__cypress__/vcr/insert' do
+      before do
+        env['PATH_INFO'] = '/__cypress__/vcr/insert'
+      end
+
+      it do
+        env['rack.input'] = rack_input(['cas1'])
+
+        aggregate_failures do
+          expect(response).to eq([201,
+                                  {"Content-Type"=>"application/json"},
+                                  ["{\"message\":\"OK\"}"]])
+          expect(vcr).to have_received(:turn_on!)
+          expect(vcr).to have_received(:insert_cassette).with('cas1', {})
+        end
+      end
+
+      it 'works with record' do
+        env['rack.input'] = rack_input(['cas1', { "record" => "new_episodes" }])
+
+        aggregate_failures do
+          expect(response).to eq([201,
+                                  {"Content-Type"=>"application/json"},
+                                  ["{\"message\":\"OK\"}"]])
+          expect(vcr).to have_received(:insert_cassette).with('cas1', record: :new_episodes)
+        end
+      end
+
+      it 'works with match_requests_on' do
+        env['rack.input'] = rack_input(['cas1', { "match_requests_on" => ["method", "uri"] }])
+
+        aggregate_failures do
+          expect(response).to eq([201,
+                                  {"Content-Type"=>"application/json"},
+                                  ["{\"message\":\"OK\"}"]])
+          expect(vcr).to have_received(:insert_cassette).with('cas1', match_requests_on: [:method, :uri])
+        end
+      end
+
+      it 'works with serialize_with' do
+        env['rack.input'] = rack_input(['cas1', { "serialize_with" => "yaml" }])
+
+        aggregate_failures do
+          expect(response).to eq([201,
+                                  {"Content-Type"=>"application/json"},
+                                  ["{\"message\":\"OK\"}"]])
+          expect(vcr).to have_received(:insert_cassette).with('cas1', serialize_with: :yaml)
+        end
+      end
+
+      it 'works with persist_with' do
+        env['rack.input'] = rack_input(['cas1', { "persist_with" => "file_system" }])
+
+        aggregate_failures do
+          expect(response).to eq([201,
+                                  {"Content-Type"=>"application/json"},
+                                  ["{\"message\":\"OK\"}"]])
+          expect(vcr).to have_received(:insert_cassette).with('cas1', persist_with: :file_system)
+        end
+      end
+    end
+
+    describe '/__cypress__/vcr/eject' do
+      before do
+        env['PATH_INFO'] = '/__cypress__/vcr/eject'
+      end
+
+      it do
+        aggregate_failures do
+          expect(response).to eq([201,
+                                  {"Content-Type"=>"application/json"},
+                                  ["{\"message\":\"OK\"}"]])
+          expect(vcr).to have_received(:turn_off!)
+          expect(vcr).to have_received(:eject_cassette)
+        end
+      end
+    end
+
+    describe '"Other paths"' do
+      it 'calls vcr turn off the first time' do
+        env['PATH_INFO'] = '/test'
+
+        expect(response).to eq([200, {}, ["app did /test"]])
+        expect(vcr).to have_received(:turn_off!)
+      end
+
+      it 'runs app' do
+        aggregate_failures do
+          %w(/ /__cypress__/login command /cypress_command /).each do |path|
+            env['PATH_INFO'] = path
+
+            response = subject.call(env)
+
+            expect(response).to eq([200, {}, ["app did #{path}"]])
+            expect(vcr).to have_received(:turn_off!)
+          end
+        end
+      end
+    end
+  end
+end

data/specs_e2e/cypress.config.js

@@ -0,0 +1,10 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  projectId: "2b6cjr",
+  e2e: {
+    baseUrl: "http://localhost:5017",
+    defaultCommandTimeout: 10000,
+    supportFile: "cypress/support/index.js"
+  }
+})

data/{spec/integrations → specs_e2e}/rails_3_2/.gitignore

@@ -1,6 +1,6 @@
 .bundle
 node_modules
-cypress.json
+cypress.config.js
 package-lock.json
 cypress/
 config/initializers/cypress_on_rails.rb

data/specs_e2e/rails_3_2/.ruby_version

@@ -0,0 +1 @@
+2.3.8

data/{spec/integrations → specs_e2e}/rails_3_2/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 gem 'rails', '~> 3.2.22'
 
 group :development, :test do
-  gem 'cypress-on-rails', path: '../../../'
+  gem 'cypress-on-rails', path: '../../'
 end

data/{spec/integrations → specs_e2e}/rails_3_2/test.sh

@@ -4,9 +4,9 @@ set -eo pipefail
 echo '--- testing rails 3.2'
 
 echo '-- setting environment'
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-RAILS_ENV=test
-BUNDLE_GEMFILE="$DIR/Gemfile"
+export DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+export RAILS_ENV=test
+export BUNDLE_GEMFILE="$DIR/Gemfile"
 cd $DIR
 
 echo '-- bundle install'
@@ -15,7 +15,8 @@ bundle install --quiet --gemfile="$DIR/Gemfile" --retry 2 --path vendor/bundle
 
 echo '-- cypress install'
 bundle exec ./bin/rails g cypress_on_rails:install --install_cypress_with=npm
-rm -vf cypress/integration/rails_examples/advance_factory_bot_spec.js
+rm -vf cypress/e2e/rails_examples/advance_factory_bot.cy.js
+rm -vf cypress/e2e/rails_examples/using_vcr.cy.js
 
 echo '-- start rails server'
 # make sure the server is not running
@@ -25,13 +26,13 @@ bundle exec ./bin/rails server -p 5017 -e test &
 sleep 2 # give rails a chance to start up correctly
 
 echo '-- cypress run'
-cp -fv ../cypress.json .
-if [ -z $CYPRESS_RECORD_KEY ]
-then
-    node_modules/.bin/cypress run
-else
+cp -fv ../cypress.config.js .
+# if [ -z $CYPRESS_RECORD_KEY ]
+# then
+#     node_modules/.bin/cypress run
+# else
     node_modules/.bin/cypress run --record
-fi
+# fi
 
 echo '-- stop rails server'
 kill -9 `cat tmp/pids/server.pid`