cypress-on-rails 1.10.1 → 1.15.1

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 '/__e2e__/vcr/insert' do
+      before do
+        env['PATH_INFO'] = '/__e2e__/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 '/__e2e__/vcr/eject' do
+      before do
+        env['PATH_INFO'] = '/__e2e__/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(/ /__e2e__/login command /e2e_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/specs_e2e/playwright.config.js

@@ -0,0 +1,79 @@
+// @ts-check
+const { defineConfig, devices } = require('@playwright/test');
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * @see https://playwright.dev/docs/test-configuration
+ */
+module.exports = defineConfig({
+  testDir: './playwright/e2e',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL: 'http://127.0.0.1:5017',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    {
+      name: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ..devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});
+

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'
@@ -14,8 +14,9 @@ bundle --version
 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
+bundle exec ./bin/rails g cypress_on_rails:install --install_cypress --install_playwright --install_with=npm
+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,18 @@ 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 '-- playwright run'
+cp -fv ../playwright.config.js .
+npx playwright install-deps
+npx playwright test playwright/e2e/
 
 echo '-- stop rails server'
 kill -9 `cat tmp/pids/server.pid`

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

@@ -1,10 +1,11 @@
 .bundle
 spec/node_modules
-spec/cypress.json
+spec/cypress.config.js
 spec/package.json
 spec/yarn.lock
 spec/cypress
 config/initializers/cypress_on_rails.rb
 vendor/bundle
 tmp/pids
-tmp/cache
+tmp/cache
+log/*.*

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

@@ -5,5 +5,7 @@ gem 'rails', '~> 4.2.10'
 gem 'sprockets', '~> 3.7.2'
 
 group :development, :test do
-  gem 'cypress-on-rails', path: '../../../'
+  gem 'vcr'
+  gem 'webmock'
+  gem 'cypress-on-rails', path: '../../'
 end

data/specs_e2e/rails_4_2/app/controllers/using_vcr_controller.rb

@@ -0,0 +1,10 @@
+class UsingVcrController < ApplicationController
+  def index
+  end
+
+  def record_cats
+    uri = URI('https://cat-fact.herokuapp.com/facts')
+    res = Net::HTTP.get_response(uri)
+    @cat_facts = JSON.parse(res.body)
+  end
+end

data/{spec/integrations → specs_e2e}/rails_4_2/app/models/post.rb

@@ -7,7 +7,9 @@ class Post < OpenStruct
     @all ||= []
     post = new(attributes)
     @all << post
-    attributes['all'] = @all.index(post)
+    post.id = @all.index(post)
+    attributes['id'] = @all.index(post)
+    attributes
   end
 
   def self.all

data/specs_e2e/rails_4_2/app/views/using_vcr/index.html.erb

@@ -0,0 +1,6 @@
+<h1>Using VCR</h1>
+<pre>
+  <%= JSON.pretty_generate VCR.configuration.as_json['default_cassette_options'] %>
+</pre>
+
+<%= link_to 'Record Cats', { action: :record_cats } %>

data/specs_e2e/rails_4_2/app/views/using_vcr/record_cats.html.erb

@@ -0,0 +1,7 @@
+<h1>Record from Cats API</h1>
+
+<ul>
+  <% @cat_facts.each do |fact| %>
+    <li><%= fact['text'] %></li>
+  <% end %>
+<ul>

data/{spec/integrations → specs_e2e}/rails_4_2/config/routes.rb

@@ -1,10 +1,15 @@
 Rails.application.routes.draw do
+  get 'using_vcr/index'
+
   # The priority is based upon order of creation: first created -> highest priority.
   # See how all your routes lay out with "rake routes".
 
   # You can have the root of your site routed with "root"
   root 'welcome#index'
 
+  get 'using_vcr/:action', to: 'using_vcr#:action'
+
+
   # Example of regular route:
   #   get 'products/:id' => 'catalog#view'
 

data/specs_e2e/rails_4_2/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "rails_4_2",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "devDependencies": {
+    "cypress": "^10.0.2",
+    "cypress-on-rails": "file:../../plugin"
+  }
+}

data/specs_e2e/rails_4_2/test.sh

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+set -eo pipefail
+
+echo '--- testing rails 4.2'
+
+echo '-- setting environment'
+export DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+export RAILS_ENV=test
+export BUNDLE_GEMFILE="$DIR/Gemfile"
+cd $DIR
+
+echo '-- bundle install'
+gem install bundler -v "~> 1.0" --conservative
+bundle --version
+bundle install --quiet --gemfile="$DIR/Gemfile" --retry 2 --path vendor/bundle
+
+echo '-- cypress and playwright install'
+bundle exec ./bin/rails g cypress_on_rails:install --install_folder=spec/e2e --cypress_folder=spec/cypress --playwright_folder=spec/playwright --install_cypress --install_playwright --experimental --install_with=npm --skip
+rm -vf spec/cypress/e2e/rails_examples/advance_factory_bot.cy.js
+
+echo '-- start rails server'
+# make sure the server is not running
+(kill -9 `cat tmp/pids/server.pid` || true )
+
+bundle exec ./bin/rails server -p 5017 -e test &
+sleep 5 # give rails a chance to start up correctly
+
+echo '-- cypress run'
+cp -fv ../cypress.config.js spec/
+# if [ -z $CYPRESS_RECORD_KEY ]
+# then
+#     npx cypress run -P ./spec
+# else
+    npx cypress run -P ./spec --record
+# fi
+
+echo '-- playwright run'
+cp -fv ../playwright.config.js spec/
+cd spec
+npx playwright install-deps
+npx playwright test spec/playwright/e2e/
+
+echo '-- stop rails server'
+kill -9 `cat tmp/pids/server.pid` || true

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

@@ -1,6 +1,6 @@
 .bundle
 test/node_modules
-test/cypress.json
+test/cypress.config.js
 test/package.json
 test/yarn.lock
 test/cypress/

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

@@ -11,5 +11,5 @@ gem 'bootsnap', '>= 1.1.0', require: false
 
 group :development, :test do
   gem 'database_cleaner'
-  gem 'cypress-on-rails', path: '../../../'
+  gem 'cypress-on-rails', path: '../../'
 end

data/specs_e2e/rails_5_2/app/assets/javascripts/posts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/specs_e2e/rails_5_2/app/assets/stylesheets/posts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/specs_e2e/rails_5_2/test.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+set -eo pipefail
+
+echo '--- testing rails 5.2'
+
+echo '-- setting environment'
+export DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+export RAILS_ENV=test
+export BUNDLE_GEMFILE="$DIR/Gemfile"
+cd $DIR
+
+echo '-- bundle install'
+bundle --version
+bundle config set --local path 'vendor/bundle'
+bundle install --quiet --gemfile="$DIR/Gemfile" --retry 2
+
+echo '-- migration'
+bundle exec ./bin/rails db:drop || true
+bundle exec ./bin/rails db:create db:migrate
+
+echo '-- cypress and playwright install'
+bundle exec ./bin/rails g cypress_on_rails:install --install_folder=test/e2e --cypress_folder=test/cypress --playwright_folder=test/playwright --install_cypress --install_playwright --install_with=npm --skip
+rm -vf test/cypress/e2e/rails_examples/using_vcr.cy.js
+
+echo '-- start rails server'
+# make sure the server is not running
+(kill -9 `cat tmp/pids/server.pid` || true )
+
+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.config.js test/
+cd test
+# if [ -z $CYPRESS_RECORD_KEY ]
+# then
+#     npx cypress run
+# else
+    npx cypress run --record
+# fi
+
+echo '-- playwright run'
+cp -fv ../../playwright.config.js .
+npx playwright install-deps
+npx playwright test test/playwright/e2e/
+
+echo '-- stop rails server'
+kill -9 `cat ../tmp/pids/server.pid` || true