How to run Cypress and Playwright side-to-side on a migration scenario

[wagnerpereira]

I'm setting up Playwright to run in parallel to cypress on our pipeline during migration from cypress to playwright.

What could be the best approach to cypress-on-rails to support this scenário of migration beetween the two ?

install_folder need to change in each context.

Cypress

    c.install_folder = File.expand_path("#{__dir__}/../../spec/cypress")

Playwright

    c.install_folder = File.expand_path("#{__dir__}/../../spec/playwright")

Gem initializer should be agnostic?

# config/initializers/cypress_on_rails.rb
if defined?(CypressOnRails)
  CypressOnRails.configure do |c|
    c.api_prefix = ""
    c.install_folder = File.expand_path("#{__dir__}/../../spec/cypress")
    # 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?
    #  c.use_vcr_middleware = !Rails.env.production?
    c.logger = Rails.logger

    # If you want to enable a before_request logic, such as authentication, logging, sending metrics, etc.
    #   Refer to https://www.rubydoc.info/gems/rack/Rack/Request for the `request` argument.
    #   Return nil to continue through the Cypress command. Return a response [status, header, body] to halt.
    # c.before_request = lambda { |request|
    #   unless request.env['warden'].authenticate(:secret_key)
    #     return [403, {}, ["forbidden"]]
    #   end
    # }
  end

  # # if you compile your asssets on CI
  # if ENV['CYPRESS'].present? && ENV['CI'].present?
  #  Rails.application.configure do
  #    config.assets.compile = false
  #    config.assets.unknown_asset_fallback = false
  #  end
  # end
end

[wagnerpereira]

@grantspeelman @shakacode

Thanks on creating this discussion!

We opt to create a env var to select the e2e framework on execution time on pipeline. Like this:

if defined?(CypressOnRails)
  CypressOnRails.configure do |c|
    c.api_prefix = ""
    c.install_folder = File.expand_path("#{__dir__}/../../spec/#{ENV["FRAMEWORK_E2E"]}")
    # WARNING!! CypressOnRails can execute arbitrary ruby code
    # please use with extra caution if enabling on hosted servers or starting your lo

Then we pass this ENV var on each github actions workflow job, cypress and playwright:

      FRAMEWORK_E2E: cypress
      FRAMEWORK_E2E: playwright

...
      - name: Run http server with the app in the background
        env:
          PGUSER: postgres
          PGHOST: localhost
          REDIS_URL: redis://localhost:6379/0
          RAILS_ENV: test
          COVERAGE: true
          FRAMEWORK_E2E: playwright
        run: |
          nohup bundle exec rails server -b 0.0.0.0 -p 3000 &
          echo $! > rails_server.pid
...

Thanks again!