razorrisk-cassini-utilities-cassid 0.8.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a20a127dff057f134d43aff004ec6b89fa7ca76745f7040b9d8e7c7c651d6dc8
+  data.tar.gz: ac515f0f87b992c5e5981074d3c1610028d0714f93d17be818625306cb805b95
+SHA512:
+  metadata.gz: a1e1fee413b545600b7ccbdf2ba33aa3d3108657a0f9d0e6c2001a2ebc0f23817495de73707a5ffcb13d8f063e7f57a80637d0734e46edd53145f27edab8577c
+  data.tar.gz: 75b9b4ab865c853c1694c0546b7929859a5f27bea6514b19f96172a4898c751345a6a0af285a3f4abf8703d15c20e3597c55f138099c57101e51266dea101be1

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log
+
+## [0.5.3] (2018-07-05)
+
+**Implemented enhancements:**
+
+none
+
+**Fixed defects:**
+
+none
+
+**Dependencies and packaging:**
+
+- separated into own project/repo/package [WEBAPI-138]
+
+**Merged pull requests:**
+
+none
+
+## END OF CHANGE LOG
+

data/LICENSE

@@ -0,0 +1,5 @@
+Cassini
+
+Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+All rights reserved.
+

data/README.md

@@ -0,0 +1,2 @@
+T.B.C.
+

data/bin/cassid

@@ -0,0 +1,279 @@
+#! /usr/bin/env ruby
+# encoding: UTF-8
+
+# ##########################################################################
+#
+# Startup daemon for Cassini
+#
+# Copyright (c) 2018 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/utilities/cassid'
+
+require 'razor_risk/cassini/cli'
+require 'razor_risk/cassini/diagnostics/util_functions'
+require 'razor_risk/cassini/util/version_util'
+
+require 'razor_risk/extensions/hash/dig'
+require 'razor_risk/core/diagnostics/extensions/libclimate'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'libclimate'
+require 'pantheios'
+require 'recls'
+
+require 'nokogiri'
+require 'socket'
+require 'yaml'
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Utilities::CassiD
+
+include ::RazorRisk::Cassini::Diagnostics
+
+include ::RazorRisk::Cassini::Util::VersionUtil
+
+include ::RazorRisk::Core::Diagnostics::Logger
+
+# ##########################################################################
+# version
+
+PROGRAM_VERSION =   ::RazorRisk::Cassini::Utilities::CassiD::VERSION
+
+# ##########################################################################
+# constants
+
+SERVICE_NAME         = 'razorrisk-service-cassid'
+SERVICE_DISPLAY_NAME = 'Razor Web Services'
+SERVICE_DESCRIPTION  = 'Razor Risk Web Service API'
+DEPRECIATION_NOTICE  = 'NOTICE: this option has been depreciated in favour of service installation'
+RUBY_PATH            = `where ruby`.split("\n")[0].chomp
+
+
+#############################################################################
+# compatibility checks
+
+check_version_compatibility RazorRisk::Core::Diagnostics::Extensions, '0.2'
+check_version_compatibility ::LibCLImate, '0.8'
+check_version_compatibility ::Pantheios, '0.20'
+check_version_compatibility ::Recls, '2.8'
+
+
+# Listens on the specified port for the message 'exit' and returns when it is
+# received.
+#
+# @param port [Integer] The port to listen on.
+#
+# @raise [Errno::EADDRINUSE] if the port is alredy in use.
+def listen_for_exit port
+
+    TCPServer.open(port) do |server|
+        log :notice, "Listening for exit message on port #{port}"
+        loop do
+            client = server.accept
+
+            line = ''
+            while c = client.getc
+                line += c
+                break if 4 < line.length
+            end
+            client.close
+
+            if /^exit$/i =~ line
+                break
+            end
+        end
+    end
+end
+
+# ##########################################################################
+# command-line processing
+
+options      = {}
+service_args = []
+
+climate = LibCLImate::Climate.new do |cl|
+
+    cl.add_option('--detach-child-processes', help: DEPRECIATION_NOTICE) do
+        log :warning, DEPRECIATION_NOTICE
+    end
+    cl.add_alias('--detach-child-processes=true', '-d')
+    cl.add_alias('--detach-child-processes=false', '-D')
+
+    cl.add_option(
+        '--microservice-multiplier',
+        alias: '-m',
+        help: "overrides the 'us_multiplier' configuration setting to the given number. Must be greater than 0"
+    ) do |o, a|
+        service_args << o.given_name
+        service_args << o.value
+    end
+
+    cl.add_flag(
+        '--monitor-startup',
+        help: 'monitors child process statuses during initialisation'
+    ) do
+        service_args << '--monitor-startup'
+    end
+
+    cl.add_flag(
+        '--pedantic',
+        help: 'conducts checks that the configuration is correct'
+    ) do
+        service_args << '--pedantic'
+    end
+
+    cl.add_option(
+        '--max-restarts',
+        help: 'maximum number of times to restart a microservice; this is only available when running as a service'
+    ) do |o, a|
+        val = Integer(o.value, nil: true)
+        climate.abort(
+            "max retries must be 0 or a positive integer; use --help for usage"
+        ) if val.nil? || val < 0
+        service_args << o.given_name
+        service_args << o.value
+    end
+
+    cl.add_option(
+        '--service-name',
+        help: 'service installation name'
+    ) do |o, a|
+        options[:service_name] = (o.value || '').chomp
+        climate.abort 'Service name may not be empty' if options[:service_name].empty?
+    end
+
+    cl.add_option(
+        '--service-display-name',
+        help: 'service installation display name'
+    ) do |o, a|
+        options[:service_display_name] = (o.value || '').chomp
+        climate.abort 'Service display name may not be empty' if options[:service_display_name].empty?
+    end
+
+    cl.add_option('--exit-listener-port',
+        alias: '-e',
+        help: "sets the port number to listen on for an exit command, must be in range #{Main::VALID_PORTS}; NOTE: this is for testing only"
+    ) do |o, a|
+
+        options[:exit_port] = Integer(o.value, nil: true) and Main::VALID_PORTS.include?(options[:exit_port]) or climate.abort "invalid value port number; use --help for usage"
+    end
+
+    cl.option_log_threshold(
+        options,
+        no_program_name: true,
+        no_benchmark: true,
+        limit: -2
+    )
+
+    cl.usage_values = '[ <config-yaml-file> | register <config-yaml-file> | unregister | start | stop'
+
+    cl.info_lines = [
+
+        'Startup Daemon for Cassini',
+        ::RazorRisk::Cassini::CLI.Copyright(2018),
+        :version,
+        '',
+        'Executes a Cassini instance based on a configuration file',
+        '',
+    ]
+end
+
+r = climate.run ARGV.dup
+
+begin
+    case r.values[0].downcase
+    when 'start'
+
+        name    = options[:service_name] || SERVICE_NAME
+        service = ServiceController.new(name)
+        if service.start
+            $stdout.puts "Started #{name} as a service"
+        else
+            $stdout.puts "Failed to start #{name} as a service"
+        end
+    when 'stop'
+
+        name    = options[:service_name] || SERVICE_NAME
+        service = ServiceController.new(name)
+        if service.stop
+            $stdout.puts "Stopped #{name} service"
+        else
+            $stdout.puts "Failed to stop #{name} service"
+        end
+    when 'unregister'
+
+        name    = options[:service_name] || SERVICE_NAME
+        service = ServiceController.new(name)
+        if service.unregister
+            $stdout.puts "Removed service #{name}"
+        else
+            $stderr.puts "Failed to removed service #{name}"
+        end
+
+    when 'register'
+
+        config_file  = r.values[1] || ''
+        name         = options[:service_name] || SERVICE_NAME
+        display_name = options[:service_display_name] || SERVICE_DISPLAY_NAME
+        service      = ServiceController.new(name)
+
+        if service.register(
+            display_name,
+            SERVICE_DESCRIPTION,
+            Dir.pwd,
+            File.join('bin', SERVICE_NAME),
+            config_file,
+            RUBY_PATH,
+            *service_args,
+        )
+            $stdout.puts "Registered #{display_name} (#{name}) as a service"
+        else
+            $stdout.puts "Failed to register #{display_name} (#{name}) as a service"
+        end
+    else
+
+        config_path = r.values[0] || ''
+        exit_port   = options[:exit_port]
+
+        config_path, options = Main::process_cli(*ARGV.dup)
+
+        at_exit do
+            Main::kill_children
+        end
+
+        trap 'SIGINT' do
+            climate.abort "processing cancelled ..."
+        end
+
+        Main::init_logging(nil, nil, nil)
+        Main::init(config_path, **options)
+
+        $stdout.puts
+        $stdout.puts "Use Ctrl-C to terminate, along with all child processes"
+
+        if exit_port
+            begin
+                listen_for_exit exit_port
+            rescue Errno::EADDRINUSE
+                msg = "Exit port #{exit_port} is already in use"
+                log :critical, msg
+                climate.abort msg
+            end
+        else
+            loop { sleep(1) }
+        end
+    end
+rescue => x
+    climate.abort x.message
+end
+
+# ############################## end of file ############################# #
+
+

