service_skeleton 0.0.0.48.g4a40599 → 1.0.4

data/ultravisor/spec/ultravisor/shutdown_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+require_relative "../spec_helper"
+
+require_relative "../../lib/ultravisor"
+
+describe Ultravisor do
+  let(:args) { {} }
+  let(:ultravisor) { Ultravisor.new(**args) }
+  let(:mock_thread) { instance_double(Thread) }
+
+  describe "#shutdown" do
+    it "takes the @op_m lock" do
+      expect(ultravisor.instance_variable_get(:@op_m)).to receive(:synchronize).and_call_original
+
+      ultravisor.shutdown
+    end
+
+    context "when the ultravisor isn't running" do
+      it "returns itself" do
+        expect(ultravisor.shutdown).to eq(ultravisor)
+      end
+    end
+
+    context "when the ultravisor is running" do
+      before(:each) do
+        ultravisor.instance_variable_set(:@running_thread, mock_thread)
+        allow(ultravisor.instance_variable_get(:@op_cv))
+          .to receive(:wait) do
+          ultravisor.instance_variable_set(:@running_thread, nil)
+        end
+      end
+
+      it "signals the ultravisor to shutdown" do
+        expect(ultravisor.instance_variable_get(:@queue)).to receive(:<<).with(:shutdown)
+
+        ultravisor.shutdown
+      end
+
+      it "waits until the CV is signalled" do
+        expect(ultravisor.instance_variable_get(:@op_cv)).to receive(:wait) do |m|
+          expect(m).to eq(ultravisor.instance_variable_get(:@op_m))
+            ultravisor.instance_variable_set(:@running_thread, nil)
+            nil
+        end
+
+        ultravisor.shutdown
+      end
+
+      context "when asked to not wait" do
+        it "doesn't wait on the CV" do
+          expect(ultravisor.instance_variable_get(:@op_cv)).to_not receive(:wait)
+
+          ultravisor.shutdown(wait: false)
+        end
+      end
+
+      it "returns itself" do
+        expect(ultravisor.shutdown).to eq(ultravisor)
+      end
+
+      context "when forced" do
+        before(:each) do
+          allow(mock_thread).to receive(:kill)
+        end
+
+        it "kills the thread" do
+          expect(mock_thread).to receive(:kill)
+
+          ultravisor.shutdown(force: true)
+        end
+
+        it "tells everyone waiting for the shutdown that the deed is done" do
+          expect(ultravisor.instance_variable_get(:@op_cv)).to receive(:broadcast)
+
+          ultravisor.shutdown(force: true)
+        end
+
+        it "unsets the running thread" do
+          ultravisor.shutdown(force: true)
+
+          expect(ultravisor.instance_variable_get(:@running_thread)).to be(nil)
+        end
+
+        it "doesn't wait on the CV" do
+          expect(ultravisor.instance_variable_get(:@op_cv)).to_not receive(:wait)
+
+          ultravisor.shutdown(force: true)
+        end
+
+        context "with children" do
+          let(:child) { Ultravisor::Child.new(id: :one, klass: Object, method: :to_s) }
+
+          before(:each) do
+            ultravisor.instance_variable_set(:@children, [[:child, child]])
+          end
+
+          it "forcibly shuts down the children" do
+            expect(child).to receive(:shutdown).with(force: true)
+
+            ultravisor.shutdown(force: true)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.0.0.48.g4a40599
+  version: 1.0.4
 platform: ruby
 authors:
 - Matt Palmer
-autorequire: 
+- Sam Saffron
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-01 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -86,20 +87,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: ultravisor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.a
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.a
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -188,16 +175,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -230,16 +217,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
@@ -290,15 +277,16 @@ description: |
   for your services, as well as a collection of helper classes to manage
   common aspects of a system service.
 email:
-- matt.palmer@discourse.org
+- sam.saffron@discourse.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".git-blame-ignore-revs"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -331,10 +319,41 @@ files:
 - lib/service_skeleton/ultravisor_children.rb
 - lib/service_skeleton/ultravisor_loggerstash.rb
 - service_skeleton.gemspec
+- ultravisor/.yardopts
+- ultravisor/Guardfile
+- ultravisor/README.md
+- ultravisor/lib/ultravisor.rb
+- ultravisor/lib/ultravisor/child.rb
+- ultravisor/lib/ultravisor/child/call.rb
+- ultravisor/lib/ultravisor/child/call_receiver.rb
+- ultravisor/lib/ultravisor/child/cast.rb
+- ultravisor/lib/ultravisor/child/cast_receiver.rb
+- ultravisor/lib/ultravisor/child/process_cast_call.rb
+- ultravisor/lib/ultravisor/error.rb
+- ultravisor/lib/ultravisor/logging_helpers.rb
+- ultravisor/spec/example_group_methods.rb
+- ultravisor/spec/example_methods.rb
+- ultravisor/spec/spec_helper.rb
+- ultravisor/spec/ultravisor/add_child_spec.rb
+- ultravisor/spec/ultravisor/child/call_spec.rb
+- ultravisor/spec/ultravisor/child/cast_spec.rb
+- ultravisor/spec/ultravisor/child/id_spec.rb
+- ultravisor/spec/ultravisor/child/new_spec.rb
+- ultravisor/spec/ultravisor/child/restart_delay_spec.rb
+- ultravisor/spec/ultravisor/child/restart_spec.rb
+- ultravisor/spec/ultravisor/child/run_spec.rb
+- ultravisor/spec/ultravisor/child/shutdown_spec.rb
+- ultravisor/spec/ultravisor/child/spawn_spec.rb
+- ultravisor/spec/ultravisor/child/unsafe_instance_spec.rb
+- ultravisor/spec/ultravisor/child/wait_spec.rb
+- ultravisor/spec/ultravisor/new_spec.rb
+- ultravisor/spec/ultravisor/remove_child_spec.rb
+- ultravisor/spec/ultravisor/run_spec.rb
+- ultravisor/spec/ultravisor/shutdown_spec.rb
 homepage: https://github.com/discourse/service_skeleton
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -345,12 +364,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: The bare bones of a service
 test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-
-rvm:
-  - 2.5.3
-  - 2.4.5
-  - 2.3.8
-
-gemfile:
-  - Gemfile