etcd-discovery 1.0.7 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2790e1221f8d46a73e327158ea3db9e513f53722e5e4523f511cf68a574c31ba
-  data.tar.gz: 8ce9db41cf12d657f140d45af8cd6c3da27392e9830df7dcb07c2b1715472fcc
+  metadata.gz: 02edd48044abeca02169d432516a65ea48c8843b22942686c88f4c9761fd10f4
+  data.tar.gz: a3c0768508b0043521b98017d71442261e17fd63f7d4cd8c7c5f0e05ece91203
 SHA512:
-  metadata.gz: 3aefec153e1278701479ea097526aeaffd3bc636734d66fa2ca6e4a7ebe98da3f87b251d5b1fa28a51adbed0dc4b65be61f2ef3783971b3836fb77204eafcd4f
-  data.tar.gz: 9e6753a7ef169a4e9bb5de3f1ce0a931151a83dab71cb39d4abfc54a4678fe023fd535819c3880ca95d771684cc729bef169a63e5cde500bf489e2eb4bcddb4c
+  metadata.gz: 573344b8a4f8de0222d0da6e38ef5dddfe8f67d55585c26d66edd44345dbd3adb27f25c4e911fe15bba2f3be711d8db5d4374dc3cdd189ebdc8495f8c0cf51cd
+  data.tar.gz: 7620dff391769b07332e7e8608098b734f4285f794ee670dafe1e4dd45607c21d3cc1c5f2ec54b4ea9fd4eaa9c8478ddb7285a8156653b985c86ac49f68cd7e3

data/lib/etcd-discovery/config.rb

@@ -17,11 +17,11 @@ module EtcdDiscovery
 
     def validate
       if use_ssl
-        if cacert.nil? or !File.exists? cacert
+        if cacert.nil? || !File.exist?(cacert)
           raise InvalidSSLConfig, "cacert"
-        elsif ssl_key.nil? or !File.exists? ssl_key
+        elsif ssl_key.nil? || !File.exist?(ssl_key)
           raise InvalidSSLConfig, "ssl_key"
-        elsif ssl_cert.nil? or !File.exists? ssl_cert
+        elsif ssl_cert.nil? || !File.exist?(ssl_cert)
           raise InvalidSSLConfig, "ssl_cert"
         end
       end

data/lib/etcd-discovery/host.rb

@@ -13,11 +13,11 @@ module EtcdDiscovery
       else
         raise TypeError, "requires a Etcd::Node or a Hash, not a #{arg.class}"
       end
-      if !attributes.has_key?('name') or !attributes.has_key?('ports')
+      if !attributes.has_key?("name") || !attributes.has_key?("ports")
         raise InvalidHost, "attributes 'name' and 'ports' should be defined"
       end
-      attributes['user'] = "" if attributes['user'].nil?
-      attributes['password'] = "" if attributes['password'].nil?
+      attributes["user"] = "" if attributes["user"].nil?
+      attributes["password"] = "" if attributes["password"].nil?
     end
 
     def to_json
@@ -25,42 +25,47 @@ module EtcdDiscovery
     end
 
     def to_uri(schemes = ["https", "http"])
-      a = attributes # Shorten name
-      schemes = [schemes] if !schemes.is_a?(Array)
-      scheme = schemes.select{|s|
-        !a['ports'][s].nil?
-      }.first
-      if a['user'].empty?
-        URI("#{scheme}://#{a['name']}:#{a['ports'][scheme]}")
-      else
-        URI("#{scheme}://#{a['user']}:#{a['password']}@#{a['name']}:#{a['ports'][scheme]}")
+      schemes = Array(schemes)
+
+      scheme = schemes.find { |s| attributes["ports"][s] }
+      raise "No valid scheme found" unless scheme
+
+      if attributes["user"].nil? || attributes["user"].empty?
+        return URI("#{scheme}://#{attributes["name"]}:#{attributes["ports"][scheme]}")
       end
+
+      URI("#{scheme}://#{attributes["user"]}:#{attributes["password"]}@#{attributes["name"]}:#{attributes["ports"][scheme]}")
     end
 
     def to_private_uri(schemes = ["https", "http"])
       a = attributes
-      if a['private_hostname'].empty?
-        return self.to_uri(schemes)
+      if a["private_hostname"].empty?
+        return to_uri(schemes)
       end
       schemes = [schemes] if !schemes.is_a?(Array)
-      scheme = schemes.select{ |s|
-        !a['private_ports'][s].nil?
-      }.first
+      scheme = schemes.find { |s|
+        !a["private_ports"][s].nil?
+      }
 
