test-recorder 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e868dca992d2695188debf897102cd76ed6374a25abcb0bbd8875414f9714f9e
-  data.tar.gz: ecad80fbed7bc759ef3d30043b1fcdeb15202f3caa3a6e095b29e9d5ccf77e9c
+  metadata.gz: db491c5f3e52392c234291c174bbc1fff1bfb67d05a0ba23e50560529ea21d25
+  data.tar.gz: ae3f23d20992e0ec4e9cc4597fa15e346e52e1d2c31e482eab750d64942f8df1
 SHA512:
-  metadata.gz: d13e0d7f4fe1056b99f367c08ea89424cfc86780a0d04754425098c7d9c9964f8abb675360a6fafd8c3e8db4fdb0e5f4b9d55890e2376dbf70391a2c3ddfac52
-  data.tar.gz: dccb98cfda3cf96ffd888f3cea87cc8cfd9d27631da0ce66408c410fbf1b74fc74c7ea45461c48ffe1c29cca1895d96c7716884189fe4e689ea7175c4dd6e480
+  metadata.gz: d4964d2703dc893155e0d246843141221e75991c57eb93da21e3c1331c9d9d648f56cf32d88885d4f89fc6da07b3889215549c055c9986aeecd3ac9c43bde1d7
+  data.tar.gz: d4c944875e4ee763fa6b88c434e700afa63fd1c3380d392e2d18f589a3e6f15aae4c2c83a52ece118829b0b343581efbe8b4a9d982b291921715c4e72f553f31

data/.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
         node-version: '14'
     - name: Install ffmpeg
       run: |
-        sudo apt install ffmpeg
+        sudo apt update && sudo apt install ffmpeg
     - name: Install dependencies
       run: |
         gem install bundler --no-document

data/Gemfile

@@ -1,7 +1,8 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in videotest-recorder.gemspec
+# Specify your gem's dependencies in test-recorder.gemspec
 gemspec
 
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
+gem "debug"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    test-recorder (0.1.1)
+    test-recorder (0.1.4)
       activesupport
       selenium-devtools
       selenium-webdriver (>= 4.0)
@@ -9,20 +9,30 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.0)
+    activesupport (7.0.3)
       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.9)
-    i18n (1.8.11)
+    concurrent-ruby (1.1.10)
+    debug (1.5.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.2)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    minitest (5.15.0)
     rake (12.3.3)
+    reline (0.3.1)
+      io-console (~> 0.5)
     rexml (3.2.5)
     rubyzip (2.3.2)
-    selenium-devtools (0.96.0)
+    selenium-devtools (0.101.0)
       websocket (~> 1.0)
     selenium-webdriver (4.1.0)
       childprocess (>= 0.5, < 5.0)
@@ -36,6 +46,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport-testing-metadata
+  debug
   minitest (~> 5.0)
   rake (~> 12.0)
   test-recorder!

data/README.md

@@ -2,7 +2,7 @@
 
 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)
