test-queue 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a84d8eb24f2cdebe31f18be510d2ba28c8633e963beb62e498ef32674df3f761
-  data.tar.gz: 9869e95d639d312876faa0264b238ee8702ec21f5e5bc0bfe0d149ea1d83df31
+  metadata.gz: b99d05b99bd64f0b8efb578d5641077984fae57a6cef805f3ed92beb0fadb56b
+  data.tar.gz: dec70c7bef1dd759350333fa913ee780494dab07575342baa9e6545a9808c42a
 SHA512:
-  metadata.gz: 7a33f1567709b2fda5670cac096733d0ab1e029fe4db18aec6e1a449b00dd919e979167febe5a249b875d28e536224f0680dfb9810f2b585ea6064fcdb500dcf
-  data.tar.gz: 2486c1c8a85b4fe9fbe87eb98b7aa76ea97e01951f7e66d6db64e91dae57f8692f8354d036a7d57c342a46ab2833c6aac9fb7263b138fdb802d6993765a2e9b4
+  metadata.gz: 8ac80e29b3b5f7ac78db7f4167a8d75de63e3e5295f00139182257b99991003abd801f38c9c216310ab21566fba1ac216585c3621204d59df1a58f917e2cbf30
+  data.tar.gz: caf10f2498bd05f890dad0cc4feb45c5b0d2824d4ef3a3a00c9e1255fdbdf777437eee4ea9a4543752125c90f5cea7361778bec0b1eb64527ce895bdea93ec5b

data/README.md

@@ -10,46 +10,16 @@ Specifically optimized for CI environments: build statistics from each run
 are stored locally and used to sort the queue at the beginning of the
 next run.
 
-## Design
-
-test-queue uses a simple master + pre-fork worker model. The master
-exposes a unix domain socket server which workers use to grab tests off
-the queue.
-
-```console
-─┬─ 21232 minitest-queue master
- ├─── 21571 minitest-queue worker [3] - AuthenticationTest
- ├─── 21568 minitest-queue worker [2] - ApiTest
- ├─── 21565 minitest-queue worker [1] - UsersControllerTest
- └─── 21562 minitest-queue worker [0] - UserTest
-```
-
-test-queue also has a distributed mode, where additional masters can share
-the workload and relay results back to a central master.
-
-## Environment variables
-
-- `TEST_QUEUE_WORKERS`: number of workers to use per master (default: all available cores)
-- `TEST_QUEUE_VERBOSE`: show results as they are available (default: `0`)
-- `TEST_QUEUE_SOCKET`: unix socket `path` (or tcp `address:port` pair) used for communication (default: `/tmp/test_queue_XXXXX.sock`)
-- `TEST_QUEUE_RELAY`: relay results back to a central master, specified as tcp `address:port`
-- `TEST_QUEUE_STATS`: `path` to cache build stats in-build CI runs (default: `.test_queue_stats`)
-- `TEST_QUEUE_FORCE`: comma separated list of suites to run
-- `TEST_QUEUE_RELAY_TIMEOUT`: when using distributed builds, the amount of time a remote master will try to reconnect to start work
-- `TEST_QUEUE_RELAY_TOKEN`: when using distributed builds, this must be the same on remote masters and the central master for remote masters to be able to connect.
-- `TEST_QUEUE_REMOTE_MASTER_MESSAGE`: when using distributed builds, set this on a remote master and it will appear in that master's connection message on the central master.
-- `TEST_QUEUE_SPLIT_GROUPS`: split tests up by example rather than example group. Faster for tests with short setup time such as selenium. RSpec only. Add the :no_split tag to ExampleGroups you don't want split.
-
 ## Usage
 
-test-queue bundles `testunit-queue`, `minitest-queue` and `rspec-queue` binaries which can be used directly:
+test-queue bundles `testunit-queue`, `minitest-queue`, and `rspec-queue` binaries which can be used directly:
 
 ```console
 $ minitest-queue $(find test/ -name \*_test.rb)
 $ rspec-queue --format progress spec
 ```
 