data/bin/razorrisk-service-cassid

@@ -0,0 +1,90 @@
+#! /usr/bin/env ruby
+# encoding: UTF-8
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/utilities/cassid'
+require 'razor_risk/cassini/diagnostics/util_functions'
+
+require 'razor_risk/core/diagnostics/extensions/libclimate'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'libclimate'
+require 'pantheios'
+
+require 'win32/daemon'
+
+# ##########################################################
+# includes
+
+include ::RazorRisk::Cassini::Utilities::CassiD
+include ::RazorRisk::Cassini::Diagnostics
+
+
+# ##########################################################################
+# version
+
+PROGRAM_VERSION = ::RazorRisk::Cassini::Utilities::CassiD::VERSION
+
+
+# ##########################################################
+# Service Main
+
+class CassiDDaemon < Win32::Daemon
+
+    include ::Pantheios
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    at_exit do
+
+        log :notice, 'Service stopping...'
+        begin
+            Main::kill_children
+        rescue => x
+            log :critical, "Failed to kill child processes (#{x.class}): #{x.message})"
+            exit! 1
+        else
+            exit!
+        end
+    end
+
+    def service_main
+
+        Main::init_logging(nil, nil, nil)
+
+        log :informational, 'Started CassiD Service'
+
+        config_path, options = Main::process_cli(*ARGV.dup)
+
+        Main::init(config_path, **options)
+
+        while running?
+            loop do
+                unless Main::children_running?
+                    Main::restart_children(options[:max_restarts])
+                end
+                sleep 10
+            end
+        end
+    end
+
+    def service_stop
+
+        log :informational, "Stopping CassiD Service"
+        exit
+    end
+end
+
+CassiDDaemon.mainloop
+
+
+# ############################## end of file ############################# #
+
+