bake-test-external 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47a071dbbd5823bf15e24a29988176668f249f0a5449e527ae7ea6353e1e8a93
-  data.tar.gz: d4fc771066257b210e74233c5456cacea65707f4fe5708685400065cd09bc67f
+  metadata.gz: a468b46f1192614e834259be98b4938d9ee453233a4e5f30e80b54690e0a0605
+  data.tar.gz: 193a7447f7e4542a26607c04513f0de72a2897d61a15424de4a6c162e8c12c33
 SHA512:
-  metadata.gz: ab045efb381fcd9e61f7d00eeb056e634cfd42292122104154908959dc39dd0dd74e27350a550032991deae542cabc7a9975eaa2083e25cf4cf8ba82b105fc14
-  data.tar.gz: e1d4e308a5e717dd1fd95b58b25dc60ab4606dcb399d1f2d5928f03603d22f1770711bb6c4c8d2a7fc6c7c809e091b959425068aacce6cc582e94b34de1845aa
+  metadata.gz: 5f3c50ff877fcfaae28beecedabee21fbec98d4a695353b5904c568d044497fb2196a7b33e8342459586a7ab93a4ac69037d8199c172813d63e088f19d2eeddc
+  data.tar.gz: 9183e958d2958c800cc6fa97bb73b78d0b00ecbb01125723ac1762954de467f6eaf086ce2f4de4faad90de250bfeeb8a408461a999babd5147c2fa6d11bd3e9d

data/bake/test/external.rb

@@ -5,144 +5,52 @@
 # Copyright, 2022, by Akshay Birajdar.
 # Copyright, 2022, by Hiroaki Osawa.
 
+def initialize(context)
+	super
+	
+	require 'bake/test/external'
+	require 'bundler'
+	require 'yaml'
+end
+
 DEFAULT_EXTERNALS_PATH = 'config/external.yaml'
-DEFAULT_COMMAND = "bake test"
 
 # Run external tests.
 # @parameter gemspec [String] The input gemspec path.
-def external(input: nil, gemspec: self.find_gemspec)
-	require 'bundler'
-	require 'yaml'
+def external(input: nil, gemspec: nil)
+	input ||= default_input
 	
-	if input.nil? and File.exist?(DEFAULT_EXTERNALS_PATH)
-		# symbolize_names is unsupported on Ruby 2.7
-		input = YAML.load_file(DEFAULT_EXTERNALS_PATH) # , symbolize_names: true)
-	end
+	controller = Bake::Test::External::Controller.new
+	gemspec ||= controller.find_gemspec
 	
 	input&.each do |key, config|
 		config = config.transform_keys(&:to_sym)
 		config[:env] ||= {}
 		
 		Bundler.with_unbundled_env do
-			clone_and_test(gemspec.name, key, config)
+			controller.clone_and_test(gemspec.name, key, config)
 		end
 	end
 end
 
-private
-
-def find_gemspec(glob = "*.gemspec")
-	paths = Dir.glob(glob, base: @root).sort
-	
-	if paths.size > 1
-		raise "Multiple gemspecs found: #{paths}, please specify one!"
-	end
-	
-	if path = paths.first
-		return ::Gem::Specification.load(path)
-	end
-end
-
-def clone_and_test(name, key, config)
-	path = clone_repository(name, key, config)
+def clone(input: nil, gemspec: nil)
+	input ||= default_input
 	
-	test_repository(path, config) or abort("External tests #{key} failed!")
-end
-
-def clone_repository(name, key, config)
-	require 'fileutils'
+	controller = Bake::Test::External::Controller.new
+	gemspec ||= controller.find_gemspec
 	
-	url = config[:url]
-	
-	path = "external/#{key}"
-	
-	unless File.directory?(path)
-		FileUtils.mkdir_p path
-		command = ["git", "clone", "--depth", "1"]
-		
-		if branch = config[:branch]
-			command << "--branch" << branch
-		end
-		
-		if tag = config[:tag]
-			command << "--tag" << tag
-		end
-		
-		command << url << path
-		system(config[:env], *command)
-		
-		# I tried using `bundle config --local local.async ../` but it simply doesn't work.
-		# system("bundle", "config", "--local", "local.async", __dir__, chdir: path)
-		
-		gemfile_path = self.gemfile_path(path, config)
+	input&.each do |key, config|
+		config = config.transform_keys(&:to_sym)
+		config[:env] ||= {}
 		