-But the underlying `TestQueue::Runner::TestUnit`, `TestQueue::Runner::MiniTest` and `TestQueue::Runner::RSpec` are
+But the underlying `TestQueue::Runner::TestUnit`, `TestQueue::Runner::Minitest`, and `TestQueue::Runner::RSpec` are
 built to be subclassed by your application. I recommend checking a new
 executable into your project using one of these superclasses.
 
@@ -66,19 +36,19 @@ runner to reset any global state.
 ``` ruby
 #!/usr/bin/env ruby
 
-class MyAppTestRunner < TestQueue::Runner::MiniTest
+class MyAppTestRunner < TestQueue::Runner::Minitest
   def after_fork(num)
-    # use separate mysql database (we assume it exists and has the right schema already)
+    # Use separate mysql database (we assume it exists and has the right schema already)
     ActiveRecord::Base.configurations.configs_for(env_name: 'test', name: 'primary').database << num.to_s
     ActiveRecord::Base.establish_connection(:test)
 
-    # use separate redis database
+    # Use separate redis database
     $redis.client.db = num
     $redis.client.reconnect
   end
 
   def prepare(concurrency)
-    # create mysql databases exists with correct schema
+    # Create mysql databases exists with correct schema
     concurrency.times do |i|
       # ...
     end
@@ -97,22 +67,52 @@ end
 MyAppTestRunner.new.execute
 ```
 
+## Environment variables
+
+- `TEST_QUEUE_WORKERS`: Number of workers to use per master (default: all available cores)
+- `TEST_QUEUE_VERBOSE`: Show results as they are available (default: `0`)
+- `TEST_QUEUE_SOCKET`: Unix socket `path` (or TCP `address:port` pair) used for communication (default: `/tmp/test_queue_XXXXX.sock`)
+- `TEST_QUEUE_RELAY`: Relay results back to a central master, specified as TCP `address:port`
+- `TEST_QUEUE_STATS`: `path` to cache build stats in-build CI runs (default: `.test_queue_stats`)
+- `TEST_QUEUE_FORCE`: Comma separated list of suites to run
+- `TEST_QUEUE_RELAY_TIMEOUT`: When using distributed builds, the amount of time a remote master will try to reconnect to start work
+- `TEST_QUEUE_RELAY_TOKEN`: When using distributed builds, this must be the same on remote masters and the central master for remote masters to be able to connect.
+- `TEST_QUEUE_REMOTE_MASTER_MESSAGE`: When using distributed builds, set this on a remote master and it will appear in that master's connection message on the central master.
+- `TEST_QUEUE_SPLIT_GROUPS`: Split tests up by example rather than example group. Faster for tests with short setup time such as selenium. RSpec only. Add the `:no_split` tag to `ExampleGroups` you don't want split.
+
+## Design
+
+test-queue uses a simple master + pre-fork worker model. The master
+exposes a Unix domain socket server which workers use to grab tests off
+the queue.
+
+```console
+─┬─ 21232 minitest-queue master
+ ├─── 21571 minitest-queue worker [3] - AuthenticationTest
+ ├─── 21568 minitest-queue worker [2] - ApiTest
+ ├─── 21565 minitest-queue worker [1] - UsersControllerTest
+ └─── 21562 minitest-queue worker [0] - UserTest
+```
+
+test-queue also has a distributed mode, where additional masters can share
+the workload and relay results back to a central master.
+
 ## Distributed mode
 
-To use distributed mode, the central master must listen on a tcp port. Additional masters can be booted
+To use distributed mode, the central master must listen on a TCP port. Additional masters can be booted
 in relay mode to connect to the central master. Remote masters must provide a `TEST_QUEUE_RELAY_TOKEN`
 to match the central master's.
 
 ```console
-$ TEST_QUEUE_RELAY_TOKEN=123 TEST_QUEUE_SOCKET=0.0.0.0:12345 bundle exec minitest-queue ./test/sample_test.rb
-$ TEST_QUEUE_RELAY_TOKEN=123 TEST_QUEUE_RELAY=0.0.0.0:12345  bundle exec minitest-queue ./test/sample_test.rb
+$ TEST_QUEUE_RELAY_TOKEN=123 TEST_QUEUE_SOCKET=0.0.0.0:12345 bundle exec minitest-queue ./test/example_test.rb
+$ TEST_QUEUE_RELAY_TOKEN=123 TEST_QUEUE_RELAY=0.0.0.0:12345  bundle exec minitest-queue ./test/example_test.rb
 $ TEST_QUEUE_RELAY_TOKEN=123 ./test-multi.sh
 ```
 
 See the [Parameterized Trigger Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Parameterized+Trigger+Plugin)
-for a simple way to do this with jenkins.
+for a simple way to do this with Jenkins.
 
 ## See also
 
-  * https://github.com/Shopify/rails_parallel
-  * https://github.com/grosser/parallel_tests
+- https://github.com/Shopify/rails_parallel
+- https://github.com/grosser/parallel_tests

data/exe/cucumber-queue

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require 'test_queue'
 require 'test_queue/runner/cucumber'

data/exe/minitest-queue

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require 'test_queue'
 require 'test_queue/runner/minitest'
 
-TestQueue::Runner::MiniTest.new.execute
+TestQueue::Runner::Minitest.new.execute

data/exe/rspec-queue

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require 'test_queue'
 require 'test_queue/runner/rspec'

data/exe/testunit-queue

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require 'test_queue'
 require 'test_queue/runner/testunit'

data/lib/test-queue.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'test_queue'

data/lib/test_queue/iterator.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module TestQueue
   class Iterator
+    include Enumerable
+
     attr_reader :sock
 
-    def initialize(test_framework, sock, filter=nil, run_token:, early_failure_limit: nil)
+    def initialize(test_framework, sock, filter = nil, run_token:, early_failure_limit: nil)
       @test_framework = test_framework
       @done = false
       @suite_stats = []
@@ -18,29 +22,34 @@ module TestQueue
     end
 
     def each
-      fail "already used this iterator. previous caller: #@done" if @done
+      raise "already used this iterator. previous caller: #{@done}" if @done
 
       procline = $0
 
-      while true
+      loop do
         # If we've hit too many failures in one worker, assume the entire
         # test suite is broken, and notify master so the run
         # can be immediately halted.
         if @early_failure_limit && @failures >= @early_failure_limit
-          connect_to_master("KABOOM")
+          connect_to_master('KABOOM')
           break
         else
           client = connect_to_master("POP #{Socket.gethostname} #{Process.pid}")
         end
         break if client.nil?
+
+        # rubocop:disable Lint/IncompatibleIoSelectWithFiberScheduler
+        # This false positive will be resolved by https://github.com/rubocop/rubocop/pull/11830.
         _r, _w, e = IO.select([client], nil, [client], nil)
-        break if !e.empty?
+        # rubocop:enable Lint/IncompatibleIoSelectWithFiberScheduler
+        break unless e.empty?
 
-        if data = client.read(65536)
+        if (data = client.read(65536))
           client.close
           item = Marshal.load(data)
           break if item.nil? || item.empty?
-          if item == "WAIT"
+
+          if item == 'WAIT'
             $0 = "#{procline} - Waiting for work"
             sleep 0.1
             next
@@ -54,7 +63,7 @@ module TestQueue
           $0 = "#{procline} - #{suite.respond_to?(:description) ? suite.description : suite}"
           start = Time.now
           if @filter
-            @filter.call(suite){ yield suite }
+            @filter.call(suite) { yield suite }
           else
             yield suite
           end
@@ -65,10 +74,11 @@ module TestQueue
         end
       end
     rescue Errno::ENOENT, Errno::ECONNRESET, Errno::ECONNREFUSED
+      # noop
     ensure
       $0 = procline
