checkson 0.1 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ab2f87748c7e3e77a1039fd9b7fff153687069c01edfb7ac94e8594cab6f04f
-  data.tar.gz: 022660ab8a3dc7b6c324bf109e8a598793702f29fad90b426a7e7afc432d4fb3
+  metadata.gz: 8884f708c7fbe9c64243ce90b8942d822ee0bf3b664f1198e97198c7af339b1d
+  data.tar.gz: 9e1289046c0f46788c918b3b611f6424a2c15fe632523487d7f6750faa2c3c06
 SHA512:
-  metadata.gz: 86a5f89b4cd75ee3302a40decd676c8f9b0b38fc4963fcecb92055fddae5a4b1a0d5fcdf59a5fab7ce92066cd3afdfe6533897a97b8c5aad3ecc580cd49d5ceb
-  data.tar.gz: 7adaf87b8b50bb79a28900eae335f35930bc0413f9c8e5ac61fb826356296adcd6ea9df0cb541ff79f78300dc55ebeca7b455eb4aaa00163796334c840b458a6
+  metadata.gz: aacb646e006f6af49070ad5f7e299bdb546c8cfea6c6b3d99fb92aea3d9f361f13b523f3f3546951d77b9a2ccba7b2a50ac19661b7326a061c05224aaa1e53e2
+  data.tar.gz: 76fde610194ed4e82fc4d653b18bed353dc0d269e1d99079faada485f29806c5e27531e2b601c360bb6af9145f65d4c70db9027a2509227ec397ced2de0f6d61

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,7 +1,15 @@
 # frozen_string_literal: true
 
-require_relative 'checkson/ui'
-require_relative 'checkson/context'
-require_relative 'checkson/config'
-require_relative 'checkson/checks/base'
-require_relative 'checkson/checks/shell'
+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,75 @@
+# 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
+        warn 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
+  end
+end

data/lib/checkson/checks/base.rb

@@ -1,31 +1,36 @@
 # frozen_string_literal: true
 
-class Base
-  attr_reader :messages
-
-  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 = []
@@ -18,7 +19,8 @@ module Checkson
       @checks << OpenStruct.new(
         klass: context.klass,
         description: description,
-        params: context.params
+        params: context.params,
+        help: context.help
       )
     end
   end

data/lib/checkson/context.rb

@@ -6,6 +6,7 @@ module Checkson
     def initialize(&block)
       @kass = nil
       @params = {}
+      @help = []
       instance_eval(&block)
     end
 
@@ -16,5 +17,10 @@ module Checkson
     def set(key, value)
       @params[key.to_sym] = value
     end
+
+    def help(message = nil)
+      @help << message if message
+      @help
+    end
   end
 end

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
@@ -8,37 +10,84 @@ module Checkson
     def initialize
       set_default_options
       parse_options
-      start_cfgd
+      start_checks
     end
 
-    protected
+    private
 
-    def start_cfgd
-      @config = Checkson::Config.new(@opts[:config])
+    def start_checks
+      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
-        puts c.ok?
+        @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)
+      status_column = winsize[1] / 3 * 2
+      print check.description
+      case sym.status
+      when :ok
+        puts "\033[#{status_column}G\033[1;32mOK\033[0m"
+      when :failed
+        puts "\033[#{status_column}G\033[1;31mFAILED\033[0m"
+        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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkson
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.6'
 platform: ruby
 authors:
 - Florian Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies: []
 description: A simple framework for checking node facts
 email: florian@fsrv.xyz
@@ -20,7 +20,12 @@ files:
 - README.md
 - bin/checkson
 - lib/checkson.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