cyperful 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 341d51e03119eed5f4354673d25c81f2630ee73bb48e29312a797db76b389f80
-  data.tar.gz: f52e880307fa10e3529ebaac44d165e860bcb94e5913d9c0808732881ac96e63
+  metadata.gz: f340215ffcef3e16c1738d36eb2b71461bbd32e2011598d000793326f806b6d4
+  data.tar.gz: 545e19084294a2d481a7e9d156f6ba5e4758fb52332c17dc2e2574be820b2256
 SHA512:
-  metadata.gz: 5baea001193479787f029a38b800fc98fdd5eee46450eefdf6a874c16b890181f49c110c97fe1ae668d160d1c925996ce3d40fe8013dedfa342f015a0cdaa6b5
-  data.tar.gz: d72eaed23330c7ebcc2c865685c0ee4c1854911f5680c5b7dc42d951d8ba5d9c77cb8e89a4a3609d33523f4cfd0b47c52685d3a15257ffbd9a3057b7de308806
+  metadata.gz: 524bbb91d707a457adfa888bc8db5a2d97886714dedc026d8647d2f243f8ff381f46a47af8cffe3fb4d46242aacfd515f2dda1b2a794252f758b5899ca312e9a
+  data.tar.gz: e20223308f8c0df25df5aab64d97f24d4ef6f0b57bb530106e82a3234f5701f1ca434afa87dad9b50155f73043aef6b1afbe328ebb99aed35ad53fac29dc5ef9

data/lib/cyperful/driver.rb

@@ -61,7 +61,7 @@ class Cyperful::Driver
     @steps =
       Cyperful::TestParser.new(@test_class).steps_per_test.fetch(@test_name)
 
-    editor = "vscode" # TODO: support other editors?
+    editor_scheme = Cyperful.config.editor_scheme
 
     @steps.each_with_index do |step, i|
       step.merge!(
@@ -70,11 +70,14 @@ class Cyperful::Driver
         start_at: nil,
         end_at: nil,
         paused_at: nil,
-        permalink: "#{editor}://file/#{@source_filepath}:#{step.fetch(:line)}",
+        permalink:
+          if editor_scheme && !editor_scheme.empty?
+            "#{editor_scheme}://file/#{@source_filepath}:#{step.fetch(:line)}"
+          end,
       )
     end
 
-    # NOTE: there can be multiple steps per line, this takes the last instance
+    # TODO: support multiple multiple steps per line, this takes only the last instance
     @step_per_line = @steps.index_by { |step| step[:line] }
 
     @current_step = nil

data/lib/cyperful/framework_injections.rb

@@ -1,5 +1,29 @@
 require "action_dispatch/system_testing/driver"
 
+# The Minitest test helper.
+# TODO: support other test frameworks like RSpec
+module Cyperful::SystemTestHelper
+  def setup
+    Cyperful.setup(self.class, self.method_name)
+    super
+  end
+
+  def teardown
+    error = passed? ? nil : failure
+
+    error = error.error if error.is_a?(Minitest::UnexpectedError)
+
+    Cyperful.teardown(error)
+    super
+  end
+
+  # Disable default screenshot on failure b/c we handle them ourselves.
+  # https://github.com/rails/rails/blob/main/actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb#L156
+  def take_failed_screenshot
+    nil
+  end
+end
+
 # we need to override the some Capybara::Session methods because they
 # control the top-level browser window, but we want them
 # to control the iframe instead
@@ -37,34 +61,14 @@ module PrependCapybaraWindow
 end
 Capybara::Window.prepend(PrependCapybaraWindow)
 
-# The Minitest test helper.
-# TODO: support other test frameworks like RSpec
-module Cyperful::SystemTestHelper
-  def setup
-    Cyperful.setup(self.class, self.method_name)
-    super
-  end
-
-  def teardown
-    error = passed? ? nil : failure
-
-    error = error.error if error.is_a?(Minitest::UnexpectedError)
-
-    Cyperful.teardown(error)
-    super
-  end
-
-  # Disable default screenshot on failure b/c we handle them ourselves.
-  # https://github.com/rails/rails/blob/main/actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb#L156
-  def take_failed_screenshot
-    nil
-  end
-end
-
 module PrependSystemTestingDriver
   def initialize(...)
     super(...)
 
