test_bench-executable 3.0.0.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3361ac46c2f4a7c781487b6cb0bd2cbba8e42641e9c65f6f79c818dc4d117c10
+  data.tar.gz: 4e880c8bd7c350be520d97090576aff3ec1df15d1ed7fb554c8afb6514258e21
+SHA512:
+  metadata.gz: 73653a1db9633eafb8c2f78a5fc23d40e91db825ef926223601812f28ce994aa4c60a15951997e9ff1ce35701b7f2d649642709334033de4c780ae409bd047e2
+  data.tar.gz: 3a1b01385a0711606330638591c9ef1bed953efc2da99f7f6cc6f9efe03c799317c460c1e5deaddbd799ae35d62420268f822e74b3713bf8133b6683d77327b2

data/executables/bench

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'test_bench'
+
+exit_code = TestBench::Executable.()
+
+exit(exit_code)

data/lib/test_bench/executable/controls/path.rb

@@ -0,0 +1,7 @@
+module TestBench
+  class Executable
+    module Controls
+      Path = Run::Path
+    end
+  end
+end

data/lib/test_bench/executable/controls/random.rb

@@ -0,0 +1,7 @@
+module TestBench
+  class Executable
+    module Controls
+      Random = Run::Random
+    end
+  end
+end

data/lib/test_bench/executable/controls/run.rb

@@ -0,0 +1,10 @@
+module TestBench
+  class Executable
+    module Controls
+      module Run
+        Path = TestBench::Run::Controls::Path
+        Random = TestBench::Run::Controls::Random
+      end
+    end
+  end
+end

data/lib/test_bench/executable/controls/standard_input.rb

@@ -0,0 +1,29 @@
+module TestBench
+  class Executable
+    module Controls
+      module StandardInput
+        module Create
+          def self.call(*paths)
+            if paths.empty?
+              paths = Path.examples
+            end
+
+            content = <<~TEXT
+            #{paths.join("\n")}
+            TEXT
+
+            file = Session::Controls::Path::File::Create.(content)
+
+            ::File.open(file, 'r')
+          end
+
+          def self.contents
+            <<~TEXT
+            #{Path.example}
+            TEXT
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/executable/controls.rb

@@ -0,0 +1,8 @@
+require 'test_bench/run/controls'
+
+require 'test_bench/executable/controls/run'
+
+require 'test_bench/executable/controls/path'
+require 'test_bench/executable/controls/random'
+
+require 'test_bench/executable/controls/standard_input'

data/lib/test_bench/executable/defaults.rb

@@ -0,0 +1,13 @@
+module TestBench
+  class Executable
+    module Defaults
+      def self.path
+        ENV.fetch('TEST_BENCH_DEFAULT_TEST_PATH', 'test/automated')
+      end
+
+      def self.program_name
+        $PROGRAM_NAME || 'bench'
+      end
+    end
+  end
+end

data/lib/test_bench/executable/executable.rb

@@ -0,0 +1,59 @@
+module TestBench
+  class Executable
+    def run
+      @run ||= Run::Substitute.build
+    end
+    attr_writer :run
+
+    def arguments
+      @arguments ||= []
+    end
+    attr_writer :arguments
+
+    def stdin
+      @stdin ||= STDIN
+    end
+    attr_writer :stdin
+
+    def self.build(arguments=nil, env: nil)
+      instance = new
+
+      arguments = ParseArguments.(arguments, env:)
+      instance.arguments = arguments
+
+      Run.configure(instance)
+
+      instance
+    end
+
+    def self.call(arguments=nil, env: nil)
+      instance = build(arguments, env:)
+      instance.()
+    end
+
+    def call
+      result = run.() do
+        if not stdin.tty?
+          until stdin.eof?
+            path = stdin.gets(chomp: true)
+
+            next if path.empty?
+
+            run << path
+          end
+        end
+
+        arguments.each do |path|
+          run << path
+        end
+
+        if not run.ran?
+          run << Defaults.path
+        end
+      end
+
+      exit_code = result ? 0 : 1
+      exit_code
+    end
+  end
+end

data/lib/test_bench/executable/parse_arguments.rb

