sus 0.17.2 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b86dafae68ebeadfd3e2b7aa2f94e955a05f9b65bf3fcaf1dfdd65a8822a0722
-  data.tar.gz: 7714b5ca6dbac3f8a68f386a369c152c2086e1b9d907040c3163f4f7df8b2670
+  metadata.gz: e39bdf28a3135bf28cf66714d3ac2998c1c863e979c172573a3e5e509de2246e
+  data.tar.gz: 88273ca646abe719cb562693f233d6210d8e505456ae8dd663d74971086d33b7
 SHA512:
-  metadata.gz: 1d35bd5af4e176105da748d46df24d101e828bd579f6daa32f1907909daa8401abdd73d0bb8f63195ac2c5c787db8af56ec1d7c7131947e0553a7005db0127c6
-  data.tar.gz: 510e795dfe14659e2dc2ab166a546c1547b26d2c1476595260ee67124c5d01e162223196057e22635317cac382d399e36a46f8487b6bdc98baa29867b4606966
+  metadata.gz: eca3ca7daddbc30591698658f6d87cc11a56c9dee2456b1060339fe1442aa5d8479a11ccdf7d9f4e7d617478ff033b0c24482db8d8145b7046e69a106a75409c
+  data.tar.gz: 2df536e6206a37f475bde130d8a6f8f4f8c8eab49a3ea2f7d29f48b4a64b53d6145cc77c27f2105043385756cc8d44d34983334a6de633c5c8d78275777b1ee7

data/bin/sus-host

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+
+require 'json'
+
+require_relative '../lib/sus/config'
+config = Sus::Config.load
+
+require_relative '../lib/sus'
+
+verbose = false
+guard = Thread::Mutex.new
+
+require 'etc'
+count = Etc.nprocessors
+
+$stdout.sync = true
+
+input = $stdin.dup
+$stdin.reopen(File::NULL)
+output = $stdout.dup
+$stdout.reopen($stderr)
+
+def failure_messages_for(assertions)
+	messages = []
+	
+	assertions.each_failure do |failure|
+		messages << failure.message
+	end
+	
+	return messages
+end
+
+while line = input.gets
+	message = JSON.parse(line)
+	
+	if tests = message['run']
+		jobs = Thread::Queue.new
+		results = Thread::Queue.new
+		
+		top = Sus::Assertions.new(measure: true)
+		config.before_tests(top)
+		
+		aggregate = Thread.new do
+			while result = results.pop
+				top.add(result)
+			end
+		end
+		
+		loader = Thread.new do
+			registry = config.load_registry(tests)
+			
+			registry.each do |child|
+				jobs << child
+			end
+			
+			jobs.close
+		end
+		
+		workers = count.times.map do |index|
+			Thread.new do
+				while job = jobs.pop
+					guard.synchronize do
+						output.puts JSON.generate({started: job.identity})
+					end
+					
+					assertions = Sus::Assertions.new(measure: true)
+					job.call(assertions)
+					results.push(assertions)
+					
+					guard.synchronize do
+						if assertions.passed?
+							output.puts JSON.generate({passed: job.identity, duration: assertions.clock.ms})
+						elsif assertions.errored?
+							output.puts JSON.generate({errored: job.identity, messages: failure_messages_for(assertions), duration: assertions.clock.ms})
+						else
+							output.puts JSON.generate({failed: job.identity, messages: failure_messages_for(assertions), duration: assertions.clock.ms})
+						end
+					end
+				end
+			end
+		end
+		
+		loader.join
+		workers.each(&:join)
+		results.close
+		
+		aggregate.join
+		config.after_tests(top)
+		
+		workers.each(&:join)
+		
+		if config.respond_to?(:covered)
+			if covered = config.covered and covered.record?
+				covered.policy.each do |coverage|
+					output.puts JSON.generate({coverage: coverage.path, counts: coverage.counts})
+				end
+			end
+		end
+		
+		output.puts JSON.generate({finished: true, message: top.output.string, duration: top.clock.ms})
+	else
+		$stderr.puts "Unknown message: #{message}"
+	end
+end

