test-recorder 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    test-recorder (0.1.0)
+      headless
+      railties
+
+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)
+      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)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  test-recorder!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 yuuji.yaginuma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# Videotest::Recorder
+
+:hammer_and_pick: WIP :hammer_and_pick:

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.verbose = true
+  t.warning = true
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "videotest/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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/test-recorder.rb

@@ -0,0 +1 @@
+require "test_recorder"

data/lib/test_recorder.rb

@@ -0,0 +1 @@
+require "test_recorder/version"

data/lib/test_recorder/rails.rb

@@ -0,0 +1,5 @@
+require "test_recorder/rails/setup_and_teardown"
+
+ActiveSupport.on_load(:action_dispatch_system_test_case) do
+  include TestRecorder::Rails::SetupAndTeardown
+end

data/lib/test_recorder/rails/setup_and_teardown.rb

@@ -0,0 +1,34 @@
+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
+
+        super
+      end
+
+      def before_teardown
+        if failures.empty?
+          headless.video.stop_and_discard
+        else
+          video = video_dir.join("failures_#{self.name}.mp4")
+          headless.video.stop_and_save(video)
+          puts "[Video]: #{video}"
+        end
+      ensure
+        super
+      end
+    end
+  end
+end

data/lib/test_recorder/rspec.rb

@@ -0,0 +1,45 @@
+require "headless"
+require "fileutils"
+
+module TestRecorder
+  module Rspec
+    CHARS_TO_TRANSLATE = ['/', '.', ':', ',', "'", '"', " "].freeze
+
+    class << self
+      attr_accessor :headless, :video_dir
+
+      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}"]
+        else
+          headless.video.stop_and_discard
+        end
+      end
+
+      def method_name(example)
+        example.description.underscore.tr(CHARS_TO_TRANSLATE.join, "_")[0...200] + "_#{rand(1000)}"
+      end
+    end
+  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)
+
+    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
+
+  config.after(type: :system) do |example|
+    TestRecorder::Rspec.after_failed_example(example)
+  end
+
+  config.after(type: :feature) do |example|
+    TestRecorder::Rspec.after_failed_example(example)
+  end
+end

data/lib/test_recorder/version.rb

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

data/test-recorder.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/test_recorder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "test-recorder"
+  spec.version       = TestRecorder::VERSION
+  spec.authors       = ["Yuji Yaginuma"]
+  spec.email         = ["yuuji.yaginuma@gmail.com"]
+
+  spec.summary       = %q{Automatically record videos when tests failed.}
+  spec.homepage      = "http://github.com/y-yagi/test-recorder"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  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"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: test-recorder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Yaginuma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: headless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- yuuji.yaginuma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/test-recorder.rb
+- lib/test_recorder.rb
+- lib/test_recorder/rails.rb
+- lib/test_recorder/rails/setup_and_teardown.rb
+- lib/test_recorder/rspec.rb
+- lib/test_recorder/version.rb
+- test-recorder.gemspec
+homepage: http://github.com/y-yagi/test-recorder
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/y-yagi/test-recorder
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Automatically record videos when tests failed.
+test_files: []