ops_team 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f947ab7c489798b9868dde0124578cfbc747baee9017edab35ddeed55328e27
-  data.tar.gz: 49e885e7155a06c8960dadd505713a2da32081537a7998a4b6fc6c0aa6cb916b
+  metadata.gz: 164882aa877bcf1e7026038b7a5af80466f6d93bdde7004746b023d27c209201
+  data.tar.gz: e829f092558ea07bc81758a00a4551cd707d6c2c15fa4bada88bf30638abdb9d
 SHA512:
-  metadata.gz: fe7fd8380653accb913cccc03b22b1a5463b9da28305df09587f9c2c21c9adf2c43f11217fadf4746a65e3f685ff88e258735f5e34a338846dea77f492f2919e
-  data.tar.gz: 7ceea9ca0c2ced123f2afa57a6d33901546fbaff1b91fee357e66b9a85d1e91c3fb64dac9206552010bca2033f18fe285156320bae422d468b68c60b91de4234
+  metadata.gz: 0e643d7c06f4eb3afd4837502a23d383a66c1dec472aff0e4bf0471c45240094db510a26d9d2c24c8688723108c92514dba2af6f25c0dddc25f4c34ec6d9bc3b
+  data.tar.gz: 6ffbd12aa5626f08ecde1d88d011a7318644624c27bbccd06ef15eca3016cedf26f228306eedc314234f92548b83fb5470acf3e06c6f5470514ac693bc9314b3

data/bin/print_config

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

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
+    command: ops 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
+    command: ops 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

@@ -5,14 +5,13 @@ 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(config, args, options)
+	def initialize(config, args)
 		@config = config
 		@args = args
-		@options = options
 	end
 
 	def run
-		load_secrets if load_secrets?
+		Secrets.load if load_secrets?
 
 		Kernel.exec(to_s)
 	end
@@ -29,15 +28,13 @@ class Action
 		@config["command"]
 	end
 
-	def load_secrets?
-		@config["load_secrets"]
+	def description
+		@config["description"]
 	end
 
-	def load_secrets
-		Secrets.new(secrets_file).load
-	end
+	private
 
-	def secrets_file
-		`echo -n #{@options&.dig("secrets", "path")}`
+	def load_secrets?
+		@config["load_secrets"]
 	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,6 +5,12 @@ 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

data/lib/builtins/exec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'builtin'
+require 'output'
+require 'secrets'
+require 'options'
+
+module Builtins
+	class Exec < Builtin
+		class << self
+			def description
+				"executes the given command in the `ops` environment, i.e. with environment variables set"
+			end
+		end
+
+		def run
+			Secrets.load if Options.get("exec.load_secrets")
+			Kernel.exec(@args.join(" "))
+		end
+	end
+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

@@ -8,7 +8,13 @@ module Builtins
 	class Version < Builtin
 		GEMSPEC_FILE = "#{__dir__}/../../ops_team.gemspec"
 
-		def run
+		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

data/lib/ops.rb

@@ -29,6 +29,7 @@ class Ops
 		exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
 
 		environment.set_variables
+		app_config.load
 
 		return builtin.run if builtin
 
@@ -70,7 +71,7 @@ class Ops
 
 	def actions
 		config["actions"].transform_values do |config|
-			Action.new(config, @args, action_options)
+			Action.new(config, @args)
 		end
 	end
 
@@ -91,10 +92,6 @@ class Ops
 		end
 	end
 
-	def action_options
-		@action_options ||= @config.dig("options", "actions")
-	end
-
 	def env_vars
 		@config.dig("options", "environment") || {}
 	end
@@ -102,6 +99,14 @@ class Ops
 	def environment
 		@environment ||= Environment.new(env_vars)
 	end
+
+	def app_config_file
+		`echo #{Options.get("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

@@ -3,15 +3,19 @@
 require 'json'
 
 require 'output'
+require 'app_config'
+require 'Options'
 
-class Secrets
-	def initialize(filename = "")
-		@filename = filename.empty? ? default_filename : filename
-	end
+class Secrets < AppConfig
+	class << self
+		def load
+			Secrets.new(expand_path(Options.get("secrets.path"))).load
+		end
 
-	def load
-		secrets['environment']&.each do |key, value|
-			ENV[key] = value
+		private
+
+		def expand_path(path)
+			`echo #{path}`.chomp
 		end
 	end
 
@@ -31,18 +35,7 @@ class Secrets
 		"config/#{environment}/secrets.json"
 	end
 
-	def secrets
-		@secrets ||= JSON.parse(file_contents)
-	rescue JSON::ParserError => e
-		Output.error("Error parsing secrets data: #{e}")
-		{}
-	end
-
 	def file_contents
-		@filename.match(/\.ejson$/) ? `ejson decrypt #{@filename}` : File.open(@filename).read
-	end
-
-	def environment
-		ENV['environment']
+		@file_contents ||= @filename.match(/\.ejson$/) ? `ejson decrypt #{@filename}` : super
 	end
 end

data/ops_team.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
 	s.name = 'ops_team'
-	s.version = '0.2.1'
+	s.version = '0.2.6'
 	s.authors = [
 		'nickthecook@gmail.com'
 	]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ops_team
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 platform: ruby
 authors:
 - nickthecook@gmail.com
@@ -59,15 +59,19 @@ 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/exec.rb
+- lib/builtins/help.rb
 - lib/builtins/helpers/dependency_handler.rb
 - lib/builtins/init.rb
 - lib/builtins/up.rb
@@ -80,7 +84,6 @@ files:
 - lib/dependencies/dir.rb
 - lib/dependencies/docker.rb
 - lib/dependencies/gem.rb
-- lib/dependencies/terraform.rb
 - lib/dependency.rb
 - lib/environment.rb
 - lib/ops.rb

data/lib/dependencies/terraform.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'dependency'
-
-module Dependencies
-	class Terraform < Dependency
-		def met?
-			false
-		end
-
-		def always_act?
-			true
-		end
-
-		def meet
-			execute("cd #{name} && terraform init && terraform apply -input=false --auto-approve")
-		end
-
-		def unmeet
-			execute("cd #{name} && terraform destroy -input=false --auto-approve")
-		end
-	end
-end