sensu-plugins-foreman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd5b7dac8c5758b96aa6e960ebb54421789e6ae23f0b6fee6a2eb696bd338634
+  data.tar.gz: 1358f88d1859c86092fb7e99d7c5f0ebfa5c323ee268acff97f4605fe09caeb9
+SHA512:
+  metadata.gz: 4c4e5e194f4f4c4a17186c3b9324f97b52b2dce719624e6c1fc9754e6b1d2f167ec23b16eeef40ed48bf4c04eab334e25ad540f68f67fd4f3d5ec833c0b53899
+  data.tar.gz: 1c5370a186a624bc8688d7c71ebfd2b7ef571db1cf092a2055a3d8e2e0dd2f5b544916d892fc3ad88f3165235a8f8d574cc8c1b9ec368556c540c7e508bc0b95

data/.bonsai.yml

@@ -0,0 +1,26 @@
+description: "#{repo}"
+builds:
+- platform: "debian"
+  arch: "amd64"
+  asset_filename: "#{repo}_#{version}_debian_linux_amd64.tar.gz"
+  sha_filename: "#{repo}_#{version}_sha512-checksums.txt"
+  filter:
+  -  "entity.system.os == 'linux'"
+  -  "entity.system.arch == 'amd64'"
+  -  "entity.system.platform == 'debian'"
+- platform: "centos"
+  arch: "amd64"
+  asset_filename: "#{repo}_#{version}_centos_linux_amd64.tar.gz"
+  sha_filename: "#{repo}_#{version}_sha512-checksums.txt"
+  filter:
+  -  "entity.system.os == 'linux'"
+  -  "entity.system.arch == 'amd64'"
+  -  "entity.system.platform == 'rhel'"
+- platform: "alpine"
+  arch: "amd64"
+  asset_filename: "#{repo}_#{version}_alpine_linux_amd64.tar.gz"
+  sha_filename: "#{repo}_#{version}_sha512-checksums.txt"
+  filter:
+  -  "entity.system.os == 'linux'"
+  -  "entity.system.arch == 'amd64'"
+  -  "entity.system.platform == 'alpine'"

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Naming/FileName:
+  Exclude:
+    - 'lib/sensu-plugins-foreman.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,48 @@
+sudo: required
+language: ruby
+
+rvm:
+  - 2.5.5
+
+services:
+  - docker
+
+cache:
+  - bundler
+
+before_install:
+  - gem install bundler
+
+install:
+  - bundle install
+
+script:
+  - gem build sensu-plugins-foreman.gemspec
+  - gem install sensu-plugins-foreman-*.gem
+
+before_deploy:
+- bash -c "[ ! -d bonsai/ ] && git clone https://github.com/sensu/sensu-go-bonsai-asset.git bonsai || echo 'bonsai/ exists, skipping git clone'"
+
+deploy:
+  - provider: rubygems
+    api_key:
+      secure: acgMaDcv3myahq4wzN4i7b4g22vrd2EOAutZEyYcmczQTEXM8PGRo08n0F6HkJs1Mgo73jn+u8nrlTItTserEsaiRFyGcyFgi8EQt8DvqPzbDPyq/yPse0/r7uxPVTHAUREVuQRoZreEi+V+aSkNn9R3GRbXFjiVorYnM2rZvGhDiw9i+S3gq0j0jo2H2AE3JKHtatdrI3MTAha3LCgkfhwmJURr/4r0Dp/0wfuRpLhrO+tLTVDfIffxAQ/oRDLXnu4VJ21cM2ejyx4lGHxPPmGoOvc3rZFLFd8MQN/CtsuBqIbBIjLe5gkqD4HxfM3DM1HFxE7GGquk7V1RpW2rjcTF+kO6zYh7hS9fz4ccRL3prWFXg9qwQ24D54XVqDhXm3R2e5IRRoq4vOYq7LMv4ejdBZGNzEnGYzZSy/up9W9wydtySP7mFZsxu0qlJLgSXCgM5dz6KHth9U6HJgp46LwkQVrF6czWH1lGyPv9HqgASjrTUaNdFjoaseZEVB6CXiiCbhj2iT7EHk7/AGNW3hmp3YODgdFm3Ehd+gwK6KhTS4btfRsQwGA6qBhrwOTpmedx+B53Y5clcpkxZRYQfsz3pN9KU2lVSsWj70mOofwdl6VwFJoX/Q0jd9fDncGyH9+KrwfyGSQb5yKMn8OQcVIg5w+HKlya2XroH0faPTI=
+    gem: sensu-plugins-foreman
+    on:
+      tags: true
+      all_branches: true
+      rvm: 2.5.5
+      repo: SICSoftwareGmbH/sensu-plugins-foreman
+
+  - provider: script
+    script:
+      - ./deploy.sh
+    skip_cleanup: true
+    on:
+      tags: true
+      all_branches: true
+      rvm: 2.5.5
+
+env:
+  global:
+    secure: "FLaeOypv/KK9RPGjshGWB5Vbh3JigzxeKD0XGhur/flxxCu8LhbUuNRd2maxU77cZoYEk+wU/YiHSJbWyjmA2JTPvmgrKGz4O5AjPG6+F52D8VhkX8dzYwi/7S4XlfMl9i33tog3ifpwi2lVYoImIr1SDzJKZBg7NyEqAkvAUGGLIaUZILc0EtIROgL72wsUk+Xcr2Y+9HXgk+LCNSuoFEPsKrOV5NAWvLfAdhStmkF7s40SdigEtmqovy7tbhn+EA84QoU4VuzhR8d1+IlovmvuTODUg00br5kPMLXwwVjMvZlcDSm1G02GaUiADccRwjuYdOrApWRJSECUYHDVkDLMcitCvuAlmm0+dCAQ+kzH41BV0+FnAKUl3m0wsp+PgfULG6c6/B+dxwg3xrcq04eINJpa8jchJ623Tt11LmkTxQ4N6fcpGYeFLiP6onwrjUCr0eK0v8cdrIg8gb/kw55MnpNKSkjt2RseJRK8yy5yIFA6Jzkja/rlMhVgvxKNcjdHcfaZnyA1tbvM301vfwP7DFCwZSpJfIcsCeMNkMcM7aKabXx3Mx9/TVWm2fehkjfvyRT8FKk9b8Qzlc4u5TYdOTg9RA+B/eF3cqef0S+QMSfVmijBjSqwMHXJCkUqe4GLIHueTu9agXTaMoFU0tZsnlFOxgrBRxSlVLcs8qA="

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2019-08-12
+### Added
+- check if foreman-proxy is alive
+- check if foreman-proxy provides required features

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in foo.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 SIC! Software GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+## sensu-plugins-foreman
+
+[![Build Status](https://travis-ci.org/SICSoftwareGmbH/sensu-plugins-foreman.svg?branch=master)](https://travis-ci.org/SICSoftwareGmbH/sensu-plugins-foreman)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-foreman.svg)](http://badge.fury.io/rb/sensu-plugins-foreman)
+[![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/SICSoftwareGmbH/sensu-plugins-foreman)
+
+This plugin provides checks for [foreman](https://theforeman.org).
+
+## Sensu Asset  
+  The Sensu assets packaged from this repository are built against the Sensu ruby runtime environment. When using these assets as part of a Sensu Go resource (check, mutator or handler), make sure you include the corresponding Sensu ruby runtime asset in the list of assets needed by the resource.  The current ruby-runtime assets can be found [here](https://bonsai.sensu.io/assets/sensu/sensu-ruby-runtime) in the [Bonsai Asset Index](https://bonsai.sensu.io).
+
+## Functionality
+
+## Files
+ * bin/check-foreman-proxy-alive
+ * bin/check-foreman-proxy-features
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/check-foreman-proxy-alive

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# check-foreman-proxy-alive
+#
+# DESCRIPTION:
+#   Checks if foreman-proxy is alive
+#
+# OUTPUT:
+#   Plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# LICENSE:
+#   SIC! Software GmbH <info@sic.software>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'net/https'
+require 'json'
+
+# Checks if foreman-proxy daemon is working
+class CheckForemanProxy < Sensu::Plugin::Check::CLI
+  DEFAULT_URL = 'https://localhost:8443/'
+
+  option :url,
+         short: '-u URL',
+         long: '--url URL',
+         description: 'URL of foreman-proxy',
+         default: nil
+
+  def run
+    check
+  rescue StandardError => e
+    critical("Request error: #{e.message}")
+  end
+
+  private
+
+  def url
+    return config[:url] if config[:url]&.positive?
+
+    DEFAULT_URL
+  end
+
+  def version_response
+    uri = URI.parse(File.join(url, 'version'))
+
+    http = Net::HTTP.new(uri.host, uri.port, nil, nil)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    req = Net::HTTP::Get.new(uri.request_uri)
+
+    http.request(req)
+  end
+
+  def parse_version_response(res)
+    data = JSON.parse(res.body)
+
+    [data['version'], data['modules']]
+  end
+
+  def check
+    res = version_response
+
+    if res.code.to_i == 200
+      version, modules = parse_version_response(res)
+
+      modules = modules.keys.map { |k| "#{k} (#{modules[k]})" }.join(', ')
+
+      ok("version: #{version}, modules: #{modules}")
+    else
+      critical(res.body)
+    end
+  end
+end

data/bin/check-foreman-proxy-features

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+#   check-foreman-proxy-features
+#
+# DESCRIPTION:
+#   Checks for required foreman-proxy features
+#
+# OUTPUT:
+#   Plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# LICENSE:
+#   SIC! Software GmbH <info@sic.software>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'net/https'
+require 'json'
+
+# Checks if foreman-proxy daemon is working
+class CheckForemanProxy < Sensu::Plugin::Check::CLI
+  DEFAULT_URL = 'https://localhost:8443/'
+
+  option :url,
+         short: '-u URL',
+         long: '--url URL',
+         description: 'URL of foreman-proxy',
+         default: nil
+
+  option :features,
+         short: '-f FEATURES',
+         long: '--features FEATURES',
+         description: 'Comma separated list of required features',
+         default: ''
+
+  def run
+    check
+  rescue StandardError => e
+    critical("Request error: #{e.message}")
+  end
+
+  private
+
+  def url
+    return config[:url] if config[:url]&.positive?
+
+    DEFAULT_URL
+  end
+
+  def features
+    config[:features].split(',').map(&:strip)
+  end
+
+  def features_response
+    uri = URI.parse(File.join(url, 'features'))
+
+    http = Net::HTTP.new(uri.host, uri.port, nil, nil)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    req = Net::HTTP::Get.new(uri.request_uri)
+
+    http.request(req)
+  end
+
+  def parse_features_response(res)
+    JSON.parse(res.body)
+  end
+
+  def process_available_features(available_features)
+    missing = features - available_features
+    unwanted = available_features - features
+
+    if missing.any? || unwanted.any?
+      messages = []
+      messages << "missing: #{missing.join(', ')}" if missing.any?
+      messages << "unwanted: #{unwanted.join(', ')}" if unwanted.any?
+
+      warning(messages.join(', '))
+    else
+      ok("available: #{available_features.join(', ')}")
+    end
+  end
+
+  def check
+    res = features_response
+
+    if res.code.to_i == 200
+      available_features = parse_features_response(res)
+
+      process_available_features(available_features)
+    else
+      critical(res.body)
+    end
+  end
+end

data/deploy.sh

@@ -0,0 +1,5 @@
+#!/bin/bash -e
+
+curl -s -H "Authorization: token ${GITHUB_TOKEN}" --data "{\"tag_name\": \"${TRAVIS_TAG}\"}" -X POST "https://api.github.com/repos/${TRAVIS_REPO_SLUG}/releases"
+
+./bonsai/ruby-runtime/travis-build-ruby-plugin-assets.sh sensu-plugins-foreman

data/lib/sensu-plugins-foreman.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'sensu-plugins-foreman/version'

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SensuPluginsForeman
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/sensu-plugins-foreman.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sensu-plugins-foreman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sensu-plugins-foreman'
+  spec.version       = SensuPluginsForeman::Version::STRING
+  spec.authors       = ['SIC! Software GmbH', 'Florian Schwab']
+  spec.email         = ['info@sic.software', 'me@ydkn.io']
+  spec.summary       = 'This plugin provides checks for foreman'
+  spec.description   = 'Sensu plugins for foreman'
+  spec.homepage      = 'https://github.com/SICSoftwareGmbH/sensu-plugins-foreman'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/SICSoftwareGmbH/sensu-plugins-foreman/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-foreman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SIC! Software GmbH
+- Florian Schwab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Sensu plugins for foreman
+email:
+- info@sic.software
+- me@ydkn.io
+executables:
+- check-foreman-proxy-alive
+- check-foreman-proxy-features
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bonsai.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/check-foreman-proxy-alive
+- bin/check-foreman-proxy-features
+- deploy.sh
+- lib/sensu-plugins-foreman.rb
+- lib/sensu-plugins-foreman/version.rb
+- sensu-plugins-foreman.gemspec
+homepage: https://github.com/SICSoftwareGmbH/sensu-plugins-foreman
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SICSoftwareGmbH/sensu-plugins-foreman
+  source_code_uri: https://github.com/SICSoftwareGmbH/sensu-plugins-foreman
+  changelog_uri: https://github.com/SICSoftwareGmbH/sensu-plugins-foreman/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: This plugin provides checks for foreman
+test_files: []