-		File.open(gemfile_path, 'r+') do |file|
-			pattern = /gem.*?['"]#{name}['"]/
-			lines = file.grep_v(pattern)
-
-			file.seek(0)
-			file.truncate(0)
-			file.puts(lines)
-			file.puts nil, "# Added by external testing:"
-			file.puts("gem #{name.to_s.dump}, path: '../../'")
-
-			config[:extra]&.each do |line|
-				file.puts(line)
-			end
-		end
-
-		system(config[:env], "bundle", "install", chdir: path)
-	end
-	
-	return path
-end
-
-def test_repository(path, config)
-	command = config.fetch(:command, DEFAULT_COMMAND)
-	
-	Array(command).each do |line|
-		system(config[:env], *line, chdir: path)
+		controller.clone_repository(gemspec.name, key, config)
 	end
 end
 
-GEMFILE_NAMES = ["Gemfile", "gems.rb"]
-
-def resolve_gemfile_path(root, config)
-	if config_path = config[:gemfile]
-		path = File.join(root, config_path)
-		
-		unless File.exist?(path)
-			raise ArgumentError, "Specified gemfile path does not exist: #{config_path.inspect}!"
-		end
-		
-		# We consider this to be a custom gemfile path:
-		return false, path
-	end
-	
-	GEMFILE_NAMES.each do |name|
-		path = File.join(root, name)
-		
-		if File.exist?(path)
-			# We consider this to be a default gemfile path:
-			return true, path
-		end
-	end
-	
-	raise ArgumentError, "Could not find gem file in #{root.inspect}!"
-end
+private
 
-def gemfile_path(root, config)
-	config.fetch(:cached_gemfile_path) do
-		root = File.expand_path(root, @root)
-		default, path = self.resolve_gemfile_path(root, config)
-		
-		config[:cached_gemfile_path] = path
-		
-		# Custom gemfile paths should be set explicitly:
-		unless default
-			config[:env]['BUNDLE_GEMFILE'] = path
-		end
-		
-		return path
+def default_input
+	if File.exist?(DEFAULT_EXTERNALS_PATH)
+		YAML.load_file(DEFAULT_EXTERNALS_PATH)
 	end
 end

data/lib/bake/test/external/controller.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
+
+require 'fileutils'
+require 'pathname'
+
+module Bake
+	module Test
+		module External
+			class Controller
+				DEFAULT_COMMAND = "bake test"
+				
+				def initialize(root = nil)
+					@root = Pathname.new(root || Dir.pwd)
+				end
+				
+				def find_gemspec(pattern = "*.gemspec")
+					paths = @root.glob(pattern)
+					
+					if paths.size > 1
+						raise "Multiple gemspecs found: #{paths}, please specify one!"
+					end
+					
+					if path = paths.first
+						return ::Gem::Specification.load(path.to_s)
+					end
+				end
+				
+				def clone_and_test(name, key, config)
+					path = clone_repository(name, key, config)
+					
+					test_repository(path, config) or abort("External tests #{key} failed!")
+				end
+				
+				def clone_repository(name, key, config)
+					url = config[:url]
+					
+					path = File.join(@root, "external", key)
+					
+					unless File.directory?(path)
+						FileUtils.mkdir_p path
+						command = ["git", "clone", "--depth", "1"]
+						
+						if branch = config[:branch]
+							command << "--branch" << branch
+						end
+						
+						if tag = config[:tag]
+							command << "--tag" << tag
+						end
+						
+						command << url << path
+						system(config[:env], *command)
+						
+						# I tried using `bundle config --local local.async ../` but it simply doesn't work.
+						# system("bundle", "config", "--local", "local.async", __dir__, chdir: path)
+						
+						gemfile_path = self.gemfile_path(path, config)
+						relative_root = @root.relative_path_from(gemfile_path.dirname)
+						
+						File.open(gemfile_path, 'r+') do |file|
+							pattern = /gem.*?['"]#{name}['"]/
+							lines = file.grep_v(pattern)
+				
+							file.seek(0)
+							file.truncate(0)
+							file.puts(lines)
+							file.puts nil, "# Added by external testing:"
+							file.puts("gem #{name.to_s.dump}, path: #{relative_root.to_s.dump}")
+				
+							config[:extra]&.each do |line|
+								file.puts(line)
+							end
+						end
+				
+						system(config[:env], "bundle", "install", chdir: path)
+					end
+					
+					return path
+				end
+				
+				def test_repository(path, config)
+					command = config.fetch(:command, DEFAULT_COMMAND)
+					
+					Array(command).each do |line|
+						system(config[:env], *line, chdir: path)
+					end
+				end
+				
+				GEMFILE_NAMES = ["Gemfile", "gems.rb"]
+				
+				def resolve_gemfile_path(root, config)
+					if config_path = config[:gemfile]
+						path = File.join(root, config_path)
+						
+						unless File.exist?(path)
+							raise ArgumentError, "Specified gemfile path does not exist: #{config_path.inspect}!"
+						end
+						
+						# We consider this to be a custom gemfile path:
+						return false, path
+					end
+					
+					GEMFILE_NAMES.each do |name|
+						path = File.join(root, name)
+						
+						if File.exist?(path)
+							# We consider this to be a default gemfile path:
+							return true, path
+						end
+					end
+					
+					raise ArgumentError, "Could not find gem file in #{root.inspect}!"
+				end
+				
+				def gemfile_path(root, config)
+					config.fetch(:cached_gemfile_path) do
+						root = File.expand_path(root, @root)
+						default, path = self.resolve_gemfile_path(root, config)
+						
+						# Custom gemfile paths should be set explicitly:
+						unless default
+							config[:env]['BUNDLE_GEMFILE'] = path
+						end
+						
+						path = Pathname.new(path)
+						
+						config[:cached_gemfile_path] = path
+						
+						return path
+					end
+				end
+			end
+		end
+	end
+end

data/lib/bake/test/external/version.rb

@@ -6,7 +6,7 @@
 module Bake
 	module Test
 		module External
-			VERSION = "0.4.0"
+			VERSION = "0.5.0"
 		end
 	end
 end

data/lib/bake/test/external.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
+
+require_relative 'external/version'
+require_relative 'external/controller'

data/readme.md

@@ -6,20 +6,9 @@ A gem for executing external (downstream) tests.
 
 ## Usage
 
-Add a file `config/external.yaml` to your project, and add entries like:
+Please see the [project documentation](https://ioquatix.github.io/bake-test-external/) for more details.
 
-``` yaml
-bake:
-  url: https://github.com/ioquatix/bake.git
-  command: bundle exec rspec
-  # branch: optional-branch-name
-```
-
-``` bash
-$ bake test:external
-```
-
-It will clone the listed repositories, inject your current gem into the fetched gemfile, and run the given command. This has the effect of running their test suite with your latest code. You can use this as part of your test suite to receive feedback that a downstream dependent codebase is okay or broken because of a change you've made.
+  - [Getting Started](https://ioquatix.github.io/bake-test-external/guides/getting-started/index) - This guide will help you get started with `bake-test-external` and show you how to use it in your project.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-test-external
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -39,7 +39,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-06-13 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bake
@@ -62,6 +62,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bake/test/external.rb
+- lib/bake/test/external.rb
+- lib/bake/test/external/controller.rb
 - lib/bake/test/external/version.rb
 - license.md
 - readme.md
@@ -69,6 +71,7 @@ homepage: https://github.com/ioquatix/bake-test-external
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://ioquatix.github.io/bake-test-external/
   funding_uri: https://github.com/sponsors/ioquatix/
   source_code_uri: https://github.com/ioquatix/bake-test-external.git
 post_install_message: