e2e_tests_connector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6278f234d995c75f505a708c1f8631c3ee25878fb42066d6f96d78f58b0f8d51
+  data.tar.gz: '0769662a217b16c330d26c8cb9315caa228a865eea39e2f738e65c3345ae5ddf'
+SHA512:
+  metadata.gz: daa2d87357337e775c28c80110b3276ac26df591ea0adfcf9aa7b75a495e55cbaf2bc4d3a54ec97b30e46914f816aeeed4704b13df576a66e685674647c7535b
+  data.tar.gz: 4d2be916085fdfbdd7f5babaeb2503cd92f138f20ab1a46c71f8bd9bdcec19ef51d79e8cc6d02bef654a1851677ff37e5f1138afc6ee8334ea7329f8ba580cbb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 owen2345
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# E2eTestsConnector
+
+
+## Usage
+This gem permits to connect frontend apps like react, angular, etc with backend rails apps to run end to end tests using libraries like [cypress](https://www.cypress.io/)
+
+## Backend Installation
+- Add dependency    
+    Add this line to your application's Gemfile:
+    ```ruby
+    group :test do
+      gem 'e2e_tests_connector'
+    end
+    ```
+    
+    And then execute:
+    ```bash
+    $ bundle install
+    ```
+- Mount route      
+  ```ruby
+    mount E2eTestsConnector::Engine, at: '/e2e_tests_connector'
+  ```
+
+## Frontend Installation
+- Copy [backend_connector.ts](/docs/backend_connector.ts?raw=true) into `cypress/support/backend_connector.ts` 
+- Import the connector in `cypress/support/index.js`
+  `import './backend_connector';`
+
+## Configuration
+Optionally change default configurations when using custom factories or database cleaners
+```ruby
+# config/initializers/e2e_tests_connector.rb
+return unless defined?(E2eTestsConnector)
+
+E2eTestsConnector::Config.init_custom_mocks = lambda do |_params|
+  # here custom mocks or initializers when starting e2e tests (default empty) 
+end
+
+E2eTestsConnector::Config.reset_db = lambda do |_params|
+  # here custom database cleaner (default DatabaseCleaner.clean) 
+end
+
+E2eTestsConnector::Config.run_factory = lambda do |_params|
+  # here custom factory builder (default FactoryBot) 
+end
+```
+
+## Running
+- Start test applications, like:    
+  `cd backend_app/ && RAILS_ENV=test bundle exec rails s -e test -p 3001 &`    
+  `cd frontend_app/ && PORT=3000 BROWSER=none RAILS_PORT=3001 yarn start test --silent &`    
+- Run e2e tests (hosts and ports may vary based on your test apps)    
+  `CYPRESS_BASE_URL=http://localhost:3000 CYPRESS_BACKEND_URL=http://localhost:3001 yarn cypress run`
+  
+## Samples
+- Factory command
+  ```typescript
+    // Multiple values
+    cy.factory('create_list(:article, 2)').as('articles');
+    // => [{ id: 1, title: "Sample article", created_at: "..", ... }, { id: 2, title: "Sample article", created_at: "..", ... }]
+  
+    // Provide custom data
+    cy.factory('create(:article, title: "Sample article")').as('article');
+    // => { id: 1, title: "Sample article", created_at: "..", ... }
+  
+    // Return custom data
+    cy.factory('create(:article).as_json(only: [:id, :title])').as('article');
+    // => { id: 1, title: "..." }
+  
+    // Multiple commands
+    cy.factory(['create(:article, kind: :external)', 'create(:article, kind: :internal)']).as('articles');
+    // => [{ id: 1, title: "..", kind: "external", ... }, { id: 2, title: "..", kind: "internal", ... }]
+  ```
+- Custom command
+  ```typescript
+    // Single value
+    cy.cmd('Article.find(1)').as('article');
+    // => { id: 1, title: "..", kind: "external", ... }  
+  
+    // Multiple values
+    cy.cmd('Article.where(kind: :external)').as('articles');
+    // => [{ id: 1, title: "..", kind: "external", ... }, { id: 2, title: "..", kind: "external", ... }, ...]
+  
+    // Multiple commands
+    cy.cmd(['Article.find(1)', 'Article.find(2)']).as('articles');
+    // => [{ id: 1, title: "..", kind: "external", ... }, { id: 2, title: "..", kind: "internal", ... }]
+  ```
+- Full example
+  ```typescript
+    describe('When listing articles', () => {
+      beforeEach(() => {
+        // cy.stubLoginWith();
+        cy.factory('create_list(:article, 2)').as('articles');
+      });
+      
+      it('includes all expected articles', function () {
+        cy.visit('/articles');
+        cy.get('table tbody tr').should('have.length', this.articles.length);
+      });
+     
+      describe('When filtering', () => {
+        it('returns expected article', function () {
+          const article = this.articles[0];
+          cy.visit(`/articles/filter=${article.number}`);
+          cy.get('table').contains(article.number);
+        });
+      });
+    });
+  ```  
+
+## Troubleshooting
+- `uninitialized constant E2eTestsConnector::Config::DatabaseCleaner`    
+  Require the corresponding library in `spec/spec_helper.rb`
+  ```ruby
+    require 'factory_bot_rails' # OR
+    require 'database_cleaner/active_record'
+  ```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/e2e_tests_connector/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module E2eTestsConnector
+  class ApplicationController < ActionController::API
+  end
+end

data/app/controllers/e2e_tests_connector/connector_controller.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'rspec/rails' if defined?(RSpec)
+require Rails.root.join('spec/rails_helper').to_s if defined?(RSpec)
+require 'database_cleaner/active_record' if defined?(DatabaseCleaner)
+
+module E2eTestsConnector
+  class ConnectorController < ApplicationController
+    def call
+      case params[:kind]
+      when 'reset_db'
+        run_reset_db
+      when 'factory'
+        run_factory
+      when 'init_custom_mocks'
+        init_custom_mocks
+      else
+        run_command
+      end
+    end
+
+    private
+
+    def single_command?
+      params[:commands].is_a?(String)
+    end
+
+    def run_reset_db
+      E2eTestsConnector::Config.reset_db.call(params)
+      render json: { res: nil }
+    end
+
+    def run_factory
+      res = E2eTestsConnector::Config.run_factory.call(params)
+      render json: { res: single_command? ? res.first : res }
+    end
+
+    def run_command
+      res = Array(params[:commands]).map { |cmd| eval(cmd) } # rubocop:disable Security/Eval
+      render json: { res: single_command? ? res.first : res }
+    end
+
+    def init_custom_mocks
+      E2eTestsConnector::Config.init_custom_mocks.call(params)
+      render json: { res: nil }
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+E2eTestsConnector::Engine.routes.draw do
+  match 'call', to: 'connector#call', via: %i[get post]
+end

data/lib/e2e_tests_connector.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'e2e_tests_connector/version'
+require 'e2e_tests_connector/engine'
+require 'e2e_tests_connector/config'
+
+module E2eTestsConnector
+  def self.table_name_prefix
+    ''
+  end
+end

data/lib/e2e_tests_connector/config.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module E2eTestsConnector
+  class Config
+    # By default void
+    # @return nil
+    cattr_accessor :init_custom_mocks do
+      lambda do |_params|
+      end
+    end
+
+    # By default using database cleaner
+    # @return nil
+    cattr_accessor :reset_db do
+      lambda do |_params|
+        DatabaseCleaner.strategy = :truncation
+        DatabaseCleaner.clean
+      end
+    end
+
+    # By default using factory bot
+    # @return (Array<ActiveRecord>)
+    cattr_accessor :run_factory do
+      lambda do |params|
+        Array(params[:commands]).map do |cmd|
+          FactoryBot.class_eval(cmd).as_json(params[:jsonArgs])
+        end
+      end
+    end
+  end
+end

data/lib/e2e_tests_connector/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module E2eTestsConnector
+  class Engine < ::Rails::Engine
+    isolate_namespace E2eTestsConnector
+  end
+end

data/lib/e2e_tests_connector/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module E2eTestsConnector
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: e2e_tests_connector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- owen2345
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Permits to connect frontend apps with backend apps to run e2e tests like
+  cypress
+email:
+- owenperedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/e2e_tests_connector/application_controller.rb
+- app/controllers/e2e_tests_connector/connector_controller.rb
+- config/routes.rb
+- lib/e2e_tests_connector.rb
+- lib/e2e_tests_connector/config.rb
+- lib/e2e_tests_connector/engine.rb
+- lib/e2e_tests_connector/version.rb
+homepage: https://github.com/owen2345/e2e_tests_connector
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/owen2345/e2e_tests_connector
+  source_code_uri: https://github.com/owen2345/e2e_tests_connector
+  changelog_uri: https://github.com/owen2345/e2e_tests_connector
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Permits to connect frontend apps with backend apps to run e2e tests like
+  cypress
+test_files: []