ops_team 0.11.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 952f4e8174c60f623b0768fc6a35eb62524c1f574ea8d887c07023d423365d8e
-  data.tar.gz: 9e8421e67c77535683fd7aae10d90c8a671ea3e58c37656a975f303092c8df06
+  metadata.gz: 2290c83f4f7765f62b2efe59ed8e662970039057b7d3d948b68e4f0f0eb46a7c
+  data.tar.gz: 9b9948ff23bf8799ca294c9a637638980e9b679bb862657085712a97bde35fc1
 SHA512:
-  metadata.gz: 8e3c9bb627b2f8570cca8a3dd60f8e176138dcf01b9417889bcf50e2a24cc25759f5cf0492784bbc28e779fe6d201f570e0992fcb1a8261cab9d09f2f4d54e40
-  data.tar.gz: 4c89388eb2bf7669cb7d4ddc588424911f56d04a5f6c72921e9fb2729caa0c95aa7cd2efac3b7040842d8976c367364eb881e0e4e672583b3c923d97b291d297
+  metadata.gz: 7fa27cf9f164af9e91a2d27820e811779a0781cb6b2f8849ef37e6ddd6042d4188422560343559ee072701351dc60f51cc48ce74c82bc1aa9201d233e37ef09d
+  data.tar.gz: 6af6633e1552b93fa07c3f6443bd292e0695fe9595dfda661e588fd9cc84df8176b2f5b1dbc7613d47bde7b5e1ed30a1b9551bbfd9963c7cc5b70bcb4b54c460

data/Gemfile

@@ -6,8 +6,12 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem "bcrypt_pbkdf"
 gem "colorize"
+gem "e2mmap"
 gem "ed25519"
 gem "ejson"
+gem "etc"
+gem "io-console"
+gem "json"
 gem "net-ssh"
 gem "require_all"
 
@@ -17,6 +21,7 @@ group :test do
 end
 
 group :development do
+	gem "irb"
 	gem "pry"
 	gem "pry-byebug"
 	gem "rerun"

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/action_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class ActionList
+	class UnknownActionError < StandardError; end
+
+	def initialize(actions_list, args)
+		@actions_list = actions_list
+		@args = args
+
+		process_action_list
+	end
+
+	def get(name)
+		@actions[name]
+	end
+
+	def get_by_alias(name)
+		@aliases[name]
+	end
+
+	def names
+		@actions.keys
+	end
+
+	def aliases
+		@aliases.keys
+	end
+
+	private
+
+	def process_action_list
+		@actions = {}
+		@aliases = {}
+
+		@actions_list.each do |name, config|
+			action = Action.new(config, @args)
+
+			@actions[name] = action
+			@aliases[action.alias] = action
+		end
+	end
+end

data/lib/action_suggester.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class ActionSuggester
+	def initialize(dictionary)
+		@dictionary = dictionary
+	end
+
+	def check(word)
+		spellchecker.correct(word)
+	end
+
+	private
+
+	def spellchecker
+		@spellchecker ||= DidYouMean::SpellChecker.new(dictionary: @dictionary)
+	end
+end

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/environment.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'version'
+
 class Environment
 	def initialize(env_hash)
 		@env_hash = env_hash
@@ -21,6 +23,7 @@ class Environment
 
 	def set_ops_variables
 		ENV["OPS_YML_DIR"] = Dir.pwd
+		ENV["OPS_VERSION"] = Version.version.to_s
 	end
 
 	def set_environment_aliases

data/lib/hook_handler.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'output'
+
 class HookHandler
 	class HookConfigError < StandardError; end
 	class HookExecError < StandardError; end
@@ -22,6 +24,7 @@ class HookHandler
 
 	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?

data/lib/ops.rb

@@ -3,12 +3,17 @@
 
 require 'yaml'
 require 'require_all'
+require "rubygems"
 
 require 'hook_handler'
 require 'action'
 require 'output'
 require 'options'
 require 'environment'
+require 'version'
+require 'action_list'
+require 'action_suggester'
+
 require_rel "builtins"
 
 # executes commands based on local `ops.yml`
@@ -20,6 +25,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
@@ -35,11 +41,14 @@ class Ops
 	end
 
 	def run
+		# "return" is here to allow specs to stub "exit" without executing everything after it
 		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
-		Output.error("Error: #{e}")
+		Output.error(e.to_s)
+		print_did_you_mean
 		exit(UNKNOWN_ACTION_EXIT_CODE)
 	end
 
@@ -54,11 +63,37 @@ class Ops
 		end
 	end
 
+	def print_did_you_mean
+		suggestions = did_you_mean.check(@action_name)
+
+		Output.out("Did you mean '#{suggestions.join(", ")}'?") if suggestions.any?
+	end
+
+	def did_you_mean
+		ActionSuggester.new(action_list.names + action_list.aliases + builtin_names)
+	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
-		do_before_run_action
+		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,10 +101,16 @@ class Ops
 		exit(ERROR_LOADING_APP_CONFIG_EXIT_CODE)
 	end
 
-	def do_before_run_action
+	def do_before_all
 		environment.set_variables
 		AppConfig.load
-		hook_handler.do_hooks("before")
+	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
@@ -83,24 +124,22 @@ class Ops
 		nil
 	end
 
+	def builtin_names
+		Builtins.constants.select { |c| Builtins.const_get(c).is_a? Class }.map(&:downcase)
+	end
+
 	def action
-		return actions[@action_name] if actions[@action_name]
-		return aliases[@action_name] if aliases[@action_name]
+		return action_list.get(@action_name) if action_list.get(@action_name)
+		return action_list.get_by_alias(@action_name) if action_list.get_by_alias(@action_name)
 
 		raise UnknownActionError, "Unknown action: #{@action_name}"
 	end
 
-	def actions
-		@actions ||= begin
-			if config["actions"]
-				config["actions"]&.transform_values do |config|
-					Action.new(config, @args)
-				end
-			else
-				# only print this error if ops.yml had something in it
-				Output.warn("'ops.yml' has no 'actions' defined.") if config.any?
-				{}
-			end
+	def action_list
+		@action_list ||= begin
+			Output.warn("'ops.yml' has no 'actions' defined.") if config.any? && config["actions"].nil?
+
+			ActionList.new(config["actions"], @args)
 		end
 	end
 
@@ -114,14 +153,6 @@ class Ops
 		end
 	end
 
-	def aliases
-		@aliases ||= begin
-			actions.each_with_object({}) do |(_name, action), alias_hash|
-				alias_hash[action.alias] = action if action.alias
-			end
-		end
-	end
-
 	def env_vars
 		@config.dig("options", "environment") || {}
 	end
@@ -129,10 +160,6 @@ class Ops
 	def environment
 		@environment ||= Environment.new(env_vars)
 	end
-
-	def app_config
-		@app_config ||= AppConfig.new
-	end
 end
 
 Ops.new(ARGV).run if $PROGRAM_NAME == __FILE__

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.11.0'
+	s.version = '0.13.1'
 	s.authors = [
 		'nickthecook@gmail.com'
 	]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.1
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -146,6 +146,8 @@ files:
 - etc/ruby.template.yml
 - etc/terraform.template.yml
 - lib/action.rb
+- lib/action_list.rb
+- lib/action_suggester.rb
 - lib/app_config.rb
 - lib/builtin.rb
 - lib/builtins/background.rb
@@ -176,6 +178,7 @@ files:
 - lib/options.rb
 - lib/output.rb
 - lib/secrets.rb
+- lib/version.rb
 - loader.rb
 - ops_team.gemspec
 homepage: https://github.com/nickthecook/ops