poise-monit 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b8431aa0868c66f89d7de71426b2f9f1cfb3dbd
-  data.tar.gz: ae851e48383783f8ee8c18731aea27310a9c2077
+  metadata.gz: f47b9d1c32a3af42021e1a8b7cdb98c39e00f4e8
+  data.tar.gz: 9ff65baa3d1da13f8987c783877aba69ac8cdcd6
 SHA512:
-  metadata.gz: a057f285f6ab413378e3a6cc863ff11a98698ce8470f5e2b249d0cb2a0576aa28574c14bdb60cacc5d6d83d1c71d00368e12b168d675ca735a97a5454c4b3183
-  data.tar.gz: 1a8a1a3895ac84e20bb6d747af4af3724362ac4737231fcf69af42f1b51e24e3613e28c07995fff485afcfe229253a4d9a526234fa005d93220e23c87d91ec16
+  metadata.gz: d7e83a4af5eedb1c12a6fb3fcd95abda4513dc74fa1210736a17afed1131433a42afa7c50888d31406d0f60c1d1d84c9aa68fb4f16a98c44360e828ab992230a
+  data.tar.gz: 425505c36a7d6e2931db851fb6c7d11c638c397cc3d5e920f13e6d0cc12b0cc771ceb3e8d43f78cb5af60369b906d1e688e0c1f58f514beacffec86dd159ca52

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Poise-Monit Changelog
 
+## v1.2.0
+
+* New resource `monit_check` for more easily creating service checks.
+
 ## v1.1.0
 
 * Improve compatibility with Chef 12.4 and earlier.

data/README.md

@@ -146,6 +146,40 @@ end
 
 One of `source` or `content` is required.
 
+### `monit_check`
+
+The `monit_check` resource writes out a Monit configuration file for a service
+check. It is a subclass of `monit_config` and so inherits its actions and
+properties. It defaults to being a process check.
+
+```ruby
+monit_check 'httpd' do
+  check 'if failed port 80 protocol http request "/_status" then restart'
+  extra [
+    'every 5 cycles',
+    'group www',
+  ]
+end
+```
+
+#### Actions
+
+* `:create` – Create and manage the configuration file. *(default)*
+* `:delete` – Delete the configuration file.
+
+#### Properties
+
+* `check_type` – Type of check. *(default: process)*
+* `with` – WITH-ish string for this check. This is the part that goes after the
+  check name. Set to false to disable. *(default: PIDFILE /var/run/check_name.pid)*
+* `start_program` – Command to use to start the service for process checks. Set
+  to false disable. *(default: automatic)*
+* `stop_program` – Command to use to stop the service for process checks. Set
+  to false disable. *(default: automatic)*
+* `check` – Service health check or checks. `'IF '` will be prepended if not
+  given.
+* `extra` – Line or lines to be added to the service definition as is.
+
 ## Monit Providers
 
 ### `binaries`
