Simplify test file loading

Simon Coffey · Simon Coffey · commit 9e24e01671a4 · 2023-02-04T12:29:19.000Z
Loading files for tests currently involves a lot of manually-constructed
relative requires, as well as a Dir.chdir in the tests/all_tests.rb file
which adjusts where requires need to be relative from.

Apart from some boilerplate, the main effect of this is that it's hard
to run a single test file from the command line, as you need to edit the
all_tests.rb file.

This makes things a bit simpler by:

* Adding the tests directory to the load path for the `rake test` task
* Removing the chdir and using Pathname to manage the loading in
  all_tests.rb
* Replacing all relative requires with direct ones.

You can now run a single test file from the root directory of the
project in a fairly standard way:

    $ ruby -Ilib:tests tests/units/test_object.rb

Signed-off-by: Simon Coffey &lt;simon.coffey@futurelearn.com&gt;
diff --git a/Rakefile b/Rakefile
@@ -1,7 +1,7 @@
 require 'bundler/gem_tasks'
 require 'English'
 
-require "#{File.expand_path(File.dirname(__FILE__))}/lib/git/version"
+require 'git/version'
 
 default_tasks = []
 
@@ -10,7 +10,9 @@ task :test do
   sh 'git config --global user.email "git@example.com"' if `git config user.email`.empty?
   sh 'git config --global user.name "GitExample"' if `git config user.name`.empty?
 
-  require File.dirname(__FILE__) + '/tests/all_tests.rb'
+  $LOAD_PATH << 'tests'
+
+  require 'all_tests'
 end
 default_tasks << :test
 
diff --git a/tests/all_tests.rb b/tests/all_tests.rb
@@ -1,8 +1,11 @@
-Dir.chdir(File.dirname(__FILE__)) do
-  Dir.glob('**/test_*.rb') do |test_case|
-    require "#{File.expand_path(File.dirname(__FILE__))}/#{test_case}"
-  end
+require 'pathname'
+
+Pathname.glob('tests/**/test_*.rb') do |test_case|
+  require test_case.expand_path.relative_path_from(__dir__)
 end
 
-# To run a single test:
-# require_relative 'units/test_lib_meets_required_version'
+# To run a single test, comment the above and uncomment:
+# require 'units/test_lib_meets_required_version'
+
+# or alternatively run single tests from the command line:
+# $ ruby -Ilib:tests tests/units/test_lib_meets_required_version.rb
diff --git a/tests/units/test_archive.rb b/tests/units/test_archive.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestArchive < Test::Unit::TestCase
 
diff --git a/tests/units/test_bare.rb b/tests/units/test_bare.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestBare < Test::Unit::TestCase
 
diff --git a/tests/units/test_base.rb b/tests/units/test_base.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestBase < Test::Unit::TestCase
 
diff --git a/tests/units/test_branch.rb b/tests/units/test_branch.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestBranch < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_commit_with_empty_message.rb b/tests/units/test_commit_with_empty_message.rb
@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestCommitWithEmptyMessage < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_commit_with_gpg.rb b/tests/units/test_commit_with_gpg.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestCommitWithGPG < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_config.rb b/tests/units/test_config.rb
@@ -1,24 +1,24 @@
 #!/usr/bin/env ruby
 
-require_relative '../test_helper'
+require 'test_helper'
 
 class TestConfig < Test::Unit::TestCase
   def setup
     set_file_paths
     @git = Git.open(@wdir)
   end
-  
+
   def test_config
     c = @git.config
     assert_equal('Scott Chacon', c['user.name'])
     assert_equal('false', c['core.bare'])
   end
-  
+
   def test_read_config
     assert_equal('Scott Chacon', @git.config('user.name'))
     assert_equal('false', @git.config('core.bare'))
   end
-  
+
   def test_set_config
     in_temp_dir do |path|
       g = Git.clone(@wbare, 'bare')
diff --git a/tests/units/test_config_module.rb b/tests/units/test_config_module.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestConfigModule < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_describe.rb b/tests/units/test_describe.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestDescribe < Test::Unit::TestCase
 
diff --git a/tests/units/test_diff.rb b/tests/units/test_diff.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestDiff < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_diff_non_default_encoding.rb b/tests/units/test_diff_non_default_encoding.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestDiffWithNonDefaultEncoding < Test::Unit::TestCase
   def git_working_dir
