integration_test_kit 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8f6dfe01264de37be1a2d7b2db367498c096cf8cf3a29df7526f9f39444a8fb
+  data.tar.gz: 553cb776a3acb7458d3bf62eec914c89dacda32a6cca1c99fe0349a2ec155dc6
+SHA512:
+  metadata.gz: 9fa65d6de8fbedcc037c15e6ff63c9783077d5a8098656b93e2c9774440c83ca96be37d5ab86c4219db7c6cc42e02e05af8a9c3214dd6475334ba812447a5374
+  data.tar.gz: 408bc472d8fa202c9b1df307caa7f6c47d3f6db231fa8dd9a1176e3e827c1e07018097e6a3305ccbc59dc434cf7b24b8c512ca85c4ee3390ee8855585b708537

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 OfferZen
+
+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,101 @@
+# Integration Test Kit
+
+[![HitCount](http://hits.dwyl.io/Offerzen/integration_test_kit.svg)](http://hits.dwyl.io/Offerzen/integration_test_kit)
+
+Integration Test Kit provides a small DSL for defining integration test commands, and an endpoint for calling them locally.
+
+The initial use case was for running integration test commands for specific testing scenarios in [Cypress](https://www.cypress.io), such as cleaning the test database or creating seed data.
+
+Integration Test Kit is inspired by the functionality of [Cypress On Rails](https://github.com/shakacode/cypress-on-rails).
+
+## Usage
+You'll need to define commands within a directory of your choosing. Commands are set up using a simple DSL:
+```ruby
+IntegrationTestKit.define do
+  command :example do
+    puts 'Ruby code can be run here'
+  end
+end
+```
+
+You can then run commands with a POST to `/<name_of_mount_path>/commands?name=<name_of_command>`, or with `"name": "example"` in the body as JSON.
+
+If you're using Cypress, you can add a command to your `support/commands.js` file to make this easier:
+```js
+Cypress.Commands.add('appCommand', command => {
+  cy.request({
+    method: 'POST',
+    url: `/<name_of_mount_path>/commands`,
+    body: {
+      name: command
+    }
+  })
+})
+```
+
+## Installation
+### Things to note
+* Integration Test Kit is meant for usage within the test environment only. Don't include it or configure it in production.
+* There is a check to ensure that the gem is only configured for the test environment during configuration and when running commands.
+* The gem is a Rails Engine, and is meant for usage within a Rails application.
+
+Add this line to your application's Gemfile in the test group:
+
+```ruby
+group :test do
+  gem 'integration_test_kit'
+end
+```
+
+And then run:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install integration_test_kit
+```
+
+Configure Integration Test Kit in an initializer, or in `config/environments/test.rb`. Currently, the only configuration option is the commands load path:
+```ruby
+  IntegrationTestKit.configure do |config|
+    config.commands_load_path = 'spec/cypress/commands'
+  end
+```
+
+Create commands within a Ruby file inside the commands load path directory (eg. `test.rb`).
+
+```ruby
+require 'integration_test_kit'
+
+IntegrationTestKit.define do
+  command :example do
+    puts 'Ruby code can be run here'
+  end
+
+  command :another_example do
+    puts 'Ruby code can be run here'
+  end
+end
+```
+
+Mount the routes within your application (`routes.rb` or equivalent):
+```ruby
+if Rails.env.test?
+  mount IntegrationTestKit::Engine => '/integration_test_kit'
+end
+```
+
+You are now able to run commands with a POST to `/integration_test_kit/commands/name=example`, or with `"name": "example"` in the body as JSON.
+
+## Contributing
+Feel free to create an issue or submit a PR.
+
+## Release
+
+1. [Bump the version](https://semver.org/)
+2. Follow the standard [ruby gems release guide](https://bundler.io/v2.0/guides/creating_gem.html#releasing-the-gem)
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IntegrationTestKit'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/integration_test_kit_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/integration_test_kit .js
+//= link_directory ../stylesheets/integration_test_kit .css

data/app/assets/javascripts/integration_test_kit/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/integration_test_kit/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/integration_test_kit/application_controller.rb

@@ -0,0 +1,5 @@
+module IntegrationTestKit
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/integration_test_kit/commands_controller.rb

@@ -0,0 +1,9 @@
+module IntegrationTestKit
+  class CommandsController < ApplicationController
+    def create
+      IntegrationTestKit.run_command(params[:name])
+      
+      head :ok
+    end
+  end
+end

data/app/helpers/integration_test_kit/application_helper.rb

@@ -0,0 +1,4 @@
+module IntegrationTestKit
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/integration_test_kit/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Integration test kit</title>
+  <%= stylesheet_link_tag    "integration_test_kit/application", media: "all" %>
+  <%= javascript_include_tag "integration_test_kit/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+IntegrationTestKit::Engine.routes.draw do
+  resources :commands, only: :create
+end

data/lib/integration_test_kit.rb

@@ -0,0 +1,39 @@
+require 'integration_test_kit/engine'
+require 'integration_test_kit/configuration'
+require 'integration_test_kit/registry'
+require 'integration_test_kit/errors'
+
+module IntegrationTestKit
+  @commands = {}
+
+  def self.commands
+    @commands
+  end
+  
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  
+  def self.configure
+    raise EnvironmentError unless Rails.env.test?
+    
+    yield configuration
+    
+    Dir[Rails.root.join(configuration.commands_load_path, '*.rb')].each do |file|
+      require File.expand_path(file)
+    end
+  end
+
+  def self.run_command(name)
+    raise EnvironmentError unless Rails.env.test?
+    
+    @commands[name.to_sym].call
+
+    true
+  end
+
+  def self.define(&block)
+    registry = Registry.new
+    registry.instance_eval(&block)
+  end
+end

data/lib/integration_test_kit/configuration.rb

@@ -0,0 +1,5 @@
+module IntegrationTestKit  
+  class Configuration
+    attr_accessor :commands_load_path
+  end
+end

data/lib/integration_test_kit/engine.rb

@@ -0,0 +1,5 @@
+module IntegrationTestKit
+  class Engine < ::Rails::Engine
+    isolate_namespace IntegrationTestKit
+  end
+end

data/lib/integration_test_kit/errors.rb

@@ -0,0 +1,7 @@
+module IntegrationTestKit
+  class EnvironmentError < ::StandardError
+    def initialize(msg='Rails environment must be "test"')
+      super
+    end
+  end
+end

data/lib/integration_test_kit/registry.rb

@@ -0,0 +1,9 @@
+require 'integration_test_kit'
+
+module IntegrationTestKit
+  class Registry
+    def command(name, &block)
+      IntegrationTestKit.commands[name.to_sym] = block
+    end
+  end
+end

data/lib/integration_test_kit/version.rb

@@ -0,0 +1,3 @@
+module IntegrationTestKit
+  VERSION = '0.1.2'
+end

data/lib/tasks/integration_test_kit_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :integration_test_kit do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: integration_test_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Ethan Marrs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integration Test Kit provides a small DSL for defining integration test
+  commands, and an endpoint for calling them locally.
+email:
+- ethan@offerzen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/integration_test_kit_manifest.js
+- app/assets/javascripts/integration_test_kit/application.js
+- app/assets/stylesheets/integration_test_kit/application.css
+- app/controllers/integration_test_kit/application_controller.rb
+- app/controllers/integration_test_kit/commands_controller.rb
+- app/helpers/integration_test_kit/application_helper.rb
+- app/views/layouts/integration_test_kit/application.html.erb
+- config/routes.rb
+- lib/integration_test_kit.rb
+- lib/integration_test_kit/configuration.rb
+- lib/integration_test_kit/engine.rb
+- lib/integration_test_kit/errors.rb
+- lib/integration_test_kit/registry.rb
+- lib/integration_test_kit/version.rb
+- lib/tasks/integration_test_kit_tasks.rake
+homepage: https://github.com/Offerzen/integration_test_kit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A small DSL for defining and calling integration test commands.
+test_files: []