checkson 0.2 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2222386bd03c3421453df6fc47a6d91343a68a4e10f2eb33a5ca3108c9f39147
-  data.tar.gz: d234523870e13a2bdd163b101a0f82e270205e80929c013adda59d4d9a51b388
+  metadata.gz: 89f4f13274b708ecae4ba0db251e0edc4b63e28ca0a5a482512db7cf7c68d6a8
+  data.tar.gz: 3a44997b59f6963c3d1509540051704d4ab7efa6f820222c39b35c5982dc7481
 SHA512:
-  metadata.gz: 1255ff0bc3a4e7393c82a0a404b17090397fe5956a7e389d0069d66790bfe262418baf197871f667e69e47843d10fc3c1fae0b514d49a7f91547b8688ce074b5
-  data.tar.gz: b52e63e8fc994b9d5310c12c315830ec58e0bf2537d8fbd0d3f45a2881ce41a35f9284e1e7b46baeb25257cf6fb581c13d59f991ac12c914c88f67cc4193c15e
+  metadata.gz: 6b178d04e887558d28024837ab6e613741cea34ac2f8d9df8876db60775c1ecc0fca729e944c1375c6a1884512845868e829396d00b7702a65f81c4bcba9b939
+  data.tar.gz: f8976bdd3303b3e1a057cc9ce6c43f86dda8e094294364acf3bdc2fe883bf2b2e952e8d5925dd6b68eee9f313e99eddf82e8a045c2432619ef952275f7641679

data/README.md

@@ -1,3 +1,4 @@
 # 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)
 

data/bin/checkson

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/checkson'
+require 'checkson'
 Checkson::UI.new

data/lib/checkson.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
 
-require_relative 'checkson/ui'
-require_relative 'checkson/context'
-require_relative 'checkson/config'
-require_relative 'checkson/check'
+module Checkson
+  autoload :Config, 'checkson/config'
+  autoload :Context, 'checkson/context'
+  autoload :APIClient, 'checkson/apiclient'
+  autoload :UI, 'checkson/ui'
+
+  module Check
+    autoload :Base, 'checkson/checks/base'
+    autoload :DNS, 'checkson/checks/dns'
+    autoload :Shell, 'checkson/checks/shell'
+    autoload :Process, 'checkson/checks/process'
+  end
+end

data/lib/checkson/apiclient.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+require 'erb'
+require 'socket'
+require 'digest'
+require 'logger'
+
+module Checkson
+  class APIClient
+    attr_reader :apiaddr
+    attr_reader :outfile
+    def initialize(apiaddr, outfile)
+      @apiaddr = apiaddr
+      @outfile = outfile
+    end
+
+    def getchecks
+      template = <<-TEMPLATE
+        <%@checks.each do |check| %>
+        check '<%=check["description"]%>' do
+          using <%=check["check"]%>
+          <%check["sets"].each do |key,value| %>
+          set :<%=key%>, "<%=value%>"
+          <%end%>
+        <%unless check["helps"].eql?(nil)%>
+          <%check["helps"].each do |help| %>
+          help '<%= help %>'
+          <%end%>
+        <%end%>
+        end
+        <% end %>
+      TEMPLATE
+      querydata = get
+      @checks = querydata['checks'] if querydata['status'].eql? 'ok'
+      begin
+        remove_empty_lines(ERB.new(template).result(binding))
+      rescue StandardError
+        die querydata['error']
+      end
+    end
+
+    def writechecks
+      File.open(@outfile, 'w') do |f|
+        f.write(getchecks)
+      end
+    end
+
+    private
+
+    def remove_empty_lines(string)
+      regex = /^[\s]*$\n/
+      string.gsub(regex, '')
+    end
+
+    def get
+      token = ENV['CHECKSON_API_KEY']
+      token ||= 'empty'
+      hostname = Socket.gethostname
+      query("#{keyhash(token)}/get/#{hostname}")
+    end
+
+    def query(command)
+      @ep = "#{@apiaddr}/api/v1"
+      route = "#{@ep}/#{command}"
+      JSON.parse(Net::HTTP.get(URI.parse(route)))
+    end
+
+    def keyhash(token)
+      Digest::SHA512.hexdigest(token)
+    end
+
+    def die(msg)
+      warn(msg)
+      exit 1
+    end
+  end
+end

data/lib/checkson/checks/base.rb

@@ -1,31 +1,36 @@
 # frozen_string_literal: true
 