@@ -223,6 +257,23 @@ end
 
 To set the `monit` provider as the global default, use [`poise-sevice-monit`](https://github.com/poise/poise-service-monit).
 
+## Upgrading From `monit`
+
+Upgrading from the older [`monit` cookbook](https://github.com/poise/poise-monit-compat)
+is relatively straightforward. The `node['monit']` attributes can either be
+converted to `node['poise-monit']['recipe']` if you want to use the default
+recipe, or you can invoke the `monit` resource in your own recipe code if needed.
+
+When switching cookbooks in-place on a server, make sure you check for any
+`conf.d/` config files created by the old cookbook. Notably `conf.d/compat.conf`
+may interfere with the configuration generation. You can remove it:
+
+```ruby
+monit_config 'compat' do
+  action :delete
+end
+```
+
 ## Sponsors
 
 Development sponsored by [Bloomberg](http://www.bloomberg.com/company/technology/).

data/chef/templates/monit_check.conf.erb

@@ -0,0 +1,13 @@
+CHECK <%= @new_resource.check_type.to_s.upcase %> <%= @new_resource.check_name %><% if @new_resource.with %> <%= @new_resource.with %><% end %>
+  <%- if @new_resource.start_program -%>
+  start program = "<%= @new_resource.start_program %>"
+  <%- end -%>
+  <%- if @new_resource.stop_program -%>
+  stop program = "<%= @new_resource.stop_program %>"
+  <%- end -%>
+  <%- Array(@new_resource.check).each do |check_line| -%>
+  <%= check_line !~ /^if/i ? 'IF ' : '' %><%= check_line.strip %>
+  <%- end -%>
+  <%- Array(@new_resource.extra).each do |extra_line| -%>
+  <%= extra_line.strip %>
+  <%- end -%>

data/chef/templates/monit_service.conf.erb

@@ -1,4 +1,4 @@
-check process <%= @service_resource.service_name %> with pidfile <%= @pid_file %>
+check process <%= @service_resource.service_name %> pidfile <%= @pid_file %>
   start program = "<%= @script_path %> start"
   stop program = "<%= @script_path %> stop"
   <%- Array(@options['checks']).each do |line| -%>

data/lib/poise_monit/resources.rb

@@ -15,6 +15,7 @@
 #
 
 require 'poise_monit/resources/monit'
+require 'poise_monit/resources/monit_check'
 require 'poise_monit/resources/monit_config'
 require 'poise_monit/resources/monit_service'
 

data/lib/poise_monit/resources/monit_check.rb

@@ -0,0 +1,158 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'poise_languages/utils'
+require 'poise_monit/resources/monit_config'
+
+
+module PoiseMonit
+  module Resources
+    # (see MonitCheck::Resource)
+    # @since 1.2.0
+    module MonitCheck
+      # A `monit_check` resource to write out a Monit configuration file with a
+      # service check.
+      #
+      # @provides monit_check
+      # @action create
+      # @action delete
+      # @example
+      #   monit_check 'httpd' do
+      #     check 'if failed port 80 protocol http request "/_status" then restart'
+      #   end
+      class Resource < MonitConfig::Resource
+        provides(:monit_check)
+
+        attribute('', template: true, default_source: 'monit_check.conf.erb')
+        # @!attribute check_type
+        #   Type of check. Not making this an explicit array to allow for new
+        #   check types in Monit without a cookbook release.
+        #   @return [String]
+        attribute(:check_type, kind_of: String, default: 'process')
+        # @!attribute with
+        #   WITH-ish string for this check. This is the part that goes after the
+        #   check name. Set to false to disable. Defaults to an automatic PID
+        #   file for process checks and disabled for others.
+        #   @return [String, nil, false]
+        #   @example Process check
+        #     monit_check 'httpd' do
+        #        with 'PIDFILE /var/run/apache2.pid'
+        #     end
+        #   @example File check
+        #     monit_check 'httpd_log' do
+        #       check_type 'file'
+        #       with 'PATH /var/log/apache2/error.log'
+        #     end
+        attribute(:with, kind_of: [String, NilClass, FalseClass], default: lazy { default_with })
+        # @!attribute start_program
+        #   Command to use to start the service for process checks. Set to false
+        #   to disable. Defaults to an auto-detect using `systemctl`, `service`
+        #   or `/etc/init.d/$name`.
+        #   @return [String, nil, false]
+        attribute(:start_program, kind_of: [String, NilClass, FalseClass], default: lazy { default_start_program })
+        # @!attribute stop_program
+        #   Command to use to stop the service for process checks. Set to false
+        #   to disable. Defaults to an auto-detect using `systemctl`, `service`
+        #   or `/etc/init.d/$name`.
+        #   @return [String, nil, false]
+        attribute(:stop_program, kind_of: [String, NilClass, FalseClass], default: lazy { default_stop_program })
+        # @!attribute check
+        #   Service health check or checks. `'IF '` will be prepended if not
+        #   given.
+        #   @return [String, Array<String>]
+        attribute(:check, kind_of: [String, Array], default: [])
+        # @!attribute extra
+        #   Line or lines to be added to the service definition as is.
+        #   @return [String, Array<String>]
+        attribute(:extra, kind_of: [String, Array], default: [])
+
+        # An alias for #check_name to make things more semantically meaningful.
+        alias_method :check_name, :config_name
+
+        # An alias for #if_ to allow writing things like look more like Monit
+        # configuration files. This can't be `if` because that's a keyword.
+        #
+        # @example
+        #   monit_check 'httpd' do
+        #     if_ 'failed port 80 protocol http request "/_status" then restart'
+        #   end
+        alias_method :if_, :check
+
+        private
+
+        # Default WITH-ish value.
+        #
+        # @return [String]
+        def default_with
+          _if_process("PIDFILE /var/run/#{check_name}.pid")
+        end
+
+        # Default start program value.
+        #
+        # @return [String]
+        def default_start_program
+          _init_command('start')
+        end
+
+        # Default stop program value.
+        #
+        # @return [String]
+        def default_stop_program
+          _init_command('stop')
+        end
+
+        # Helper for default values that only apply to process checks.
+        #
+        # @param value [Object] Value to return for process checks.
+        # @return [Object, nil]
+        def _if_process(value)
+          if check_type.to_s.downcase == 'process'
+            value
+          else
+            nil
+          end
+        end
+
+        # Find the right command to control the init system. This checks
+        # systemctl, service, and then gives up and uses /etc/init.d.
+        #
+        # @param action [String] Init action to run.
+        # @return [String, nil]
+        def _init_command(action)
+          cmd = if systemctl = PoiseLanguages::Utils.which('systemctl')
+            "#{systemctl} #{action} #{check_name}"
+          elsif service = PoiseLanguages::Utils.which('service')
+            "#{service} #{check_name} #{action}"
+          else
+            # ¯\_(ツ)_/¯
+            "/etc/init.d/#{check_name} #{action}"
+          end
+          _if_process(cmd)
+        end
+      end
+
+      # The provider for `monit_check`.
+      #
+      # @see Resource
+      # @provides monit_check
+      class Provider < MonitConfig::Provider
+        provides(:monit_check)
+
+        # This space left intentionally blank. All behaviors are in the base.
+      end
+    end
+  end
+end

data/lib/poise_monit/version.rb

@@ -16,5 +16,5 @@
 
 
 module PoiseMonit
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/test/spec/resources/monit_check_spec.rb

@@ -0,0 +1,189 @@
+#
+# Copyright 2015-2016, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe PoiseMonit::Resources::MonitCheck do
+  step_into(:monit_check)
+  let(:systemctl) { nil }
+  let(:service) { nil }
+  before do
+    allow(PoiseLanguages::Utils).to receive(:which).with('systemctl').and_return(systemctl)
+    allow(PoiseLanguages::Utils).to receive(:which).with('service').and_return(service)
+  end
+
+  context 'action :create' do
+    recipe do
+      monit 'monit'
+      monit_check 'httpd'
+    end
+
+    it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "/etc/init.d/httpd start"
+  stop program = "/etc/init.d/httpd stop"
+EOH
+
+    context 'with systemd' do
+      let(:systemctl) { '/sbin/systemctl' }
+
+      it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "/sbin/systemctl start httpd"
+  stop program = "/sbin/systemctl stop httpd"
+EOH
+    end # /context with systemd
+
+    context 'with service' do
+      let(:service) { '/sbin/service' }
+
+      it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "/sbin/service httpd start"
+  stop program = "/sbin/service httpd stop"
+EOH
+    end # /context with service
+
+    context 'with check string' do
+      recipe do
+        monit 'monit'
+        monit_check 'httpd' do
+          check 'if failed port 80 protocol http request "/_status" then restart'
+        end
+      end
+
+      it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "/etc/init.d/httpd start"
+  stop program = "/etc/init.d/httpd stop"
+  if failed port 80 protocol http request "/_status" then restart
+EOH
+    end # /context with check string
+
+    context 'with check array' do
+      recipe do
+        monit 'monit'
+        monit_check 'httpd' do
+          check [
+            'if failed port 80 protocol http request "/_status" then restart',
+            'if failed port 443 protocol https and certificate valid > 30 days then alert',
+          ]
+        end
+      end
+
+      it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "/etc/init.d/httpd start"
+  stop program = "/etc/init.d/httpd stop"
+  if failed port 80 protocol http request "/_status" then restart
+  if failed port 443 protocol https and certificate valid > 30 days then alert
+EOH
+    end # /context with check array
+
+    context 'with if_ string' do
+      recipe do
+        monit 'monit'
+        monit_check 'httpd' do
+          if_ 'failed port 80 protocol http request "/_status" then restart'
+        end
+      end
+
+      it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "/etc/init.d/httpd start"
+  stop program = "/etc/init.d/httpd stop"
+  IF failed port 80 protocol http request "/_status" then restart
+EOH
+    end # /context with if_ string
+
+    context 'with extra string' do
+      recipe do
+        monit 'monit'
+        monit_check 'httpd' do
+          extra 'MODE ACTIVE'
+        end
+      end
+
+      it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "/etc/init.d/httpd start"
+  stop program = "/etc/init.d/httpd stop"
+  MODE ACTIVE
+EOH
+    end # /context with extra string
+
+    context 'with extra array' do
+      recipe do
+        monit 'monit'
+        monit_check 'httpd' do
+          extra [
+            'MODE ACTIVE',
+            'GROUP www',
+          ]
+        end
+      end
+
+      it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "/etc/init.d/httpd start"
+  stop program = "/etc/init.d/httpd stop"
+  MODE ACTIVE
+  GROUP www
+EOH
+    end # /context with extra array
+
+    context 'with start_program' do
+      recipe do
+        monit 'monit'
+        monit_check 'httpd' do
+          start_program 'apachectl start'
+        end
+      end
+
+      it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "apachectl start"
+  stop program = "/etc/init.d/httpd stop"
+EOH
+    end # /context with start_program
+
+    context 'with stop_program' do
+      recipe do
+        monit 'monit'
+        monit_check 'httpd' do
+          stop_program 'apachectl stop'
+        end
+      end
+
+      it { is_expected.to render_file('/etc/monit/conf.d/httpd.conf').with_content(<<-EOH) }
+CHECK PROCESS httpd PIDFILE /var/run/httpd.pid
+  start program = "/etc/init.d/httpd start"
+  stop program = "apachectl stop"
+EOH
+    end # /context with stop_program
+  end # /context action :create
+
+  context 'action :delete' do
+    recipe do
+      monit 'monit'
+      monit_check 'httpd' do
+        action :delete
+      end
+    end
+
+    it { is_expected.to delete_file('/etc/monit/conf.d/httpd.conf') }
+  end # /context action :delete
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise-monit
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite
@@ -114,6 +114,7 @@ files:
 - chef/attributes/default.rb
 - chef/recipes/default.rb
 - chef/templates/monit.conf.erb
+- chef/templates/monit_check.conf.erb
 - chef/templates/monit_service.conf.erb
 - lib/poise_monit.rb
 - lib/poise_monit/cheftie.rb
@@ -125,6 +126,7 @@ files:
 - lib/poise_monit/monit_providers/system.rb
 - lib/poise_monit/resources.rb
 - lib/poise_monit/resources/monit.rb
+- lib/poise_monit/resources/monit_check.rb
 - lib/poise_monit/resources/monit_config.rb
 - lib/poise_monit/resources/monit_service.rb
 - lib/poise_monit/resources/monit_test.rb
@@ -151,6 +153,7 @@ files:
 - test/spec/monit_providers/dummy_spec.rb
 - test/spec/monit_providers/system_spec.rb
 - test/spec/recipe_spec.rb
+- test/spec/resources/monit_check_spec.rb
 - test/spec/resources/monit_config_spec.rb
 - test/spec/resources/monit_service_spec.rb
 - test/spec/resources/monit_spec.rb
@@ -176,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A Chef cookbook for managing the Monit process manager.
@@ -200,6 +203,7 @@ test_files:
 - test/spec/monit_providers/dummy_spec.rb
 - test/spec/monit_providers/system_spec.rb
 - test/spec/recipe_spec.rb
+- test/spec/resources/monit_check_spec.rb
 - test/spec/resources/monit_config_spec.rb
 - test/spec/resources/monit_service_spec.rb
 - test/spec/resources/monit_spec.rb