watchmonkey_cli 1.5 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 856c3354f0039a351a73dfd0175af79e387078fb
-  data.tar.gz: 07e20ff5db1bc068d50784b826a05d412b5a7836
+  metadata.gz: c8e8b3281a2641174927f13de6f09d0bf2c35988
+  data.tar.gz: 1dbd8ec4d401dae1651fae131a874381242365f6
 SHA512:
-  metadata.gz: e19791d169aa0d08700b7f85a2b38932271f640b676737f50ecd0beab86c87486068967f5a3ed896925d4fc43548a09932bed2cec201d8fc9ba58d62ed4d3538
-  data.tar.gz: 1fa78746dafc66551783806f3ea963badf8aae01a61fdc23fdf349655449721c6203837607013506279d513c8f6cc0f7b44c00de008b22f91b58a7614d658077
+  metadata.gz: 41cffe415bdb00af10d9ee99ce1a5a59db0f9fa989c2938eefb329c378f4b16687774713946a82b02e4b44c23f6a48187f942ed96ace18a992f235ea58935ba1
+  data.tar.gz: 6be8aa148f2a41b3a4766e34ed02f9192d6591aa7486c49250190adced0e3546b1dfb4b7b898a098741d82ff089622541743ab4ddb4d8104c4933741c3d552c1

data/.gitignore

@@ -7,7 +7,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc

data/README.md

@@ -68,21 +68,21 @@ If you want to deactivate single configs just rename the file to start with two
 
 
 ## Application configuration