-class Base
-  attr_reader :status
-
-  def initialize(_opts = {})
-    @status = :ok
-  end
-
-  def ok?
-    @status == :ok
-  end
-
-  def failed?
-    !ok?
-  end
-
-  protected
-
-  def log(message)
-    @messages << message
-  end
-
-  def ok!
-    @status = :ok
-  end
-
-  def failed!
-    @status = :failed
+module Checkson
+  module Check
+    class Base
+      attr_reader :status, :messages
+
+      def initialize(_opts = {})
+        @messages = []
+        @status = :ok
+      end
+
+      def ok?
+        @status == :ok
+      end
+
+      def failed?
+        !ok?
+      end
+
+      protected
+
+      def log(message)
+        @messages << message
+      end
+
+      def ok!
+        @status = :ok
+      end
+
+      def failed!
+        @status = :failed
+      end
+    end
   end
 end

data/lib/checkson/checks/dns.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Checkson
+  module Check
+    class DNS < Checkson::Check::Base
+      def initialize(opts = {})
+        @opts = { domain: 'heise.de',
+                  timeout: 1,
+                  host: 'localhost' }.merge(opts)
+        super()
+      end
+
+      def check
+        require 'resolv'
+        resolver = Resolv::DNS.new(nameserver: [@opts[:host]])
+        resolver.timeouts = @opts[:timeout]
+        begin
+          resolver.getaddress(@opts[:domain])
+        rescue Resolv::ResolvTimeout
+          failed!
+          log("Resolving #{@opts[:domain]} timed out")
+        rescue Resolv::ResolvError
+          failed!
+          log("Could not resolve #{@opts[:domain]}")
+        end
+      end
+    end
+  end
+end

data/lib/checkson/checks/packagemanagers/abstractpkgmgr.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Checkson
+  module Check
+    module Pkganager
+      class AbstractPkgmanager
+        def self.descendants
+          ObjectSpace.each_object(Class).select { |klass| klass < self }
+        end
+      end
+
+      class Pkgmanager < AbstractPkgmanager
+        def self.adapters
+          AbstractPkgmanager.descendants - [self]
+        end
+
+        def self.adapter
+          @adapter ||= adapters.find { |adapter| adapter.supports_os? Facter['osfamily'].value.downcase }
+        end
+      end
+    end
+  end
+end

data/lib/checkson/checks/packages.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Checkson
+  module Check
+    class Shell < Checkson::Check::Base
+      def initialize(opts = {})
+        @opts = (@opts || {}).merge(opts)
+        super()
+      end
+
+      def check
+        raise ArgumentError, 'No code given' unless @opts[:code]
+
+        execute(@opts[:code])
+        failed! unless $?.exitstatus.zero?
+      end
+
+      protected
+
+      def execute(command)
+        `sh -c "#{command.gsub(/"/, '\"')}"`
+      end
+    end
+  end
+end

data/lib/checkson/checks/process.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'ipaddr'
+
+module Checkson
+  module Check
+    class Process < Checkson::Check::Shell
+      def initialize(opts = {})
+        @opts = opts
+        raise ArgumentError, 'Neither pidfile nor process name given' unless @opts[:pidfile] || @opts[:name]
+
+        super()
+      end
+
+      def check
+        @opts[:pidfile] ? check_pidfile : check_name
+      end
+
+      protected
+
+      def check_pidfile
+        pid = File.read(@opts[:pidfile]).strip
+        execute("kill -0 #{pid} 2>&1")
+
+        unless $?.exitstatus.zero?
+          failed!
+          log("Process ID #{pid} is not running")
+        end
+      rescue Errno::ENOENT
+        failed!
+        log("Cannot open pidfile: #{@opts[:pidfile]}")
+      end
+
+      def check_name
+        ps = execute('ps aux')
+
+        if @opts[:name].is_a?(Regexp) && ps !~ (@opts[:name])
+          failed!
+          log("No process found matching regular expression `#{@opts[:name].source}`")
+        elsif !ps.include?(@opts[:name])
+          failed!
+          log("No process found matching name `#{@opts[:name]}`")
+        end
+      end
+    end
+  end
+end

data/lib/checkson/checks/shell.rb

@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
-class Shell < Base
-  def initialize(opts = {})
-    @opts = (@opts || {}).merge(opts)
-    super()
-  end
+module Checkson
+  module Check
+    class Shell < Checkson::Check::Base
+      def initialize(opts = {})
+        @opts = (@opts || {}).merge(opts)
+        super()
+      end
 
