checkson 0.9 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cac8e522bab24c578456dfb2c52f859989e63be405d2d63ec6d828059303a69
-  data.tar.gz: 8f6c0543e1f88bb628a858e041073b1dbbb822ea7aa496edaadc302c6ef8ec7b
+  metadata.gz: 3034c81ee8dcdfd2144f5717ce4aab906401e1073c59e1d0c74c48579d2d36e1
+  data.tar.gz: 639e559b5370aa20637b9f78bfbf81399bc3332035df17e4025308666d384890
 SHA512:
-  metadata.gz: 6f857be6d9da861cecbc4baa81095150b9cc6db6bca5883682dd5f5e7e0d9012a16c004deb784223101c07afd5b9fb16d73751c83de2fbfd2826a2c42f48b6e0
-  data.tar.gz: 82b818b24e66189fc6ecc9af6f5643c7c25dc0cce0dec8eff45c24738983c02d57a8e9695f072e7a1c73d2f0018c4ca5a209e25e08f2640d43a205c35bbd21ed
+  metadata.gz: 6a2084ae9a54298000135078937cfdf1036e773ad591caf3377bb49c0e625116a160ddbdcda5a091e56968d8fd98ee7fabe0aae8d47c381540b1ff85cb2aff98
+  data.tar.gz: 5dc0b857a5c2a429eeac127ed8769219682da575f2a8c52cea7bfe67947965ce0572110001e58c33430ffaa4c89c77a1173d8332f202f8b1709e4e572db6de46

data/README.md

@@ -1,4 +1,24 @@
 # Checkson