+    # SUPER NAIVE way to include the width/height of the sidebar/header
+    # in the new screen size
+    @screen_size = [@screen_size.fetch(0) + 300, @screen_size.fetch(1) + 60]
+
     prev_capabilities = @capabilities
     @capabilities =
       proc do |driver_opts|
@@ -81,6 +85,10 @@ module PrependSystemTestingDriver
         # make sure we're not in headless mode
         driver_opts.args.delete("--headless")
         driver_opts.args.delete("--headless=new")
+
+        # hide the "Chrome is being controlled by automated test software" infobar
+        driver_opts.args.delete("--enable-automation")
+        driver_opts.exclude_switches << "enable-automation"
       end
   end
 end
@@ -90,15 +98,5 @@ ActionDispatch::SystemTesting::Driver.prepend(PrependSystemTestingDriver)
 #   Minitest::Test::PASSTHROUGH_EXCEPTIONS << Cyperful::AbstractCommand
 # end
 
-# we need to allow the iframe to be embedded in the cyperful server
-# TODO: use Rack middleware instead to support non-Rails apps
-if defined?(Rails)
-  Rails.application.config.content_security_policy do |policy|
-    policy.frame_ancestors(:self, "localhost:#{Cyperful.config.port}")
-  end
-else
-  warn "Cyperful: Rails not detected, skipping content_security_policy fix.\nThe Cyperful UI may not work correctly."
-end
-
 # fix for: Set-Cookie (SameSite=Lax) doesn't work when within an iframe with host 127.0.0.1
 Capybara.server_host = "localhost"

data/lib/cyperful/railtie.rb

@@ -0,0 +1,9 @@
+# we need to allow the iframe to be embedded in the cyperful server
+# TODO: consider Rack middleware instead to support non-Rails apps?
+class Cyperful::Railtie < Rails::Railtie
+  config.after_initialize do |app|
+    app.config.content_security_policy do |policy|
+      policy.frame_ancestors(:self, "localhost:#{Cyperful.config.port}")
+    end
+  end
+end

data/lib/cyperful/test_parser.rb

@@ -17,10 +17,12 @@ class Cyperful::TestParser
         current_scope
         status_code
         response_headers
+        title
+        query
       ]
 
-  def self.step_at_methods
-    @step_at_methods
+  def self.step_at_methods_set
+    @step_at_methods_set ||= @step_at_methods.to_set
   end
   def self.add_step_at_methods(*mods_or_methods)
     mods_or_methods.each do |mod_or_method|
@@ -78,9 +80,13 @@ class Cyperful::TestParser
 
           block_node = node.children[2]
           [test_method, block_node]
-        else
+
           # e.g. `def test_my_test; ... end`
-          # TODO
+        elsif node.type == :def && node.children[0].to_s.start_with?("test_")
+          test_method = node.children[0]
+
+          block_node = node.children[2]
+          [test_method, block_node]
         end
       end
       .compact
@@ -88,6 +94,10 @@ class Cyperful::TestParser
         out = []
         block_node.children.each { |child| find_test_steps(child, out) }
 
+        # de-duplicate steps by line number
+        # TODO: support multiple steps on the same line. `step_per_line = ...` needs to be refactored
+        out = out.reverse.uniq { |step| step[:line] }.reverse
+
         [test_method, out]
       end
   end
@@ -96,8 +106,10 @@ class Cyperful::TestParser
     return out unless ast&.is_a?(Parser::AST::Node)
 
     if ast.type == :send
-      add_node(ast, out, depth)
-      ast.children.each { |child| find_test_steps(child, out, depth) }
+      # e.g. `assert_equal current_path, "/"` should be a single step, not 2
+      unless add_node(ast, out, depth)
+        ast.children.each { |child| find_test_steps(child, out, depth) }
+      end
     elsif ast.type == :block
       method, _args, child = ast.children
 
