ops_team 0.10.4 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f2b052b1a1dfd1e4cc30acca43495993be28499f2b1fa9eb8e587da57931d3a
-  data.tar.gz: 27b21a20f77b1a0bf416f3d3a56be4142baa0b7553b3161e0b916da61b0f3422
+  metadata.gz: 684c6b13e7c5440f067ed372f28f592fc24616aaeb42284ec30465166bd1ce79
+  data.tar.gz: 67ba1850a8f28e7025bc3d179bdb33d6506dffa0c5a94b2aa50fce20e0c20dce
 SHA512:
-  metadata.gz: 67f1395a225c91a2ee619ecd1eb6eb26e16ca05bafb5f82916508875a7b58c0eafe40be120f83ec2b55a42aa3695bcb91cf1b1ca5973c521029bd377f9c02c86
-  data.tar.gz: cf644c0878ce56c6f11c6e45719044a72aa71a566bca492c5f51966436ef25010ec19dd6c5d8f5a0f4cd408177a114975f4e3160b27977bda3360db4ce456282
+  metadata.gz: 747a3dfac949e43f25f3ee19b31bb60d9824b25265b5c8d09c0af9f298a514b2fec0fd48cace35c4ebc553847ebd9bf9b6ea246433a5efb51b7c4918bbc39628
+  data.tar.gz: 32d665f336d2d31d7189b5bc9569155c00c4d27ba8b2260d282295c3e2664d0ead0729454996275a2d189f446a2afebc9ae6f9f66303d38245e511978ee58b88

data/lib/action.rb

@@ -32,6 +32,10 @@ class Action
 		@config["description"]
 	end
 
+	def skip_hooks?(name)
+		@config["skip_#{name}_hooks"]
+	end
+
 	private
 
 	def load_secrets?

data/lib/builtins/version.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
-require "rubygems"
-
 require "output"
+require "version"
 
 module Builtins
 	class Version < Builtin
-		GEMSPEC_FILE = "#{__dir__}/../../ops_team.gemspec"
-
 		class << self
 			def description
 				"prints the version of ops that is running"
@@ -15,18 +12,7 @@ module Builtins
 		end
 
 		def run
-			unless gemspec
-				Output.error("Unable to load gemspec at '#{GEMSPEC_FILE}")
-				return false
-			end
-
-			Output.out(gemspec.version)
-		end
-
-		private
-
-		def gemspec
-			@gemspec ||= Gem::Specification.load(GEMSPEC_FILE)
+			Output.out(::Version.version)
 		end
 	end
 end

data/lib/dependency.rb

@@ -4,11 +4,12 @@ require 'open3'
 require 'English'
 
 require 'output'
+require 'executor'
 
 class Dependency
 	DESCRIPTION_TYPE_WIDTH = 8
 
-	attr_reader :name, :output, :exit_code
+	attr_reader :name
 
 	def initialize(name)
 		@name = name
@@ -45,15 +46,23 @@ class Dependency
 	end
 
 	def success?
-		@exit_code.nil? ? true : @exit_code.zero?
+		@executor.nil? ? true : @executor.success?
+	end
+
+	def output
+		@executor&.output
+	end
+
+	def exit_code
+		@executor&.exit_code
 	end
 
 	private
 
 	def execute(cmd)
-		@output, status = Open3.capture2e(cmd)
-		@exit_code = status.exitstatus
+		@executor = Executor.new(cmd)
+		@executor.execute
 
-		success?
+		@executor.success?
 	end
 end

data/lib/executor.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Executor
+	attr_reader :output, :exit_code
+
+	class << self
+		def execute(command)
+			@output, status = Open3.capture2e(command)
+			@exit_code = status.exitstatus
+
+			[@output, @exit_code]
+		end
+	end
+
+	def initialize(command)
+		@command = command
+	end
+
+	def execute
+		@output, status = Open3.capture2e(@command)
+		@exit_code = status.exitstatus
+
+		success?
+	end
+
+	def success?
+		@exit_code.nil? ? true : @exit_code.zero?
+	end
+end

data/lib/hook_handler.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'output'
+
+class HookHandler
+	class HookConfigError < StandardError; end
+	class HookExecError < StandardError; end
+
+	def initialize(config)
+		@config = config
+	end
+
+	def do_hooks(name)
+		raise HookConfigError, "'hooks.#{name}' must be a list" unless hooks(name).is_a?(Array)
+
+		execute_hooks(name)
+	end
+
+	private
+
+	def hooks(name)
+		@config.dig("hooks", name) || []
+	end
+
+	def execute_hooks(name)
+		hooks(name).each do |hook|
+			Output.notice("Running #{name} hook: #{hook}")
+			output, exit_code = Executor.execute(hook)
+
+			next if exit_code.zero?
+
+			raise HookExecError, "#{name} hook '#{hook}' failed with exit code #{exit_code}:\n#{output}"
+		end
+	end
+end

