sensu-plugins-supervisor 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f28d33126ebdfe715d04b80fbf60cea89cd11605
-  data.tar.gz: db2f155c66e448bb5cbfd132df75b690d5b4f606
+  metadata.gz: c922cbf319f5d21d6c8e78cf90414eb2e037cc36
+  data.tar.gz: 1154177fd39375c195c552844d1d3f5365b37dc2
 SHA512:
-  metadata.gz: 4b3eca48c9dfcb1bd8858c9db31c329652c9a77fbc59251054d6125408003ac8fa8f190f5dc70173c73e05d74a4c1ea5c1bc77eb37e3bbf73bef9058ca05ecfc
-  data.tar.gz: 97484d954e89859d5c4b86cbb2525aa89b41581e771d6f12cebe90205362184dfe038788cd5f9b249c8d21c4d2f479d79f8d96a7144003d5b0426878033843d4
+  metadata.gz: ddcc2dbc3a63fb52f2c77307c5fbf413007185d3d3336887deeeeb519020b9341ad1e56987c4b0a536abee64a3ac13eb732cf58fc3fa0d0391347ed413291d7a
+  data.tar.gz: 6a2ec5c1507c437fdc1a3f81c805af9b2eddfc21432464d68eda9a78d65ca788b9ef2fd0b8a27c0b68920ba85a94dade2140d0a86d4354532513cf4acaeb30b5

data/CHANGELOG.md

@@ -4,6 +4,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
+## [1.1.0] 2017-06-12
+### Added
+- support for ruby 2.4: issues caused by `libxmlrpc` being removed from ruby 2.4. Basically we need to solve this by checking the version of ruby at **install time** where dependencies in `.gemspec` are specified at **build time**. This requires using a ruby extension. I included comments in several places to make this more obvious to users that might be confused by this behavior. I also included some Dockerfiles for ruby 2.2-2.4 so that we can test this out better.
+
 ## [1.0.3] 2017-06-07
 ### Fixed
 - check-supervisor-socket.rb: Switched to ox for xmlrpc parser, fixes #19.
@@ -54,7 +58,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-supervisor/compare/1.0.3...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-supervisor/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-supervisor/compare/1.0.3...1.1.0
 [1.0.3]: https://github.com/sensu-plugins/sensu-plugins-supervisor/compare/1.0.2...1.0.3
 [1.0.2]: https://github.com/sensu-plugins/sensu-plugins-supervisor/compare/1.0.1...1.0.2
 [1.0.1]: https://github.com/sensu-plugins/sensu-plugins-supervisor/compare/1.0.0...1.0.1

data/README.md

@@ -18,4 +18,179 @@
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
 
