cypress_rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0960d9a791f200510066c77fe170e1df621d7e60'
-  data.tar.gz: e5a7cbba16e63adf40b52ab0921dc2785e78bf9f
+  metadata.gz: 80aae4380a1af0433ae1b914dbcbc6ee37263132
+  data.tar.gz: b564ccbc5a13d27a1f37dafab087c9147b7d5aea
 SHA512:
-  metadata.gz: 69c7165251fd91bdb505a5762463e8d4699b8ee9497ce2e73595bc9b17fc848cc93a50d6446027bfbc3203b48bb4e20036ab7757ee2e936393fc137cca0ef867
-  data.tar.gz: b571aa52a32bc6f710798058c26a736502080d0a10ab71a0dbeb8d5b360a09806c15567b5be707f1cc2a93cf106c707272d50841007f518c96aa23341a056cd6
+  metadata.gz: 1340b659aab5c49c6958dbdefc3a02986987e0ca03ddd9c98ca78f13507be7513d9ce76d4a8cce7e3e9eb338dafb2c582f0cbc62ad9a3ef0694a3f433c68b417
+  data.tar.gz: e58a245a1965c6a022c7bbb82a8e200755a1f5114c270d7ee588368e6fb676282c212d74b4e5d0afe2d079eac38d60968ce11d3258100b693f96467570032307

data/.circleci/config.yml

@@ -0,0 +1,62 @@
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2-node
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run: sudo apt-get update
+      - run: sudo apt-get install xvfb libgtk2.0-0 libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "cypress_rails.gemspec" }}
+          - v1-dependencies-
+      - restore_cache:
+          keys:
+          - v1-passing-node-modules-{{ checksum "./spec/support/dummy_passing/yarn.lock" }}
+          - v1-passing-node-modules-
+      - restore_cache:
+          keys:
+          - v1-failing-node-modules-{{ checksum "./spec/support/dummy_failing/yarn.lock" }}
+          - v1-failing-node-modules-
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - run:
+          name: Install passing node dependencies
+          command: |
+            cd spec/support/dummy_passing && yarn install && npx cypress install && cd -
+      - run:
+          name: Install failing node dependencies
+          command: |
+            cd spec/support/dummy_failing && yarn install && npx cypress install && cd -
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+      - save_cache:
+          paths:
+            - ./spec/support/dummy_passing/node_modules
+          key: v1-passing-node-dependencies-{{ checksum "./spec/support/dummy_passing/yarn.lock" }}
+      - save_cache:
+          paths:
+            - ./spec/support/dummy_failing/node_modules
+          key: v1-failing-node-dependencies-{{ checksum "./spec/support/dummy_failing/yarn.lock" }}
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -3,3 +3,6 @@
 /html/
 /pkg/
 /vendor/cache/*.gem
+**/node_modules/
+**/cypress/videos/
+**/cypress/screenshots/

data/README.md