data/bin/sus-tree

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'json'
+
+require_relative '../lib/sus/config'
+config = Sus::Config.load
+
+require_relative '../lib/sus'
+
+verbose = false
+registry = config.registry
+puts Sus::Tree.new(registry.base).to_json

data/lib/sus/assertions.rb

@@ -41,6 +41,7 @@ module Sus
 			@count = 0
 		end
 		
+		attr :identity
 		attr :target
 		attr :output
 		attr :level
@@ -75,6 +76,13 @@ module Sus
 			"\#<#{self.class} #{@passed.size} passed #{@failed.size} failed #{@deferred.size} deferred #{@skipped.size} skipped #{@errored.size} errored>"
 		end
 		
+		def message
+			{
+				text: @output.string,
+				location: @identity&.to_location
+			}
+		end
+		
 		def total
 			@passed.size + @failed.size + @deferred.size + @skipped.size + @errored.size
 		end
@@ -138,24 +146,65 @@ module Sus
 			@errored.any?
 		end
 		
+		class Assert
+			def initialize(identity, message)
+				@identity = identity
+				@message = message
+			end
+			
+			attr :identity
+			attr :message
+			
+			def each_failure(&block)
+				yield self
+			end
+			
+			def message
+				{
+					text: @message,
+					location: @identity&.to_location
+				}
+			end
+		end
+		
 		def assert(condition, message = nil)
 			@count += 1
 			
+			message ||= self.output.string
+			backtrace = Output::Backtrace.first(@identity)
+			identity = @identity&.scoped
+			
 			if condition
-				@passed << self
+				@passed << Assert.new(identity, message)
 				
 				if !@orientation || @verbose
-					@output.puts(:indent, *pass_prefix, message || "assertion", Output::Backtrace.first(@identity))
+					@output.puts(:indent, *pass_prefix, message, backtrace)
 				end
 			else
-				@failed << self
+				@failed << Assert.new(identity, message)
 				
 				if @orientation || @verbose
-					@output.puts(:indent, *fail_prefix, message || "assertion", Output::Backtrace.first(@identity))
+					@output.puts(:indent, *fail_prefix, message, backtrace)
 				end
 			end
 		end
 		
+		def each_failure(&block)
+			return to_enum(__method__) unless block_given?
+			
+			# if self.failed? and @identity
+			# 	yield self
+			# end
+			
+			@failed.each do |assertions|
+				assertions.each_failure(&block)
+			end
+			
+			@errored.each do |assertions|
+				assertions.each_failure(&block)
+			end
+		end
+		
 		def skip(reason)
 			@output.puts(:indent, :skipped, skip_prefix, reason)
 			@skipped << self
@@ -184,8 +233,31 @@ module Sus
 			end
 		end
 		
+		class Error
+			def initialize(identity, error)
+				@identity = identity
+				@error = error
+			end
+			
+			attr :identity
+			attr :error
+			
+			def each_failure(&block)
+				yield self
+			end
+			
+			def message
+				{
+					text: @error.message,
+					location: @identity&.to_location
+				}
+			end
+		end
+		
 		def error!(error)
-			@errored << self
+			identity = @identity.scoped(error.backtrace_locations)
+			
+			@errored << Error.new(identity, error)
 			
 			lines = error.message.split(/\r?\n/)
 			
@@ -198,11 +270,11 @@ module Sus
 			@output.write(Output::Backtrace.for(error, @identity))
 		end
 		
-		def nested(target, identity: @identity, isolated: false, inverted: false, **options)
+		def nested(target, identity: @identity, isolated: false, buffered: false, inverted: false, **options)
 			result = nil
 			
 			# Isolated assertions need to have buffered output so they can be replayed if they fail:
-			if isolated
+			if isolated or buffered
 				output = @output.buffered
 			else
 				output = @output

data/lib/sus/base.rb

@@ -39,12 +39,13 @@ module Sus
 		end
 	end
 	
-	def self.base(description = nil)
+	def self.base(description = nil, root: nil)
 		base = Class.new(Base)
 		
 		base.extend(Context)
+		base.identity = Identity.new(root) if root
 		base.description = description