data/lib/ops.rb

@@ -3,11 +3,14 @@
 
 require 'yaml'
 require 'require_all'
+require "rubygems"
 
+require 'hook_handler'
 require 'action'
 require 'output'
 require 'options'
 require 'environment'
+require 'version'
 require_rel "builtins"
 
 # executes commands based on local `ops.yml`
@@ -19,6 +22,7 @@ class Ops
 	INVALID_SYNTAX_EXIT_CODE = 64
 	UNKNOWN_ACTION_EXIT_CODE = 65
 	ERROR_LOADING_APP_CONFIG_EXIT_CODE = 66
+	MIN_VERSION_NOT_MET_EXIT_CODE = 67
 
 	class << self
 		def project_name
@@ -34,7 +38,9 @@ class Ops
 	end
 
 	def run
+		# "return" is here to allow specs to stub "exit"
 		return exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
+		return exit(MIN_VERSION_NOT_MET_EXIT_CODE) unless min_version_met?
 
 		run_action
 	rescue UnknownActionError => e
@@ -53,12 +59,28 @@ class Ops
 		end
 	end
 
+	def min_version_met?
+		return true unless min_version
+
+		if Version.min_version_met?(min_version)
+			true
+		else
+			Output.error("ops.yml specifies minimum version of #{min_version}, but ops version is #{Version.version}")
+			false
+		end
+	end
+
+	def min_version
+		config["min_version"]
+	end
+
 	def run_action
-		environment.set_variables
-		AppConfig.load
+		do_before_all
 
 		return builtin.run if builtin
 
+		do_before_action
+
 		Output.notice("Running '#{action}' from #{CONFIG_FILE} in environment '#{ENV['environment']}'...")
 		action.run
 	rescue AppConfig::ParsingError => e
@@ -66,6 +88,22 @@ class Ops
 		exit(ERROR_LOADING_APP_CONFIG_EXIT_CODE)
 	end
 
+	def do_before_all
+		environment.set_variables
+		AppConfig.load
+	end
+
+	def do_before_action
+		hook_handler.do_hooks("before") unless ENV["OPS_RUNNING"] || action.skip_hooks?("before")
+
+		# this prevents before hooks from running in ops executed by ops
+		ENV["OPS_RUNNING"] = "1"
+	end
+
+	def hook_handler
+		@hook_handler ||= HookHandler.new(config)
+	end
+
 	def builtin
 		@builtin ||= Builtin.class_for(name: @action_name).new(@args, config)
 	rescue NameError

data/lib/version.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rubygems"
+
+class Version
+	GEMSPEC_FILE = "#{__dir__}/../ops_team.gemspec"
+
+	class << self
+		# these class methods exist because I don't want to have to call `Version.new.version` elsewhere
+		def version
+			new.send(:version)
+		end
+
+		def min_version_met?(min_version)
+			new.send(:min_version_met?, min_version)
+		end
+	end
+
+	private
+
+	# these instance methods exist so that I don't have to clear class variables between tests
+	def version
+		unless gemspec
+			Output.error("Unable to load gemspec at '#{GEMSPEC_FILE}")
+			return nil
+		end
+
+		gemspec.version
+	end
+
+	def min_version_met?(min_version)
+		Gem::Version.new(version) >= Gem::Version.new(min_version)
+	end
+
+	def gemspec
+		@gemspec ||= Gem::Specification.load(GEMSPEC_FILE)
+	end
+end

data/ops_team.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
 	s.name = 'ops_team'
-	s.version = '0.10.4'
+	s.version = '0.12.2'
 	s.authors = [
 		'nickthecook@gmail.com'
 	]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.12.2
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -170,10 +170,13 @@ files:
 - lib/dependencies/sshkey.rb
 - lib/dependency.rb
 - lib/environment.rb
+- lib/executor.rb
+- lib/hook_handler.rb
 - lib/ops.rb
 - lib/options.rb
 - lib/output.rb
 - lib/secrets.rb
+- lib/version.rb
 - loader.rb
 - ops_team.gemspec
 homepage: https://github.com/nickthecook/ops