ops_team 0.1.7 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af22f3dad0669e5cae68bc2bfbe6f8c2e7227bc11d74a4295d59c9e7fa4ea79e
-  data.tar.gz: bed9b0448b2b2051d6e2d817f7f48bab44c1b901d5586b157d81491bdd0dd2a2
+  metadata.gz: fb200091bd81044096f650bc1647958dd129b12b14c309516b7e7ce0324e8889
+  data.tar.gz: 0edf7442cd2106ac2de48b6c14d16510111fa10759fe320aaea1856f366c8703
 SHA512:
-  metadata.gz: f46ef6fb3cdc4fb430405b73d7f1c9c0f0261fe313d7ff02275b2ea1a31be6c3283cb3c232fd601af34c852ba3ae3eb4ceb00f7db2253a519d92ca8e01413a55
-  data.tar.gz: 1462ee358b52b81e48526bb276723eb2f9fce3e16d8ee72089182544606c2e8501d045af0505e10a09e6527317ebd729eaa71042bebbc533521ae379f2a92f13
+  metadata.gz: '0379eecf548037718aebf63b722f9571f21410daafd13a6b9ae893cfe7d3fbd3c0a58c40ea10dd1ac35d52c1de580894a774859755185dd8c32eb130db6d31fc'
+  data.tar.gz: 6e08799eb7cf0c196c88e93ecd68f7d48beedd803291d07b362750c9d738785736e9db49ca3c02d180544efa731f7064d5b5537016db8427b826e8057e4a2210

data/bin/print_config

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+echo $KEY1
+echo $KEY2

data/bin/print_secrets

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+echo "$SECRET1"
+echo "$SECRET2"

data/etc/ops.template.yml

@@ -7,5 +7,7 @@ dependencies:
 actions:
   start:
     command: docker-compose up -d
+    description: starts the service
   stop:
     command: docker-compose down
+    description: stops the service

data/etc/ruby.template.yml

@@ -7,23 +7,31 @@ dependencies:
 actions:
   start:
     command: echo update me
+    description: starts the app
   stop:
     command: echo update me too
+    description: stops the app
   test:
     command: rspec
     alias: t
+    description: runs unit tests
   test-watch:
     command: rerun -x ops test
     alias: tw
+    description: runs unit tests every time a file changes
   lint:
     command: bundle exec rubocop --safe-auto-correct
     alias: l
+    description: runs rubocop with safe autocorrect
   build:
     command: gem build *.gemspec
     alias: b
+    description: builds the gem
   install:
     command: gem install `ls -t *.gem | head -n1`
     alias: i
+    description: installs the gem
   build-and-install:
     command: ops build && ops install
     alias: bi
+    description: builds and installs the gem

data/etc/terraform.template.yml

@@ -9,21 +9,28 @@ actions:
   apply:
     command: terraform apply
     alias: a
+    description: runs 'terraform apply'
   apply-auto-approve:
     command: terraform apply --auto-approve
     alias: aa
+    description: runs 'terraform apply' with auto-approve
   destroy:
     command: terraform destroy
     alias: d
+    description: runs 'terraform destroy'
   destroy-auto-approve:
     command: terraform destroy --auto-approve
     alias: dd
+    description: runs 'terraform destroy' with auto-approve
   plan:
     command: terraform plan
     alias: p
+    description: runs 'terraform plan'
   graph:
     command: terraform graph | dot -T pdf -o resource_graph.pdf
     alias: g
+    description: runs 'terraform graph'
   open-graph:
     command: ops graph && open resource_graph.pdf
     alias: og
+    description: opens the terraform graph with the OS 'open' command

data/lib/action.rb

@@ -1,18 +1,49 @@
 # frozen_string_literal: true
 
+require 'secrets'
+
 # represents one action to be performed in the shell
 # can assemble a command line from a command and args
 class Action
-	def initialize(command, args)
-		@command = command
+	def initialize(config, args, options)
+		@config = config
 		@args = args
+		@options = options
 	end
 
 	def run
+		load_secrets if load_secrets?
+
 		Kernel.exec(to_s)
 	end
 
 	def to_s
-		"#{@command} #{@args.join(' ')}"
+		"#{command} #{@args.join(' ')}"
+	end
+
+	def alias
+		@config["alias"]
+	end
+
+	def command
+		@config["command"]
+	end
+
+	def description
+		@config["description"]
+	end
+
+	private
+
+	def load_secrets?
+		@config["load_secrets"]
+	end
+
+	def load_secrets
+		Secrets.new(secrets_file).load
+	end
+
+	def secrets_file
+		`echo #{@options&.dig("secrets", "path")}`.chomp
 	end
 end

data/lib/app_config.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class AppConfig
+	def initialize(filename = "")
+		@filename = filename.empty? ? default_filename : filename
+	end
+
+	def load
+		config['environment']&.each do |key, value|
+			ENV[key] = value
+		end
+	end
+
+	private
+
+	def default_filename
+		"config/#{environment}/config.json"
+	end
+
+	def config
+		@config ||= file_contents ? JSON.parse(file_contents) : {}
+	rescue JSON::ParserError => e
+		Output.error("Error parsing config data: #{e}")
+		{}
+	end
+
+	def file_contents
+		@file_contents ||= begin
+			File.open(@filename).read
+		rescue Errno::ENOENT
+			nil
+		end
+	end
+
+	def environment
+		ENV['environment']
+	end
+end

data/lib/builtin.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 class Builtin
+	class << self
+		def description
+			"no description"
+		end
+	end
+
 	def initialize(args, config)
 		@args = args
 		@config = config

data/lib/builtins/down.rb

@@ -8,6 +8,12 @@ require 'builtins/helpers/dependency_handler'
 
 module Builtins
 	class Down < Builtin
+		class << self
+			def description
+				"stops dependent services listed in ops.yml"
+			end
+		end
+
 		def run
 			# TODO: return a success/failure status to the caller
 			unmeet_dependencies
@@ -39,7 +45,7 @@ module Builtins
 			else
 				Output.failed
 				Output.error("Error unmeeting #{dependency.type} dependency '#{dependency.name}':")
-				puts(dependency.output)
+				Output.out(dependency.output)
 			end
 		end
 	end

data/lib/builtins/env.rb

@@ -5,12 +5,16 @@ require 'output'
 
 module Builtins
 	class Env < Builtin
+		class << self
+			def description
+				"prints the current environment, e.g. 'dev', 'production', 'staging', etc."
+			end
+		end
+
 		def run
 			Output.print(environment)
 		end
 
-		private
-
 		def environment
 			ENV['environment']
 		end

data/lib/builtins/help.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+require 'builtin'
+
+module Builtins
+	class Help < Builtin
+		class << self
+			def description
+				"displays available builtins and actions"
+			end
+		end
+
+		def run
+			Output.out("Builtins:")
+			Output.out("  #{builtins.join("\n  ")}")
+			Output.out("")
+			Output.out("Actions:")
+			Output.out("  #{actions.join("\n  ")}")
+		end
+
+		private
+
+		def builtins
+			builtin_class_names.map do |class_name|
+				description = Builtins.const_get(class_name).description
+				format("%<name>-35s %<desc>s", name: class_name.downcase.to_s.yellow, desc: description)
+			end
+		end
+
+		def builtin_class_names
+			Builtins.constants.select { |c| Builtins.const_get(c).is_a? Class }
+		end
+
+		def actions
+			@config["actions"].map do |name, value|
+				format("%<name>-35s %<desc>s", name: name.yellow, desc: value["description"] || value["command"])
+			end
+		end
+	end
+end

data/lib/builtins/init.rb

@@ -12,6 +12,12 @@ module Builtins
 		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.")

data/lib/builtins/up.rb

@@ -9,6 +9,12 @@ require 'output'
 
 module Builtins
 	class Up < Builtin
+		class << self
+			def description
+				"attempts to meet dependencies listed in ops.yml"
+			end
+		end
+
 		def run
 			# TODO: return a success/failure status to the caller
 			meet_dependencies
@@ -40,7 +46,7 @@ module Builtins
 			else
 				Output.failed
 				Output.error("Error meeting #{dependency.type} dependency '#{dependency.name}':")
-				puts(dependency.output)
+				Output.out(dependency.output)
 			end
 		end
 	end

data/lib/builtins/version.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "rubygems"
+
+require "output"
+
+module Builtins
+	class Version < Builtin
+		GEMSPEC_FILE = "#{__dir__}/../../ops_team.gemspec"
+
+		class << self
+			def description
+				"prints the version of ops that is running"
+			end
+		end
+
+			def run
+			unless gemspec
+				Output.error("Unable to load gemspec at '#{GEMSPEC_FILE}")
+				return false
+			end
+
+			Output.out(gemspec.version)
+		end
+
+		private
+
+		def gemspec
+			@gemspec ||= Gem::Specification.load(GEMSPEC_FILE)
+		end
+	end
+end

data/lib/environment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Environment
+	def initialize(env_hash)
+		@env_hash = env_hash
+	end
+
+	def set_variables
+		@env_hash.each do |key, value|
+			ENV[key] = value
+		end
+
+		ENV['environment'] = environment
+	end
+
+	def environment
+		return 'dev' if ENV['environment'].nil? || ENV['environment'].empty?
+
+		ENV['environment']
+	end
+end