-				
+		
 		return base
 	end
 end

data/lib/sus/clock.rb

@@ -33,6 +33,10 @@ module Sus
 			duration
 		end
 		
+		def ms
+			duration * 1000.0
+		end
+		
 		def to_s
 			duration = self.duration
 			
@@ -45,6 +49,10 @@ module Sus
 			end
 		end
 		
+		def reset!(duration = 0.0)
+			@duration = duration
+		end
+		
 		def start!
 			@start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 		end

data/lib/sus/config.rb

@@ -82,12 +82,12 @@ module Sus
 			@registry ||= self.load_registry
 		end
 		
-		def load_registry
-			registry = Sus::Registry.new
+		def load_registry(paths = @paths)
+			registry = Sus::Registry.new(root: @root)
 			
-			if @paths&.any?
+			if paths&.any?
 				registry = Sus::Filter.new(registry)
-				@paths.each do |path|
+				paths.each do |path|
 					registry.load(path)
 				end
 			else
@@ -99,42 +99,41 @@ module Sus
 			return registry
 		end
 		
-		def before_tests(assertions)
+		def before_tests(assertions, output: self.output)
+			@clock.reset!
 			@clock.start!
 		end
 		
-		def after_tests(assertions)
+		def after_tests(assertions, output: self.output)
 			@clock.stop!
 			
-			self.print_summary(assertions)
+			self.print_summary(output, assertions)
 		end
 		
 		protected
 		
-		def print_summary(assertions)
-			output = self.output
-			
+		def print_summary(output, assertions)
 			assertions.print(output)
 			output.puts
 			
-			print_finished_statistics(assertions)
+			print_finished_statistics(output, assertions)
 			
 			if !partial? and assertions.passed?
-				print_test_feedback(assertions)
+				print_test_feedback(output, assertions)
 			end
 			
-			print_slow_tests(assertions)
-			print_failed_assertions(assertions)
+			print_slow_tests(output, assertions)
+			print_failed_assertions(output, assertions)
 		end
 		
-		def print_finished_statistics(assertions)
+		def print_finished_statistics(output, assertions)
 			duration = @clock.duration
 			rate = assertions.count / duration
 			
 			output.puts "🏁 Finished in ", @clock, "; #{rate.round(3)} assertions per second."
 		end
 		
-		def print_test_feedback(assertions)
+		def print_test_feedback(output, assertions)
 			duration = @clock.duration
 			rate = assertions.count / duration
 			
@@ -179,7 +178,7 @@ module Sus
 			end
 		end
 		
-		def print_slow_tests(assertions, threshold = 0.1)
+		def print_slow_tests(output, assertions, threshold = 0.1)
 			slowest_tests = assertions.passed.select{|test| test.clock > threshold}.sort_by(&:clock).reverse!
 			
 			if slowest_tests.empty?
@@ -193,7 +192,7 @@ module Sus
 			end
 		end
 		
-		def print_assertions(title, assertions)
+		def print_assertions(output, title, assertions)
 			if assertions.any?
 				output.puts
 				output.puts title
@@ -206,9 +205,9 @@ module Sus
 			end
 		end
 		
-		def print_failed_assertions(assertions)
-			print_assertions("🤔 Failed assertions:", assertions.failed)
-			print_assertions("🔥 Errored assertions:", assertions.errored)
+		def print_failed_assertions(output, assertions)
+			print_assertions(output, "🤔 Failed assertions:", assertions.failed)
+			print_assertions(output, "🔥 Errored assertions:", assertions.errored)
 		end
 	end
 end

data/lib/sus/expect.rb

@@ -5,14 +5,16 @@
 
 module Sus
 	class Expect
-		def initialize(assertions, subject, inverted: false)
+		def initialize(assertions, subject, inverted: false, buffered: false)
 			@assertions = assertions
 			@subject = subject
 			@inverted = inverted
+			@buffered = buffered
 		end
-
+		
 		attr :subject
 		attr :inverted
+		attr :assertions
 		
 		def not
 			self.dup.tap do |expect|
@@ -31,13 +33,16 @@ module Sus
 		end
 		
 		def to(predicate)
