ops_team 0.13.3 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea3bc79f136cc22e2710bba983cb23d14ed332d7f9a4e14e1bf94b53f17e5a1b
-  data.tar.gz: 404cc0d081d9d1bbe4082fd4e24532322f5a1324d8063a6e6eaaea615a7a0321
+  metadata.gz: d3beee0325741d140b711ee3f939306452b176b9be9f7d9094c1e578ed780373
+  data.tar.gz: 33aef85445dd2494967e246c1b4ebfe7433d76b9b09512756cb2a086321438cd
 SHA512:
-  metadata.gz: 1df25521312cd853043220089fed8b33b0bd3bbaa192ac3720e17528a14615ecd74ac3a17d69d3c87209f571149ef8d6d9adc4ce877cad9ef8fd0bf0b36fe0ef
-  data.tar.gz: 261a40eac02451b42d6c331bb2281647f687c04e2aafba7523d42a70bcc37e486904cf58993869452641f50d1ce07c2ea417054013c726b28cc75c6b6f6ee7f6
+  metadata.gz: b0d69fca7b243d34d4c14cf53d8b10942b212cd53fd897c136079d9883e939670f3b74c3383df547d6c2f9a7c1d25f0ce4ba11e3337e566cdab010a6ebe81ef9
+  data.tar.gz: 96e25352e3b8b337a53632e560e1f494c38d2fc09b0b314c4a4e6e07aec92324b52051ac0c5235a4ab8d394247683890230dd5b29fe86b8ec26102af0482c559

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,117 @@
+# 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)
+			config_keys_for(env) | secrets_keys_for(env)
+		end
+
+		def config_keys_for(env)
+			(config_for(env)["environment"]&.keys || []).map do |key|
+				"[CONFIG] #{key}"
+			end
+		end
+
+		def secrets_keys_for(env)
+			(secrets_for(env)["environment"]&.keys || []).map do |key|
+				"[SECRET] #{key}"
+			end
+		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
+	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

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
 
-require 'dependency'
+require 'dependencies/versioned_dependency'
 require 'dependencies/helpers/apt_cache_policy'
 
 module Dependencies
-	class Apt < Dependency
-		PACKAGE_NAME_SEPARATOR = "/"
-
+	class Apt < VersionedDependency
 		def met?
-			return apt_cache_policy.installed_version == package_version if package_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
@@ -23,25 +27,13 @@ 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
 
-		def package_name
-			name_components[0]
-		end
-
-		def package_version
-			name_components[1]
-		end
-
-		def name_components
-			name.split(PACKAGE_NAME_SEPARATOR, 2)
-		end
-
 		def apt_cache_policy
-			@apt_cache_policy ||= Dependencies::Helpers::AptCachePolicy.new(package_name)
+			@apt_cache_policy ||= Dependencies::Helpers::AptCachePolicy.new(dep_name)
 		end
 
 		def sudo_string

data/lib/dependencies/gem.rb

@@ -4,18 +4,20 @@ require 'dependency'
 require 'options'
 
 module Dependencies
-	class Gem < Dependency
+	class Gem < VersionedDependency
 		def met?
-			execute("gem list -i '^#{name}$'")
+			if versioned?
+				execute("gem list -i '^#{dep_name}$' -v '#{dep_version}'") if versioned?
+			else
+				execute("gem list -i '^#{name}$'")
+			end
 		end
 
 		def meet
-			if Options.get("gem.use_sudo")
-				execute("sudo gem install #{name}")
-			elsif Options.get("gem.user_install")
-				execute("gem install --user-install #{name}")
+			if versioned?
+				execute("#{sudo_string}gem install #{user_install_string}'#{dep_name}' -v '#{dep_version}'")
 			else
-				execute("gem install #{name}")
+				execute("#{sudo_string}gem install #{user_install_string}'#{name}'")
 			end
 		end
 
@@ -23,5 +25,15 @@ module Dependencies
 			# do nothing; we don't want to uninstall packages and reinstall them every time
 			true
 		end
+
+		private
+
+		def sudo_string
+			Options.get("gem.use_sudo") ? "sudo " : ""
+		end
+
+		def user_install_string
+			Options.get("gem.user_install") ? "--user-install " : ""
+		end
 	end
 end

data/lib/dependencies/versioned_dependency.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dependencies
+	class VersionedDependency < Dependency
+		VERSION_SEPARATOR = " "
+
+		def dep_name
+			name_components[0]
+		end
+
+		def dep_version
+			name_components[1]
+		end
+
+		def versioned?
+			!!dep_version
+		end
+
+		private
+
+		def name_components
+			name.split(VERSION_SEPARATOR, 2)
+		end
+	end
+end

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

@@ -40,7 +40,7 @@ class Output
 			@err.puts(msg.yellow)
 		end
 
-		alias_method :notice, :warn
+		alias notice warn
 
 		def error(msg)
 			@err.puts(msg.red)

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.13.3'
+	s.version = '0.15.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.13.3
+  version: 0.15.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
@@ -170,6 +171,7 @@ files:
 - lib/dependencies/gem.rb
 - lib/dependencies/helpers/apt_cache_policy.rb
 - lib/dependencies/sshkey.rb
+- lib/dependencies/versioned_dependency.rb
 - lib/dependency.rb
 - lib/environment.rb
 - lib/executor.rb