ops_team 0.19.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78add7ded2123905f17245092c6133825009a94e16568f98cb476113335aaa93
-  data.tar.gz: 52599bd611ee57a986b9cc2dc6c360def280b12843b9395ff6eb52e359307366
+  metadata.gz: 6ef9ff578bc479b6bbe53bee8143f2a0477393c32518ae15e417ab8338ac5fb4
+  data.tar.gz: 289a6516bda02ad14993a4529358a671a7ea500269ac9710f42a960cc5a3e524
 SHA512:
-  metadata.gz: 390c1581cacc1a290cb4e165665e00799502fea8315aac6eac43a32e8bc987c2e986bb7550c90bd75c6cef25f87d41b1f4227c087907b182277b5403ef681e84
-  data.tar.gz: c35a9d8d7e70d9a901ca5686ead93a19182b23b7becce3d5fda3df4069b03bda45ad8869680b2ca54a0b3ac30031ed368a6be1d91d6f830891fa4c3963a4ee5c
+  metadata.gz: 685a469476c1ccbf25511c8ac1b0eec7cfc1eb3e9056eb8102905c88fbc48266a88dc0aaf3969ee4a6bc16bfc3cd840889d2dd3d4a39e84ce70b3eb43bb5594c
+  data.tar.gz: 87e5e4cb4ed35aac7107cd5614ec7fecaa66fa4fc11ffd077df87cf33daea4d324c2a7df99bac2e63507624762a67a925d132a85b6b1e08e9814ac8715cac3c8

data/bin/ops

@@ -1,8 +1,31 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative "../loader"
+require 'optparse'
+
+
+def usage
+	puts "Usage: ops [-f|--file <ops_yml>] action [<action args>"
+	puts "  ops_yml:      the config file to load instead of './ops.yml'"
+	puts "  action_args:  arguments to the action loaded from the config file; depends on the action"
+
+	exit(1)
+end
 
+options = {}
+while ARGV[0]&.match(/^-/)
+	opt = ARGV.shift
+	case opt
+	when '-f', '--file'
+		usage unless ARGV.length >= 1
+
+		options[:file] = ARGV.shift
+	else
+		usage
+	end
+end
+
+require_relative "../loader"
 require 'ops'
 
-Ops.new(ARGV).run
+Ops.new(ARGV, config_file: options[:file]).run

data/lib/action.rb

@@ -17,9 +17,11 @@ class Action
 			raise NotAllowedInEnvError, "Action not allowed in #{Environment.environment} environment."
 		end
 
-		Secrets.load if load_secrets?
-
-		Kernel.exec(to_s)
+		if perform_shell_expansion?
+			Kernel.exec(to_s)
+		else
+			Kernel.exec(*to_a)
+		end
 	end
 
 	def to_s
@@ -56,10 +58,14 @@ class Action
 		end
 	end
 
+	def load_secrets?
+		@config["load_secrets"].nil? ? false : @config["load_secrets"]
+	end
+
 	private
 
-	def load_secrets?
-		@config["load_secrets"]
+	def to_a
+		command.split(" ").reject(&:nil?) | @args
 	end
 
 	def not_in_envs
@@ -77,4 +83,8 @@ class Action
 
 		true
 	end
+
+	def perform_shell_expansion?
+		@config["shell_expansion"].nil? ? true : @config["shell_expansion"]
+	end
 end

data/lib/builtins/help.rb

@@ -3,12 +3,15 @@
 require 'colorize'
 
 require 'builtin'
+require 'forwards'
 
 module Builtins
 	class Help < Builtin
+		NAME_WIDTH = 35
+
 		class << self
 			def description
-				"displays available builtins and actions"
+				"displays available builtins, actions, and forwards"
 			end
 		end
 
@@ -16,15 +19,24 @@ module Builtins
 			Output.out("Builtins:")
 			Output.out("  #{builtins.join("\n  ")}")
 			Output.out("")
+			Output.out("Forwards:")
+			Output.out("  #{forwards.join("\n  ")}")
+			Output.out("")
 			Output.out("Actions:")
 			Output.out("  #{actions.join("\n  ")}")
 		end
 
 		private
 
+		def forwards
+			Forwards.new(@config).forwards.map do |name, dir|
+				format("%<name>-#{NAME_WIDTH}s %<desc>s" , name: name.yellow, desc: "#{dir}")
+			end
+		end
+
 		def builtins
 			builtin_class_map.map do |klass, name|
-				format("%<name>-35s %<desc>s", name: name.downcase.to_s.yellow, desc: klass.description)
+				format("%<name>-#{NAME_WIDTH}s %<desc>s", name: name.downcase.to_s.yellow, desc: klass.description)
 			end
 		end
 
@@ -55,7 +67,7 @@ module Builtins
 			return [] unless @config["actions"]
 
 			@config["actions"].map do |name, action_config|
