ops_team 0.14.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b9ea41a7031a3b0433fa1dce7a5d6e3acff2a0845df7e614d7348c42decfb17
-  data.tar.gz: b1914623e6e5990aa695112abdcf094b130fc10235fa4aaa1c03ac8d2ca70d14
+  metadata.gz: e4467e73bf2ee29bd368007e420ab6ec5291819bc3ea4d6f0e98e268b9311778
+  data.tar.gz: 6b2c1976f43978255cd85ec7e53af2cb89986c8a7b56eeb159035bcd7735c1fa
 SHA512:
-  metadata.gz: bfb2ac0c3c7da9ea5cfb8113b9557e015739eb7ef7972ecf19c59924171274f28babacd9bba222a852dd0e141ac8b8a8d0bb83bb685c82bb644753b2f7c5c2fa
-  data.tar.gz: c885476119307be822abbb6a2762ab610094a4373ba701cc07359d17f6209d964fc8a83828b4c5a7a066ca4a6115072d9f94f267a50f0a4e5020d648afcaeac2
+  metadata.gz: ca3cb0915e5a328dfe0933ac6894d0b64a12d65d5905c8ee99385fb73f5f3f58d7635448e0d565f7944ee17d85a44e8d3ba00026ca13f7b6415ba53e9f068060
+  data.tar.gz: b0d1429874a25e8229ef56182fb56dc4997d6ca1f30385eb386a97e6a16ed22b8cbbd18f1e7b5321092a029ce0c61d9f76a93a4da25732a9fe9057299b187468

data/lib/action.rb

@@ -36,6 +36,20 @@ class Action
 		@config["skip_#{name}_hooks"]
 	end
 
+	def config_valid?
+		config_errors.empty?
+	end
+
+	def config_errors
+		@config_errors ||= begin
+			errors = []
+
+			errors << "No 'command' specified in 'action'." unless @config['command']
+
+			errors
+		end
+	end
+
 	private
 
 	def load_secrets?

data/lib/app_config.rb

@@ -8,6 +8,14 @@ class AppConfig
 			new(app_config_path).load
 		end
 
+		def default_filename
+			config_path_for(Environment.environment)
+		end
+
+		def config_path_for(env)
+			"config/#{env}/config.json"
+		end
+
 		private
 
 		def app_config_path
@@ -20,7 +28,7 @@ class AppConfig
 	end
 
 	def initialize(filename = "")
-		@filename = filename.empty? ? default_filename : filename
+		@filename = filename.empty? ? AppConfig.default_filename : filename
 	end
 
 	def load
@@ -31,10 +39,6 @@ class AppConfig
 
 	private
 
-	def default_filename
-		"config/#{environment}/config.json"
-	end
-
 	def config
 		@config ||= file_contents ? YAML.safe_load(file_contents) : {}
 	rescue YAML::SyntaxError => e
@@ -48,8 +52,4 @@ class AppConfig
 			nil
 		end
 	end
-
-	def environment
-		ENV['environment']
-	end
 end

data/lib/builtin.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class Builtin
+	class ArgumentError < StandardError; end
+
 	attr_reader :args, :config
 
 	class << self

data/lib/builtins/envdiff.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'builtin'
+
+module Builtins
+	class EnvDiff < Builtin
+		class << self
+			def description
+				"compares keys present in config and secrets between different environments"
+			end
+		end
+
+		def run
+			check_args
+
+			if source_only_keys.empty? && dest_only_keys.empty?
+				Output.out("Environments '#{source_env}' and '#{dest_env}' define the same #{source_keys.length} key(s).")
+				return
+			end
+
+			output_key_summary(source_only_keys, source_env, dest_env) if source_only_keys.any?
+			output_key_summary(dest_only_keys, dest_env, source_env) if dest_only_keys.any?
+		end
+
+		private
+
+		def output_key_summary(keys, in_env, not_in_env)
+			Output.warn("Environment '#{in_env}' defines keys that '#{not_in_env}' does not:\n")
+			keys.each do |key|
+				Output.warn("   - #{key}")
+			end
+			Output.out("")
+		end
+
+		def source_only_keys
+			@source_only_keys ||= source_keys - dest_keys
+		end
+
+		def dest_only_keys
+			@dest_only_keys ||= dest_keys - source_keys
+		end
+
+		def source_keys
+			@source_keys ||= keys_for(source_env)
+		end
+
+		def dest_keys
+			@dest_keys ||= keys_for(dest_env)
+		end
+
+		def keys_for(env)
+			tagged_config_keys_for(env) + tagged_secrets_keys_for(env)
+		end
+
+		def tagged_config_keys_for(env)
+			config_keys_for(env).map do |key|
+				"[CONFIG] #{key}"
+			end
+		end
+
+		def tagged_secrets_keys_for(env)
+			secrets_keys_for(env).map do |key|
+				"[SECRET] #{key}"
+			end
+		end
+
+		def config_keys_for(env)
+			(config_for(env)["environment"]&.keys || []) - ignored_keys
+		end
+
+		def secrets_keys_for(env)
+			(secrets_for(env)["environment"]&.keys || []) - ignored_keys
+		end
+
+		def config_for(env)
+			YAML.load_file(config_path_for(env))
+		end
+
+		def secrets_for(env)
+			YAML.load_file(secrets_path_for(env))
+		end
+
+		def check_args
+			raise Builtin::ArgumentError, "Usage: ops envdiff <env_one> <env_two>" unless args.length == 2
+
+			check_environment(source_env)
+			check_environment(dest_env)
+		end
+
+		def source_env
+			args[0]
+		end
+
+		def dest_env
+			args[1]
+		end
+
+		def check_environment(name)
+			raise_missing_file_error(config_path_for(name)) unless config_file_exists?(name)
+			raise_missing_file_error(secrets_path_for(name)) unless secrets_file_exists?(name)
+		end
+
+		def raise_missing_file_error(path)
+			raise Builtin::ArgumentError, "File '#{path}' does not exist."
+		end
+
+		def config_file_exists?(env)
+			File.exist?(config_path_for(env))
+		end
+
+		def secrets_file_exists?(env)
+			File.exist?(secrets_path_for(env))
+		end
+
+		def config_path_for(env)
+			AppConfig.config_path_for(env)
+		end
+
+		def secrets_path_for(env)
+			Secrets.config_path_for(env)
+		end
+
+		def ignored_keys
+			Options.get("envdiff.ignored_keys") || []
+		end
+	end
+
+	Envdiff = EnvDiff
+end

data/lib/builtins/help.rb

@@ -54,12 +54,18 @@ module Builtins
 		def actions
 			return [] unless @config["actions"]
 
-			@config["actions"].map do |name, value|
-				format("%<name>-35s %<desc>s",
-					name: name.yellow,
-					desc: value["description"] || value["command"]
+			@config["actions"].map do |name, action_config|
+				format("%<name>-40s %<desc>s",
+					name: "#{name.yellow} #{alias_string_for(action_config)}",
+					desc: action_config["description"] || action_config["command"]
 				)
 			end.sort
 		end
+
+		def alias_string_for(action_config)
+			return "[#{action_config["alias"]}]" if action_config["alias"]
+
+			""
+		end
 	end
 end

data/lib/environment.rb

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
 
 require 'version'
+require 'secrets'
+require 'app_config'
 
 class Environment
+	class << self
+		def environment
+			return 'dev' if ENV['environment'].nil? || ENV['environment'].empty?
+
+			ENV['environment']
+		end
+	end
+
 	def initialize(env_hash)
 		@env_hash = env_hash
 	end
@@ -13,22 +23,18 @@ class Environment
 		set_configured_variables
 	end
 
-	def environment
-		return 'dev' if ENV['environment'].nil? || ENV['environment'].empty?
-
-		ENV['environment']
-	end
-
 	private
 
 	def set_ops_variables
 		ENV["OPS_YML_DIR"] = Dir.pwd
 		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)
 	end
 
 	def set_environment_aliases
 		environment_aliases.each do |alias_name|
-			ENV[alias_name] = environment
+			ENV[alias_name] = Environment.environment
 		end
 	end
 

data/lib/ops.rb

@@ -19,6 +19,7 @@ require_rel "builtins"
 # executes commands based on local `ops.yml`
 class Ops
 	class UnknownActionError < StandardError; end
+	class ActionConfigError < StandardError; end
 
 	CONFIG_FILE = "ops.yml"
 
@@ -26,6 +27,8 @@ class Ops
 	UNKNOWN_ACTION_EXIT_CODE = 65
 	ERROR_LOADING_APP_CONFIG_EXIT_CODE = 66
 	MIN_VERSION_NOT_MET_EXIT_CODE = 67
+	ACTION_CONFIG_ERROR_EXIT_CODE = 68
+	BUILTIN_SYNTAX_ERROR_EXIT_CODE = 69
 
 	RECOMMEND_HELP_TEXT = "Run 'ops help' for a list of builtins and actions."
 
@@ -52,6 +55,9 @@ class Ops
 		Output.error(e.to_s)
 		Output.out(RECOMMEND_HELP_TEXT) unless print_did_you_mean
 		exit(UNKNOWN_ACTION_EXIT_CODE)
+	rescue ActionConfigError => e
+		Output.error("Error(s) running action '#{@action_name}': #{e}")
+		exit(ACTION_CONFIG_ERROR_EXIT_CODE)
 	end
 
 	private
@@ -98,9 +104,14 @@ class Ops
 
 		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)

data/lib/secrets.rb

@@ -9,31 +9,35 @@ require 'options'
 
 class Secrets < AppConfig
 	class << self
+		def default_filename
+			config_path_for(Environment.environment)
+		end
+
+		def config_path_for(env)
+			File.exist?(ejson_path_for(env)) ? ejson_path_for(env) : json_path_for(env)
+		end
+
 		private
 
+		def ejson_path_for(env)
+			"config/#{env}/secrets.ejson"
+		end
+
+		def json_path_for(env)
+			"config/#{env}/secrets.json"
+		end
+
 		def app_config_path
 			expand_path(Options.get("secrets.path"))
 		end
 	end
 
 	def initialize(filename = "")
-		@filename = filename.empty? ? default_filename : actual_filename_for(filename)
+		@filename = filename.empty? ? Secrets.default_filename : actual_filename_for(filename)
 	end
 
 	private
 
-	def default_filename
-		File.exist?(default_ejson_filename) ? default_ejson_filename : default_json_filename
-	end
-
-	def default_ejson_filename
-		"config/#{environment}/secrets.ejson"
-	end
-
-	def default_json_filename
-		"config/#{environment}/secrets.json"
-	end
-
 	def actual_filename_for(filename)
 		File.exist?(filename) ? filename : filename.sub(".ejson", ".json")
 	end

data/ops_team.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.17.0
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -154,6 +154,7 @@ files:
 - lib/builtins/background_log.rb
 - lib/builtins/down.rb
 - lib/builtins/env.rb
+- lib/builtins/envdiff.rb
 - lib/builtins/exec.rb
 - lib/builtins/help.rb
 - lib/builtins/helpers/dependency_handler.rb