-If you want to add custom checkers, hooks or change default settings you can create `~/.watchmonkey/config.rb`. The file will be eval'd in the application object's context. Take a look at the [example configuration file](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/application.rb) and [application.rb](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/doc/config_example.rb).
+If you want to add custom checkers, hooks or change default settings you can create `~/.watchmonkey/config.rb`. The file will be eval'd in the application object's context. Take a look at the [example configuration file](https://github.com/2called-chaos/watchmonkey_cli/blob/master/doc/config_example.rb) and [application.rb](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/application.rb).
 
 
 ## Custom checkers
-If you want to monitor something that is not covered by the buildin handlers you can create your own, it's not that hard and should be a breeze if you are used to Ruby. All descendants of the `WatchmonkeyCli::Checker` class will be initialized and are usable in the application. Documentation is thin but you can take a look at the [example checker](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/doc/checker_example.rb), the [buildin checkers](https://github.com/2called-chaos/watchmonkey_cli/tree/master/lib/watchmonkey_cli/checkers) or just [open an issue](https://github.com/2called-chaos/watchmonkey_cli/issues/new) and I might just implement it real quick.
+If you want to monitor something that is not covered by the buildin handlers you can create your own, it's not that hard and should be a breeze if you are used to Ruby. All descendants of the `WatchmonkeyCli::Checker` class will be initialized and are usable in the application. Documentation is thin but you can take a look at the [example checker](https://github.com/2called-chaos/watchmonkey_cli/blob/master/doc/checker_example.rb), the [buildin checkers](https://github.com/2called-chaos/watchmonkey_cli/tree/master/lib/watchmonkey_cli/checkers) or just [open an issue](https://github.com/2called-chaos/watchmonkey_cli/issues/new) and I might just implement it real quick.
 
 
 ## Additional Features
 
 ### ReQueue
 By default Watchmonkey will run all tests once and then exit. This addon will enable Watchmonkey to run in a loop and run tests on a periodic interval.
-Since this seems like a core feature it might get included directly into Watchmonkey but for now take a look at the documentation in the [ReQueue source code](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/requeue.rb) for integration instructions.
+Since this seems like a core feature it might get included directly into Watchmonkey but for now take a look at the [application configuration file](https://github.com/2called-chaos/watchmonkey_cli/blob/master/doc/config_example.rb) and [ReQueue source code](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/requeue.rb) for integration examples.
 
 ### Platypus support
-[Platypus](http://sveinbjorn.org/platypus) is a MacOS software to create dead simple GUI wrappers for scripts. There is buildin support for the interface types ProgressBar and WebView. For information look at the documentation in the [Platypus hook source code](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/platypus.rb).
+[Platypus](http://sveinbjorn.org/platypus) is a MacOS software to create dead simple GUI wrappers for scripts. There is buildin support for the interface types ProgressBar and WebView. For integration examples take a look at the [application configuration file](https://github.com/2called-chaos/watchmonkey_cli/blob/master/doc/config_example.rb) and [Platypus hook source code](https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/platypus.rb).
 
 
 ## Contributing

data/VERSION

@@ -1 +1 @@
-1.5
+1.6

data/doc/checker_example.rb

@@ -0,0 +1,67 @@
+# You will need to place this file somewhere and require it in your
+# `~/.watchmonkey/config.rb` in order for it to register in the application.
+# You can also place it into `~/watchmonkey/checkers/` and it will get required
+# automatically unless the file name starts with two underscores.
+
+module MyWatchmonkeyCheckers
+  class MyChecker < WatchmonkeyCli::Checker
+    # ============
+    # = Required =
+    # ============
+    # This name defines how you can add tests in your configs.
+    #     e.g. my_checker "http://google.com", some_option: true
+    self.checker_name = "my_checker"
+
+    # Called by configuration defining a check with all the arguments.
+    #   e.g. my_checker "http://google.com", some_option: true
+    # Should invoke `app.enqueue` which will by default call `#check!` method with given arguments.
+    def enqueue host, opts = {}
+      opts = { some_option: false }.merge(opts)
+
+      # If you want to exec commands (locally or SSH) usually a connection or symbol is passed.
+      # The buildin handlers follow this logic:
+      host = app.fetch_connection(:loopback, :local) if !host || host == :local
+      host = app.fetch_connection(:ssh, host) if host.is_a?(Symbol)
+
+      # requires first argument to be self (the checker), all other arguments are passed to `#check!` method.
+      app.enqueue(self, host, opts)
+    end
+
+    # First argument is the result object, all other arguments came from `app.enqueue` call.
+    def check! result, host, opts = {}
+      # Do your checks and modify the result object.
+      # Debug messages will not show if -s/--silent or -q/--quiet argument is passed.
+      # Info messages will not show if -q/-quiet argument is passed.
+
+      result.error "foo" # add error message (type won't be changed)
+      result.error! "foo" # add error message (type changes to error)
+      result.info "foo"
+      result.info! "foo"
+      result.debug "foo"
+      result.debug! "foo"
+    end
+
+
+
+    # ============
+    # = Optional =
+    # ============
+    def init
+      # hook method (called when checker is being initialized)
+    end
+
+    def start
+      # hook method (called after all checkers were initialized and configs + hosts are loaded)
+      # can/should be used for starting connections, etc.
+    end
+
+    def stop
+      # hook method (called on application shutdown)
+      # connections should be closed here
+
+      # DO NOT CLOSE CONNECTIONS HANDLED BY THE APP!
+      # Keep in mind that the checkers run concurrently
+      # and therefore shared resources might still be in use
+    end
+  end
+end

data/doc/config_example.rb

@@ -0,0 +1,45 @@
+# Create this file as ~/.watchmonkey/config.rb
+# This file is eval'd in the application object's context after it's initialized!
+
+# Change option defaults (arguments will still override these settings)
+# For options refer to application.rb#initialize
+#     https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/application.rb
+@opts[:threads] = 50
+
+
+
+# Integrate ReQueue (module for infinite checking)
+# For options refer to the source code:
+#     https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/requeue.rb
+if @argv.delete("--requeue") || @argv.delete("--reQ")
+  require "watchmonkey_cli/hooks/requeue"
+  WatchmonkeyCli::Requeue.hook!(self)
+
+  # change options after hooking!
+  @opts[:threads] = 8 # don't need as many here because speed is not a concern
+  @opts[:default_requeue] = 60 # default delay before requeuing checker, override with `every: 10.minutes` checker option
+end
+
+
+
+# Integrate Platypus (module for MacOS tool Platypus)
+# For options refer to the source code:
+#     https://github.com/2called-chaos/watchmonkey_cli/blob/master/lib/watchmonkey_cli/hooks/platypus.rb
+if @argv.delete("--platypus")
+  require "watchmonkey_cli/hooks/platypus"
+
+  # Options:
+  #   * notifications(1)
+  #       1 - silent notifications (OS X notifications)
+  #       2 - notifications with sound (OS X notifications)
+  #       everything else disables notifications (and renders the hook somewhat useless)
+  #   * progress(true)
+  #       outputs "PROGRESS:##" for Platypus ProgressBar interface (useless if HTML is enabled)
+  #   * html(false)
+  #       outputs HTML for Platypus WebView interface
+  #   * draw_delay(1)
+  #       seconds between HTML updates (useless if HTML is disabled)
+  WatchmonkeyCli::Platypus.hook!(self, notifications: 1, html: true, draw_delay: 3)
+
+  @opts[:colorize] = false # doesn't render in platypus
+end

data/lib/watchmonkey_cli/checkers/unix_load.rb

@@ -20,6 +20,13 @@ module WatchmonkeyCli
         emsg << "load5 is to high (limit5 is #{opts[:limits][1]}, load5 is #{ld[1]})" if ld[1] > opts[:limits][1]
         emsg << "load15 is to high (limit15 is #{opts[:limits][2]}, load15 is #{ld[2]})" if ld[2] > opts[:limits][2]
         result.error!(emsg.join("\n\t")) if emsg.any?
+
+        # plotter support
+        app.fire :plotter_push, self, host, {
+          load1: ld[0], limit1: opts[:limits][0],
+          load5: ld[1], limit5: opts[:limits][1],
+          load15: ld[2], limit15: opts[:limits][2],
+        }
       end
 
       def _parse_response res

data/lib/watchmonkey_cli/hooks/requeue.rb

@@ -2,10 +2,15 @@ module WatchmonkeyCli
   class Requeue
     def self.hook!(app)
       app.instance_eval do
+        @requeue = []
+
         # app options
         @opts[:loop_forever] = true
         @opts[:logfile] = logger_filename # enable logging
 
+        # scheduler options
+        @opts[:requeue_scheduler_hibernation] = 1 # tickrate of schedule in seconds
+
         # module options
         @opts[:default_requeue]                   = 60
         # @opts[:default_requeue_ftp_availability]  = 60
@@ -19,9 +24,6 @@ module WatchmonkeyCli
         # @opts[:default_requeue_unix_memory]       = 60
         @opts[:default_requeue_www_availability]  = 30
 
-        # Requeue threads
-        @requeue = []
-
 
         # =================
         # = Status thread =
@@ -45,6 +47,25 @@ module WatchmonkeyCli
         end
 
 
+        # =================
+        # = Scheduler thread =
+        # =================
+        @requeue_scheduler_thread = Thread.new do
+          Thread.current.abort_on_exception = true
+          loop do
+            break if $wm_runtime_exiting
+            sync do
+              @requeue.each_with_index do |(run_at, callback), index|
+                next if run_at > Time.now
+                callback.call()
+                @requeue.delete_at(index)
+              end
+            end
+            sleep @opts[:requeue_scheduler_hibernation]
+          end
+        end
+
+
         # =========
         # = Hooks =
         # =========
@@ -61,11 +82,8 @@ module WatchmonkeyCli
 
         hook :wm_shutdown do
           sync do
-            debug "[ReQ] #{@requeue.length} items in requeue..."
-            unless @requeue.empty?
-              @requeue.each(&:kill).each(&:join).select!(&:alive?)
-              debug "[ReQ] #{@requeue.length} items in requeue..."
-            end
+            @requeue_scheduler_thread.try(:join)
+            debug "[ReQ] Clearing #{@requeue.length} items in requeue..."
             @requeue_status_thread.try(:kill).try(:join)
           end
         end
@@ -77,12 +95,9 @@ module WatchmonkeyCli
         def requeue checker, args, delay = 10
           return if $wm_runtime_exiting
           sync do
-            @requeue << Thread.new {
-              Thread.current.abort_on_exception = true
-              sleep(delay)
+            @requeue << [Time.now + delay, ->{
               checker.enqueue(*args)
-              sync { @requeue.delete Thread.current }
-            }
+            }]
           end
         end
       end

data/lib/watchmonkey_cli/version.rb

@@ -1,4 +1,4 @@
 module WatchmonkeyCli
-  VERSION = "1.5"
+  VERSION = "1.6"
   UPDATE_URL = "https://raw.githubusercontent.com/2called-chaos/watchmonkey_cli/master/VERSION"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watchmonkey_cli
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: '1.6'
 platform: ruby
 authors:
 - Sven Pachnit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-24 00:00:00.000000000 Z
+date: 2016-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,6 +112,8 @@ files:
 - VERSION
 - bin/watchmonkey
 - bin/watchmonkey.sh
+- doc/checker_example.rb
+- doc/config_example.rb
 - lib/watchmonkey_cli.rb
 - lib/watchmonkey_cli/application.rb
 - lib/watchmonkey_cli/application/colorize.rb