-      if a['user'].nil? || a['user'] == ""
-        URI("#{scheme}://#{a['private_hostname']}:#{a['private_ports'][scheme]}")
+      if a["user"].nil? || a["user"] == ""
+        URI("#{scheme}://#{a["private_hostname"]}:#{a["private_ports"][scheme]}")
       else
-        URI("#{scheme}://#{a['user']}:#{a['password']}@#{a['private_hostname']}:#{a['private_ports'][scheme]}")
+        URI("#{scheme}://#{a["user"]}:#{a["password"]}@#{a["private_hostname"]}:#{a["private_ports"][scheme]}")
       end
     end
 
     def set_credentials(user, password)
-      @attributes['user'] = user
-      @attributes['password'] = password
+      @attributes["user"] = user
+      @attributes["password"] = password
     end
 
     def to_s
-      self.to_uri.to_s
+      uri = to_uri
+      if uri.userinfo
+        user, _password = uri.userinfo.split(":", 2)
+        uri.userinfo = "#{user}:REDACTED"
+      end
+      uri.to_s
     end
   end
 end

data/lib/etcd-discovery/registrar.rb

@@ -1,4 +1,4 @@
-require 'securerandom'
+require "securerandom"
 
 module EtcdDiscovery
   class InvalidStateError < StandardError
@@ -25,17 +25,27 @@ module EtcdDiscovery
       @logger = Logger.new($stdout)
 
       if host.is_a? Hash
-        @host = Host.new host.merge('service_name' => service, 'uuid' => SecureRandom.uuid)
+        if host.has_key?("uuid")
+          host_uuid = "#{SecureRandom.uuid}-#{host["private_hostname"]}"
+          host = host.merge("uuid" => host_uuid)
+        end
+        @host = Host.new host
       elsif host.is_a? EtcdDiscovery::Host
+        if host.attributes.has_key?("uuid")
+          host.attributes["uuid"] = "#{SecureRandom.uuid}-#{host.attributes["private_hostname"]}"
+        end
         @host = host
       else
         raise TypeError, "host should be a Hash or a Etcd::Host, is a #{host.class}"
       end
 
+      # This attribute is later used when instantiating EtcdDiscovery::Service. We want this value to be the content of `service`, always.
+      @host.attributes["service_name"] = service
+
       @service = EtcdDiscovery::Service.new service_params
       @state = :new
-      @user     = @host.attributes['user']
-      @password = @host.attributes['password']
+      @user = @host.attributes["user"]
+      @password = @host.attributes["password"]
     end
 
     def register
@@ -49,30 +59,31 @@ module EtcdDiscovery
       service_value = @service.to_json
 
       # Do not start credentials synchro if the service is not public or has no credentials
-      if @service.attributes['public'] && (@service.attributes['user'].present? || @service.attributes['password'].present?)
-        @watcher = Thread.new {
-          @logger.warn "Watcher #{@service.attributes['name']} started"
+      if @service.attributes["public"] && (@service.attributes["user"].present? || @service.attributes["password"].present?)
+        @watcher = Thread.new do
+          @logger.warn "Watcher #{@service.attributes["name"]} started"
           index = 0
           while @state == :started
             begin
-              resp = client.watch service_key, { index: index }
+              resp = client.watch service_key, index: index
             rescue => e
               @logger.warn "Fail to watch #{service_key}: #{e}, #{e.message}, #{e.class}"
               index = 0
+              sleep(config.register_ttl / 2)
               next
             end
             value = JSON.parse resp.node.value
-            @user = value['user']
-            @password = value['password']
+            @user = value["user"]
+            @password = value["password"]
             @host.set_credentials user, password
             @service.set_credentials user, password
             index = resp.etcd_index
           end
-        }
+        end
       end
 
       client.set(service_key, value: service_value)
-      @thread = Thread.new {
+      @thread = Thread.new do
         @logger.warn "Register '#{@service}' started"
         while @state == :started
           value = @host.to_json
@@ -84,18 +95,17 @@ module EtcdDiscovery
           sleep config.register_renew
         end
         @logger.warn "Register '#{@service}' stopped"
-      }
-
+      end
 
-      return self
+      self
     end
 
     def stop
       raise InvalidStateError.new(@state, :started) if @state != :started
       @logger.debug "Set state to :stopped"
       @state = :stopped
-      @logger.debug "Delete #{key}"
-      client.delete(key)
+      @logger.debug "Delete #{host_key}"
+      client.delete(host_key)
     end
 
     def client
@@ -107,24 +117,24 @@ module EtcdDiscovery
     end
 
     def host_key
-      "/services/#{@service.attributes['name']}/#{@host.attributes['uuid']}"
+      "/services/#{@service.attributes["name"]}/#{@host.attributes["uuid"]}"
     end
 
     def service_key
