test-recorder 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db491c5f3e52392c234291c174bbc1fff1bfb67d05a0ba23e50560529ea21d25
-  data.tar.gz: ae3f23d20992e0ec4e9cc4597fa15e346e52e1d2c31e482eab750d64942f8df1
+  metadata.gz: c74ddd16cdffa85784c96e4be8bc549752122364fa729a5cf8cc68fc923d4dc0
+  data.tar.gz: 5b9d3ec1a27a641c447ac896a031625153027797a9b5d2a163bdb17f706a88b0
 SHA512:
-  metadata.gz: d4964d2703dc893155e0d246843141221e75991c57eb93da21e3c1331c9d9d648f56cf32d88885d4f89fc6da07b3889215549c055c9986aeecd3ac9c43bde1d7
-  data.tar.gz: d4c944875e4ee763fa6b88c434e700afa63fd1c3380d392e2d18f589a3e6f15aae4c2c83a52ece118829b0b343581efbe8b4a9d982b291921715c4e72f553f31
+  metadata.gz: 572f1b6775222278e1e036c8c7e692f1991521fbcc30ecab6e44f7e713252670f62a2b88f308ff0eb6467ee6c65db90966f98f3cffd1a8d2e8bf59372b601199
+  data.tar.gz: 397223170511f89678bbf2593586929965a12dd6b1c969d328a18cdc26b818717b39173f818210eb3be457b12f0df9d354718cf4175d12eab4d95d697d99b10e

data/.github/workflows/ci.yml

@@ -11,13 +11,13 @@ jobs:
       cancel-in-progress: true
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3.0.3'
-    - uses: actions/setup-node@v1
+        ruby-version: '3.2'
+    - uses: actions/setup-node@v2
       with:
-        node-version: '14'
+        node-version: '18'
     - name: Install ffmpeg
       run: |
         sudo apt update && sudo apt install ffmpeg

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    test-recorder (0.1.4)
+    test-recorder (0.1.5)
       activesupport
       selenium-devtools
       selenium-webdriver (>= 4.0)
@@ -9,36 +9,35 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     activesupport-testing-metadata (0.1.0)
       activesupport (>= 4.0)
-    childprocess (4.1.0)
     concurrent-ruby (1.1.10)
-    debug (1.5.0)
-      irb (>= 1.3.6)
-      reline (>= 0.2.7)
-    i18n (1.10.0)
+    debug (1.7.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    io-console (0.5.11)
-    irb (1.4.1)
+    io-console (0.6.0)
+    irb (1.6.2)
       reline (>= 0.3.0)
-    minitest (5.15.0)
+    minitest (5.17.0)
     rake (12.3.3)
-    reline (0.3.1)
+    reline (0.3.2)
       io-console (~> 0.5)
     rexml (3.2.5)
     rubyzip (2.3.2)
-    selenium-devtools (0.101.0)
-      websocket (~> 1.0)
-    selenium-webdriver (4.1.0)
-      childprocess (>= 0.5, < 5.0)
+    selenium-devtools (0.109.0)
+      selenium-webdriver (~> 4.2)
+    selenium-webdriver (4.7.1)
       rexml (~> 3.2, >= 3.2.5)
-      rubyzip (>= 1.2.2)
-    tzinfo (2.0.4)
+      rubyzip (>= 1.2.2, < 3.0)
+      websocket (~> 1.0)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     websocket (1.2.9)
 
@@ -53,4 +52,4 @@ DEPENDENCIES
   test-recorder!
 
 BUNDLED WITH
-   2.2.32
+   2.4.3

data/README.md

@@ -5,6 +5,7 @@ Record a video automatically when tests failed. The videos are generated in `tmp
 [![Build Status](https://github.com/y-yagi/test-recorder/workflows/CI/badge.svg)](https://github.com/y-yagi/test-recorder/actions)
 [![Gem Version](https://badge.fury.io/rb/test-recorder.svg)](http://badge.fury.io/rb/test-recorder)
 
+This gem was inspired by [Record video feature of Playwright](https://playwright.dev/docs/videos).
 
 ## Requirements
 

data/lib/test_recorder/cdp_recorder.rb

@@ -1,10 +1,13 @@
+require "open3"
 require "fileutils"
+require "tempfile"
 
 module TestRecorder
   class CdpRecorder
     def initialize(enabled:)
       @enabled = enabled
-      @tmpdir = nil
+      @started = nil
+      @page = nil
       setup
     end
 
@@ -15,21 +18,20 @@ module TestRecorder
 
     def start(page:, enabled: nil)
       enabled = @enabled if enabled.nil?
-      return unless enabled
+      @started = enabled
+      return unless @started
 
-      @tmpdir = Dir.mktmpdir("testrecorder")
-      counter = 1
+      @tmp_video = Tempfile.open(["testrecorder", ".webm"])
+      cmd = "ffmpeg -loglevel quiet -f image2pipe -avioflags direct -fpsprobesize 0 -probesize 32 -analyzeduration 0 -c:v mjpeg -i - -y -an -r 25 -qmin 0 -qmax 50 -crf 8 -deadline realtime -speed 8 -b:v 1M -threads 1 #{@tmp_video.path}"
+      @stdin, @wait_thrs = *Open3.pipeline_w(cmd)
+      @stdin.set_encoding("ASCII-8BIT")
 
       @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
+        @stdin.print(decoded_data) rescue nil
         @page.driver.browser.devtools.page.screencast_frame_ack(session_id: event["sessionId"])
       end
 
@@ -37,25 +39,24 @@ module TestRecorder
     end
 
     def stop_and_discard
-      FileUtils.rm_rf(@tmpdir) unless @tmpdir.nil?
+      if @started
+        @page.driver.browser.devtools.page.stop_screencast
+        @stdin.close
+      end
     end
 
     def stop_and_save(filename)
-      return if @tmpdir.nil? || @page.nil?
+      return "" unless @started
 
       @page.driver.browser.devtools.page.stop_screencast
+      @stdin.close
+      @wait_thrs.each(&:join)
+
       video_path = File.join(@video_dir, filename)
+      FileUtils.copy(@tmp_video.path, video_path)
+      @tmp_video.close(true)
 
-      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

@@ -13,7 +13,7 @@ module TestRecorder
         if failures.empty?
           @cdp_recorder.stop_and_discard
         else
-          video_path = @cdp_recorder.stop_and_save("failures_#{self.name}.mp4")
+          video_path = @cdp_recorder.stop_and_save("failures_#{self.name}.webm")
           puts "[Video]: #{video_path}" if File.exist?(video_path)
         end
       ensure

data/lib/test_recorder/rspec.rb

@@ -10,7 +10,7 @@ module TestRecorder
 
       def after_failed_example(example)
         if example.exception
-          video_path = cdp_recorder.stop_and_save("failures_#{method_name(example)}.mp4").to_s
+          video_path = cdp_recorder.stop_and_save("failures_#{method_name(example)}.webm").to_s
           if File.exist?(video_path)
             example.metadata[:extra_failure_lines] = [example.metadata[:extra_failure_lines], "[Video]: #{video_path}"].flatten
           end

data/lib/test_recorder/version.rb

@@ -1,3 +1,3 @@
 module TestRecorder
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-recorder
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Yuji Yaginuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Automatically record videos when tests failed.