@@ -105,6 +117,7 @@ class Cyperful::TestParser
 
       if method.type == :send
         depth += 1 if add_node(method, out, depth)
+
         method.children.each { |child| find_test_steps(child, out, depth) }
       end
 
@@ -115,7 +128,7 @@ class Cyperful::TestParser
   end
 
   private def add_node(node, out, depth)
-    unless Cyperful::TestParser.step_at_methods.include?(node.children[1])
+    unless Cyperful::TestParser.step_at_methods_set.include?(node.children[1])
       return false
     end
 

data/lib/cyperful/ui_server.rb

@@ -1,4 +1,5 @@
 require "webrick/websocket"
+require "webrick/httpproxy"
 
 # fix for: webrick-websocket incorrectly assumes `Upgrade` header is always present
 module FixWebrickWebsocketServer
@@ -34,9 +35,16 @@ class Cyperful::UiServer
     @server =
       WEBrick::Websocket::HTTPServer.new(
         Port: @port,
-        DocumentRoot: File.join(Cyperful::ROOT_DIR, "public"),
         Logger: WEBrick::Log.new("/dev/null"),
         AccessLog: [],
+        **unless Cyperful::DEV_MODE
+          {
+            DocumentRoot: File.join(Cyperful::ROOT_DIR, "public"),
+            DocumentRootOptions: {
+              FancyIndexing: false,
+            },
+          }
+        end || {},
       )
 
     notify_queue = @notify_queue
@@ -118,6 +126,10 @@ class Cyperful::UiServer
       res["Content-Type"] = "application/json"
       res.status = 200
     end
+
+    if Cyperful::DEV_MODE
+      @server.mount("/", ReverseProxy, target_url: "http://localhost:3005")
+    end
   end
 
   def start_async
@@ -134,4 +146,37 @@ class Cyperful::UiServer
 
     @server.shutdown
   end
+
+  # super naive reverse proxy
+  class ReverseProxy < WEBrick::HTTPServlet::AbstractServlet
+    def initialize(server, config = {})
+      super
+      @target_url = config.fetch(:target_url)
+      @forward_headers = config[:forward_headers] || ["accept"]
+    end
+
+    def do_GET(request, response)
+      # Target server URL
+      target_uri = URI(@target_url)
+      target_uri.path = request.path
+      target_uri.query = request.query_string if request.query_string
+
+      # Create a new request to the target server with the original request path
+      target_request = Net::HTTP::Get.new(target_uri)
+      @forward_headers.each do |header|
+        target_request[header] = request[header]
+      end
+
+      # Send the request to the target server
+      target_response =
+        Net::HTTP.start(target_uri.host, target_uri.port) do |http|
+          http.request(target_request)
+        end
+
+      # Set the response from the target server as the response to send back to the client
+      response.status = target_response.code.to_i
+      response["Content-Type"] = target_response["content-type"]
+      response.body = target_response.body
+    end
+  end
 end

data/lib/cyperful.rb

@@ -4,6 +4,10 @@ require "listen"
 module Cyperful
   ROOT_DIR = File.expand_path("..", __dir__)
 
+  # Add `CYPERFUL_DEV=1` to use the Vite dev hot-reloading server
+  # instead of the pre-built files in `public/`
+  DEV_MODE = !!ENV["CYPERFUL_DEV"]
+
   @current = nil
 
   class Config < Struct.new(
@@ -11,6 +15,7 @@ module Cyperful
     :auto_run_on_reload,
     :reload_test_files,
     # :reload_source_files, # not implemented yet
+    :editor_scheme,
     :history_recording, # EXPERIMENTAL
     keyword_init: true,
   )
@@ -19,6 +24,7 @@ module Cyperful
         port: 3004,
         auto_run_on_reload: true,
         reload_test_files: true,
+        editor_scheme: "vscode",
         history_recording: true,
       )
     end
@@ -60,3 +66,4 @@ require "cyperful/test_parser"
 require "cyperful/ui_server"
 require "cyperful/driver"
 require "cyperful/framework_injections"
+require "cyperful/railtie" if defined?(Rails::Railtie)