+### Some extra info on a hack regarding xmlrpc
+So in ruby 2.4 they removed `xmlrpc` from stdlib and made it a ruby gem. As this gem is only installable on 2.3 (according to doc but most users report being unable to install in 2.3) this creates problems. On the surface you might think that we could do something like this in the `.gemspec`:
+
+```ruby
+if RUBY_VERSION >= "2.4"
+  installer.install "xmlrpc", "~> 0.3"
+end
+```
+
+However this is not something we need evaluated at build time but actually at install time. Ruby does not have a great way of doing this but we can accomplish this by using a c extension to force this behavior at run time. This was based off: http://www.programmersparadox.com/2012/05/21/gemspec-loading-dependent-gems-based-on-the-users-system/
+
+### Testing this behavior
+I have included 2 dockerfiles to test installing on ruby 2.3 and ruby 2.4.
+
+#### Building
+Ruby 2.2:
+```
+$ docker build -f Dockerfile-ruby2.2 .
+Sending build context to Docker daemon  221.2kB
+Step 1/6 : FROM ruby:2.2-slim
+2.2-slim: Pulling from library/ruby
+10a267c67f42: Already exists
+0aaa89427703: Already exists
+4e4351445696: Already exists
+72c399ee88ad: Pull complete
+cd4fc9895ed7: Pull complete
+00facae99acf: Pull complete
+Digest: sha256:9f39e5306ac98b6ff46a7f5247ace88b4e3723a3fe04dcfa317cabed07dadd8f
+Status: Downloaded newer image for ruby:2.2-slim
+ ---> 81e5c2fd16a9
+Step 2/6 : RUN mkdir /usr/src/app
+ ---> Running in f92de1d4ae5a
+ ---> 7e0786e64a4a
+Removing intermediate container f92de1d4ae5a
+Step 3/6 : ADD . /usr/src/app
+ ---> 9d2cb5c24d80
+Removing intermediate container e52c9e26d2cc
+Step 4/6 : WORKDIR /usr/src/app
+ ---> 94d1e262851f
+Removing intermediate container 427d79912bd9
+Step 5/6 : RUN apt-get update   && apt-get install -y build-essential
+ ---> Running in 62819ad68ade
+<INTENTIONALLY_REMOVED_OUTPUT_FROM_APT>
+ ---> 4ee671ec2163
+Removing intermediate container 62819ad68ade
+Step 6/6 : CMD ./docker-test
+ ---> Running in 25d0d0e45692
+ ---> d0339d43c554
+Removing intermediate container 25d0d0e45692
+Successfully built d0339d43c554
+```
+
+Ruby 2.3:
+```
+$ docker build -f Dockerfile-ruby2.3 .
+Sending build context to Docker daemon  179.7kB
+Step 1/6 : FROM ruby:2.3-slim
+ ---> 684863def0d3
+Step 2/6 : RUN mkdir /usr/src/app
+ ---> Using cache
+ ---> e62979ea3e34
+Step 3/6 : ADD . /usr/src/app
+ ---> 7bbdf2f16ff5
+Removing intermediate container bdaf432e06fe
+Step 4/6 : WORKDIR /usr/src/app
+ ---> b9b014ac62a2
+Removing intermediate container 0f9ebd7711ff
+Step 5/6 : RUN apt-get update   && apt-get install -y build-essential
+ ---> Running in 06d6ce00c56d
+<INTENTIONALLY_REMOVED_OUTPUT_FROM_APT>
+ ---> 30e212e3dc48
+Removing intermediate container 06d6ce00c56d
+Step 6/6 : CMD ./docker-test
+ ---> Running in a1205ff9acce
+ ---> e9e3c5affbc0
+Removing intermediate container a1205ff9acce
+Successfully built e9e3c5affbc0
+```
+
+Ruby 2.4:
+```
+$ docker build -f Dockerfile-ruby2.4 .
+Sending build context to Docker daemon  178.2kB
+Step 1/6 : FROM ruby:2.4-slim
+ ---> 6dd077757d49
+Step 2/6 : RUN mkdir /usr/src/app
+ ---> Using cache
+ ---> 4f45395487f3
+Step 3/6 : ADD . /usr/src/app
+ ---> fd2af990b369
+Removing intermediate container 6b5e7cc4a515
+Step 4/6 : WORKDIR /usr/src/app
+ ---> f2019fc2ae01
+Removing intermediate container d471aea79711
+Step 5/6 : RUN apt-get update   && apt-get install -y build-essential
+ ---> Running in 3f9106d17a3d
+<INTENTIONALLY_REMOVED_OUTPUT_FROM_APT>
+ ---> ae1a635f5731
+Removing intermediate container 3f9106d17a3d
+Step 6/6 : CMD ./docker-test
+ ---> Running in ccc8b4be1d08
+ ---> 6d927a3f6fd1
+Removing intermediate container ccc8b4be1d08
+Successfully built 6d927a3f6fd1
+```
+
+#### Validation
+Ruby 2.2:
+```
+$ docker run d0339d43c554
+WARNING:  pessimistic dependency on ox (~> 2.5.0) may be overly strict
+  if ox is semantically versioned, use:
+    add_runtime_dependency 'ox', '~> 2.5', '>= 2.5.0'
+WARNING:  See http://guides.rubygems.org/specification-reference/ for help
+  Successfully built RubyGem
+  Name: sensu-plugins-supervisor
+  Version: 1.1.0
+  File: sensu-plugins-supervisor-1.1.0.gem
+Successfully installed mixlib-cli-1.7.0
+Successfully installed sensu-plugin-1.4.5
+Successfully installed ruby-supervisor-0.0.2
+Building native extensions.  This could take a while...
+Successfully installed ox-2.5.0
+Building native extensions.  This could take a while...
+You can use the embedded Ruby by setting EMBEDDED_RUBY=true in /etc/default/sensu
+Successfully installed sensu-plugins-supervisor-1.1.0
+5 gems installed
+```
+
+Ruby 2.3:
+```
+$ docker run e9e3c5affbc0
+WARNING:  pessimistic dependency on ox (~> 2.5.0) may be overly strict
+  if ox is semantically versioned, use:
+    add_runtime_dependency 'ox', '~> 2.5', '>= 2.5.0'
+WARNING:  See http://guides.rubygems.org/specification-reference/ for help
+  Successfully built RubyGem
+  Name: sensu-plugins-supervisor
+  Version: 1.1.0
+  File: sensu-plugins-supervisor-1.1.0.gem
+Successfully installed mixlib-cli-1.7.0
+Successfully installed sensu-plugin-1.4.5
+Successfully installed ruby-supervisor-0.0.2
+Building native extensions.  This could take a while...
+Successfully installed ox-2.5.0
+Building native extensions.  This could take a while...
+You can use the embedded Ruby by setting EMBEDDED_RUBY=true in /etc/default/sensu
+Successfully installed sensu-plugins-supervisor-1.1.0
+5 gems installed
+```
+
+Ruby 2.4:
+```
+$ docker run 6d927a3f6fd1
+WARNING:  pessimistic dependency on ox (~> 2.5.0) may be overly strict
+  if ox is semantically versioned, use:
+    add_runtime_dependency 'ox', '~> 2.5', '>= 2.5.0'
+WARNING:  See http://guides.rubygems.org/specification-reference/ for help
+  Successfully built RubyGem
+  Name: sensu-plugins-supervisor
+  Version: 1.1.0
+  File: sensu-plugins-supervisor-1.1.0.gem
+Building native extensions.  This could take a while...
+Successfully installed json-1.8.6
+Successfully installed mixlib-cli-1.7.0
+Successfully installed sensu-plugin-1.4.5
+Successfully installed ruby-supervisor-0.0.2
+Building native extensions.  This could take a while...
+Successfully installed ox-2.5.0
+Building native extensions.  This could take a while...
+You can use the embedded Ruby by setting EMBEDDED_RUBY=true in /etc/default/sensu
+Successfully installed sensu-plugins-supervisor-1.1.0
+6 gems installed
+```
+
 ## Notes

