utils 0.84.0 → 0.85.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dda5615db1b6e0a3ceb342ec83ca1d2a9db169f45f4c0207daec1ba456e6456
-  data.tar.gz: 90a9bc8dd0937badb77c947d9e98abae918b6098cee076cff40868021727905d
+  metadata.gz: 3fd913953f77f177caac61d9a98e615eaba79f5aad327b892a8728d510443b3f
+  data.tar.gz: d8f2937862ac26cffa7a4d3244155354b33e587d0fc6cecacedbf6539845bbf4
 SHA512:
-  metadata.gz: '08cb02b22c75148956266066e107e8ea2e1b90162479df973ba010b7c2edf6d339240e8cbc7f5c4957eb249b56cde34f17216aa24b70bcc162fd8c05775d8c52'
-  data.tar.gz: fe9c4966eb16d5ee1344626789232c939653841af8f7ecd132d5b1cf0ab96f953e2019e3d0e9238dc93442d1ec90b9dc9f87a2d8886d51b803a2bd2cce70e29c
+  metadata.gz: cc3e00dd0c01f36a2835f74c490f2b35cb8d64b7d4197d49d7c3ae09e247ea3d6067483d34facbdc40c19018516e7a368ddfeb4a38e26efc6d8cf460a8785e4a
+  data.tar.gz: 566f70210d3ff85d8798cc2876371e49c86d2ec959fa11f76a6ecc6e546819953878fcabc53e210de8c1b024dab9d61863f86f5c415fcb02551fe0f79420b8de

data/bin/probe

@@ -33,6 +33,7 @@ def usage
 
       -n TESTNAME   run the test TESTNAME in file FILENAME
       -t FRAMEWORK  use test framework FRAMEWORK (rspec, test-unit or cucumber)
+      -s SERVER_URL tcp/unix URL to connect to
       -c            start probe as a client
       -C FOO[=BAR]  set/get env variable on probe server
       -l            start probe as a server
@@ -72,6 +73,17 @@ def find_cmd(*cmds, on_fail: -> *cmds { fail "no #{cmds * '|'} command found" })
   cmds.map { |c| `which #{c}`.full?(:chomp) }.compact.first or on_fail.(*cmds)
 end
 
+# The server_url method retrieves the configured server URL for probe operations.
+#
+# This method checks if a server URL has been specified via command-line
+# options and returns it if available. Otherwise, it falls back to the server
+# URL configured in the probe settings.
+#
+# @return [ String ] the server URL for probe operations
+def server_url
+  $opts[?s] || $config.probe.server_url
+end
+
 # The start_server method initializes and begins operation of a probe server.
 #
 # This method configures the environment for server operation by setting the
@@ -79,10 +91,7 @@ end
 # probe server instance to handle incoming requests and process jobs.
 def start_server
   Thread.abort_on_exception = $DEBUG
-  ProbeServer.new(
-    server_type: $config.probe.server_type,
-    port: $config.probe.tcp_server_port
-  ).start
+  ProbeServer.new(server_url:).start
 end
 
 # The connect_server method establishes a connection to a probe server and
@@ -93,10 +102,7 @@ end
 # It also enqueues jobs for execution on the probe server when specified.
 #
 def connect_server
-  probe_client = ProbeClient.new(
-    server_type: $config.probe.server_type,
-    port: $config.probe.tcp_server_port
-  )
+  probe_client = ProbeClient.new(server_url:)
   if setting = $opts[?C]
     case setting
     when /\A([^=]+)=([^=]+)\z/
@@ -125,7 +131,7 @@ if i = ARGV.index('--')
 else
   $args = ARGV.dup
 end
-$opts = go 'lct:n:C:h', $args
+$opts = go 'lct:n:C:s:h', $args
 $opts[?h] and usage
 
 case

data/lib/utils/config_file.rb

@@ -224,22 +224,16 @@ class Utils::ConfigFile
     # @param dirs [ Array<String> ] the array of directory names to include
     config :include_dirs, %w[lib test tests ext spec]
 
-    # The server_type method configures the type of server to be used.
+    # The server_url method configures the URL for the probe server
+    # communication.
     #
-    # This method sets up the server type configuration option, which
-    # determines the underlying server implementation to be utilized, this is
-    # either :unix for UNIX domain sockets or :tcp for TCP Sockets.
+    # This method sets up a DSL accessor for the probe server URL, providing a
+    # default value that uses a Unix domain socket located in the current
+    # working directory.
     #