-      "/services_infos/#{@service.attributes['name']}"
+      "/services_infos/#{@service.attributes["name"]}"
     end
 
     def service_params
       params = {
-        'name' =>     host.attributes['service_name'],
-        'critical' => host.attributes['critical'],
-        'user' =>     host.attributes['user'],
-        'password' => host.attributes['password'],
-        'public' =>   host.attributes['public']
+        "name" => @host.attributes["service_name"],
+        "critical" => @host.attributes["critical"],
+        "user" => @host.attributes["user"],
+        "password" => @host.attributes["password"],
+        "public" => @host.attributes["public"]
       }
-      params['hostname'] = host.attributes['name']if params['public']
-      params['ports'] = host.attributes['ports']  if params['public']
-      return params
+      params["hostname"] = @host.attributes["name"] if params["public"]
+      params["ports"] = @host.attributes["ports"] if params["public"]
+      params
     end
   end
 end

data/lib/etcd-discovery/service.rb

@@ -21,44 +21,49 @@ module EtcdDiscovery
       client = EtcdDiscovery.config.client
       begin
         service = client.get("/services_infos/#{service}")
-        return new service.node
+        new service.node
       rescue Etcd::KeyNotFound
-        return new('name' => service)
+        new("name" => service)
       end
     end
 
     def all
       client = EtcdDiscovery.config.client
       begin
-        node = client.get("/services/#{attributes['name']}", recursive: true).node
+        node = client.get("/services/#{attributes["name"]}", recursive: true).node
       rescue Etcd::KeyNotFound
-        raise ServiceNotFound, attributes['name']
+        raise ServiceNotFound, attributes["name"]
       end
-      raise ServiceNotFound, attributes['name'] if node.children.empty?
-      return node.children.map { |c| Host.new(c) }
+      raise ServiceNotFound, attributes["name"] if node.children.empty?
+      node.children.map { |c| Host.new(c) }
     end
 
     def one
       all.sample
     end
 
-    def to_uri(schemes = ['https', 'http'])
-      a = attributes
-      return one.to_uri(schemes) unless a['public']
+    def to_uri(schemes = ["https", "http"])
+      schemes = Array(schemes)
 
-      schemes = [schemes] if !schemes.is_a?(Array)
-      scheme = schemes.reject do |s|
-        a['ports'][s].nil?
-      end.first
-      if a['user'].nil? || a['user'] == ''
-        URI("#{scheme}://#{a['hostname']}:#{a['ports'][scheme]}")
-      else
-        URI("#{scheme}://#{a['user']}:#{a['password']}@#{a['hostname']}:#{a['ports'][scheme]}")
+      return one.to_uri(schemes) unless attributes["public"]
+
+      scheme = schemes.find { |s| attributes["ports"][s] }
+      raise "No valid scheme found" unless scheme
+
+      if attributes["user"].nil? || attributes["user"].empty?
+        return URI("#{scheme}://#{attributes["hostname"]}:#{attributes["ports"][scheme]}")
       end
+
+      URI("#{scheme}://#{attributes["user"]}:#{attributes["password"]}@#{attributes["hostname"]}:#{attributes["ports"][scheme]}")
     end
 
     def to_s
-      to_uri.to_s
+      uri = to_uri
+      if uri.userinfo
+        user, _password = uri.userinfo.split(":", 2)
+        uri.userinfo = "#{user}:REDACTED"
+      end
+      uri.to_s
     end
 
     def to_json
@@ -66,8 +71,8 @@ module EtcdDiscovery
     end
 
     def set_credentials(user, password)
-      @attributes['user'] = user
-      @attributes['password'] = password
+      @attributes["user"] = user
+      @attributes["password"] = password
     end
   end
 end

data/lib/etcd-discovery.rb

@@ -1,11 +1,11 @@
 ## Require files from etcd-discovery
 
-require 'etcd'
-require 'json'
-require 'logger'
+require "etcd"
+require "json"
+require "logger"
 
 dir = File.join File.dirname(__FILE__), "etcd-discovery"
-Dir["#{dir}/*.rb"].each do |file|
+Dir["#{dir}/*.rb"].sort.each do |file|
   require file
 end
 
@@ -17,7 +17,7 @@ module EtcdDiscovery
   end
 
   def self.configure(&block)
-    yield config if block_given?
+    yield config if block
     config.validate
   end
 

data/spec/etcd-discovery/registrar_spec.rb

@@ -1,16 +1,16 @@
-require 'spec_helper.rb'
+require "spec_helper"
 
 RSpec.describe EtcdDiscovery::Registrar do
   context "without a running client" do
