test-unit-launchable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '01920d3a94ad73191d001d98102c60a817c1148356c75b15bc224144eaa7d04f'
+  data.tar.gz: 47a02921e804d71a2922775f769335d210dcdc60662a97f1ccf109c92e81acd0
+SHA512:
+  metadata.gz: 2bdec3d56533bbd3a146c6b73c01471b6852f0b1c06fa86a8bd88c6788ecd32a282d4bad79e12369f39e192ffbe27cbe7dafb028b514ad90c76c30da7ef76584
+  data.tar.gz: 7c4e5e5fbbdcb56bc516eea1bdca2cf44eb13712ebd3fce7b9240c49ef397b37628b29faedc170a4eea34663414068bf37cc5c526c6dba91cbeb112d8e898c79

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Naoto Ono
+
+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,42 @@
+# Test::Unit::Launchable
+
+test-unit-launchable is a convinient plugin for test-unit that generates a Launchable test report file based on the test results.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add test-unit-launchable
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install test-unit-launchable
+
+## Usage
+
+```ruby
+require "test/unit/runner/launchable"
+```
+
+```
+ruby test/example_test.rb --runner=launchable --launchable-test-report-json=report.json
+```
+
+## CLI options
+
+- --launchable-test-report-json=PATH
+  - Report test results in [Launchable JSON format](https://www.launchableinc.com/docs/resources/integrations/raw/).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ono-max/test-unit-launchable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/test/unit/launchable/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Test
+  module Unit
+    module Launchable
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/test/unit/runner/launchable.rb

@@ -0,0 +1,16 @@
+require "test/unit/autorunner"
+
+module Test
+  module Unit
+    AutoRunner.register_runner(:launchable) do |auto_runner|
+      require_relative 'testrunner'
+      Test::Unit::UI::Launchable::JSON::TestRunner
+    end
+
+    AutoRunner.setup_option do |auto_runner, opts|
+      opts.on("--launchable-test-report-json=PATH", 'Report test results in Launchable JSON format') do |path|
+        auto_runner.runner_options[:launchable_test_report] = path
+      end
+    end
+  end
+end

data/lib/test/unit/ui/launchable/json/testrunner.rb

@@ -0,0 +1,349 @@
+require 'json'
+require 'test/unit/ui/testrunnermediator'
+require 'test/unit/ui/console/testrunner'
+
+module Test
+  module Unit
+    module UI
+      module Launchable
+        module JSON
+          class TestRunner < UI::Console::TestRunner
+            def initialize(suite, options={})
+              super
+              @curt_test_case = nil
+              @json_stream_writer = nil
+            end
+
+            def attach_to_mediator
+              # To output logs to both stderr/stdout and an XML file,
+              # `UI::Console::TestRunner#attach_to_mediator` is called here.
+              super
+
+              test_report = @options[:launchable_test_report]
+              return unless test_report
+
+              @json_stream_writer = JSONStreamWriter.new(test_report)
+              @mediator.add_listener(::Test::Unit::TestCase::STARTED_OBJECT) do |test|
+                @curt_test_case = LaunchableTestCase.new(test)
+              end
+              @mediator.add_listener(::Test::Unit::TestCase::FINISHED_OBJECT) do |test|
+                @curt_test_case.elapsed_time = test.elapsed_time
+                @json_stream_writer.open_nested_object do |writer|
+                  # The test path is a URL-encoded representation.
+                  # https://github.com/launchableinc/cli/blob/v1.81.0/launchable/testpath.py#L18
+                  writer.write_key_value("testPath", @curt_test_case.test_path)
+                  writer.write_key_value("duration", @curt_test_case.elapsed_time)
+                  writer.write_key_value("status", @curt_test_case.status)
+                  writer.write_key_value("stderr", @curt_test_case.stderr)
+                  writer.write_key_value("stdout", nil)
+                  writer.write_key_value("createdAt", Time.now.to_s)
+                end
+                @curt_test_case = nil
+              end
+              @mediator.add_listener(TestResult::FAULT) do |fault|
+                @curt_test_case.fault = fault
+              end
+              @mediator.add_listener(TestRunnerMediator::FINISHED) do
+                @json_stream_writer.close
+              end
+            end
+          end
+
+          class LaunchableTestCase
+            attr_reader :method_name, :class_name, :source_location
+            attr_accessor :fault, :elapsed_time
+
+            def initialize(test)
+              @method_name = test.method_name
+              @class_name = test.class.name
+              @failure_msg = ""
+              @source_location = test.method(@method_name).source_location.first
+            end
+
+            def status
+              case @fault
+              when Pending, Omission
+                'TEST_SKIPPED'
+              when Error, Failure
+                'TEST_FAILED'
+              else
+                'TEST_PASSED'
+              end
+            end
+
+            def stderr
+              @fault&.message
+            end
+
+            def test_path
+              {file: @source_location, class: @class_name, testcase: @method_name}.map{|key, val|
+                "#{encode_test_path_component(key)}=#{encode_test_path_component(val)}"
+              }.join('#')
+            end
+
+            def encode_test_path_component component
+              component.to_s.gsub('%', '%25').gsub('=', '%3D').gsub('#', '%23').gsub('&', '%26')
+            end
+          end
+
+          class JSONStreamWriter
+            class TestCaseWriter
+              def initialize(file, indent)
+                @file = file
+                @indent = indent
+                @file.puts
+                @indent += 2
+                write_indent
+                @file.puts("{")
+                @indent += 2
+                @writer = KeyValueWriter.new(file, @indent)
+              end
+
+              def write_test_path_components(components)
+                @writer.open_array("testPathComponents") do
+                  components.each {|component|
+                    @writer.open_nested_object do |obj_writer|
+                      obj_writer.write_key_value("type", component[:type])
+                      obj_writer.write_key_value("name", component[:name])
+                    end
+                  }
+                end
+              end
+
+              def write_duration(duration)
+                @writer.write_key_value("duration", duration)
+              end
+
+              def write_status(status)
+                @writer.write_key_value("status", status)
+              end
+
+              def write_stdout(stdout)
+                @writer.write_key_value("stdout", stdout)
+              end
+
+              def write_stderr(stderr)
+                @writer.write_key_value("stderr", stderr)
+              end
+
+              def write_created_at(created_at)
+                @writer.write_key_value("createdAt", created_at)
+              end
+
+              def close
+                @writer.close
+              end
+
+              def write_indent
+                @file.write(" " * @indent)
+              end
+            end
+
+            class KeyValueWriter
+              def initialize(file, indent)
+                @indent = indent
+                @file = file
+                @is_first_key_val = true
+                @is_first_element = true
+              end
+
+              def write_key_value(key, value)
+                if @is_first_key_val
+                  @is_first_key_val = false
+                else
+                  write_comma
+                end
+                @file.puts
+                write_indent
+                @file.write(to_json_str(key))
+                @file.write(":", " ")
+                @file.write(to_json_str(value))
+              end
+
+              def open_nested_object
+                @file.puts("{")
+                @indent += 2
+                @writer = KeyValueWriter.new(file, @indent)
+              end
+
+              def open_nested_object
+                if @is_first_element
+                  @is_first_element = false
+                else
+                  write_comma
+                end
+                @indent += 2
+                @file.puts
+                write_indent
+                @file.write("{")
+                @indent += 2
+                yield KeyValueWriter.new(@file, @indent)
+                @indent -= 2
+                @file.puts
+                write_indent
+                @file.write("}")
+                @is_first_key_val = false
+                @indent -= 2
+              end
+
+              def close
+                @indent -= 2
+                @file.puts
+                write_indent
+                @file.write("}")
+              end
+
+              def open_array(key)
+                if @is_first_key_val
+                  @is_first_key_val = false
+                else
+                  write_comma
+                end
+                write_indent
+                @file.write(to_json_str(key))
+                write_colon
+                @file.write(" ")
+                @file.write("[")
+                yield
+                @file.puts
+                write_indent
+                @file.write("]")
+              end
+
+              def close_array
+                @file.puts
+                write_indent
+                @file.puts("]")
+              end
+
+              private
+
+              def write_comma
+                @file.write(',')
+              end
+
+              def write_indent
+                @file.write(" " * @indent)
+              end
+  
+              def to_json_str(obj)
+                ::JSON.dump(obj)
+              end
+
+              def write_colon
+                @file.write(":")
+              end
+            end
+
+            class ArrayWriter
+              def initialize(file, indent)
+                @indent = indent
+                @file = file
+                @is_first_element = true
+              end
+
+              def open_array(key)
+                write_indent
+                @file.write(to_json_str(key))
+                write_colon
+                @file.write(" ")
+                @file.write("[")
+              end
+
+              def close_array
+                @file.puts
+                write_indent
+                @file.puts("]")
+              end
+
+              private
+
+              def write_comma
+                @file.write(',')
+              end
+
+              def write_indent
+                @file.write(" " * @indent)
+              end
+
+              def write_colon
+                @file.write(":")
+              end
+
+              def to_json_str(obj)
+                ::JSON.dump(obj)
+              end
+            end
+
+            def initialize path
+              @file = File.open(path, "w")
+              @indent = 2
+              @file.puts("{")
+              write_indent
+              open_array("testCases")
+              @file.flush
+              @is_first_nested_obj = true
+            end
+
+            def write_test_case
+              if @is_first_nested_obj
+                @is_first_nested_obj = false
+              else
+                write_comma
+              end
+              # @file.puts
+              # @indent += 2
+              # write_indent
+              # @file.puts("{")
+              writer = TestCaseWriter.new(@file, @indent)
+              yield writer
+              # @file.puts
+              # write_indent
+              # @file.write("}")
+              # @indent -= 2
+              writer.close
+            end
+
+            def close
+              close_array
+              @file.puts("}")
+              @file.flush
+              @file.close
+            end
+
+            private
+
+            def open_array(key)
+              @file.write(to_json_str(key))
+              write_colon
+              @file.write(" ")
+              @file.write("[")
+            end
+
+            def close_array
+              @file.puts
+              write_indent
+              @file.puts("]")
+            end
+
+            def write_indent
+              @file.write(" " * @indent)
+            end
+
+            def write_colon
+              @file.write(":")
+            end
+
+            def write_comma
+              @file.write(',')
+            end
+
+            def to_json_str(obj)
+              ::JSON.dump(obj)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/test/unit/launchable.rbs

@@ -0,0 +1,8 @@
+module Test
+  module Unit
+    module Launchable
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: test-unit-launchable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naoto Ono
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: test-unit-launchable is a convinient plugin for test-unit that generates
+  a Launchable test report file based on the test results.
+email:
+- onoto1998@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/test/unit/launchable/version.rb
+- lib/test/unit/runner/launchable.rb
+- lib/test/unit/ui/launchable/json/testrunner.rb
+- sig/test/unit/launchable.rbs
+homepage: https://github.com/ono-max/test-unit-launchable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ono-max/test-unit-launchable
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: test-unit plugin that generates a Launchable test report file
+test_files: []