+[![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)
 
 
@@ -22,7 +22,7 @@ Rails system tests and RSpec(System Spec and Feature Spec).
 
 ## Limitations
 
-Currently, this gem only supports a Chrome headless.
+Currently, this gem only supports a Headless Chrome.
 
 ## Usage
 
@@ -47,3 +47,50 @@ require 'test_recorder/rails'
 ```ruby
 require 'test_recorder/rspec'
 ```
+
+### Only record specific tests
+
+`TestRecorder` records all tests by default. But if you want to limit the tests, you can do it by specifying metadata.
+
+#### Rails
+
+##### 1: Install the additional Gem
+
+Using Bundler, add the following to your Gemfile:
+
+```ruby
+gem 'activesupport-testing-metadata', group: :test
+```
+
+##### 2. Disable `TestRecorder`, and specified tests with the tag
+
+```ruby
+# test/test_helper.rb
+require 'test_recorder/rails'
+require 'active_support/testing/metadata'
+
+TestRecorder.disable!
+```
+
+```ruby
+test "test to something", test_recorder: true do
+  # ...
+end
+```
+
+#### RSpec
+
+You don't need to install other gems. Only disable `TestRecorder`, and specified tests with the tag.
+
+```ruby
+# test/test_helper.rb
+require 'test_recorder/rspec'
+
+TestRecorder.disable!
+```
+
+```ruby
+it "test to something", test_recorder: true do
+  # ...
+end
+

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "videotest/recorder"
+require "test_recorder"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/test_recorder/cdp_recorder.rb

@@ -4,7 +4,8 @@ module TestRecorder
   class CdpRecorder
     def initialize(enabled:)
       @enabled = enabled
-      setup if @enabled
+      @tmpdir = nil
+      setup
     end
 
     def setup
@@ -12,21 +13,22 @@ module TestRecorder
       FileUtils.mkdir_p(@video_dir)
     end
 
-    def start(page:)
-      return unless @enabled
+    def start(page:, enabled: nil)
+      enabled = @enabled if enabled.nil?
+      return unless enabled
 
       @tmpdir = Dir.mktmpdir("testrecorder")
-      @counter = 1
+      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
+        filename = "%010d.jpeg" %  counter
         if Dir.exist?(@tmpdir)
           IO.binwrite("#{File.join(@tmpdir, filename)}", decoded_data)
-          @counter += 1
+          counter += 1
         end
         @page.driver.browser.devtools.page.screencast_frame_ack(session_id: event["sessionId"])
       end
@@ -35,11 +37,11 @@ module TestRecorder
     end
 
     def stop_and_discard
-      FileUtils.rm_rf(@tmpdir)
+      FileUtils.rm_rf(@tmpdir) unless @tmpdir.nil?
     end
 
     def stop_and_save(filename)
-      return if !@enabled || @page.nil?
+      return if @tmpdir.nil? || @page.nil?
 
       @page.driver.browser.devtools.page.stop_screencast
       video_path = File.join(@video_dir, filename)

data/lib/test_recorder/rails/setup_and_teardown.rb

@@ -1,11 +1,10 @@
-require "fileutils"
-
 module TestRecorder
   module Rails
     module SetupAndTeardown
       def before_setup
-        @cdp_recorder = TestRecorder::CdpRecorder.new(enabled: true)
-        @cdp_recorder.start(page: page)
+        @cdp_recorder = TestRecorder::CdpRecorder.new(enabled: TestRecorder.enabled?)
+        enabled = respond_to?(:metadata) ? metadata[:test_recorder] : nil
+        @cdp_recorder.start(page: page, enabled: enabled)
 
         super
       end

data/lib/test_recorder/rspec/example_wrapper.rb

@@ -3,7 +3,10 @@ module TestRecorder
     module ExampleWrapper
       def run_before_example
         super
-        TestRecorder::RSpec.cdp_recorder.start(page: @example_group_instance.page)
+        TestRecorder::RSpec.cdp_recorder.start(
+          page: @example_group_instance.page,
+          enabled: self.metadata[:test_recorder]
+        )
       end
     end
   end

data/lib/test_recorder/rspec.rb

@@ -29,7 +29,7 @@ end
 RSpec::Core::Example.prepend(TestRecorder::RSpec::ExampleWrapper)
 
 RSpec.configure do |config|
-  TestRecorder::RSpec.cdp_recorder = TestRecorder::CdpRecorder.new(enabled: true)
+  TestRecorder::RSpec.cdp_recorder = TestRecorder::CdpRecorder.new(enabled: TestRecorder.enabled?)
 
   config.after(type: :system) do |example|
     TestRecorder::RSpec.after_failed_example(example)

data/lib/test_recorder/version.rb

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

data/lib/test_recorder.rb

@@ -1 +1,17 @@
 require "test_recorder/version"
+
+module TestRecorder
+  class << self
+    def enable!
+      @enable = true
+    end
+
+    def disable!
+      @enable = false
+    end
+
+    def enabled?
+      defined?(@enable) ? @enable : true
+    end
+  end
+end

data/test-recorder.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport"
   spec.add_dependency "selenium-webdriver", ">= 4.0"
   spec.add_dependency "selenium-devtools"
+  spec.add_development_dependency "activesupport-testing-metadata"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-recorder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Yuji Yaginuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport-testing-metadata
+  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: 
 email:
 - yuuji.yaginuma@gmail.com