diff --git a/tests/units/test_diff_with_escaped_path.rb b/tests/units/test_diff_with_escaped_path.rb
@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 # Test diff when the file path has to be quoted according to core.quotePath
 # See https://git-scm.com/docs/git-config#Documentation/git-config.txt-corequotePath
diff --git a/tests/units/test_each_conflict.rb b/tests/units/test_each_conflict.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestEachConflict < Test::Unit::TestCase
   
diff --git a/tests/units/test_escaped_path.rb b/tests/units/test_escaped_path.rb
@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "#{File.dirname(__FILE__)}/../test_helper"
+require 'test_helper'
 
 # Test diff when the file path has escapes according to core.quotePath
 # See https://git-scm.com/docs/git-config#Documentation/git-config.txt-corequotePath
diff --git a/tests/units/test_git_clone.rb b/tests/units/test_git_clone.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'test/unit'
-require_relative '../test_helper'
+require 'test_helper'
 
 # Tests for Git.clone
 class TestGitClone < Test::Unit::TestCase
diff --git a/tests/units/test_git_dir.rb b/tests/units/test_git_dir.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestGitDir < Test::Unit::TestCase
   def test_index_calculated_from_git_dir
diff --git a/tests/units/test_git_path.rb b/tests/units/test_git_path.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestGitPath < Test::Unit::TestCase
 
diff --git a/tests/units/test_index_ops.rb b/tests/units/test_index_ops.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestIndexOps < Test::Unit::TestCase
   
diff --git a/tests/units/test_init.rb b/tests/units/test_init.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 require 'stringio'
 require 'logger'
 
diff --git a/tests/units/test_lib.rb b/tests/units/test_lib.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 require "fileutils"
 
 # tests all the low level git communication
diff --git a/tests/units/test_lib_meets_required_version.rb b/tests/units/test_lib_meets_required_version.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestLibMeetsRequiredVersion < Test::Unit::TestCase
   def test_with_supported_command_version
diff --git a/tests/units/test_log.rb b/tests/units/test_log.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require 'logger'
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestLog < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_logger.rb b/tests/units/test_logger.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require 'logger'
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestLogger < Test::Unit::TestCase
 
diff --git a/tests/units/test_ls_files_with_escaped_path.rb b/tests/units/test_ls_files_with_escaped_path.rb
@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 # Test diff when the file path has to be quoted according to core.quotePath
 # See https://git-scm.com/docs/git-config#Documentation/git-config.txt-corequotePath
diff --git a/tests/units/test_merge.rb b/tests/units/test_merge.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestMerge < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_merge_base.rb b/tests/units/test_merge_base.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestMergeBase < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_object.rb b/tests/units/test_object.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestObject < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_remotes.rb b/tests/units/test_remotes.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require_relative '../test_helper'
+require 'test_helper'
 
 class TestRemotes < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_repack.rb b/tests/units/test_repack.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestRepack < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_show.rb b/tests/units/test_show.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestShow < Test::Unit::TestCase
   def test_do_not_chomp_contents
diff --git a/tests/units/test_signed_commits.rb b/tests/units/test_signed_commits.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 require "fileutils"
 
 class TestSignedCommits < Test::Unit::TestCase
diff --git a/tests/units/test_stashes.rb b/tests/units/test_stashes.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestStashes < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_status.rb b/tests/units/test_status.rb
@@ -1,7 +1,7 @@
 
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestStatus < Test::Unit::TestCase
 
diff --git a/tests/units/test_tags.rb b/tests/units/test_tags.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestTags < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_thread_safety.rb b/tests/units/test_thread_safety.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestThreadSafety < Test::Unit::TestCase
   def setup
diff --git a/tests/units/test_tree_ops.rb b/tests/units/test_tree_ops.rb
@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class TestTreeOps < Test::Unit::TestCase
 
diff --git a/tests/units/test_windows_cmd_escaping.rb b/tests/units/test_windows_cmd_escaping.rb
@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 # Test diff when the file path has to be quoted according to core.quotePath
 # See https://git-scm.com/docs/git-config#Documentation/git-config.txt-corequotePath
diff --git a/tests/units/test_worktree.rb b/tests/units/test_worktree.rb
@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require 'fileutils'
 require 'pathname'
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 SAMPLE_LAST_COMMIT = '5e53019b3238362144c2766f02a2c00d91fcc023'
 
