ops_team 0.14.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 158077a8d8c025f32b231991165c500b93000422bfc411ff88124a86dad7af05
-  data.tar.gz: db0c44533b58f0a65b9d25921b77a5eb41f1a058f8ecae444c175a635d9f455d
+  metadata.gz: 38e13ae9a92b8cce7726c6edd5d498859a41ecf108f8c4b248b3da8918518c01
+  data.tar.gz: fdf320662ce91d561814e80445ad696a46231441f0483e178d763c41d06e8d81
 SHA512:
-  metadata.gz: a5a7026cbb1b3eee2e16128d5f1f3d36f54197327bbe5562eb28ac2c7eb74a29feb5cc743cae4f4afaef40a9e5dabc5cf4cdc17eab5dd373ed826b87e1b6744f
-  data.tar.gz: 540a77c3f21b3c015bd45300bd50c0a42b6d467607b77869b141f3a03a15399e0f3d74a59aeef8a6b6781b6538783ce874dc00d6f0811c442bc36a88923d3602
+  metadata.gz: e273245669d3a2e966cc55eff9b4536ba8fe1ee1a288e535003d004dae7e982895ee59d01f9fc2921559886d66b846a042f62890d899ae2e6845164d93627529
+  data.tar.gz: 700f6c5ef42e0b46ff4522544b6140ad7c225abacf77d3ec5f54038690a665a59dec9aee19eaba7e7a0b69c5039be809eb9f391c08bd69a03dee71bfaf46ab0a

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/dependencies/apk.rb

@@ -20,7 +20,7 @@ module Dependencies
 		end
 
 		def should_meet?
-			`uname`.chomp == "Linux" && system("which apk")
+			`uname`.chomp == "Linux" && system("which apk", out: File::NULL, err: File::NULL)
 		end
 	end
 end

data/lib/dependencies/apt.rb

@@ -6,13 +6,19 @@ require 'dependencies/helpers/apt_cache_policy'
 module Dependencies
 	class Apt < VersionedDependency
 		def met?
-			return apt_cache_policy.installed_version == dep_version if dep_version
-
-			apt_cache_policy.installed?
+			if versioned?
+				apt_cache_policy.installed_version == dep_version
+			else
+				apt_cache_policy.installed?
+			end
 		end
 
 		def meet
-			execute("#{sudo_string}apt-get install -y #{name}")
+			if versioned?
+				execute("#{sudo_string}apt-get install -y #{dep_name}=#{dep_version}")
+			else
+				execute("#{sudo_string}apt-get install -y #{name}")
+			end
 		end
 
 		def unmeet
@@ -21,7 +27,7 @@ module Dependencies
 		end
 
 		def should_meet?
-			`uname`.chomp == "Linux" && system("which apt-get")
+			`uname`.chomp == "Linux" && system("which apt-get", out: File::NULL, err: File::NULL)
 		end
 
 		private

data/lib/environment.rb

@@ -3,6 +3,14 @@
 require 'version'
 
 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,12 +21,6 @@ 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
@@ -28,7 +30,7 @@ class Environment
 
 	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.0'
+	s.version = '0.15.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.14.0
+  version: 0.15.1
 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