prerequisites 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8ff637be0e81f14cf0f706d1fa4c9ec7fa3ae9959fa96212b20153365049863
+  data.tar.gz: a3b75123ad34c9faf976a2f762fc2eb8b4b0f4d298d31b40d6e585aee355d932
+SHA512:
+  metadata.gz: 869c46534e715fc19e9369c5a8fcb438f3a716b1574285b1990e87136f7f8130e9485d76098229a769bdbbd44808da27f57c387e65fdb8fc392aad64fd2d4550
+  data.tar.gz: 2fb73fb4bf3306abe07e9712821158b8ba92e0b46bbfb25ab2fac8b69372bc6e828fa7d2d75a21f5e49f585b058199fa40a90bf1b41ccee390daeed5d3e73851

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "rspec"
+gem "pry-byebug"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (1.0.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry-byebug
+  rspec
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 David Salgado
+
+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,49 @@
+# Prerequisites Gem
+
+A ruby gem to make it easy to test that a set of prerequisite conditions are in place.
+
+This is particularly useful when using ruby as 'glue' code for sysadmin or other tasks.
+
+## Installation
+
+```
+gem install prerequisites
+```
+
+Or add to your `Gemfile`:
+
+```
+gem "prerequisites"
+```
+
+## Usage
+
+This example checks that:
+
+* Environment variables "FOO" and "BAR" are set
+* Environment variable "BAZ" is set to the value "whatever"
+* Executables "grep", "git", and "kubectl" are in your $PATH
+
+```
+config = {
+  environment_variables: [
+    "FOO",
+    "BAR",
+    { "BAZ" => "whatever" }
+  ],
+  executables_in_path: [
+    "grep",
+    "git",
+    "kubectl"
+  ]
+}
+
+Prerequisites.new(config).check
+```
+
+If any of these conditions are not met, the code will raise an error of class:
+
+* Prerequisites::EnvironmentVariableError
+* Prerequisites::ExecutableError
+
+...depending on the problem.

data/lib/prerequisites.rb

@@ -0,0 +1,66 @@
+require "open3"
+
+class Prerequisites
+  attr_reader :config
+
+  def initialize(config)
+    @config = config
+  end
+
+  def check
+    environment_variables
+    executables_in_path
+  end
+
+  private
+
+  def environment_variables
+    config.dig(:environment_variables).to_a.each do |env_var|
+      if env_var.is_a?(Hash)
+        var, value = env_var.first
+        check_env_var_has_value(var, value)
+      else
+        check_env_var_is_set(env_var)
+      end
+    end
+
+    true
+  end
+
+  def executables_in_path
+    config.dig(:executables_in_path).to_a.each do |executable|
+      check_executable(executable)
+    end
+
+    true
+  end
+
+  def check_env_var_is_set(env_var)
+    unless ENV.key?(env_var)
+      raise Prerequisites::EnvironmentVariableError.new(
+        "Required environment variable #{env_var} is not set"
+      )
+    end
+  end
+
+  def check_env_var_has_value(var, value)
+    unless ENV[var] == value
+      raise Prerequisites::EnvironmentVariableError.new(
+        "Expected environment variable #{var} to be #{value}"
+      )
+    end
+  end
+
+  def check_executable(executable)
+    _, _, status = Open3.capture3("which #{executable}")
+
+    unless status.success?
+      raise Prerequisites::ExecutableError.new(
+        "Required executable #{executable} not found in path"
+      )
+    end
+  end
+end
+
+class Prerequisites::EnvironmentVariableError < RuntimeError; end
+class Prerequisites::ExecutableError < RuntimeError; end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: prerequisites
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Salgado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: 
+email: david@digitalronin.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/prerequisites.rb
+homepage: https://github.com/digitalronin/prerequisites-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+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.3
+signing_key: 
+specification_version: 4
+summary: Simplify checking pre-requisites (env. vars. & executables) for ruby scripts
+test_files: []