-[![pipeline status](https://gitlab.fsrv.xyz/fsrv/checkson/badges/master/pipeline.svg)](https://gitlab.fsrv.xyz/fsrv/checkson/commits/master)
-[![Gem Version](https://badge.fury.io/rb/checkson.svg)](https://badge.fury.io/rb/checkson)
 
+## Basic information
+
+Checkson is a simple framework for host and network checking. It supports multiple modules.
+
+An example config will include multiple blocks, each for a singe test.
+
+## Example configuration
+
+```
+check 'port 61000 is open' do
+  using Shell
+  set :code, %(sockstat -4 | grep \*:61000)
+  help 'Port 61000 is closed'
+end
+
+check 'ssh daemon is running' do
+  using Process
+  set :name, 'sshd'
+  help 'Enable and start sshd'
+end
+
+```

data/lib/checkson.rb

@@ -11,5 +11,6 @@ module Checkson
     autoload :DNS, 'checkson/checks/dns'
     autoload :Shell, 'checkson/checks/shell'
     autoload :Process, 'checkson/checks/process'
+    autoload :Certificate, 'checkson/checks/certificate'
   end
 end

data/lib/checkson/apiclient.rb

@@ -10,8 +10,8 @@ require 'logger'
 
 module Checkson
   class APIClient
-    attr_reader :apiaddr
-    attr_reader :outfile
+    attr_reader :apiaddr, :outfile
+
     def initialize(apiaddr, outfile)
       @apiaddr = apiaddr
       @outfile = outfile
@@ -51,7 +51,7 @@ module Checkson
     private
 
     def remove_empty_lines(string)
-      regex = /^[\s]*$\n/
+      regex = /^\s]$\n/
       string.gsub(regex, '')
     end
 

data/lib/checkson/checks/certificate.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Checkson
+  module Check
+    class Certificate < Checkson::Check::Base
+      def initialize(opts = {})
+        @opts = (@opts || {}).merge(opts)
+        @opts[:port] ||= 443
+        super()
+      end
+
+      def check
+        raise ArgumentError, 'No options given' unless @opts[:domain] && @opts[:port] || @opts[:certfile] || @opts[:leftdays]
+
+        @opts[:domain] ? http_check : file_check
+      end
+
+      protected
+
+      def cert_check(cert)
+        time_left = @opts[:leftdays] * 86_400
+        failed! if Time.now + time_left > cert.not_after
+      end
+
+      def file_check
+        require 'openssl'
+        begin
+          raw = File.read @opts[:certfile] if File.file? @opts[:certfile]
+          certificate = OpenSSL::X509::Certificate.new raw
+          cert_check certificate
+        rescue StandardError
+          failed!
+        end
+      end
+
+      def http_check
+        require 'net/http'
+        require 'openssl'
+
+        uri = URI::HTTPS.build(host: @opts[:domain], port: @opts[:port])
+        begin
+          response = Net::HTTP.start(uri.host, uri.port, use_ssl: true)
+          cert = response.peer_cert
+
+          cert_check cert
+        rescue StandardError
+          failed!
+        end
+      end
+    end
+  end
+end

data/lib/checkson/config.rb

@@ -5,6 +5,7 @@ require 'ostruct'
 module Checkson
   class Config
     attr_reader :checks, :name
+
     include Checkson::Check
 
     def initialize(file)

data/lib/checkson/context.rb

@@ -3,6 +3,7 @@
 module Checkson
   class Context
     attr_reader :klass, :params
+
     def initialize(&block)
       @klass = nil
       @params = {}

data/lib/checkson/ui.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 require 'optparse'
-require 'logger'
 require 'uri'
+require 'json'
 
 module Checkson
   # Simple user interface for checkson
   class UI
     def initialize
+      @jsonout = []
+
       set_default_options
       parse_options
       start_checks
@@ -29,16 +31,22 @@ module Checkson
         c = check.klass.new(check.params)
         c.check
         @num_ok += 1 if c.status.eql? :ok
-        output c, check if @opts[:verbose]
+        output_plain c, check if @opts[:verbose]
+        if @opts[:jsonexport]
+          @opts[:verbose] = false
+          jsonadd(c, check)
+        end
       end
       @num_failed = (@num_checks - @num_ok)
-      puts "-> #{@num_checks} checks performed: #{@num_ok} ok, #{@num_failed} failed"
+      puts "-> #{@num_checks} checks performed: #{@num_ok} ok, #{@num_failed} failed" unless @opts[:jsonexport]
+      output_json if @opts[:jsonexport]
     end
 
     def set_default_options
       @opts = {
         datasource: :file,
         verbose: false,
+        jsonexport: false,
         config_file: '/etc/checkson.rb',
         endpoint: 'https://checkson.fsrv.services:8080'
       }
@@ -50,6 +58,9 @@ module Checkson
         opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
           @opts[:verbose] = v
         end
+        opts.on('-j', '--[no-]jsonexport', 'do output as json') do |j|
+          @opts[:jsonexport] = j
+        end
         opts.on('-d', '--datasource [TYPE]', %i[file api], 'Set datasource type', '(file, api)') do |d|
           @opts[:datasource] = d
         end
@@ -68,11 +79,13 @@ module Checkson
           end
         end
       end.parse!
-      logger = Logger.new(STDOUT)
-      logger.info "Using datasource `#{@opts[:datasource]}`"
     end
 
-    def output(sym, check)
+    def output_json
+      puts @jsonout.to_json
+    end
+
+    def output_plain(sym, check)
       status_column = winsize[1] / 3 * 2
       print check.description
       case sym.status
@@ -85,6 +98,11 @@ module Checkson
       end
     end
 
+    def jsonadd(sym, check)
+      data = { description: check.description, status: sym.status }
+      @jsonout.append(data)
+    end
+
     def winsize
       require 'io/console'
       IO.console.winsize
@@ -92,7 +110,7 @@ module Checkson
 
     def die(msg)
       warn(msg)
-      exit 1
+      exit(1)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkson
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '1.2'
 platform: ruby
 authors:
 - Florian Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies: []
 description: A simple framework for checking node facts
 email: florian@fsrv.xyz
@@ -22,6 +22,7 @@ files:
 - lib/checkson.rb
 - lib/checkson/apiclient.rb
 - lib/checkson/checks/base.rb
+- lib/checkson/checks/certificate.rb
 - lib/checkson/checks/dns.rb
 - lib/checkson/checks/packagemanagers/abstractpkgmgr.rb
 - lib/checkson/checks/packages.rb
@@ -42,14 +43,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A simple framework for checking