file-based-healthcheck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '008743fbd28e50d9e75a5d1266ded9bd9bf4a7abb19ffeea607eec8f055f83e3'
+  data.tar.gz: fccf8c78aa4edb171e1047a82f7a632319df87ca75c0f393406d05798ab0ef0a
+SHA512:
+  metadata.gz: 70a97b3dea0b9b503cde1113bd34b7b5d191dd76a504367f69ea83c79f939449bc2b96b56a59416e2221fa49e2142db3675fe1620f99ba0165225bd2180841b9
+  data.tar.gz: b6f0753e57d11ca76d7cf9b29c5e206496612e6089bf8004a750a71d3e7a638c887a6b1b08130e108b3dbb6a0109bda44c234b607b9f674b875f4dffe6d14766

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: ruby:2.7.2
+    steps:
+      - checkout
+      - run:
+          name: Run the default task
+          command: |
+            gem install bundler -v 2.2.11
+            bundle install
+            bundle exec rake

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+on: [pull_request]
+jobs:
+  rspec:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { ruby: '2.7' }
+          - { ruby: '3.0' }
+          - { ruby: '3.1' }
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-19
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in file-based-healthcheck.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    file-based-healthcheck (0.1.0)
+      activesupport (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.3)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  x86_64-darwin-18
+  x86_64-linux
+
+DEPENDENCIES
+  file-based-healthcheck!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Karol Galanciak
+
+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,81 @@
+# FileBasedHealthcheck
+
+A gem to use a healthcheck for readiness and liveness probes in Kubernetes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'file-based-healthcheck'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install file-based-healthcheck
+
+## Usage
+
+The idea behind this gem is to register heartbeats using a file. Thanks to that and comparing when the last heartbeat, happened you can easily check if the process is running or not.
+
+Initialize a new healthcheck:
+
+``` rb
+healthcheck = FileBasedHealthcheck.new(directory: Rails.root.join("tmp"), filename: ENV.fetch("HOSTNAME"), time_threshold: 60)
+```
+
+Register a heartbeat:
+
+``` rb
+healthcheck.touch
+```
+
+To verify if the process is running:
+
+``` rb
+healthcheck.running?
+```
+
+This method is going to return `true` if the file (based on `filename`) was touched in the last `time_threshold` in seconds.
+
+To remove file:
+
+``` rb
+healthcheck.remove
+```
+
+It is recommended to implement some sort of wrapper for your processes and use this gem under the hood. Then, you could create a following binary:
+
+``` rb
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/my_process"
+
+result = MyProcess::HealthCheck.check
+if result.success?
+  exit 0
+else
+  MyProcess.logger.fatal "[MyProcess] health check failed: #{result.message}"
+  exit 1
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/file-based-healthcheck.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "file/based/healthcheck"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/file-based-healthcheck.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/file_based_healthcheck/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "file-based-healthcheck"
+  spec.version       = FileBasedHealthcheck::VERSION
+  spec.authors       = ["Karol Galanciak"]
+  spec.email         = ["karol.galanciak@gmail.com", "karol@bookingsync.com", "dev@bookingsync.com"]
+
+  spec.summary       = "A gem to use a healthcheck for readiness and liveness probes in Kubernetes."
+  spec.description   = "A gem to use a healthcheck for readiness and liveness probes in Kubernetes."
+  spec.homepage      = "https://github.com/BookingSync/file-based-healthcheck"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/BookingSync/file-based-healthcheck."
+  spec.metadata["changelog_uri"] = "https://github.com/BookingSync/file-based-healthcheck/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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "activesupport", ">= 3.2"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/file-based-healthcheck.rb

@@ -0,0 +1 @@
+requir "file_based_healthcheck"

data/lib/file_based_healthcheck/version.rb

@@ -0,0 +1,6 @@
+class FileBasedHealthcheck
+  VERSION = "0.1.0"
+
+  module Version
+  end
+end

data/lib/file_based_healthcheck.rb

@@ -0,0 +1,34 @@
+require "file_based_healthcheck/version"
+require "fileutils"
+require "active_support/core_ext/time"
+
+class FileBasedHealthcheck
+  attr_reader :directory, :filename, :time_threshold
+  private     :directory, :filename, :time_threshold
+
+  def initialize(directory:, filename:, time_threshold:)
+    @directory = directory
+    @filename = filename
+    @time_threshold = time_threshold
+  end
+
+  def touch
+    FileUtils.touch(file_path)
+  end
+
+  def running?
+    return false if !File.exists?(file_path)
+
+    File.mtime(file_path).advance(seconds: time_threshold).utc > Time.now.utc
+  end
+
+  def remove
+    File.delete(file_path) if File.exists?(file_path)
+  end
+
+  private
+
+  def file_path
+    File.join(directory, filename)
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: file-based-healthcheck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Galanciak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A gem to use a healthcheck for readiness and liveness probes in Kubernetes.
+email:
+- karol.galanciak@gmail.com
+- karol@bookingsync.com
+- dev@bookingsync.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- file-based-healthcheck.gemspec
+- lib/file-based-healthcheck.rb
+- lib/file_based_healthcheck.rb
+- lib/file_based_healthcheck/version.rb
+homepage: https://github.com/BookingSync/file-based-healthcheck
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BookingSync/file-based-healthcheck
+  source_code_uri: https://github.com/BookingSync/file-based-healthcheck.
+  changelog_uri: https://github.com/BookingSync/file-based-healthcheck/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: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A gem to use a healthcheck for readiness and liveness probes in Kubernetes.
+test_files: []