test-recorder 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 745f47568a578d0d76e8558dc16fd6277045cd86dca6a09f38b4914b90e09775
-  data.tar.gz: 9ec908cb4e136d8137d5304c77594fd0d88e81070ff5b086198035e5cdef1d39
+  metadata.gz: e868dca992d2695188debf897102cd76ed6374a25abcb0bbd8875414f9714f9e
+  data.tar.gz: ecad80fbed7bc759ef3d30043b1fcdeb15202f3caa3a6e095b29e9d5ccf77e9c
 SHA512:
-  metadata.gz: f3962a434f3c98a2dfdd9840cf60205795cc175a18b34d2eb3dd66f6c1ec43603f9b6bd53cc0970811e1cfd6cb54149bdef3db2858173db72769f75a191b750e
-  data.tar.gz: 97b93c654e9125cf0732c803e49808d4fb6a72402827307708cd52853d21def581843c9d8da877b027206d322cebae31a9efab655f28617212adfc4e299152f2
+  metadata.gz: d13e0d7f4fe1056b99f367c08ea89424cfc86780a0d04754425098c7d9c9964f8abb675360a6fafd8c3e8db4fdb0e5f4b9d55890e2376dbf70391a2c3ddfac52
+  data.tar.gz: dccb98cfda3cf96ffd888f3cea87cc8cfd9d27631da0ce66408c410fbf1b74fc74c7ea45461c48ffe1c29cca1895d96c7716884189fe4e689ea7175c4dd6e480

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    concurrency:
+      group: ${{ github.ref }}
+      cancel-in-progress: true
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0.3'
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '14'
+    - name: Install ffmpeg
+      run: |
+        sudo apt install ffmpeg
+    - name: Install dependencies
+      run: |
+        gem install bundler --no-document
+        bundle install
+    - name: Run test
+      run: bundle exec rake

data/Gemfile.lock

@@ -1,67 +1,36 @@
 PATH
   remote: .
   specs:
-    test-recorder (0.1.0)
-      headless
-      railties
+    test-recorder (0.1.1)
+      activesupport
+      selenium-devtools
+      selenium-webdriver (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.3.4)
-      actionview (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      rack (~> 2.0, >= 2.0.8)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.4)
-      activesupport (= 6.0.3.4)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.0.3.4)
+    activesupport (7.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.7)
-    crass (1.0.6)
-    erubi (1.9.0)
-    headless (2.3.1)
-    i18n (1.8.5)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    childprocess (4.1.0)
+    concurrent-ruby (1.1.9)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    loofah (2.7.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (1.0.0)
-    mini_portile2 (2.4.0)
     minitest (5.14.2)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    railties (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
     rake (12.3.3)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+    rexml (3.2.5)
+    rubyzip (2.3.2)
+    selenium-devtools (0.96.0)
+      websocket (~> 1.0)
+    selenium-webdriver (4.1.0)
+      childprocess (>= 0.5, < 5.0)
+      rexml (~> 3.2, >= 3.2.5)
+      rubyzip (>= 1.2.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket (1.2.9)
 
 PLATFORMS
   ruby
@@ -72,4 +41,4 @@ DEPENDENCIES
   test-recorder!
 
 BUNDLED WITH
-   2.1.4
+   2.2.32

data/README.md

@@ -1,3 +1,49 @@
-# Videotest::Recorder
+# TestRecorder
 
-:hammer_and_pick: WIP :hammer_and_pick:
+Record a video automatically when tests failed. The videos are generated in `tmp/videos` directory.
+
+![CI](https://github.com/y-yagi/test-recorder/workflows/CI/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/test-recorder.svg)](http://badge.fury.io/rb/test-recorder)
+
+
+## Requirements
+
+This gem depends on FFmpeg. Please install that package.
+
+On Debian/Ubuntu:
+
+```bash
+sudo apt-get install ffmpeg
+```
+
+## Supported libraries
+
+Rails system tests and RSpec(System Spec and Feature Spec).
+
+## Limitations
+
+Currently, this gem only supports a Chrome headless.
+
+## Usage
+
+### 1: Install the gem
+
+Using Bundler, add the following to your Gemfile:
+
+```ruby
+gem 'test-recorder', group: :test
+```
+
+### 2: Load library into your tests
+
+#### Rails
+
+```ruby
+require 'test_recorder/rails'
+```
+
+#### RSpec
+
+```ruby
+require 'test_recorder/rspec'
+```

data/Rakefile

@@ -6,7 +6,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "lib"
   t.verbose = true
   t.warning = true
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = ["test/integration_test.rb"]
 end
 
 task :default => :test

data/lib/test_recorder/cdp_recorder.rb

@@ -0,0 +1,59 @@
+require "fileutils"
+
+module TestRecorder
+  class CdpRecorder
+    def initialize(enabled:)
+      @enabled = enabled
+      setup if @enabled
+    end
+
+    def setup
+      @video_dir = ::Rails.root.join("tmp", "videos")
+      FileUtils.mkdir_p(@video_dir)
+    end
+
+    def start(page:)
+      return unless @enabled
+
+      @tmpdir = Dir.mktmpdir("testrecorder")
+      @counter = 1
+
+      @page = page
+      @page.driver.browser.devtools.page.enable
+
+      @page.driver.browser.devtools.page.on(:screencast_frame) do |event|
+        decoded_data = Base64.decode64(event["data"])
+        filename = "%010d.jpeg" %  @counter
+        if Dir.exist?(@tmpdir)
+          IO.binwrite("#{File.join(@tmpdir, filename)}", decoded_data)
+          @counter += 1
+        end
+        @page.driver.browser.devtools.page.screencast_frame_ack(session_id: event["sessionId"])
+      end
+
+      @page.driver.browser.devtools.page.start_screencast(format: "jpeg", quality: 90)
+    end
+
+    def stop_and_discard
+      FileUtils.rm_rf(@tmpdir)
+    end
+
+    def stop_and_save(filename)
+      return if !@enabled || @page.nil?
+
+      @page.driver.browser.devtools.page.stop_screencast
+      video_path = File.join(@video_dir, filename)
+
+      args = %W(-loglevel error -f image2 -avioflags direct -fpsprobesize 0
+        -probesize 32 -analyzeduration 0 -c:v mjpeg -i #{File.join(@tmpdir, "%010d.jpeg")}
+        -y -an -r 25 -qmin 0 -qmax 50 -crf 8 -deadline realtime -speed 8 -b:v 1M
+        -threads 1 #{video_path})
+      system("ffmpeg", *args, exception: true)
+      video_path
+    rescue => e
+      $stderr.puts("[TestRecorder] ffmpeg failed: #{e.message}")
+    ensure
+      FileUtils.rm_rf(@tmpdir)
+    end
+  end
+end

data/lib/test_recorder/rails/setup_and_teardown.rb

@@ -1,30 +1,21 @@
-require "headless"
 require "fileutils"
 
 module TestRecorder
   module Rails
     module SetupAndTeardown
-      attr_reader :video_dir, :headless
-
       def before_setup
-        @video_dir = ::Rails.root.join("tmp", "videos")
-        FileUtils.mkdir_p(video_dir)
-
-        # TODO: Allow configuring parameters.
-        @headless = Headless.new(video: { provider: :ffmpeg, codec: :libx264, extra: %w(-preset ultrafast) })
-        headless.start
-        headless.video.start_capture
+        @cdp_recorder = TestRecorder::CdpRecorder.new(enabled: true)
+        @cdp_recorder.start(page: page)
 
         super
       end
 
       def before_teardown
         if failures.empty?
-          headless.video.stop_and_discard
+          @cdp_recorder.stop_and_discard
         else
-          video = video_dir.join("failures_#{self.name}.mp4")
-          headless.video.stop_and_save(video)
-          puts "[Video]: #{video}"
+          video_path = @cdp_recorder.stop_and_save("failures_#{self.name}.mp4")
+          puts "[Video]: #{video_path}" if File.exist?(video_path)
         end
       ensure
         super

data/lib/test_recorder/rails.rb

@@ -1,3 +1,4 @@
+require "test_recorder/cdp_recorder"
 require "test_recorder/rails/setup_and_teardown"
 
 ActiveSupport.on_load(:action_dispatch_system_test_case) do

data/lib/test_recorder/rspec/example_wrapper.rb

@@ -0,0 +1,10 @@
+module TestRecorder
+  module RSpec
+    module ExampleWrapper
+      def run_before_example
+        super
+        TestRecorder::RSpec.cdp_recorder.start(page: @example_group_instance.page)
+      end
+    end
+  end
+end

data/lib/test_recorder/rspec.rb

@@ -1,20 +1,21 @@
-require "headless"
-require "fileutils"
+require "test_recorder/cdp_recorder"
+require "test_recorder/rspec/example_wrapper"
 
 module TestRecorder
-  module Rspec
+  module RSpec
     CHARS_TO_TRANSLATE = ['/', '.', ':', ',', "'", '"', " "].freeze
 
     class << self
-      attr_accessor :headless, :video_dir
+      attr_accessor :cdp_recorder
 
       def after_failed_example(example)
         if example.exception
-          video = video_dir.join("failures_#{method_name(example)}.mp4")
-          headless.video.stop_and_save(video)
-          example.metadata[:extra_failure_lines] = [example.metadata[:extra_failure_lines], "[Video]: #{video}"]
+          video_path = cdp_recorder.stop_and_save("failures_#{method_name(example)}.mp4").to_s
+          if File.exist?(video_path)
+            example.metadata[:extra_failure_lines] = [example.metadata[:extra_failure_lines], "[Video]: #{video_path}"].flatten
+          end
         else
-          headless.video.stop_and_discard
+          cdp_recorder.stop_and_discard
         end
       end
 
@@ -25,21 +26,16 @@ module TestRecorder
   end
 end
 
-RSpec.configure do |config|
-  config.before do
-    TestRecorder::Rspec.video_dir = ::Rails.root.join("tmp", "videos")
-    FileUtils.mkdir_p(TestRecorder::Rspec.video_dir)
+RSpec::Core::Example.prepend(TestRecorder::RSpec::ExampleWrapper)
 
-    TestRecorder::Rspec.headless = Headless.new(video: { provider: :ffmpeg, codec: :libx264, extra: %w(-preset ultrafast) })
-    TestRecorder::Rspec.headless.start
-    TestRecorder::Rspec.headless.video.start_capture
-  end
+RSpec.configure do |config|
+  TestRecorder::RSpec.cdp_recorder = TestRecorder::CdpRecorder.new(enabled: true)
 
   config.after(type: :system) do |example|
-    TestRecorder::Rspec.after_failed_example(example)
+    TestRecorder::RSpec.after_failed_example(example)
   end
 
   config.after(type: :feature) do |example|
-    TestRecorder::Rspec.after_failed_example(example)
+    TestRecorder::RSpec.after_failed_example(example)
   end
 end

data/lib/test_recorder/version.rb

@@ -1,3 +1,3 @@
 module TestRecorder
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test-recorder.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.add_dependency "headless"
-  spec.add_dependency "railties"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "selenium-webdriver", ">= 4.0"
+  spec.add_dependency "selenium-devtools"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: test-recorder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yuji Yaginuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: headless
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-devtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -55,9 +70,11 @@ files:
 - bin/setup
 - lib/test-recorder.rb
 - lib/test_recorder.rb
+- lib/test_recorder/cdp_recorder.rb
 - lib/test_recorder/rails.rb
 - lib/test_recorder/rails/setup_and_teardown.rb
 - lib/test_recorder/rspec.rb
+- lib/test_recorder/rspec/example_wrapper.rb
 - lib/test_recorder/version.rb
 - test-recorder.gemspec
 homepage: http://github.com/y-yagi/test-recorder
@@ -80,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Automatically record videos when tests failed.