ops_team 1.21.1 → 2.0.0.rc3

data/lib/builtins/help.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require 'colorize'
-
-module Builtins
-	class Help < Builtin
-		NAME_WIDTH = 40
-
-		class << self
-			def description
-				"displays available builtins, actions, and forwards"
-			end
-		end
-
-		def run
-			list("Builtins", builtins) if builtins.any?
-			list("Forwards", forwards) if forwards.any?
-			list("Actions", actions) if actions.any?
-
-			true
-		end
-
-		private
-
-		def list(name, items)
-			Output.out("#{name}:")
-			Output.out("  #{items.join("\n  ")}")
-			Output.out("")
-		end
-
-		def forwards
-			Forwards.new(@config).forwards.map do |name, dir|
-				format("%<name>-#{NAME_WIDTH}s %<desc>s", name: name.yellow, desc: dir.to_s)
-			end
-		end
-
-		def builtins
-			builtin_enumerator.names_by_constant.map do |klass, names|
-				names_string = names.map(&:downcase).map(&:to_s).uniq.join(", ").yellow
-
-				format("%<names>-#{NAME_WIDTH}s %<desc>s", names: names_string, desc: klass.description)
-			end
-		end
-
-		def actions
-			return [] unless @config["actions"]
-
-			@config["actions"].map do |name, action_config|
-				format("%<name>-#{NAME_WIDTH}s %<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
-
-		def builtin_enumerator
-			@builtin_enumerator ||= ::Builtins::Helpers::Enumerator
-		end
-	end
-end

data/lib/builtins/helpers/dependency_handler.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Builtins
-	module Helpers
-		class DependencyHandler
-			def initialize(dependency_set)
-				@dependency_set = dependency_set
-			end
-
-			def dependencies
-				return [] unless @dependency_set
-
-				@dependency_set.map do |type, names|
-					dependencies_for(type, names)
-				end.flatten.compact
-			end
-
-			def dependencies_for(type, names)
-				dependency_class = Dependencies.const_get(type.capitalize.to_sym, false)
-
-				names.map { |name| dependency_class.new(name) }
-			rescue NameError
-				Output.error("No way to handle dependencies of type '#{type}'; ignoring.")
-			end
-		end
-	end
-end

data/lib/builtins/helpers/enumerator.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require 'require_all'
-require_rel '..'
-
-module Builtins
-	module Helpers
-		class Enumerator
-			class << self
-				def names_by_constant
-					constants_by_name.each_with_object({}) do |(name, const), hash|
-						if hash.include?(const)
-							hash[const] << name
-						else
-							hash[const] = [name]
-						end
-					end
-				end
-
-				private
-
-				def constants_by_name
-					@constants_by_name = Builtins.constants.each_with_object({}) do |const_name, hash|
-						const = Builtins.const_get(const_name, false)
-
-						next unless const.is_a?(Class)
-
-						hash[const_name] = const
-					end
-				end
-			end
-		end
-	end
-end

data/lib/builtins/init.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-
-module Builtins
-	class Init < Builtin
-		OPS_YML = "ops.yml"
-		TEMPLATE_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "etc"))
-		OPS_YML_TEMPLATE = File.join(TEMPLATE_DIR, "%<template_name>s.template.yml")
-		DEFAULT_TEMPLATE_NAME = "ops"
-
-		class << self
-			def description
-				"creates an ops.yml file from a template"
-			end
-		end
-
-		def run
-			if File.exist?(OPS_YML)
-				Output.error("File '#{OPS_YML} exists; not initializing.")
-
-				return false
-			end
-
-			Output.out("Creating '#{OPS_YML} from template...")
-			FileUtils.cp(template_path, OPS_YML)
-
-			true
-		rescue SystemCallError
-			Output.error(template_not_found_message)
-			exit 1
-		end
-
-		private
-
-		def template_name
-			@args[0]
-		end
-
-		def template_path
-			return template_name if template_name && File.exist?(template_name)
-
-			builtin_template_path
-		end
-
-		def builtin_template_path
-			format(OPS_YML_TEMPLATE, template_name: template_name || DEFAULT_TEMPLATE_NAME)
-		end
-
-		def template_name_list
-			@template_name_list ||= Dir.entries(TEMPLATE_DIR).map do |name|
-				name.match(/^([^.]*).template.yml/)&.captures&.first
-			end.compact
-		end
-
-		def template_not_found_message
-			<<~MESSAGE
-				Template '#{template_path} does not exist.
-				\nValid template names are:
-				   - #{template_name_list.join("\n   - ")}\n
-			MESSAGE
-		end
-	end
-end

data/lib/builtins/up.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Builtins
-	class Up < Common::UpDown
-		def handle_dependency(dependency)
-			dependency.meet
-		end
-	end
-end

data/lib/builtins/version.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Builtins
-	class Version < Builtin
-		class << self
-			def description
-				"prints the version of ops that is running"
-			end
-		end
-
-		def run
-			Output.out(::Version.version)
-
-			true
-		end
-	end
-end

data/lib/dependencies/apk.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'English'
-
-module Dependencies
-	class Apk < Dependency
-		def met?
-			execute("apk info | grep -q '^#{name}'$")
-		end
-
-		def meet
-			execute("apk add #{name}")
-		end
-
-		def unmeet
-			# do nothing; we don't want to uninstall packages and reinstall them every time
-			true
-		end
-
-		def should_meet?
-			`uname`.chomp == "Linux" && system("which apk", out: File::NULL, err: File::NULL)
-		end
-	end
-end

data/lib/dependencies/apt.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Dependencies
-	class Apt < VersionedDependency
-		def met?
-			if versioned?
-				apt_cache_policy.installed_version == dep_version
-			else
-				apt_cache_policy.installed?
-			end
-		end
-
-		def meet
-			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
-			# do nothing; we don't want to uninstall packages and reinstall them every time
-			true
-		end
-
-		def should_meet?
-			`uname`.chomp == "Linux" && system("which apt-get", out: File::NULL, err: File::NULL)
-		end
-
-		private
-
-		def apt_cache_policy
-			@apt_cache_policy ||= Dependencies::Helpers::AptCachePolicy.new(dep_name)
-		end
-
-		def sudo_string
-			return "" if ENV['USER'] == "root" || `whoami` == "root" || Options.get("apt.use_sudo") == false
-
-			"sudo "
-		end
-	end
-end

data/lib/dependencies/brew.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Dependencies
-	class Brew < Dependency
-		def met?
-			execute("brew list #{name}")
-		end
-
-		def meet
-			execute("brew install #{name}")
-		end
-
-		def unmeet
-			# do nothing; we don't want to uninstall packages and reinstall them every time
-			true
-		end
-
-		def should_meet?
-			`uname`.chomp == "Darwin"
-		end
-	end
-end

data/lib/dependencies/cask.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Dependencies
-	class Cask < Brew
-		def met?
-			execute("brew list --cask #{name}")
-		end
-
-		def meet
-			execute("brew install --cask #{name}")
-		end
-	end
-end

data/lib/dependencies/custom.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module Dependencies
-	class Custom < Dependency
-		class CustomConfigError < StandardError; end
-
-		def initialize(definition)
-			super
-			@definition = definition
-			@name, @config = parse_definition
-		end
-
-		def met?
-			false
-		end
-
-		def always_act?
-			true
-		end
-
-		def meet
-			execute(up_command) if up_command
-		end
-
-		def unmeet
-			execute(down_command) if down_command
-		end
-
-		private
-
-		def up_command
-			@up_command ||= @definition.is_a?(Hash) ? @config&.dig("up") : name
-		end
-
-		def down_command
-			@down_command ||= @config && @config&.dig("down") || nil
-		end
-
-		def parse_definition
-			return @definition.first if @definition.is_a?(Hash)
-
-			[@definition.to_s, {}]
-		end
-	end
-end

data/lib/dependencies/dir.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Dependencies
-	class Dir < Dependency
-		def met?
-			execute("test -d #{name}")
-		end
-
-		def meet
-			execute("mkdir -p #{name}")
-		end
-
-		def unmeet
-			# do nothing; we don't want to delete the directory on an `ops down`
-			true
-		end
-
-		def should_meet?
-			true
-		end
-	end
-end

data/lib/dependencies/docker.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Dependencies
-	class Docker < Dependency
-		def met?
-			execute("cd #{name} && docker-compose ps | grep -q ' Up '")
-		end
-
-		def meet
-			execute("cd #{name} && docker-compose up -d")
-		end
-
-		def unmeet
-			execute("cd #{name} && docker-compose down")
-		end
-	end
-end

data/lib/dependencies/gem.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Dependencies
-	class Gem < VersionedDependency
-		def met?
-			if versioned?
-				execute("gem list -i '^#{dep_name}$' -v '#{dep_version}'") if versioned?
-			else
-				execute("gem list -i '^#{name}$'")
-			end
-		end
-
-		def meet
-			if versioned?
-				execute("#{sudo_string}gem install #{user_install_string}'#{dep_name}' -v '#{dep_version}'")
-			else
-				execute("#{sudo_string}gem install #{user_install_string}'#{name}'")
-			end
-		end
-
-		def unmeet
-			# 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/helpers/apt_cache_policy.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Dependencies
-	module Helpers
-		class AptCachePolicy
-			INSTALLED_VERSION_REGEX = /  Installed: ([-+.a-z0-9]+)/.freeze
-
-			attr_reader :name
-
-			def initialize(name)
-				@name = name
-			end
-
-			def installed_version
-				version_from_policy_version_line(installed_version_line)
-			end
-
-			def installed?
-				!!installed_version
-			end
-
-			private
-
-			def installed_version_line
-				apt_cache_lines.find { |line| line.match(/#{INSTALLED_VERSION_REGEX}/) }
-			end
-
-			def version_from_policy_version_line(line)
-				return nil if line.nil?
-
-				# E.g.:
-				#  Installed: 7.52.1-5+deb9u7
-				match = line.match(/#{INSTALLED_VERSION_REGEX}/)
-
-				match.nil? ? nil : match[1]
-			end
-
-			def apt_cache_lines
-				@apt_cache_lines ||= `apt-cache policy #{name}`.split("\n")
-			end
-		end
-	end
-end

data/lib/dependencies/pip.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'English'
-
-module Dependencies
-	class Pip < Dependency
-		DEFAULT_PIP = "python3 -m pip"
-
-		def met?
-			execute("#{pip} show #{name}")
-		end
-
-		def meet
-			execute("#{pip} install #{name}")
-		end
-
-		def unmeet
-			# do nothing; we don't want to uninstall packages and reinstall them every time
-			true
-		end
-
-		def should_meet?
-			true
-		end
-
-		private
-
-		def pip
-			Options.get("pip.command") || DEFAULT_PIP
-		end
-	end
-end

data/lib/dependencies/snap.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Dependencies
-	class Snap < VersionedDependency
-		def met?
-			system("snap list | grep -q \"^name \"")
-		end
-
-		def meet
-			execute("#{sudo_string}snap install #{name}")
-		end
-
-		def unmeet
-			# do nothing; we don't want to uninstall packages and reinstall them every time
-			true
-		end
-
-		def should_meet?
-			return false unless Options.get("snap.install")
-			return false unless `uname`.chomp == "Linux"
-			return false unless system("which snap", out: File::NULL, err: File::NULL)
-
-			true
-		end
-
-		private
-
-		def sudo_string
-			return "sudo " unless Options.get("snap.use_sudo") == false
-		end
-	end
-end

data/lib/dependencies/sshkey.rb

@@ -1,121 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-require 'net/ssh'
-
-module Dependencies
-	class Sshkey < Dependency
-		DEFAULT_KEY_SIZE = 4096
-		DEFAULT_KEY_ALGO = "rsa"
-		DEFAULT_KEY_LIFETIME_S = 3600
-		DEFAULT_KEY_FILE_COMMENT_COMMAND = "$USER@`hostname -s`"
-
-		def met?
-			# we always need to at least update the key lifetime in the agent
-			false
-		end
-
-		def meet
-			Secrets.load
-
-			Output.warn("\nNo passphrase set for SSH key '#{priv_key_name}'") if passphrase.nil? || passphrase.empty?
-
-			FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
-			generate_key unless File.exist?(priv_key_name) && File.exist?(pub_key_name)
-			add_key if success? && should_add_key?
-		end
-
-		def unmeet
-			true
-		end
-
-		def should_meet?
-			true
-		end
-
-		private
-
-		def generate_key
-			execute(
-				"ssh-keygen -b #{opt_key_size} -t #{opt_key_algo} -f #{priv_key_name} -q -N '#{passphrase}' -C '#{key_file_comment}'"
-			)
-		end
-
-		def add_key
-			Net::SSH::Authentication::Agent.connect.add_identity(
-				unencrypted_key,
-				key_comment,
-				lifetime: opt_key_lifetime
-			)
-		end
-
-		def should_add_key?
-			ENV["SSH_AUTH_SOCK"] && opt_add_keys?
-		end
-
-		def unencrypted_key
-			Net::SSH::KeyFactory.load_private_key(priv_key_name, passphrase.empty? ? nil : passphrase)
-		end
-
-		def key_comment
-			Ops.project_name
-		end
-
-		def key_file_comment
-			`echo #{opt_key_file_comment_command}`.chomp
-		end
-
-		def dir_name
-			`echo #{File.dirname(name)}`.chomp
-		end
-
-		def priv_key_name
-			`echo #{name}`.chomp
-		end
-
-		def pub_key_name
-			"#{priv_key_name}.pub"
-		end
-
-		def opt_key_size
-			Options.get("sshkey.key_size") || DEFAULT_KEY_SIZE
-		end
-
-		def opt_key_algo
-			Options.get("sshkey.key_algo") || DEFAULT_KEY_ALGO
-		end
-
-		def passphrase
-			`echo #{opt_passphrase}`.chomp
-		end
-
-		def opt_passphrase
-			@opt_passphrase ||= begin
-				return "$#{Options.get('sshkey.passphrase_var')}" if Options.get("sshkey.passphrase_var")
-
-				output_passphrase_warning if Options.get("sshkey.passphrase")
-
-				Options.get("sshkey.passphrase")
-			end
-		end
-
-		def output_passphrase_warning
-			Output.warn(
-				"\n'options.sshkey.passphrase' is deprecated and will be removed in a future release. " \
-				"Use 'options.sshkey.passphrase_var' instead."
-			)
-		end
-
-		def opt_add_keys?
-			Options.get("sshkey.add_keys").nil? ? true : Options.get("sshkey.add_keys")
-		end
-
-		def opt_key_lifetime
-			Options.get("sshkey.key_lifetime") || DEFAULT_KEY_LIFETIME_S
-		end
-
-		def opt_key_file_comment_command
-			Options.get("sshkey.key_file_comment") || DEFAULT_KEY_FILE_COMMENT_COMMAND
-		end
-	end
-end