synapse-nginx 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73199a08eec1e313f37926a0c8c38dd00ebca0b5
-  data.tar.gz: a36bede5643dbd71b4fb5baf9c886c876adf609b
+  metadata.gz: 17104df4947dd6df10df533cfc41154754cc4d76
+  data.tar.gz: 559be673ff3f04e95884df1bdf85c6baae328c0e
 SHA512:
-  metadata.gz: ac9a2eb24360488f1f04ba77049fce586f0ba73d7af8df5f69209c95d528ba09eb3eccdc1aa5f58d9563dfa06ed07d9a22724cce5bc40297fa8f07e10d5c28a1
-  data.tar.gz: 60a8611e1acd216065d9674006c11d212d4615c9e45fbeb6e94e942f6daca3cc100c448b568d4af0f1c9dcd6a6dad2381f901c7f583f2f0cae6868feaf8cc4bd
+  metadata.gz: f73b1cc80e16696f4361425106dbba149e4f5a7afd38c03d1aaf91a43fb20e639064a6feb823ec8532729e998c0d4d9859a9851f998d12e59c069ad0fb1555a3
+  data.tar.gz: a8d8bca8f7cbdd7e877dac62e9a2e250006b57eb5c65f72f82f1a517b77b4ae21738d8ebd501091fecd6d75088585138d98f1f0794f3743cab23f2434ac7f25f

data/README.md

@@ -54,7 +54,8 @@ Required if `do_writes` is set.
 You can control reloading with:
 * `do_reloads`: whether or not Synapse will reload nginx automatically (default to `true`)
 * `reload_command`: the command Synapse will run to reload NGINX. Required if `do_reloads` is set.
-* `start_command`: the command Synapse will run to start NGINX the first time. Required if `do_reloads` is set.
+* `start_command`: the command Synapse will run to start NGINX the first time. Required if `do_reloads` is set. You probably want this to check
+  if the existing NGINX is running (e.g. by sending the 0 signal to the master pid).
 * `restart_interval`: number of seconds to wait between restarts of NGINX (default: 2)
 * `restart_jitter`: percentage, expressed as a float, of jitter to multiply the `restart_interval` by when determining the next
   restart time. Use this to help prevent storms when HAProxy restarts. (default: 0.0)

data/lib/synapse-nginx.rb

@@ -1,6 +1,6 @@
 module Synapse
   module Nginx
     # Version information for Synapse::Nginx
-    VERSION = "0.2.3"
+    VERSION = "0.2.4"
   end
 end

data/lib/synapse/config_generator/nginx.rb

@@ -71,6 +71,11 @@ class Synapse::ConfigGenerator
     def tick(watchers)
       @time += 1
 
+      # Always ensure we try to start at least once
+      # Note that this should only trigger during error cases where for
+      # some reason Synapse could not start NGINX during the initial restart
+      start if opts['do_reloads'] && !@has_started
+
       # We potentially have to restart if the restart was rate limited
       # in the original call to update_config
       restart if opts['do_reloads'] && @restart_required
@@ -289,6 +294,19 @@ class Synapse::ConfigGenerator
       end
     end
 
+    def start
+      log.info "synapse: attempting to run #{opts['start_command']} to get nginx started"
+      log.info 'synapse: this can fail if nginx is already running'
+      begin
+        `#{opts['start_command']}`.chomp
+      rescue Exception => e
+        log.warn "synapse: error in NGINX start: #{e.inspect}"
+        log.warn e.backtrace
+      ensure
+        @has_started = true
+      end
+    end
+
     # restarts nginx if the time is right
     def restart
       if @time < @next_restart
@@ -299,13 +317,8 @@ class Synapse::ConfigGenerator
       @next_restart = @time + @restart_interval
       @next_restart += rand(@restart_jitter * @restart_interval + 1)
 
-      # do the actual restart
-      unless @has_started
-        log.info "synapse: attempting to run #{opts['start_command']} to get nginx started"
-        log.info 'synapse: this can fail if nginx is already running'
-        res = `#{opts['start_command']}`.chomp
-        @has_started = true
-      end
+      # On the very first restart we may need to start
+      start unless @has_started
 
       res = `#{opts['reload_command']}`.chomp
       unless $?.success?

data/spec/lib/synapse/nginx_spec.rb

@@ -94,4 +94,69 @@ describe Synapse::ConfigGenerator::Nginx do
       subject.update_config(watchers)
     end
   end
+
+  describe '#update_config' do
+    let(:watchers) { [mockwatcher] }
+
+    shared_context 'generate_config is stubbed out' do
+      let(:new_config) { 'this is a new config!' }
+      before { allow(subject).to receive(:generate_config).and_return(new_config) }
+    end
+
+    it 'always updates the config' do
+      expect(subject).to receive(:generate_config).with(watchers)
+      subject.update_config(watchers)
+    end
+
+    context 'if we support config writes' do
+      include_context 'generate_config is stubbed out'
+      before { config['nginx']['do_writes'] = true }
+
+      it 'writes the new config' do
+        expect(subject).to receive(:write_config).with(new_config)
+        subject.update_config(watchers)
+      end
+    end
+
+    context 'when we support config writes and reloads' do
+      include_context 'generate_config is stubbed out'
+
+      before do
+        config['nginx']['do_writes'] = true
+        config['nginx']['do_reloads'] = true
+        allow(subject).to receive(:write_config).and_return(true)
+        allow(subject).to receive(:`).and_return('it worked')
+      end
+
+      it 'always does a restarts and only starts once' do
+        expect(subject).to receive(:write_config).with(new_config).twice
+        expect(subject).to receive(:restart).twice.and_call_original
+        expect(subject).to receive(:start).once.and_call_original
+        subject.update_config(watchers)
+        subject.update_config(watchers)
+      end
+    end
+  end
+
+  describe '#tick' do
+    let(:watchers) { [mockwatcher] }
+
+    context 'when we support reloads' do
+      before do
+        config['nginx']['do_reloads'] = true
+        config['nginx']['start_command'] = 'foo'
+        config['nginx']['reload_command'] = 'bar'
+        allow(subject).to receive(:start)
+        allow(subject).to receive(:restart)
+        allow(subject).to receive(:`).and_return('it worked')
+      end
+
+      it 'does start once' do
+        expect(subject).to receive(:start).once.and_call_original
+        expect(subject).not_to receive(:restart)
+        subject.tick(watchers)
+        subject.tick(watchers)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synapse-nginx
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Joseph Lynch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: synapse