-  def check
-    raise ArgumentError, 'No code given' unless @opts[:code]
+      def check
+        raise ArgumentError, 'No code given' unless @opts[:code]
 
-    execute(@opts[:code])
-    failed! unless $?.exitstatus.zero?
-  end
+        execute(@opts[:code])
+        failed! unless $?.exitstatus.zero?
+      end
 
-  protected
+      protected
 
-  def execute(command)
-    `sh -c "#{command.gsub(/"/, '\"')}"`
+      def execute(command)
+        `sh -c "#{command.gsub(/"/, '\"')}"`
+      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)
       @checks = []

data/lib/checkson/ui.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'optparse'
+require 'logger'
+require 'uri'
 
 module Checkson
   # Simple user interface for checkson
@@ -11,39 +13,63 @@ module Checkson
       start_checks
     end
 
-    protected
-
-    def winsize
-      require 'io/console'
-      IO.console.winsize
-    end
+    private
 
     def start_checks
-      @config = Checkson::Config.new(@opts[:config])
+      if @opts[:datasource].eql? :api
+        client = Checkson::APIClient.new(@opts[:endpoint], '/tmp/checkson.rb')
+        client.writechecks
+        @opts[:config_file] = client.outfile
+      end
+      @config = Checkson::Config.new(@opts[:config_file])
+
+      @num_checks = @config.checks.length
+      @num_ok = 0
       @config.checks.each do |check|
         c = check.klass.new(check.params)
         c.check
-        output c, check
+        @num_ok += 1 if c.status.eql? :ok
+        output c, check if @opts[:verbose]
       end
+      @num_failed = (@num_checks - @num_ok)
+      puts "-> #{@num_checks} checks performed: #{@num_ok} ok, #{@num_failed} failed"
     end
 
     def set_default_options
       @opts = {
-        config: '/etc/checkson.rb'
+        datasource: :file,
+        verbose: false,
+        config_file: '/etc/checkson.rb',
+        endpoint: 'https://checkson.fsrv.services:8080'
       }
     end
 
     def parse_options
       OptionParser.new do |opts|
         opts.banner = 'Usage: checkson [options]'
-        opts.on('-c', '--config FILE', 'Config file to use') do |file|
+        opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
+          @opts[:verbose] = v
+        end
+        opts.on('-d', '--datasource [TYPE]', %i[file api], 'Set datasource type', '(file, api)') do |d|
+          @opts[:datasource] = d
+        end
+        opts.on('-f', '--file [FILE]', 'Config file to use') do |file|
           if File.exist?(file)
-            @opts[:config] = file
+            @opts[:config_file] = file
           else
             die("Config file #{file} does not exist")
           end
         end
+        opts.on('-e', '--endpoint [ADDR]', 'Config api to use') do |ep|
+          if ep =~ URI::DEFAULT_PARSER.make_regexp
+            @opts[:endpoint] = ep
+          else
+            die('URL of endpoint not valid')
+          end
+        end
       end.parse!
+      logger = Logger.new(STDOUT)
+      logger.info "Using datasource `#{@opts[:datasource]}`"
     end
 
     def output(sym, check)
@@ -54,14 +80,16 @@ module Checkson
         puts "\033[#{status_column}G\033[1;32mOK\033[0m"
       when :failed
         puts "\033[#{status_column}G\033[1;31mFAILED\033[0m"
-        unless check.help.empty?
-          check.help.each do |message|
-            puts "--> #{message}"
-          end
-        end
+        check.help.each { |message| puts "--> #{message}" } unless check.help.empty?
+        sym.messages.each { |message| puts "   * #{message}" }
       end
     end
 
+    def winsize
+      require 'io/console'
+      IO.console.winsize
+    end
+
     def die(msg)
       warn(msg)
       exit 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkson
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.7'
 platform: ruby
 authors:
 - Florian Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies: []
 description: A simple framework for checking node facts
 email: florian@fsrv.xyz
@@ -20,8 +20,12 @@ files:
 - README.md
 - bin/checkson
 - lib/checkson.rb
-- lib/checkson/check.rb
+- lib/checkson/apiclient.rb
 - lib/checkson/checks/base.rb
+- lib/checkson/checks/dns.rb
+- lib/checkson/checks/packagemanagers/abstractpkgmgr.rb
+- lib/checkson/checks/packages.rb
+- lib/checkson/checks/process.rb
 - lib/checkson/checks/shell.rb
 - lib/checkson/config.rb
 - lib/checkson/context.rb

data/lib/checkson/check.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'checks/base'
-require_relative 'checks/shell'