-			@assertions.nested(self, inverted: @inverted) do |assertions|
+			# This gets the identity scoped to the current call stack, which ensures that any failures are logged at this point in the code.
+			identity = @assertions.identity&.scoped
+			
+			@assertions.nested(self, inverted: @inverted, buffered: @buffered, identity: identity) do |assertions|
 				predicate.call(assertions, @subject)
 			end
 			
 			return self
 		end
-
+		
 		def and(predicate)
 			return to(predicate)
 		end
@@ -46,9 +51,9 @@ module Sus
 	class Base
 		def expect(subject = nil, &block)
 			if block_given?
-				Expect.new(@__assertions__, block)
+				Expect.new(@__assertions__, block, buffered: true)
 			else
-				Expect.new(@__assertions__, subject)
+				Expect.new(@__assertions__, subject, buffered: true)
 			end
 		end
 	end

data/lib/sus/file.rb

@@ -19,11 +19,17 @@ module Sus
 		
 		def self.build(parent, path)
 			base = Class.new(parent)
+			
 			base.extend(File)
 			base.description = path
-			base.identity = Identity.new(path)
+			base.identity = Identity.file(parent.identity, path)
 			
-			TOPLEVEL_CLASS_EVAL.call(base, path)
+			begin
+				TOPLEVEL_CLASS_EVAL.call(base, path)
+			rescue StandardError, LoadError, SyntaxError => error
+				# We add this as a child of the base class so that it is included in the tree under the file rather than completely replacing it, which can be confusing:
+				base.add FileLoadError.build(self, path, error)
+			end
 			
 			return base
 		end
@@ -35,7 +41,8 @@ module Sus
 	
 	class FileLoadError
 		def self.build(parent, path, error)
-			self.new(Identity.new(path), path, error)
+			identity = Identity.file(parent.identity, path).scoped(error.backtrace_locations)
+			self.new(identity, path, error)
 		end
 		
 		def initialize(identity, path, error)
@@ -50,6 +57,16 @@ module Sus
 			true
 		end
 		
+		EMPTY = Hash.new.freeze
+		
+		def children
+			EMPTY
+		end
+		
+		def description
+			@path
+		end
+		
 		def print(output)
 			output.write("file ", :path, @identity)
 		end
@@ -66,8 +83,6 @@ module Sus
 	module Context
 		def file(path)
 			add File.build(self, path)
-		rescue StandardError, LoadError, SyntaxError => error
-			add FileLoadError.build(self, path, error)
 		end
 	end
 end

data/lib/sus/identity.rb

@@ -5,6 +5,10 @@
 
 module Sus
 	class Identity
+		def self.file(parent, path, name = path, **options)
+			self.new(path, name, nil, nil, **options)
+		end
+		
 		def self.nested(parent, name, location = nil, **options)
 			location ||= caller_locations(3...4).first
 			
@@ -32,6 +36,13 @@ module Sus
 			self.key
 		end
 		
+		def to_location
+			{
+				path: ::File.expand_path(@path),
+				line: @line,
+			}
+		end
+		
 		def inspect
 			"\#<#{self.class} #{self.to_s}>"
 		end
@@ -69,8 +80,33 @@ module Sus
 			return @key
 		end
 		
+		# Given a set of locations, find the first one which matches this identity and return a new identity with the updated line number. This can be used to extract a location from a backtrace.
+		def scoped(locations = nil)
+			if locations
+				# This code path is normally taken if we've got an exception with a backtrace:
+				locations.each do |location|
+					if location.path == @path
+						return self.with_line(location.lineno)
+					end
+				end
+			else
+				# In theory this should be a bit faster:
+				Thread.each_caller_location do |location|
+					if location.path == @path
+						return self.with_line(location.lineno)
+					end
+				end
+			end
+			
+			return self
+		end
+		
 		protected
 		
+		def with_line(line)
+			Identity.new(@path, @name, line, @parent, unique: @unique)
+		end
+		
 		def append_unique_key(key, unique = @unique)
 			if @parent
 				@parent.append_unique_key(key)

