prerequisites 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8ff637be0e81f14cf0f706d1fa4c9ec7fa3ae9959fa96212b20153365049863
-  data.tar.gz: a3b75123ad34c9faf976a2f762fc2eb8b4b0f4d298d31b40d6e585aee355d932
+  metadata.gz: 5c98d495db904f14b84415214c21e84cf757ec4835b7bcae81aa04a1e955a447
+  data.tar.gz: 8b6922ed872fa9b10770be6e028162fd6afff1a53abf92716c2801f586a396a6
 SHA512:
-  metadata.gz: 869c46534e715fc19e9369c5a8fcb438f3a716b1574285b1990e87136f7f8130e9485d76098229a769bdbbd44808da27f57c387e65fdb8fc392aad64fd2d4550
-  data.tar.gz: 2fb73fb4bf3306abe07e9712821158b8ba92e0b46bbfb25ab2fac8b69372bc6e828fa7d2d75a21f5e49f585b058199fa40a90bf1b41ccee390daeed5d3e73851
+  metadata.gz: aefdf61eb481eb6870cc23b4ab2881af6ccdf5d815a098b05ec8c9f5b877e2f2a7539849050db4a1e75b897f2a74ccc47484337e2c9ae4b0e7da75d1b8bd9584
+  data.tar.gz: 79ef2d6c736705b85fe21b0607020f745d79050a37a60d131a445bb02f467c503720db9fc847f315be05ca912b17d0cab30a75a93dc251ade800d5e9e8c2946b

data/README.md

@@ -2,7 +2,7 @@
 
 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.
+This can be useful when using ruby as 'glue' code for sysadmin or other tasks.
 
 ## Installation
 
@@ -23,6 +23,9 @@ 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
+* The shell commands execute successfully
+
+> NB: You should ensure that any commands you list in the `shell_commands` section have no side-effects. These are supposed to be pre-flight checks.
 
 ```
 config = {
@@ -35,6 +38,10 @@ config = {
     "grep",
     "git",
     "kubectl"
+  ],
+  shell_commands: [
+    "echo whatever | grep what",
+    "kubectl config current-context | grep myk8scluster"
   ]
 }
 
@@ -45,5 +52,6 @@ If any of these conditions are not met, the code will raise an error of class:
 
 * Prerequisites::EnvironmentVariableError
 * Prerequisites::ExecutableError
+* Prerequisites::ShellCommandError
 
 ...depending on the problem.

data/lib/prerequisites.rb

@@ -10,6 +10,7 @@ class Prerequisites
   def check
     environment_variables
     executables_in_path
+    shell_commands
   end
 
   private
@@ -35,6 +36,20 @@ class Prerequisites
     true
   end
 
+  def shell_commands
+    config.dig(:shell_commands).to_a.each do |cmd|
+      _, _, status = Open3.capture3(cmd)
+
+      unless status.success?
+        raise Prerequisites::ShellCommandError.new(
+          "Shell command check failed: #{cmd}"
+        )
+      end
+    end
+
+    true
+  end
+
   def check_env_var_is_set(env_var)
     unless ENV.key?(env_var)
       raise Prerequisites::EnvironmentVariableError.new(
@@ -64,3 +79,4 @@ end
 
 class Prerequisites::EnvironmentVariableError < RuntimeError; end
 class Prerequisites::ExecutableError < RuntimeError; end
+class Prerequisites::ShellCommandError < RuntimeError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prerequisites
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Salgado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-22 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec