ops_team 0.8.8 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d627dbbdad038718bd7fce64f99d37830b7e0c8ba7b6214fa0f4639e1997d1a
-  data.tar.gz: 213ca817d96f52c6666745b9ba4312a7ef97baa019e4176c1216b9f263ac5c37
+  metadata.gz: 0a168c8803f5f12ecc5ba54fc77e4a304baa300aa100e2d81d92b2f5146551d7
+  data.tar.gz: dec291b877b6cc0fc056feb794e676abd56f5376b8373f914b6c24dfd3d7462d
 SHA512:
-  metadata.gz: 1ffdb94e555112eed03b2f2ec6b9bb945e5ee97a89d4ec353279763a599599d0a97f36c2c6496674588af95392322732b7cbea94ddee2ed00915d4b3f02d9efe
-  data.tar.gz: 0f1fdbbcbd13fbeebfe8a4e32c99bc5885140b244e47c3b7e1c910768efea8875e4cbb7d93219eafb1d8ca6fcbed9b0d77da7c9782d951c37ba22f8847abd9cf
+  metadata.gz: d96bea7054642ba35750f8efa59d6a6e2201dce98aaa5471dda573704ceb66f5daedf38f9cd7a68d2b31f9bd53ad17fff85790f61fe04fca8221ac9299140ddb
+  data.tar.gz: 86b51b059eca72ba60f30c2be14c83bc40e4e1c872c3edaa91bab6a94080eb34a59eda351ef796d42d903216ca71f1fd8059d031773fb0b1efd2e7f2b498e4f5

data/lib/action.rb

@@ -17,7 +17,7 @@ class Action
 	end
 
 	def to_s
-		"#{command} #{@args.join(' ')}"
+		"#{command} #{@args.join(' ')}".strip
 	end
 
 	def alias

data/lib/builtin.rb

@@ -1,10 +1,22 @@
 # frozen_string_literal: true
 
 class Builtin
+	attr_reader :args, :config
+
 	class << self
 		def description
 			"no description"
 		end
+
+		def class_for(name:)
+			Builtins.const_get(builtin_class_name_for(name: name), false)
+		end
+
+		private
+
+		def builtin_class_name_for(name:)
+			name.capitalize.to_sym
+		end
 	end
 
 	def initialize(args, config)

data/lib/builtins/background.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'builtin'
+
+module Builtins
+	class Background < Builtin
+		DEFAULT_SHELL = "bash"
+		DEFAULT_LOG_FILE_PREFIX = "/tmp/ops_bglog_"
+
+		class << self
+			def description
+				"runs the given command in a background session"
+			end
+
+			def log_filename
+				"#{log_filename_prefix}#{Ops.project_name}"
+			end
+
+			private
+
+			def log_filename_prefix
+				Options.get("background.log_filename_prefix") || DEFAULT_LOG_FILE_PREFIX
+			end
+		end
+
+		def run
+			subprocess = fork do
+				run_ops(args)
+			end
+
+			Process.detach(subprocess)
+		end
+
+		private
+
+		def run_ops(args)
+			Output.notice("Running '#{args.join(' ')}' with stderr and stdout redirected to '#{Background.log_filename}'")
+			$stdout.sync = $stderr.sync = true
+			$stdout.reopen(Background.log_filename, "w")
+			$stderr.reopen($stdout)
+
+			Ops.new(args).run
+		end
+
+		def shell
+			Options.get("background.shell") || DEFAULT_SHELL
+		end
+	end
+
+	# set an alias
+	Bg = Background
+end

data/lib/builtins/background_log.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'builtin'
+require 'builtins/background'
+
+module Builtins
+	class BackgroundLog < Builtin
+		class << self
+			def description
+				"displays the log from the current or most recent background task from this project"
+			end
+		end
+
+		def run
+			unless File.exist?(Background.log_filename)
+				Output.warn("No background log found at '#{Background.log_filename}'.")
+				return 0
+			end
+
+			Output.notice("Displaying background log '#{Background.log_filename}'...")
+			exec("tail #{args.join(' ')} '#{Background.log_filename}'")
+		end
+	end
+
+	# set an alias
+	Bglog = BackgroundLog
+end

data/lib/dependencies/sshkey.rb

@@ -35,6 +35,8 @@ module Dependencies
 		private
 
 		def generate_key
+			Output.warn("\nNo passphrase set for SSH key '#{priv_key_name}'") if passphrase.nil? || passphrase.empty?
+
 			execute("ssh-keygen -b #{opt_key_size} -t #{opt_key_algo} -f #{priv_key_name} -q -N '#{passphrase}'")
 		end
 
@@ -55,8 +57,7 @@ module Dependencies
 		end
 
 		def key_comment
-			# the current directory is usually named for the project
-			File.basename(::Dir.pwd)
+			Ops.project_name
 		end
 
 		def dir_name
@@ -84,7 +85,20 @@ module Dependencies
 		end
 
 		def opt_passphrase
-			Options.get("sshkey.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?

data/lib/ops.rb

@@ -19,6 +19,12 @@ class Ops
 	INVALID_SYNTAX_EXIT_CODE = 64
 	UNKNOWN_ACTION_EXIT_CODE = 65
 
+	class << self
+		def project_name
+			File.basename(::Dir.pwd)
+		end
+	end
+
 	def initialize(argv)
 		@action_name = argv[0]
 		@args = argv[1..-1]
@@ -27,7 +33,7 @@ class Ops
 	end
 
 	def run
-		exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
+		return exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
 
 		run_action
 	rescue UnknownActionError => e
@@ -39,8 +45,7 @@ class Ops
 
 	def syntax_valid?
 		if @action_name.nil?
-			# TODO: output to stderr
-			puts "Usage: ops <action>"
+			Output.error("Usage: ops <action>")
 			false
 		else
 			true
@@ -53,21 +58,17 @@ class Ops
 
 		return builtin.run if builtin
 
-		Output.warn("Running '#{action}' from #{CONFIG_FILE} in environment '#{ENV['environment']}'...")
+		Output.notice("Running '#{action}' from #{CONFIG_FILE} in environment '#{ENV['environment']}'...")
 		action.run
 	end
 
 	def builtin
-		@builtin ||= Builtins.const_get(builtin_class_name, false).new(@args, config)
+		@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_class_name
-		@action_name.capitalize.to_sym
-	end
-
 	def action
 		return actions[@action_name] if actions[@action_name]
 		return aliases[@action_name] if aliases[@action_name]

data/lib/output.rb

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

data/ops_team.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
 	s.name = 'ops_team'
-	s.version = '0.8.8'
+	s.version = '0.9.2'
 	s.authors = [
 		'nickthecook@gmail.com'
 	]
-	s.date = '2020-05-29'
+	s.date = '2020-08-11'
 	s.summary = 'ops_team handles basic operations tasks for your project, driven by YAML config'
 	s.homepage = 'https://github.com/nickthecook/ops'
 	s.files = Dir[

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.9.2
 platform: ruby
 authors:
 - nickthecook@gmail.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -148,6 +148,8 @@ files:
 - lib/action.rb
 - lib/app_config.rb
 - lib/builtin.rb
+- lib/builtins/background.rb
+- lib/builtins/background_log.rb
 - lib/builtins/down.rb
 - lib/builtins/env.rb
 - lib/builtins/exec.rb