-      @done = caller.first
-      File.open("/tmp/test_queue_worker_#{$$}_suites", "wb") do |f|
+      @done = caller(1..1).first
+      File.open("/tmp/test_queue_worker_#{$$}_suites", 'wb') do |f|
         Marshal.dump(@suite_stats, f)
       end
     end
@@ -87,8 +97,6 @@ module TestQueue
       nil
     end
 
-    include Enumerable
-
     def empty?
       false
     end
@@ -98,8 +106,8 @@ module TestQueue
       suite = @loaded_suites[suite_name]
       return suite if suite
 
-      @test_framework.suites_from_file(path).each do |name, suite|
-        @loaded_suites[name] = suite
+      @test_framework.suites_from_file(path).each do |name, suite_from_file|
+        @loaded_suites[name] = suite_from_file
       end
       @loaded_suites[suite_name]
     end

data/lib/test_queue/runner/cucumber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber'
 require 'cucumber/rspec/disable_option_parser'
 require 'cucumber/cli/main'
@@ -24,6 +26,7 @@ module Cucumber
       module InjectableFeatures
         def features
           return @features if defined?(@features)
+
           super
         end
 

data/lib/test_queue/runner/{sample.rb → example.rb}

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
+
 require_relative '../../test_queue'
 require_relative '../runner'
 
 module TestQueue
   class Runner
-    class Sample < Runner
+    class Example < Runner
+      def initialize(args)
+        super(TestFramework::Example.new(args))
+      end
+
       def spawn_workers
-        puts "Spawning #@concurrency workers"
+        puts "Spawning #{@concurrency} workers"
         super
       end
 
@@ -15,24 +21,40 @@ module TestQueue
       end
 
       def run_worker(iterator)
-        sum = 0
-        iterator.each do |item|
+        iterator.inject(0) do |sum, item|
           puts "  #{item.inspect}"
-          sum += item
+          sum + item.to_i
         end
-        sum
       end
 
       def summarize_worker(worker)
-        worker.summary  = worker.output.scan(/^\s*(\d+)/).join(', ')
+        worker.summary = worker.output.scan(/^\s*(\d+)/).join(', ')
         worker.failure_output = ''
       end
     end
   end
+
+  class TestFramework
+    class Example < TestFramework
+      def initialize(args)
+        super()
+
+        @args = args.map(&:to_s)
+      end
+
+      def all_suite_files
+        @args
+      end
+
+      def suites_from_file(_path)
+        @args.map { |i| [i, i] }
+      end
+    end
+  end
 end
 
 if __FILE__ == $0
-  TestQueue::Runner::Sample.new(Array(1..10)).execute
+  TestQueue::Runner::Example.new(Array(1..10)).execute
 end
 
 __END__
@@ -71,4 +93,3 @@ Spawning 4 workers
     [3]                                                              in 0.0036s      (pid 40409 exit 0)
     [2]                                                 3, 6, 9      in 0.0038s      (pid 40408 exit 18)
     [0]                                             1, 4, 7, 10      in 0.0044s      (pid 40406 exit 22)
-

data/lib/test_queue/runner/minitest.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 begin
   require 'minitest'
   require_relative '../runner/minitest5'
-rescue LoadError => e
+rescue LoadError
   require 'minitest/unit'
   require_relative '../runner/minitest4'
 end
 
 module TestQueue
   class Runner
-    class MiniTest < Runner
+    class Minitest < Runner
       def summarize_worker(worker)
         worker.summary = worker.lines.grep(/, \d+ errors?, /).first