data/ext/mkrf_conf.rb

@@ -0,0 +1,29 @@
+# This file needs to be named mkrf_conf.rb
+# so that rubygems will recognize it as a ruby extension
+# file and not think it is a C extension file
+
+require 'rubygems/dependency_installer.rb'
+
+# Load up the rubygem's dependency installer to
+# installer the gems we want based on the version
+# of Ruby the user has installed
+
+installer = Gem::DependencyInstaller.new
+
+begin
+  if RUBY_VERSION >= '2.4'
+    installer.install 'xmlrpc', '~> 0.3'
+  end
+
+rescue => e
+  p e
+  # Exit with a non-zero value to let rubygems something went wrong
+  exit(1)
+end
+
+# If this was C, rubygems would attempt to run make
+# Since this is Ruby, rubygems will attempt to run rake
+# If it doesn't find and successfully run a rakefile, it errors out
+f = File.open(File.join(File.dirname(__FILE__), 'Rakefile'), 'w')
+f.write("task :default\n")
+f.close

data/lib/sensu-plugins-supervisor/version.rb

@@ -1,8 +1,8 @@
 module SensuPluginsSupervisor
   module Version
     MAJOR = 1
-    MINOR = 0
-    PATCH = 3
+    MINOR = 1
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-supervisor
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -185,7 +185,8 @@ email: "<sensu-users@googlegroups.com>"
 executables:
 - check-supervisor-socket.rb
 - check-supervisor.rb
-extensions: []
+extensions:
+- ext/mkrf_conf.rb
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
@@ -193,6 +194,7 @@ files:
 - README.md
 - bin/check-supervisor-socket.rb
 - bin/check-supervisor.rb
+- ext/mkrf_conf.rb
 - lib/sensu-plugins-supervisor.rb
 - lib/sensu-plugins-supervisor/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-supervisor