-    describe '.new' do
-      context 'with a Hash' do
+    describe ".new" do
+      context "with a Hash" do
         subject { EtcdDiscovery::Registrar.new "service", {"name" => "example.com", "ports" => {"http" => 80}} }
         it "should transform the has in Host" do
           expect(subject.host.attributes["name"]).to eq "example.com"
         end
       end
 
-      context 'with a EtcdDiscovery::Host' do
+      context "with a EtcdDiscovery::Host" do
         subject { EtcdDiscovery::Registrar.new "service", EtcdDiscovery::Host.new({"name" => "example.com", "ports" => {"http" => 80}}) }
         it "should defines the state to new" do
           expect(subject.state).to eq :new
@@ -22,40 +22,81 @@ RSpec.describe EtcdDiscovery::Registrar do
   context "with an unregistered client" do
     subject { EtcdDiscovery::Registrar.new "service", EtcdDiscovery::Host.new({"name" => "example.com", "ports" => {"http" => 80}}) }
 
-    describe '#stop' do
+    describe "#stop" do
       it "should raise an exception if service not registered" do
-        expect{ subject.stop }.to raise_exception EtcdDiscovery::InvalidStateError
+        expect { subject.stop }.to raise_exception EtcdDiscovery::InvalidStateError
       end
     end
 
     its(:client) { is_expected.to eq EtcdDiscovery.config.client }
-    its(:key) { is_expected.to eq "/services/service/example.com" }
+    its(:host_key) { is_expected.to start_with "/services/service/" }
   end
 
   context "with a registered client" do
-    subject { EtcdDiscovery::Registrar.new("service", EtcdDiscovery::Host.new({"name" => "example.com", "ports" => {"http" => 80}})) }
+    let(:info) do
+      {
+        "name" => "service",
+        "critical" => true,
+        "hostname" => "public.scalingo.test",
+        "user" => "user",
+        "password" => "secret",
+        "ports" => {"https" => "5000", "http" => 80},
+        "public" => true
+      }
+    end
+    let(:host) do
+      {
+        "name" => info["hostname"],
+        "service_name" => info["name"],
+        "ports" => info["ports"],
+        "user" => info["user"],
+        "password" => info["secret"],
+        "public" => info["public"],
+        "private_ports" => info["ports"],
+        "critical" => info["critical"],
+        "private_hostname" => "private01.scalingo.test",
+        "uuid" => "my-uuid"
+      }
+    end
+    subject do
+      EtcdDiscovery::Registrar.new(
+        info["name"],
+        EtcdDiscovery::Host.new({"name" => info["hostname"], "ports" => info["ports"]})
+      )
+    end
 
-    before(:each) do subject.register ; sleep 0.2 ; end
-    after(:each) do subject.stop if subject.state == :started ; end
+    before(:each) do
+      mock_service_info(info["name"], info, true)
+      mock_hosts(info["name"], host, 1)
+      mock_set_service_key(info["name"])
+      mock_set_host_key(info["name"], subject.host.attributes["uuid"])
 
-    describe '#register' do
-      its(:thread) { is_expected.not_to eq nil }
-      it "s thread should be alived" do
-        expect(subject.thread.alive?).to eq true
-      end
+      subject.register
+    end
+
+    after(:each) do
+      mock_delete_host_key(info["name"], subject.host.attributes["uuid"])
+      subject.stop if subject.state == :started
     end
 
     describe "#stop" do
       it "should stop its registering thread" do
+        mock_delete_host_key(info["name"], subject.host.attributes["uuid"])
+
         subject.stop
-        sleep 0.2
+        # Wait for the register thread to detect the change of @state and stop.
+        sleep 0.3
         expect(subject.thread.alive?).to eq false
       end
 
-      it "should remote the etcd key of the service" do
-        expect(EtcdDiscovery.get("service").length).to eq 1
+      it "should set the service state to stopped" do
+        mock_service_info(info["name"], info)
+        mock_delete_host_key(info["name"], subject.host.attributes["uuid"])
+        expect(EtcdDiscovery.get(info["name"]).all.length).to eq 1
+
         subject.stop
-        expect { EtcdDiscovery.get("service") }.to raise_exception EtcdDiscovery::ServiceNotFound
+
+        expect(subject.state).to eq :stopped
       end
     end
   end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ Bundler.require(:default, :development, :test)
 
 EtcdDiscovery.config.register_renew = 0.1
 
-require 'webmock/rspec'
+require "webmock/rspec"
 WebMock.disable_net_connect!(allow_localhost: false)
 
 require_relative "./etcd_helper"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etcd-discovery
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.1
 platform: ruby
 authors:
 - Léo Unbekandt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: etcd
@@ -43,7 +43,7 @@ homepage: http://github.com/Scalingo/etcd-discovery-ruby
 licenses:
 - BSD
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,15 +51,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Service discovery based on etcd
 test_files: []