data/lib/sus/output/buffered.rb

@@ -30,14 +30,12 @@ module Sus
 				self.class.new(self)
 			end
 			
-			attr :output
-			
 			def each(&block)
 				@chunks.each(&block)
 			end
 			
 			def append(buffer)
-				@chunks.concat(buffer.output)
+				@chunks.concat(buffer.chunks)
 				@tee&.append(buffer)
 			end
 			

data/lib/sus/registry.rb

@@ -23,16 +23,21 @@ module Sus
 		DIRECTORY_GLOB = "**/*.rb"
 		
 		# Create a top level scope with self as the instance:
-		def initialize(base = Sus.base(self))
-			@base = base
+		def initialize(**options)
+			@base = Sus.base(self, **options)
+			@loaded = {}
 		end
-		
+
 		attr :base
 		
 		def print(output)
 			output.write("Test Registry")
 		end
 		
+		def to_s
+			@base.identity.to_s
+		end
+		
 		def load(path)
 			if ::File.directory?(path)
 				load_directory(path)
@@ -42,7 +47,7 @@ module Sus
 		end
 		
 		private def load_file(path)
-			@base.file(path)
+			@loaded[path] ||= @base.file(path)
 		end
 		
 		private def load_directory(path)

data/lib/sus/tree.rb

@@ -0,0 +1,27 @@
+module Sus
+	class Tree
+		def initialize(context)
+			@context = context
+		end
+		
+		def traverse(current = @context, &block)
+			node = {}
+			
+			node[:self] = yield(current)
+			
+			if children = current.children # and children.any?
+				node[:children] = children.values.map do |context|
+					self.traverse(context, &block)
+				end
+			end
+			
+			return node
+		end
+		
+		def to_json(options = nil)
+			traverse do |context|
+				[context.identity, context.description, context.leaf?]
+			end.to_json(options)
+		end
+	end
+end

data/lib/sus/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2021-2022, by Samuel Williams.
 
 module Sus
-	VERSION = "0.17.2"
+	VERSION = "0.18.1"
 end

data/lib/sus.rb

@@ -7,6 +7,7 @@ require_relative 'sus/version'
 require_relative 'sus/config'
 require_relative 'sus/registry'
 require_relative 'sus/assertions'
+require_relative 'sus/tree'
 
 require_relative 'sus/expect'
 require_relative 'sus/be'

data.tar.gz.sig

@@ -1,4 +1,2 @@
-.��4����RZM��3��d�Z�	�Q�;Q���Du+���J�Q�6`�1G��`z��뤫��aJ����ޏ�
-�;E���<� F�L��܀q=x��i!�X�_�p����H��[}N�q$P���H���6�k3ɹ)��>�A`�P;�:6�#�=#)� �����:�k(a��л���b�u�!&%�wiQ2�\O�	L��c��1T�	^�LJ�ؘ��y��
-ǜ���Դ���2w�D1�}�yOy`��b��.yG��qJc����M
-X񯶅*�e�
+am�����tJ��)�p����Bn�ɠϝռ:����*����-TIV�3#AFH�pg�a�WY��*k5�:�4^�>z�I�=UD,ϑk*�8�t�۳nb"��k��~�k(x�&}���M-�c�H��̚���kΑ�
+��P߾��D;q�����!��� �L7V�����d���^�@s��?kF� ��:-�a�3ag��=\{�<����#!ȔDI����p����kvM�$��K`�zP��jOם¡�)bѽ/��y�#���թ��

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.18.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-02-18 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake-test
@@ -87,11 +87,15 @@ email:
 executables:
 - sus
 - sus-parallel
+- sus-tree
+- sus-host
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/sus
+- bin/sus-host
 - bin/sus-parallel
+- bin/sus-tree
 - lib/sus.rb
 - lib/sus/assertions.rb
 - lib/sus/base.rb
@@ -131,6 +135,7 @@ files:
 - lib/sus/registry.rb
 - lib/sus/respond_to.rb
 - lib/sus/shared.rb
+- lib/sus/tree.rb
 - lib/sus/version.rb
 - lib/sus/with.rb
 - license.md