cypress-on-rails 0.2.2 → 1.0.0.beta2

data/lib/cypress_dev/middleware.rb

@@ -0,0 +1,65 @@
+require 'json'
+require 'rack'
+require 'cypress_dev/configuration'
+require 'cypress_dev/command_executor'
+
+module CypressDev
+  # Middleware to handle cypress commands and eval
+  class Middleware
+    def initialize(app, command_executor = CommandExecutor, file = ::File)
+      @app = app
+      @command_executor = command_executor
+      @file = file
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if request.path.start_with?('/__cypress__/command')
+        configuration.tagged_logged { handle_command(request) }
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def configuration
+      CypressDev.configuration
+    end
+
+    def logger
+      configuration.logger
+    end
+
+    Command = Struct.new(:name, :options, :cypress_folder) do
+      # @return [Array<Cypress::Middleware::Command>]
+      def self.from_body(body, configuration)
+        if body.is_a?(Array)
+          command_params = body
+        else
+          command_params = [body]
+        end
+        command_params.map do |params|
+          new(params.fetch('name'), params['options'], configuration.cypress_folder)
+        end
+      end
+
+      def file_path
+        "#{cypress_folder}/app_commands/#{name}.rb"
+      end
+    end
+
+    def handle_command(req)
+      body = JSON.parse(req.body.read)
+      logger.info "handle_command: #{body}"
+      commands = Command.from_body(body, configuration)
+      missing_command = commands.find {|command| !@file.exists?(command.file_path) }
+      if missing_command.nil?
+        commands.each { |command| @command_executor.load(command.file_path, command.options) }
+        [201, {}, ['success']]
+      else
+        [404, {}, ["could not find command file: #{missing_command.file_path}"]]
+      end
+    end
+  end
+end

data/lib/{cypress → cypress_dev}/railtie.rb

@@ -1,15 +1,13 @@
 require 'rails/railtie'
-module Cypress
+require 'cypress_dev/configuration'
+require 'cypress_dev/middleware'
+
+module CypressDev
   class Railtie < Rails::Railtie
     initializer :setup_cypress_middleware do |app|
-      if Cypress.run_middleware?
-        Cypress.configuration.load_support
+      if CypressDev.configuration.use_middleware?
         app.middleware.use Middleware
       end
     end
-
-    generators do
-      require_relative '../generators/install_generator'
-    end
   end
 end

data/lib/cypress_dev/simple_rails_factory.rb

@@ -0,0 +1,17 @@
+module CypressDev
+  module SimpleRailsFactory
+    def self.create(type, params = {})
+      type.camelize.constantize.create(params)
+    rescue NameError => e
+      Rails.logger.warn e.message
+    end
+
+    def self.create_list(type, amount, params = {})
+      amount.to_i.times do
+        create(type,params)
+      end
+    rescue NameError => e
+      Rails.logger.warn e.message
+    end
+  end
+end

data/lib/cypress_dev/smart_factory_wrapper.rb

@@ -0,0 +1,79 @@
+require 'cypress_dev/configuration'
+require 'cypress_dev/simple_rails_factory'
+
+module CypressDev
+  class SmartFactoryWrapper
+    module FactoryCleaner
+      def self.clean(f = FactoryBot)
+        f.factories.clear if f.respond_to?(:factories)
+        f.traits.clear if f.respond_to?(:traits)
+        f.callbacks.clear if f.respond_to?(:callbacks)
+        f.sequences.clear if f.respond_to?(:sequences)
+      end
+    end
+
+    def self.instance
+      @instance ||= new(files: [], factory: SimpleRailsFactory)
+    end
+
+    def self.configure(files:, factory:, always_reload: true)
+      @instance = new(files: files, factory: factory, always_reload: always_reload)
+    end
+
+    def self.create(*args)
+      instance.create(*args)
+    end
+
+    def self.create_list(*args)
+      instance.create_list(*args)
+    end
+
+    # @return [Array]
+    attr_accessor :files
+    attr_accessor :factory
+    attr_accessor :always_reload
+
+    def initialize(files:, factory:, always_reload: false,
+                   factory_cleaner: FactoryCleaner, kernel: Kernel, file_system: File)
+      self.files = files
+      self.factory = factory
+      self.always_reload = always_reload
+      @kernel = kernel
+      @file_system = file_system
+      @factory_cleaner = factory_cleaner
+      @latest_mtime = nil
+    end
+
+    def create(*args)
+      load_files
+      factory.create(*args)
+    end
+
+    def create_list(*args)
+      load_files
+      factory.create_list(*args)
+    end
+
+    private
+
+    def logger
+      CypressDev.configuration.logger
+    end
+
+    def load_files
+      current_latest_mtime = files.map{|file| @file_system.mtime(file) }.max
+      return unless should_reload?(current_latest_mtime)
+      logger.info 'Loading Factories'
+      @latest_mtime = current_latest_mtime
+      @factory_cleaner.clean(factory)
+      files.each do |file|
+        logger.debug "-- Loading: #{file}"
+        @kernel.load(file)
+      end
+    end
+
+    def should_reload?(current_latest_mtime)
+      @always_reload || @latest_mtime.nil? || @latest_mtime < current_latest_mtime
+    end
+  end
+end

data/lib/cypress_dev/version.rb

@@ -0,0 +1,3 @@
+module CypressDev
+  VERSION = "1.0.0.beta2"
+end

data/lib/generators/cypress_dev/install_generator.rb