@@ -0,0 +1,269 @@
+module TestBench
+  class Executable
+    class ParseArguments
+      Error = Class.new(RuntimeError)
+
+      def writer
+        @writer ||= Output::Writer::Substitute.build
+      end
+      attr_writer :writer
+
+      def env
+        @env ||= {}
+      end
+      attr_writer :env
+
+      def non_switch_arguments
+        @non_switch_arguments ||= []
+      end
+
+      attr_reader :raw_arguments
+
+      def initialize(raw_arguments)
+        @raw_arguments = raw_arguments
+      end
+
+      def self.build(arguments=nil, env: nil)
+        arguments ||= ::ARGV
+        env ||= ::ENV
+
+        instance = new(arguments)
+
+        instance.env = env
+
+        Output::Writer.configure(instance)
+
+        instance
+      end
+
+      def self.call(arguments=nil, env: nil)
+        instance = build(arguments, env:)
+        instance.()
+      end
+
+      def call
+        loop do
+          switch = next_switch
+
+          case switch
+          when '--', nil
+            break
+
+          when '-a', '--abort-on-failure'
+            env['TEST_BENCH_ABORT_ON_FAILURE'] = 'on'
+
+          when '-x', '--exclude'
+            exclude_pattern = require_next_argument(switch)
+
+            env['TEST_BENCH_EXCLUDE_FILE_PATTERN'] = [
+              env['TEST_BENCH_EXCLUDE_FILE_PATTERN'],
+              exclude_pattern
+            ].compact.join(':')
+          when '-X', '--no-exclude'
+            env['TEST_BENCH_EXCLUDE_FILE_PATTERN'] = ''
+
+          when '-s', '--strict'
+            env['TEST_BENCH_STRICT'] = 'on'
+          when '-S', '--no-strict'
+            env['TEST_BENCH_STRICT'] = 'off'
+
+          when '-r', '--require'
+            library = require_next_argument(switch)
+            require(library)
+          when '-I', '--include'
+            load_path = require_next_argument(switch)
+            if not $LOAD_PATH.include?(load_path)
+              $LOAD_PATH << load_path
+            end
+
+          when '--random-seed'
+            seed = require_next_argument(switch)
+            env['TEST_BENCH_RANDOM_SEED'] = seed
+
+          when '-b', '--omit-backtrace'
+            omit_pattern = require_next_argument(switch)
+
+            env['TEST_BENCH_OMIT_BACKTRACE_PATTERN'] = [
+              env['TEST_BENCH_OMIT_BACKTRACE_PATTERN'],
+              omit_pattern
+            ].compact.join(':')
+
+          when '-d', '--detail'
+            env['TEST_BENCH_OUTPUT_DETAIL'] = 'on'
+          when '-D', '--no-detail'
+            env['TEST_BENCH_OUTPUT_DETAIL'] = 'off'
+
+          when '--device'
+            device = require_next_argument(switch)
+            env['TEST_BENCH_OUTPUT_DEVICE'] = device
+
+          when '-l', '--output-level'
+            output_level = require_next_argument(switch)
+            env['TEST_BENCH_OUTPUT_LEVEL'] = output_level
+          when '-q', '--quiet'
+            env['TEST_BENCH_OUTPUT_LEVEL'] = 'not-passing'
+
+          when '-o', '--output-styling'
+            env['TEST_BENCH_OUTPUT_STYLING'] = 'on'
+          when '-O', '--no-output-styling'
+            env['TEST_BENCH_OUTPUT_STYLING'] = 'off'
+
+          when '--no-summary'
+            env['TEST_BENCH_OUTPUT_SUMMARY'] = 'off'
+
+          when '-h', '--help'
+            writer.write(<<~TEXT)
+Usage: #{Defaults.program_name} [options] [paths]
+
+Informational Options:
+  Help:
+      -h, --help
+          Print this help message and exit immediately
+
+Execution Options:
+  Abort On Failure:
+      -a, --abort-on-failure
+          Stops execution if a test fails or a test file aborts
+
+  Exclude File Patterns:
+      -x, --exclude PATTERN
+          Exclude test files that match PATTERN
+          If multiple --exclude arguments are supplied, then files that match any will be excluded
+      -X, --no-exclude
+          Don't exclude any files
+      Default: '*_init.rb'
+
+  Strict:
+      -s, --strict
+          Prohibit skipped tests and contexts, and require at least one test to be performed
+      -S, --no-strict
+          Relax strictness
+      Default: non strict, unless TEST_BENCH_STRICT is set to 'on'
+
+  Require Library:
+      -r, --require LIBRARY
+          Require LIBRARY before running any files
+      -I, --include DIR
+          Add DIR to the load path
+
+  Random Seed:
+      --random-seed SEED
+          Pseudorandom number seed
+
+Output Options:
+  Backtrace Formatting:
+      -b, --omit-backtrace PATTERN
+          Omits backtrace frames that match PATTERN
+          If multiple --omit-backtrace arguments are supplied, then frames that match any will be omitted
+
+  Detail:
+      -d, --detail
+          Always show details
+      -D, --no-detail
+          Never show details
+      Default: print details when their surrounding context failed, unless TEST_DETAIL is set to 'on' or 'off'
+
+  Device:
+      --device DEVICE
+          stderr: redirect output to standard error
+          null: don't write any output
+      Default: stdout
+
+  Verbosity:
+      -l, --output-level LEVEL
+          all: print output from every file
+          not-passing: print output from files that skip tests and contexts or don't perform any tests
+          failure: print output only from files that failed or aborted
+          abort: print output only from file that aborted
+      -q, --quiet
+          Sets output verbosity level to 'not-passing'
+      Default: all
+
+  Styling:
+      -o, --output-styling
+          Enable output text styling
+      -O, --no-output-styling
+          Disable output text styling
+      Default: enabled if the output device is an interactive terminal
+
+  Summary:
+      --no-summary
+          Don't print summary after running files
+
+Paths to test files (and directories containing test files) can be given after any command line arguments or via STDIN (or both).
+
+If no paths are given, the directory '#{Defaults.path}' is scanned for test files.
+
+The following environment variables can also control execution:
+
+  TEST_BENCH_ABORT_ON_FAILURE           See --abort-on-failure
+  TEST_BENCH_EXCLUDE_FILE_PATTERN       See --exclude
+  TEST_BENCH_OUTPUT_SUMMARY             See --no-summary
+  TEST_BENCH_STRICT                     See --strict
+  TEST_BENCH_RANDOM_SEED                See --random-seed
+  TEST_BENCH_FILTER_BACKTRACE_PATTERN   See --filter-backtrace
+  TEST_BENCH_OUTPUT_DETAIL              See --detail
+  TEST_BENCH_OUTPUT_DEVICE              See --device
+  TEST_BENCH_OUTPUT_LEVEL               See --output-level
+  TEST_BENCH_OUTPUT_STYLING             See --output-styling
+  TEST_BENCH_DEFAULT_TEST_PATH          Specifies default path
+
+            TEXT
+            exit(true)
+
+          else
+            raise Error, "Incorrect switch #{switch}"
+          end
+        end
+
+        remaining_arguments
+      end
+
+      def remaining_arguments
+        non_switch_arguments + raw_arguments
+      end
+      alias :arguments :remaining_arguments
+
+      def require_next_argument(switch_text)
+        argument = next_argument
+
+        if argument.nil?
+          raise Error, "Switch #{switch_text} requires an argument"
+        end
+
+        argument
+      end
+
+      def next_argument
+        next_argument = raw_arguments.shift
+
+        if next_argument.nil?
+          nil
+        elsif switch?(next_argument)
+          raw_arguments.unshift(next_argument)
+          nil
+        else
+          next_argument
+        end
+      end
+
+      def next_switch
+        until raw_arguments.empty?
+          argument = raw_arguments.shift
+
+          if switch?(argument)
+            return argument
+          end
+
+          non_switch_arguments << argument
+        end
+
+        nil
+      end
+
+      def switch?(argument)
+        argument.start_with?('-')
+      end
+    end
+  end
+end

