service_skeleton 0.0.0.1.ENOTAG

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

@@ -0,0 +1,375 @@
+--- !ruby/object:Gem::Specification
+name: service_skeleton
+version: !ruby/object:Gem::Version
+  version: 0.0.0.1.ENOTAG
+platform: ruby
+authors:
+- Matt Palmer
+- Sam Saffron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: frankenstein
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: loggerstash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sigdump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: to_regexp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git-version-bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-discourse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  When you need to write a program that provides some sort of persistent
+  service, there are some things you always need.  Logging, metrics,
+  extracting configuration from the environment, signal handling, and so on.
+  This gem provides ServiceSkeleton, a template class you can use as a base
+  for your services, as well as a collection of helper classes to manage
+  common aspects of a system service.
+email:
+- sam.saffron@discourse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".git-blame-ignore-revs"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- LICENCE
+- README.md
+- lib/service_skeleton.rb
+- lib/service_skeleton/config.rb
+- lib/service_skeleton/config_class.rb
+- lib/service_skeleton/config_variable.rb
+- lib/service_skeleton/config_variable/boolean.rb
+- lib/service_skeleton/config_variable/enum.rb
+- lib/service_skeleton/config_variable/float.rb
+- lib/service_skeleton/config_variable/integer.rb
+- lib/service_skeleton/config_variable/kv_list.rb
+- lib/service_skeleton/config_variable/path_list.rb
+- lib/service_skeleton/config_variable/string.rb
+- lib/service_skeleton/config_variable/url.rb
+- lib/service_skeleton/config_variable/yaml_file.rb
+- lib/service_skeleton/config_variables.rb
+- lib/service_skeleton/error.rb
+- lib/service_skeleton/filtering_logger.rb
+- lib/service_skeleton/generator.rb
+- lib/service_skeleton/logging_helpers.rb
+- lib/service_skeleton/metric_method_name.rb
+- lib/service_skeleton/metrics_methods.rb
+- lib/service_skeleton/runner.rb
+- lib/service_skeleton/service_name.rb
+- lib/service_skeleton/signal_manager.rb
+- lib/service_skeleton/signals_methods.rb
+- 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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: The bare bones of a service
+test_files: []