@@ -0,0 +1,59 @@
+module CypressDev
+  class InstallGenerator < Rails::Generators::Base
+    class_option :cypress_folder, type: :string, default: 'spec/cypress'
+    class_option :install_cypress_with, type: :string, default: 'yarn'
+    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_with == 'yarn'
+          command = "yarn --cwd=#{install_dir} add cypress --dev --silent"
+        elsif options.install_cypress_with == 'npm'
+          command = "cd #{install_dir}; npm add cypress --save-dev --silent"
+        end
+        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
+    end
+
+    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"
+    end
+
+    def update_files
+      append_to_file "#{options.cypress_folder}/support/index.js",
+                     'import \'./on-rails\'',
+                     after: 'import \'./commands\''
+    end
+
+
+    def update_test_rb
+      if File.exist?('config/environments/test.rb')
+        gsub_file 'config/environments/test.rb',
+                  'config.cache_classes = true',
+                  'config.cache_classes = ENV[\'CI\'].present?'
+      end
+      if File.exist?('spec/dummy/config/environments/test.rb')
+        gsub_file 'spec/dummy/config/environments/test.rb',
+                  'config.cache_classes = true',
+                  'config.cache_classes = ENV[\'CI\'].present?'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+if defined?(CypressDev)
+  CypressDev.configure do |c|
+    c.cypress_folder = File.expand_path("#{__dir__}/../../<%= options.cypress_folder %>")
+    # WARNING!! CypressDev 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.test?
+    c.logger = Rails.logger
+  end
+end

data/lib/generators/cypress_dev/templates/spec/cypress.json

@@ -0,0 +1,4 @@
+{
+  "baseUrl": "http://localhost:5002",
+  "defaultCommandTimeout": 10000
+}

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

@@ -0,0 +1,7 @@
+if defined?(DatabaseCleaner)
+  # cleaning the database using database_cleaner
+  DatabaseCleaner.strategy = :truncation
+  DatabaseCleaner.clean
+else
+  logger.warn "add database_cleaner or update clean_db"
+end

data/lib/generators/cypress_dev/templates/spec/cypress/app_commands/eval.rb

@@ -0,0 +1 @@
+Kernel.eval(command_options) unless command_options.nil?

data/lib/generators/cypress_dev/templates/spec/cypress/app_commands/factory_bot.rb

@@ -0,0 +1,12 @@
+Array.wrap(command_options).each do |factory_options|
+  factory_method = factory_options.shift
+  begin
+    logger.debug "running #{factory_method}, #{factory_options}"
+    CypressDev::SmartFactoryWrapper.public_send(factory_method, *factory_options)
+  rescue => e
+    logger.error "#{e.class}: #{e.message}"
+    logger.error e.backtrace.join("\n")
+    logger.error "#{e.record.inspect}" if e.is_a?(ActiveRecord::RecordInvalid)
+    raise e
+  end
+end

data/lib/generators/cypress_dev/templates/spec/cypress/app_commands/scenarios/basic.rb

@@ -0,0 +1,2 @@
+# You can setup your Rails state here
+# MyModel.create name: 'something'

data/lib/generators/cypress_dev/templates/spec/cypress/cypress_helper.rb

@@ -0,0 +1,30 @@
+# This is loaded once before the first command is executed
+
+begin
+ require 'database_cleaner'
+rescue LoadError => e
+ puts e.message
+end
+
+begin
+  require 'factory_bot_rails'
+rescue LoadError => e
+  puts e.message
+  begin
+    require 'factory_girl_rails'
+  rescue LoadError => e
+    puts e.message
+  end
+end
+
+require 'cypress_dev/smart_factory_wrapper'
+
+factory = CypressDev::SimpleRailsFactory
+factory = FactoryBot if defined?(FactoryBot)
+factory = FactoryGirl if defined?(FactoryGirl)
+
+CypressDev::SmartFactoryWrapper.configure(
+    always_reload: !Rails.configuration.cache_classes,
+    factory: factory,
+    files: Dir['./spec/factories/**/*.rb']
+)

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

@@ -0,0 +1,33 @@
+describe('My First On Rails Tests', function() {
+  it('setup basic scenario', function() {
+    cy.appScenario('basic')
+    cy.visit('/')
+  })
+
+  it('using factory bot', function() {
+    cy.appFactories([
+      ['create_list', 'post', 10],
+      ['create', 'post', {title: 'Hello World'} ]
+    ])
+    cy.visit('/')
+  })
+
+  it('cypress eval', function() {
+    cy.appEval("Time.now")
+  })
+
+  it('runs multiple commands', function() {
+    cy.appCommands([{ name: 'clean' },
+                    { name: 'eval', options: "Time.now" }])
+    cy.visit('/')
+  })
+
+  // 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')
+  // })
+})

data/lib/generators/cypress_dev/templates/spec/cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add("login", (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This is will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

data/lib/generators/cypress_dev/templates/spec/cypress/support/index.js

@@ -0,0 +1,21 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+import './on-rails'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

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

@@ -0,0 +1,33 @@
+// CypressDev: dont remove these command
+Cypress.Commands.add('appCommands', function (body) {
+  cy.log("APP: " + JSON.stringify(body))
+  cy.request({
+    method: 'POST',
+    url: "/__cypress__/command",
+    body: JSON.stringify(body),
+    log: true,
+    failOnStatusCode: true
+  })
+});
+
+Cypress.Commands.add('app', function (name, command_options) {
+  cy.appCommands({name: name, options: command_options})
+});
+
+Cypress.Commands.add('appScenario', function (name) {
+  cy.app('scenarios/' + name)
+});
+
+Cypress.Commands.add('appEval', function (code) {
+  cy.app('eval', code)
+});
+
+Cypress.Commands.add('appFactories', function (options) {
+  cy.app('factory_bot', options)
+});
+// CypressDev: end
+
+// The next is optional
+beforeEach(() => {
+  cy.app('clean') // have a look at cypress/app_commands/clean.rb
+});