@@ -4,7 +4,7 @@
 * [Documentation](http://rubydoc.info/gems/cypress_rails/frames)
 * [Email](mailto:szymon@szeliga.co)
 
-[![Build Status](https://secure.travis-ci.org/Szeliga/cypress_rails.svg?branch=master)](https://travis-ci.org/Szeliga/cypress_rails)
+[![CircleCI](https://circleci.com/gh/Szeliga/cypress_rails/tree/master.svg?style=svg)](https://circleci.com/gh/Szeliga/cypress_rails/tree/master)
 [![Code Climate GPA](https://codeclimate.com/github/Szeliga/cypress_rails/badges/gpa.svg)](https://codeclimate.com/github/Szeliga/cypress_rails)
 
 ## Description

data/bin/cypress-rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "cypress_rails/cli"
+
+CypressRails::CLI.start(ARGV)

data/cypress_rails.gemspec

@@ -29,13 +29,15 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_dependency "thor", "~> 0.20.0"
   gem.add_development_dependency "bundler", "~> 1.10"
   gem.add_development_dependency "codeclimate-test-reporter", "~> 0.1"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "rack"
+  gem.add_development_dependency "pry", "~> 0.11.3"
+  gem.add_development_dependency "rack", "~> 2.0.5"
   gem.add_development_dependency "rake", "~> 10.0"
   gem.add_development_dependency "rdoc", "~> 4.0"
   gem.add_development_dependency "rspec", "~> 3.0"
-  gem.add_development_dependency "rubocop"
+  gem.add_development_dependency "rubocop", "~> 0.55.0"
   gem.add_development_dependency "rubygems-tasks", "~> 0.2"
+  gem.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
 end

data/lib/cypress_rails/cli.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "thor"
+require "cypress_rails/runner"
+require "cypress_rails/server"
+
+module CypressRails
+  Config = Struct.new(:command, :cypress_command, :host, :log_path, :test_path)
+
+  class CLI < Thor
+    class_option :command,
+      required: true,
+      type: :string,
+      desc: "command to start the server",
+      aliases: %w(-c)
+    class_option :cypress_command,
+      type: :string,
+      desc: "command to run cypress",
+      default: "npx cypress",
+      aliases: %w(-cc)
+    class_option :host,
+      type: :string,
+      desc: "host on which to start the local server",
+      default: "localhost",
+      aliases: %w(-h)
+    class_option :log_path,
+      type: :string,
+      desc: "path to the log file for the server",
+      default: "/dev/null",
+      aliases: %w(-l)
+    class_option :test_path,
+      type: :string,
+      desc: "path to Cypress tests",
+      default: "./spec/cypress",
+      aliases: %w(-t)
+
+    desc "test", "Run all tests in headless mode"
+    def test
+      server.start do |host, port|
+        exit Runner.new(host: host, port: port, command: config.cypress_command).run
+      end
+    end
+
+    desc "open", "Start the server and open Cypress Dashboard"
+    def open
+      puts options
+    end
+
+    private
+
+    def server
+      @server ||= Server.new(config.host, config.command, config.log_path)
+    end
+
+    def config
+      @config ||= Config.new(
+        *options.values_at(:command, :cypress_command, :host, :log_path, :test_path)
+      )
+    end
+  end
+end

data/lib/cypress_rails/runner.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CypressRails
+  class Runner
+    def initialize(host:, port:, command: "npx cypress", output: IO.new(1))
+      @host = host
+      @port = port
+      @command = command
+      @output = output
+    end
+
+    def run
+      pid = Process.spawn(
+        {
+          "CYPRESS_app_host" => host,
+          "CYPRESS_app_port" => port.to_s,
+        },
+        command,
+        out: output,
+        err: [:child, :out]
+      )
+      output.close
+      _, status = Process.wait2(pid)
+      status.exitstatus
+    end
+
+    private
+
+    attr_reader :host, :port, :command, :output
+  end
+end

data/lib/cypress_rails/server.rb

@@ -6,11 +6,13 @@ module CypressRails
   class Server
     extend Forwardable
 
-    attr_reader :host, :port
+    attr_reader :host, :port, :command, :log_path
 
-    def initialize(host)
+    def initialize(host, command, log_path)
       @host = host
       @port = find_free_port
+      @command = command
+      @log_path = log_path
     end
 
     def start
@@ -18,7 +20,8 @@ module CypressRails
       until server_responsive?
         sleep 0.1
       end
-      yield if block_given?
+      yield(host, port) if block_given?
+    ensure
       stop_server
     end
 
@@ -26,10 +29,6 @@ module CypressRails
 
     attr_reader :pid
 
-    def_delegators :configuration,
-      :server_command,
-      :log_path
-
     def spawn_server
       @pid = Process.spawn(
         build_command,
@@ -48,13 +47,11 @@ module CypressRails
     end
 
     def stop_server
-      Process.kill("SIGINT", pid)
+      Process.kill("SIGINT", pid) if pid
     end
 
     def build_command
-      command = [server_command]
-      command << "--port #{port}"
-      command.join(" ")
+      "#{command} --port #{port}"
     end
 
     def find_free_port
@@ -63,9 +60,5 @@ module CypressRails
     ensure
       server.close if server
     end
-
-    def configuration
-      CypressRails.configuration
-    end
   end
 end

data/lib/cypress_rails/version.rb

@@ -2,5 +2,5 @@
 
 module CypressRails
   # cypress_rails version
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/cypress_rails.rb

@@ -1,25 +1,3 @@
 # frozen_string_literal: true
-
-require "singleton"
+#
 require "cypress_rails/version"
-
-module CypressRails
-  def self.configure
-    yield(configuration)
-  end
-
-  def self.configuration
-    Configuration.instance
-  end
-
-  class Configuration
-    include Singleton
-
-    attr_accessor :server_command, :log_path
-
-    def initialize
-      @server_command = ""
-      @log_path = "/dev/null"
-    end
-  end
-end

data/spec/cypress_rails/runner_spec.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "cypress_rails/server"
+require "cypress_rails/runner"
+
+RSpec.describe CypressRails::Runner do
+  let(:host) { "localhost" }
+  let(:log_path) { "/dev/null" }
+  let(:pipe) { IO.pipe }
+  let(:w) { pipe[1] }
+  let(:r) { pipe[0] }
+
+  context "when tests are passing" do
+    let(:command) { "rackup spec/support/dummy_passing/config.ru" }
+
+    it "runs cypress correctly" do
+      CypressRails::Server.new(host, command, log_path).start do |host, port|
+        CypressRails::Runner.new(
+          host: host,
+          port: port,
+          command: "cd spec/support/dummy_passing && npx cypress run",
+          output: w
+        ).run
+      end
+      result = r.read
+      expect(result).to match(/Visiting the root address/)
+      expect(result).to match(/renders OK/)
+      expect(result).to match(/\(Tests Finished\)/)
+      r.close
+    end
+
+    it "returns status code 0" do
+      status = nil
+      CypressRails::Server.new(host, command, log_path).start do |host, port|
+        status = CypressRails::Runner.new(
+          host: host,
+          port: port,
+          command: "cd spec/support/dummy_passing && npx cypress run",
+          output: w
+        ).run
+      end
+      r.read
+      r.close
+      expect(status).to eq 0
+    end
+  end
+
+  context "when tests are failing" do
+    let(:command) { "rackup spec/support/dummy_failing/config.ru" }
+
+    it "runs cypress correctly" do
+      CypressRails::Server.new(host, command, log_path).start do |host, port|
+        CypressRails::Runner.new(
+          host: host,
+          port: port,
+          command: "cd spec/support/dummy_failing && npx cypress run",
+          output: w
+        ).run
+      end
+      result = r.read
+      expect(result).to match(/Visiting the root address/)
+      expect(result).to match(/renders OK/)
+      expect(result).to match(/\(Tests Finished\)/)
+      r.close
+    end
+
+    it "returns non-zero status code" do
+      status = nil
+      CypressRails::Server.new(host, command, log_path).start do |host, port|
+        status = CypressRails::Runner.new(
+          host: host,
+          port: port,
+          command: "cd spec/support/dummy_failing && npx cypress run",
+          output: w
+        ).run
+      end
+      r.read
+      r.close
+      expect(status).not_to eq 0
+    end
+  end
+end

data/spec/cypress_rails/server_spec.rb

@@ -2,33 +2,32 @@
 
 require "spec_helper"
 require "open-uri"
-require "cypress_rails"
 require "cypress_rails/server"
 
 RSpec.describe CypressRails::Server do
-  describe "#port" do
-    subject(:port) { described_class.new("localhost").port }
+  let(:host) { "localhost" }
+  let(:command) { "rackup spec/support/dummy_passing/config.ru" }
+  let(:log_path) { "/dev/null" }
 
-    it "assigns a port number from the ephemeral range" do
-      expect(49152..65535).to cover(port)
-    end
+  describe "#port" do
+    subject(:port) { described_class.new(host, command, log_path).port }
 
     it { is_expected.to be_open_port }
   end
 
   describe "#start" do
-    subject(:server) { described_class.new("localhost") }
+    subject(:server) { described_class.new(host, command, log_path) }
 
     it "starts the server and blocks until it is ready" do
-      CypressRails.configure do |config|
-        config.server_command = "rackup spec/support/dummy/config.ru"
-      end
-
       response = nil
       server.start {
         response = open("http://localhost:#{server.port}")
       }
       expect(response.status).to include "200"
     end
+
+    it "yields the port number and host into the block" do
+      expect { |b| server.start(&b) }.to yield_with_args("localhost", server.port)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
 require "rspec"
+require "pry"
+
 Dir[File.expand_path("support/**/*.rb", __dir__)].each { |file| require file }