-        failures  = worker.lines.select{ |line|
+        failures = worker.lines.select { |line|
           line if (line =~ /^Finished/) ... (line =~ /, \d+ errors?, /)
         }[1..-2]
         worker.failure_output = failures.join("\n") if failures

data/lib/test_queue/runner/minitest4.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../runner'
 require 'set'
 require 'stringio'
@@ -31,11 +33,11 @@ class MiniTestQueueRunner < MiniTest::Unit
     ret = super
     diff = Time.now - start
 
-    output.puts("  <%.3f>" % diff)
+    output.puts('  <%.3f>' % diff)
     ret
   end
 
-  self.runner = self.new
+  self.runner = new
   self.output = StringIO.new
 end
 
@@ -44,7 +46,7 @@ class MiniTest::Unit::TestCase
     attr_accessor :test_suites
 
     def original_test_suites
-      @@test_suites.keys.reject{ |s| s.test_methods.empty? }
+      @@test_suites.keys.reject { |s| s.test_methods.empty? }
     end
   end
 
@@ -55,12 +57,13 @@ end
 
 module TestQueue
   class Runner
-    class MiniTest < Runner
+    class Minitest < Runner
       def initialize
         if ::MiniTest::Unit::TestCase.original_test_suites.any?
-          fail "Do not `require` test files. Pass them via ARGV instead and they will be required as needed."
+          raise 'Do not `require` test files. Pass them via ARGV instead and they will be required as needed.'
         end
-        super(TestFramework::MiniTest.new)
+
+        super(TestFramework::Minitest.new)
       end
 
       def run_worker(iterator)
@@ -68,10 +71,11 @@ module TestQueue
         ::MiniTest::Unit.new.run
       end
     end
+    MiniTest = Minitest # For compatibility with test-queue 0.7.0 and earlier.
   end
 
   class TestFramework
-    class MiniTest < TestFramework
+    class Minitest < TestFramework
       def all_suite_files
         ARGV
       end
@@ -84,5 +88,6 @@ module TestQueue
         }
       end
     end
+    MiniTest = Minitest # For compatibility with test-queue 0.7.0 and earlier.
   end
 end

data/lib/test_queue/runner/minitest5.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require_relative '../runner'
 
-module MiniTest
-  def self.__run reporter, options
+module Minitest
+  def self.__run(reporter, options)
     suites = Runnable.runnables
     suites.map { |suite| suite.run reporter, options }
   end
@@ -13,7 +15,7 @@ module MiniTest
   end
 
   class Test
-    def self.runnables= runnables
+    def self.runnables=(runnables)
       @@runnables = runnables
     end
 
@@ -25,17 +27,19 @@ module MiniTest
     # code, there's no way to know which are parallel and which are serial.
     # Synchronizing serial tests does add some overhead, but hopefully this is
     # outweighed by the speed benefits of using test-queue.
-    def _synchronize; Test.io_lock.synchronize { yield }; end
+    def _synchronize
+      Test.io_lock.synchronize { yield }
+    end
   end
 
   class ProgressReporter
     # Override original method to make test-queue specific output
-    def record result
+    def record(result)
       io.print '    '
       io.print result.class
       io.print ': '
       io.print result.result_code
-      io.puts("  <%.3f>" % result.time)
+      io.puts('  <%.3f>' % result.time)
     end
   end
 
@@ -44,51 +48,62 @@ module MiniTest
 
     class << self
       private
-      def total_count(options)
+
+      def total_count(_options)
         0
       end
     end
   rescue LoadError
+    # noop
   end
 end
 
 module TestQueue
   class Runner
-    class MiniTest < Runner
+    class Minitest < Runner
       def initialize
-        options = Minitest.process_args ARGV
+        @options = ::Minitest.process_args ARGV
 
-        if Minitest.respond_to?(:seed)
-          Minitest.seed = options[:seed]
-          srand Minitest.seed
+        if ::Minitest.respond_to?(:seed)
+          ::Minitest.seed = @options[:seed]
+          srand ::Minitest.seed
         end
 
-        if ::MiniTest::Test.runnables.any? { |r| r.runnable_methods.any? }
-          fail "Do not `require` test files. Pass them via ARGV instead and they will be required as needed."
+        if ::Minitest::Test.runnables.any? { |r| r.runnable_methods.any? }
+          raise 'Do not `require` test files. Pass them via ARGV instead and they will be required as needed.'
         end