-    # @return [ Symbol ] returns the server type configured
-    config :server_type, :unix
-
-    # The tcp_server_port method configures the TCP server port setting.
-    #
-    # This method sets up a configuration option that specifies the port number
-    # to be used for TCP server operations.
-    #
-    # @param value [ Integer ] the TCP server port number to use
-    config :tcp_server_port, 59999
+    # @return [ String ] the configured probe server URL including the default
+    #   socket path
+    dsl_accessor :server_url, "unix://#{Pathname.pwd + 'probe.socket'}"
 
     # The include_dirs_argument method constructs a colon-separated string from
     # include directories.

data/lib/utils/probe/probe_client.rb

@@ -57,15 +57,18 @@ module Utils::Probe
 
     # The initialize method sets up a new probe server instance.
     #
-    # This method creates and configures a Unix domain socket server for
-    # handling probe jobs and communication. It initializes the server with a
-    # specific socket name and runtime directory, preparing it to listen for
-    # incoming connections and process jobs.
+    # This method creates and configures the core components of the probe
+    # server, including initializing the Unix domain socket server for
+    # communication, setting up the job queue for processing tasks, and
+    # preparing the history tracking for completed jobs.
     #
-    # @return [ Utils::ProbeServer ] a new probe server instance configured with
-    #         the specified socket name and runtime directory
-    def initialize(server_type: :unix, port: 6666)
-      @server = create_server(server_type, port)
+    # @param server_url [ String ] the URL to be used for the probe server
+    #   communication
+    #
+    # @return [ Utils::ProbeServer ] a new probe server instance configured
+    #   with the specified socket name and runtime directory
+    def initialize(server_url:)
+      @server = create_server(server_url)
     end
 
     # The env method provides access to environment variable management through

data/lib/utils/probe/probe_server.rb

@@ -19,8 +19,8 @@ module Utils::Probe
     #
     # @return [ Utils::ProbeServer ] a new probe server instance configured
     # with the specified socket name and runtime directory
-    def initialize(server_type: :unix, port: 6666)
-      @server         = create_server(server_type, port)
+    def initialize(server_url:)
+      @server         = create_server(server_url)
       @history        = [].freeze
       @jobs_queue     = Queue.new
       @current_job_id = 0

data/lib/utils/probe/server_handling.rb

@@ -8,25 +8,20 @@ module Utils::Probe
   # creation and management within the Utils library.
   module ServerHandling
     # The create_server method initializes and returns a socket server instance
-    # based on the specified server type.
+    # based on the specified server URL configuration
     #
-    # This method creates either a TCP socket server or a domain socket server
-    # depending on the server type parameter. It configures the server with the
-    # appropriate parameters including port number for TCP servers or socket
-    # name and runtime directory for domain sockets.
+    # This method acts as a factory for creating socket server objects,
+    # delegating to the UnixSocks.from_url method to construct either a TCP
+    # socket server or a domain socket server depending on the URL scheme
+    # provided
     #
-    # @param server_type [ Symbol ] the type of socket server to create, either :tcp or another value for domain socket
-    # @param port [ Integer ] the port number to use for TCP socket server creation
+    # @param server_url [ String ] the URL specifying the socket server
+    #   configuration
     #
     # @return [ UnixSocks::TCPSocketServer, UnixSocks::DomainSocketServer ] a
-    #   new socket server instance of the specified type
-    def create_server(server_type, port)
-      case server_type
-      when :tcp
-        UnixSocks::TCPSocketServer.new(port:)
-      else
-        UnixSocks::DomainSocketServer.new(socket_name: 'probe.sock', runtime_dir: Dir.pwd)
-      end
+    #   new socket server instance configured according to the URL specification
+    def create_server(server_url)
+      UnixSocks.from_url(server_url)
     end
   end
 end

data/lib/utils/version.rb

@@ -1,6 +1,6 @@
 module Utils
   # Utils version
-  VERSION         = '0.84.0'
+  VERSION         = '0.85.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/utils.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: utils 0.84.0 ruby lib
+# stub: utils 0.85.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "utils".freeze
-  s.version = "0.84.0".freeze
+  s.version = "0.85.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utils
 version: !ruby/object:Gem::Version
-  version: 0.84.0
+  version: 0.85.0
 platform: ruby
 authors:
 - Florian Frank