data/lib/ops.rb

@@ -7,9 +7,10 @@ require 'require_all'
 require 'action'
 require 'output'
 require 'options'
+require 'environment'
 require_rel "builtins"
 
-# executes commands defined in local `ops.yml`
+# executes commands based on local `ops.yml`
 class Ops
 	class UnknownActionError < StandardError; end
 
@@ -27,7 +28,8 @@ class Ops
 	def run
 		exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
 
-		ENV['environment'] ||= 'dev'
+		environment.set_variables
+		app_config.load
 
 		return builtin.run if builtin
 
@@ -61,20 +63,16 @@ class Ops
 	end
 
 	def action
-		@action ||= Action.new(command, @args)
-	end
-
-	def command
-		@command ||= begin
-			return actions[@action_name]["command"] if actions[@action_name]
-			return aliases[@action_name]["command"] if aliases[@action_name]
+		return actions[@action_name] if actions[@action_name]
+		return aliases[@action_name] if aliases[@action_name]
 
-			raise UnknownActionError, "Unknown action: #{@action_name}"
-		end
+		raise UnknownActionError, "Unknown action: #{@action_name}"
 	end
 
 	def actions
-		config["actions"]
+		config["actions"].transform_values do |config|
+			Action.new(config, @args, action_options)
+		end
 	end
 
 	def config
@@ -88,11 +86,31 @@ class Ops
 
 	def aliases
 		@aliases ||= begin
-			actions.each_with_object({}) do |(_name, body), alias_hash|
-				alias_hash[body["alias"]] = body if body.include?("alias")
+			actions.each_with_object({}) do |(_name, action), alias_hash|
+				alias_hash[action.alias] = action if action.alias
 			end
 		end
 	end
+
+	def action_options
+		@action_options ||= @config.dig("options", "actions")
+	end
+
+	def env_vars
+		@config.dig("options", "environment") || {}
+	end
+
+	def environment
+		@environment ||= Environment.new(env_vars)
+	end
+
+	def app_config_file
+		`echo #{@options&.dig("config", "path")}`.chomp
+	end
+
+	def app_config
+		@app_config ||= AppConfig.new(app_config_file)
+	end
 end
 
 Ops.new(ARGV).run if $PROGRAM_NAME == __FILE__

data/lib/secrets.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require 'output'
+require 'app_config'
+
+class Secrets < AppConfig
+	private
+
+	def default_filename
+		return default_ejson_filename if File.exist?(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 file_contents
+		@file_contents ||= @filename.match(/\.ejson$/) ? `ejson decrypt #{@filename}` : super
+	end
+end

data/ops_team.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+	s.name = 'ops_team'
+	s.version = '0.2.4'
+	s.authors = [
+		'nickthecook@gmail.com'
+	]
+	s.date = '2020-05-29'
+	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[
+		'Gemfile',
+		'bin/*',
+		'lib/*',
+		'etc/*',
+		'lib/builtins/*',
+		'lib/builtins/helpers/*',
+		'lib/dependencies/*',
+		'loader.rb',
+		'ops_team.gemspec'
+	]
+	s.executables << 'ops'
+	s.required_ruby_version = '~> 2.5'
+	s.add_runtime_dependency 'colorize', '~> 0.8', '>= 0.8.1'
+	s.add_runtime_dependency 'require_all', '~> 1.1', '>= 1.1.6'
+	s.license = 'GPL-3.0-only'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.4
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -59,17 +59,22 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - bin/ops
+- bin/print_config
+- bin/print_secrets
 - bin/tag
 - etc/ops.template.yml
 - etc/ruby.template.yml
 - etc/terraform.template.yml
 - lib/action.rb
+- lib/app_config.rb
 - lib/builtin.rb
 - lib/builtins/down.rb
 - lib/builtins/env.rb
+- lib/builtins/help.rb
 - lib/builtins/helpers/dependency_handler.rb
 - lib/builtins/init.rb
 - lib/builtins/up.rb
+- lib/builtins/version.rb
 - lib/dependencies/apk.rb
 - lib/dependencies/apt.rb
 - lib/dependencies/brew.rb
@@ -80,10 +85,13 @@ files:
 - lib/dependencies/gem.rb
 - lib/dependencies/terraform.rb
 - lib/dependency.rb
+- lib/environment.rb
 - lib/ops.rb
 - lib/options.rb
 - lib/output.rb
+- lib/secrets.rb
 - loader.rb
+- ops_team.gemspec
 homepage: https://github.com/nickthecook/ops
 licenses:
 - GPL-3.0-only