-        super(TestFramework::MiniTest.new)
+
+        super(TestFramework::Minitest.new)
+      end
+
+      def start_master
+        puts "Run options: #{@options[:args]}\n\n"
+
+        super
       end
 
       def run_worker(iterator)
-        ::MiniTest::Test.runnables = iterator
-        ::MiniTest.run ? 0 : 1
+        ::Minitest::Test.runnables = iterator
+        ::Minitest.run ? 0 : 1
       end
     end
+    MiniTest = Minitest # For compatibility with test-queue 0.7.0 and earlier.
   end
 
   class TestFramework
-    class MiniTest < TestFramework
+    class Minitest < TestFramework
       def all_suite_files
         ARGV
       end
 
       def suites_from_file(path)
-        ::MiniTest::Test.reset
+        ::Minitest::Test.reset
         require File.absolute_path(path)
-        ::MiniTest::Test.runnables
-          .reject { |s| s.runnable_methods.empty? }
-          .map { |s| [s.name, s] }
+        ::Minitest::Test.runnables
+                        .reject { |s| s.runnable_methods.empty? }
+                        .map { |s| [s.name, s] }
       end
     end
+    MiniTest = Minitest # For compatibility with test-queue 0.7.0 and earlier.
   end
 end

data/lib/test_queue/runner/puppet_lint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../test_queue'
 require 'puppet-lint'
 
@@ -6,7 +8,7 @@ module TestQueue
     class PuppetLint < Runner
       def run_worker(iterator)
         errors = 0
-        linter =  PuppetLint.new
+        linter = PuppetLint.new
         iterator.each do |file|
           puts "Evaluating #{file}"
           linter.file = file
@@ -19,9 +21,9 @@ module TestQueue
       def summarize_worker(worker)
         lines = worker.lines
 
-        files    = lines.select{ |line| line =~ /^Evaluating/ }
-        errors   = lines.select{ |line| line =~ /^ERROR/ }
-        warnings = lines.select{ |line| line =~ /^WARNING/ }
+        files    = lines.grep(/^Evaluating/)
+        errors   = lines.grep(/^ERROR/)
+        warnings = lines.grep(/^WARNING/)
 
         worker.summary = "#{files.size} files, #{warnings.size} warnings, #{errors.size} errors"
         worker.failure_output = errors.join("\n")

data/lib/test_queue/runner/rspec.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require_relative '../runner'
 require 'rspec/core'
 
-case ::RSpec::Core::Version::STRING.to_i
+case RSpec::Core::Version::STRING.to_i
 when 2
   require_relative 'rspec2'
 when 3, 4
   require_relative 'rspec3'
 else
-  fail 'requires rspec version 2, 3, or 4'
+  raise 'requires rspec version 2, 3, or 4'
 end
 
 module TestQueue
@@ -23,7 +25,7 @@ module TestQueue
       end
 
       def summarize_worker(worker)
-        worker.summary  = worker.lines.grep(/ examples?, /).first
+        worker.summary = worker.lines.grep(/ examples?, /).first
         worker.failure_output = worker.output[/^Failures:\n\n(.*)\n^Finished/m, 1]
       end
     end
@@ -31,6 +33,14 @@ module TestQueue
 
   class TestFramework
     class RSpec < TestFramework
+      begin
+        require 'turnip/rspec'
+
+        include Turnip::RSpec::Loader
+      rescue LoadError
+        # noop
+      end
+
       def all_suite_files
         options = ::RSpec::Core::ConfigurationOptions.new(ARGV)
         options.parse_options if options.respond_to?(:parse_options)
@@ -77,6 +87,7 @@ module TestQueue
 
       def split_groups?
         return @split_groups if defined?(@split_groups)
+
         @split_groups = ENV['TEST_QUEUE_SPLIT_GROUPS'] && ENV['TEST_QUEUE_SPLIT_GROUPS'].strip.downcase == 'true'
       end
     end