data/lib/test_bench/executable.rb

@@ -0,0 +1,7 @@
+require 'test_bench/run'
+
+require 'test_bench/executable/defaults'
+
+require 'test_bench/executable/parse_arguments'
+
+require 'test_bench/executable/executable'

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: test_bench-executable
+version: !ruby/object:Gem::Version
+  version: 3.0.0.0.pre.1
+platform: ruby
+authors:
+- Brightworks Digital
+bindir: executables
+cert_chain: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test_bench-run
+  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: test_bench-bootstrap
+  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: Command line interface for TestBench.
+email: development@bright.works
+executables:
+- bench
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/test_bench
+- lib/test_bench/executable
+- lib/test_bench/executable/controls
+- lib/test_bench/executable/controls/path.rb
+- lib/test_bench/executable/controls/random.rb
+- lib/test_bench/executable/controls/run.rb
+- lib/test_bench/executable/controls/standard_input.rb
+- lib/test_bench/executable/controls.rb
+- lib/test_bench/executable/defaults.rb
+- lib/test_bench/executable/executable.rb
+- lib/test_bench/executable/parse_arguments.rb
+- lib/test_bench/executable.rb
+homepage: http://test-bench.software
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://test-bench.software
+  source_code_uri: https://github.com/test-bench-demo/test-bench-executable
+  allowed_push_host: https://rubygems.org
+  namespace: TestBench::Executable
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Command line interface for TestBench
+test_files: []