-				format("%<name>-40s %<desc>s",
+				format("%<name>-#{NAME_WIDTH}s %<desc>s",
 					name: "#{name.yellow} #{alias_string_for(action_config)}",
 					desc: action_config["description"] || action_config["command"]
 				)

data/lib/environment.rb

@@ -13,8 +13,9 @@ class Environment
 		end
 	end
 
-	def initialize(env_hash)
+	def initialize(env_hash, config_path)
 		@env_hash = env_hash
+		@config_path = config_path
 	end
 
 	def set_variables
@@ -26,7 +27,7 @@ class Environment
 	private
 
 	def set_ops_variables
-		ENV["OPS_YML_DIR"] = Dir.pwd
+		ENV["OPS_YML_DIR"] = File.dirname(@config_path)
 		ENV["OPS_VERSION"] = Version.version.to_s
 		ENV["OPS_SECRETS_FILE"] = Secrets.config_path_for(Environment.environment)
 		ENV["OPS_CONFIG_FILE"] = AppConfig.config_path_for(Environment.environment)

data/lib/forwards.rb

@@ -3,7 +3,7 @@
 require 'forward'
 
 class Forwards
-	def initialize(config, args)
+	def initialize(config, args = [])
 		@config = config
 		@args = args
 	end
@@ -12,8 +12,6 @@ class Forwards
 		Forward.new(forwards[name], @args) if forwards[name]
 	end
 
-	private
-
 	def forwards
 		@forwards ||= @config["forwards"] || {}
 	end

data/lib/ops.rb

@@ -5,25 +5,15 @@ 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 'forwards'
+require 'runner'
 
 require_rel "builtins"
 
 # executes commands based on local `ops.yml`
 class Ops
-	class UnknownActionError < StandardError; end
-	class ActionConfigError < StandardError; end
-
-	CONFIG_FILE = "ops.yml"
-
 	INVALID_SYNTAX_EXIT_CODE = 64
 	UNKNOWN_ACTION_EXIT_CODE = 65
 	ERROR_LOADING_APP_CONFIG_EXIT_CODE = 66
@@ -40,50 +30,55 @@ class Ops
 		end
 	end
 
-	def initialize(argv)
+	def initialize(argv, config_file: nil)
 		@action_name = argv[0]
 		@args = argv[1..-1]
+		@config_file = config_file || "ops.yml"
 
 		Options.set(config["options"] || {})
 	end
 
+	# rubocop:disable Metrics/MethodLength
+	# better to have all the rescues in one place
 	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
+		runner.run
+	rescue Runner::UnknownActionError => e
 		Output.error(e.to_s)
 		Output.out(RECOMMEND_HELP_TEXT) unless print_did_you_mean
 		exit(UNKNOWN_ACTION_EXIT_CODE)
-	rescue ActionConfigError => e
+	rescue Runner::ActionConfigError => e
 		Output.error("Error(s) running action '#{@action_name}': #{e}")
 		exit(ACTION_CONFIG_ERROR_EXIT_CODE)
+	rescue Builtin::ArgumentError => e
+		Output.error("Error running builtin '#{@action_name}': #{e}")
+		exit(BUILTIN_SYNTAX_ERROR_EXIT_CODE)
+	rescue AppConfig::ParsingError => e
+		Output.error("Error parsing app config: #{e}")
+		exit(ERROR_LOADING_APP_CONFIG_EXIT_CODE)
+	rescue Action::NotAllowedInEnvError => e
+		Output.error("Error running action #{@action_name}: #{e}")
+		exit(ACTION_NOT_ALLOWED_IN_ENV_EXIT_CODE)
 	end
+	# rubocop:enable Metrics/MethodLength
 
 	private
 
 	def syntax_valid?
-		if @action_name.nil?
-			Output.error("Usage: ops <action>")
-			Output.out(RECOMMEND_HELP_TEXT)
-			false
-		else
-			true
-		end
+		return true unless @action_name.nil?
+
+		Output.error("Usage: ops <action>")
+		Output.out(RECOMMEND_HELP_TEXT)
+		false
 	end
 
 	def print_did_you_mean
-		suggestions = did_you_mean.check(@action_name)
+		Output.out("Did you mean '#{runner.suggestions.join(", ")}'?") if runner.suggestions.any?
 
-		Output.out("Did you mean '#{suggestions.join(", ")}'?") if suggestions.any?
-
-		suggestions.any?
-	end
-
-	def did_you_mean
-		ActionSuggester.new(action_list.names + action_list.aliases + builtin_names)
+		runner.suggestions.any?
 	end
 
 	def min_version_met?
@@ -101,96 +96,34 @@ class Ops
 		config["min_version"]
 	end
 
-	def run_action
-		return forward.run if forward
-
-		do_before_all
-
-		return builtin.run if builtin
-
-		raise ActionConfigError, action.config_errors.join("; ") unless action.config_valid?
-
-		do_before_action
-		Output.notice("Running '#{action}' from #{CONFIG_FILE} in environment '#{ENV['environment']}'...")
-		action.run
-	rescue Builtin::ArgumentError => e
-		Output.error("Error running builtin '#{@action_name}': #{e}")
-		exit(BUILTIN_SYNTAX_ERROR_EXIT_CODE)
-	rescue AppConfig::ParsingError => e
-		Output.error("Error parsing app config: #{e}")
-		exit(ERROR_LOADING_APP_CONFIG_EXIT_CODE)
-	rescue Action::NotAllowedInEnvError => e
-		Output.error("Error running action #{@action_name}: #{e}")
-		exit(ACTION_NOT_ALLOWED_IN_ENV_EXIT_CODE)
-	end
-
-	def do_before_all
-		environment.set_variables
-		AppConfig.load
-	end
-
-	def do_before_action
-		return if ENV["OPS_RUNNING"] || action.skip_hooks?("before")
-
-		# this prevents before hooks from running in ops executed by ops
-		ENV["OPS_RUNNING"] = "1"
-		hook_handler.do_hooks("before")
-	end
-
-	def hook_handler
-		@hook_handler ||= HookHandler.new(config)
-	end
-
-	def builtin
-		@builtin ||= Builtin.class_for(name: @action_name).new(@args, config)
-	rescue NameError
-		# this means there isn't a builtin with that name in that module
-		nil
-	end
-
-	def builtin_names
-		Builtins.constants.select { |c| Builtins.const_get(c).is_a? Class }.map(&:downcase)
-	end
-
-	def forward
-		@forward ||= Forwards.new(@config, @args).get(@action_name)
-	end
-
-	def action
-		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 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
+	def runner
+		@runner ||= Runner.new(@action_name, @args, config, config_file_absolute_path)
 	end
 
 	def config
 		@config ||= begin
-			if File.exist?(CONFIG_FILE)
-				YAML.load_file(CONFIG_FILE)
+			if config_file_exists?
+				parsed_config_contents
 			else
-				Output.warn("File '#{CONFIG_FILE}' does not exist.") unless @action_name == "init"
+				Output.warn("File '#{@config_file}' does not exist.") unless @action_name == "init"
 				{}
 			end
-		rescue StandardError => e
-			Output.warn("Error parsing '#{CONFIG_FILE}': #{e}")
-			{}
 		end
 	end
 
-	def env_vars
-		config.dig("options", "environment") || {}
+	def parsed_config_contents
+		YAML.load_file(@config_file)
+	rescue StandardError => e
+		Output.warn("Error parsing '#{@config_file}': #{e}")
+		{}
+	end
+
+	def config_file_exists?
+		File.exist?(@config_file)
 	end
 
-	def environment
-		@environment ||= Environment.new(env_vars)
+	def config_file_absolute_path
+		File.expand_path(@config_file)
 	end
 end
 

data/lib/runner.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'hook_handler'
+require 'action'
+require 'action_list'
+require 'action_suggester'
+require 'forwards'
+require 'environment'
+
+class Runner
+	class UnknownActionError < StandardError; end
+	class ActionConfigError < StandardError; end
+
+	def initialize(action_name, args, config, config_path)
+		@action_name = action_name
+		@args = args
+		@config = config
+		@config_path = config_path
+	end
+
+	def run
+		return forward.run if forward
+
+		do_before_all
+
+		return builtin.run if builtin
+
+		raise UnknownActionError, "Unknown action: #{@action_name}" unless action
+		raise ActionConfigError, action.config_errors.join("; ") unless action.config_valid?
+
+		do_before_action
+		Output.notice("Running '#{action}' in environment '#{ENV['environment']}'...")
+		action.run
+	end
+
+	def suggestions
+		@suggestions ||= ActionSuggester.new(action_list.names + action_list.aliases + builtin_names).check(@action_name)
+	end
+
+	private
+
+	def do_before_all
+		AppConfig.load
+		Secrets.load if action&.load_secrets?
+		environment.set_variables
+	end
+
+	def do_before_action
+		return if ENV["OPS_RUNNING"] || action.skip_hooks?("before")
+
+		# this prevents before hooks from running in ops executed by ops
+		ENV["OPS_RUNNING"] = "1"
+		hook_handler.do_hooks("before")
+	end
+
+	def hook_handler
+		@hook_handler ||= HookHandler.new(@config)
+	end
+
+	def builtin
+		@builtin ||= Builtin.class_for(name: @action_name).new(@args, @config)
+	rescue NameError
+		# this means there isn't a builtin with that name in that module
+		nil
+	end
+
+	def builtin_names
+		Builtins.constants.select { |c| Builtins.const_get(c).is_a? Class }.map(&:downcase)
+	end
+
+	def forward
+		@forward ||= Forwards.new(@config, @args).get(@action_name)
+	end
+
+	def action
+		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)
+	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
+
+	def env_vars
+		@config.dig("options", "environment") || {}
+	end
+
+	def environment
+		@environment ||= Environment.new(env_vars, @config_path)
+	end
+end

data/ops_team.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
 	s.name = 'ops_team'
-	s.version = '0.19.1'
+	s.version = '1.2.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.19.1
+  version: 1.2.2
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -181,6 +181,7 @@ files:
 - lib/ops.rb
 - lib/options.rb
 - lib/output.rb
+- lib/runner.rb
 - lib/secrets.rb
 - lib/version.rb
 - loader.rb