ops_team 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa5c498bf634206ab5ef4e53313731fb1ab8ee71456051d03f0b50d7b98f71ab
+  data.tar.gz: 6167a9ec3c12915fe62f3ccc3de1ce2a7f22351d32a7b2c10d8bb2b3c6da291d
+SHA512:
+  metadata.gz: 0273b1834ceb76c119328e45574ba27a924bb9ba50334661ad78ffebee8883f6efa0de75f8a97536d351103e36c64accd29ac1ae68892085828600b1c85de2fb
+  data.tar.gz: f021f9ea483736c3e13692d58f9284c105117fac4b1b873dd8918b9e5b123b4bd900c8b4735805a1b7f5f149c4ff8fb5c9a5f5efafb5e75644c1c3e9ebbf5001

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "colorize"
+gem "require_all"
+
+group :test do
+	gem "fuubar"
+	gem "rspec"
+end
+
+group :development do
+	gem "pry"
+	gem "pry-byebug"
+	gem "rerun"
+	gem "rubocop"
+end

data/bin/ops

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../loader"
+
+require 'ops'
+
+Ops.new(ARGV).run

data/bin/tag

@@ -0,0 +1,16 @@
+#!/bin/bash
+# tags a commit, asking for input when needed
+
+if [ -n "$1" ]; then
+	tag="$1"
+else
+	tag=$(grep -o "'[0-9.]*'" ops_team.gemspec | sed "s/'//g")
+	if [ -z "$tag" ]; then
+		read -p "Enter tag value: " tag
+	fi
+fi
+
+comment="Tagging $tag for release"
+echo "Tagging '$tag' with comment '$comment'..."
+git tag -a "$tag" -m "$comment"
+git push origin "$tag"

data/etc/ops.template.yml

@@ -0,0 +1,11 @@
+dependencies:
+  # e.g.
+  # brew:
+    # - docker-compose
+    # - docker
+    # - curl
+actions:
+  start:
+    command: docker-compose up -d
+  stop:
+    command: docker-compose down

data/etc/ruby.template.yml

@@ -0,0 +1,29 @@
+dependencies:
+  gem:
+    - bundler
+    - rerun
+  custom:
+    - bundle
+actions:
+  start:
+    command: echo update me
+  stop:
+    command: echo update me too
+  test:
+    command: rspec
+    alias: t
+  test-watch:
+    command: rerun -x ops test
+    alias: tw
+  lint:
+    command: bundle exec rubocop --safe-auto-correct
+    alias: l
+  build:
+    command: gem build *.gemspec
+    alias: b
+  install:
+    command: gem install `ls -t *.gem | head -n1`
+    alias: i
+  build-and-install:
+    command: ops build && ops install
+    alias: bi

data/etc/terraform.template.yml

@@ -0,0 +1,26 @@
+dependencies:
+  brew:
+    - terraform
+  apt:
+    - terraform
+  custom:
+    - terraform init
+actions:
+  apply:
+    command: terraform apply
+    alias: a
+  apply-auto-approve:
+    command: terraform apply --auto-approve
+    alias: aa
+  destroy:
+    command: terraform destroy
+    alias: d
+  destroy-auto-approve:
+    command: terraform destroy --auto-approve
+    alias: dd
+  plan:
+    command: terraform plan
+    alias: p
+  graph:
+    command: terraform graph
+    alias: g

data/lib/action.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# 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
+		@args = args
+	end
+
+	def run
+		Kernel.exec(to_s)
+	end
+
+	def to_s
+		"#{@command} #{@args.join(' ')}"
+	end
+end

data/lib/builtin.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Builtin
+	def initialize(args, config)
+		@args = args
+		@config = config
+	end
+
+	def run
+		raise NotImplementedError
+	end
+end

data/lib/builtins/down.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'require_all'
+require_rel "../dependencies"
+
+require 'builtin'
+require 'builtins/helpers/dependency_handler'
+
+module Builtins
+	class Down < Builtin
+		def run
+			# TODO: return a success/failure status to the caller
+			unmeet_dependencies
+		end
+
+		private
+
+		def dependency_handler
+			Helpers::DependencyHandler.new(@config["dependencies"])
+		end
+
+		def unmeet_dependencies
+			dependency_handler.dependencies.each do |dependency|
+				# don't even output anything for dependencies that shouldn't be considered on this machine
+				next unless dependency.should_meet?
+
+				Output.status("[#{dependency.type}] #{dependency.name}")
+
+				unmeet_dependency(dependency)
+			end
+		end
+
+		def unmeet_dependency(dependency)
+			# TODO: make this simpler, and factor in `should_meet?` above, too
+			dependency.unmeet if dependency.met? || dependency.always_act?
+
+			if dependency.success?
+				Output.okay
+			else
+				Output.failed
+				Output.error("Error unmeeting #{dependency.type} dependency '#{dependency.name}':")
+				puts(dependency.output)
+			end
+		end
+	end
+end

data/lib/builtins/env.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'builtin'
+require 'output'
+
+module Builtins
+	class Env < Builtin
+		def run
+			Output.print(environment)
+		end
+
+		private
+
+		def environment
+			ENV['environment'] || 'dev'
+		end
+	end
+end

data/lib/builtins/helpers/dependency_handler.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'builtin'
+require 'output'
+
+require 'require_all'
+require_rel "../../dependencies"
+
+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
+			end
+
+			def dependencies_for(type, names)
+				dependency_class = Dependencies.const_get(type.capitalize.to_sym)
+
+				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/init.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+require 'builtin'
+require 'output'
+
+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"
+
+		def run
+			if File.exist?(OPS_YML)
+				Output.error("File '#{OPS_YML} exists; not initializing.")
+			else
+				Output.out("Creating '#{OPS_YML} from template...")
+				FileUtils.cp(template_path, OPS_YML)
+			end
+		rescue SystemCallError
+			Output.error(template_not_found_message)
+			exit 1
+		end
+
+		private
+
+		def template_name_arg
+			@args[0]
+		end
+
+		def template_path
+			format(OPS_YML_TEMPLATE, template_name: template_name_arg || 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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'require_all'
+require_rel "../dependencies"
+
+require 'builtin'
+require 'builtins/helpers/dependency_handler'
+require 'output'
+
+module Builtins
+	class Up < Builtin
+		def run
+			# TODO: return a success/failure status to the caller
+			meet_dependencies
+		end
+
+		private
+
+		def dependency_handler
+			Helpers::DependencyHandler.new(@config["dependencies"])
+		end
+
+		def meet_dependencies
+			dependency_handler.dependencies.each do |dependency|
+				# don't even output anything for dependencies that shouldn't be considered on this machine
+				next unless dependency.should_meet?
+
+				Output.status("[#{dependency.type}] #{dependency.name}")
+
+				meet_dependency(dependency)
+			end
+		end
+
+		def meet_dependency(dependency)
+			# TODO: make this simpler, and factor in `should_meet?` above, too
+			dependency.meet if !dependency.met? || dependency.always_act?
+
+			if dependency.success?
+				Output.okay
+			else
+				Output.failed
+				Output.error("Error meeting #{dependency.type} dependency '#{dependency.name}':")
+				puts(dependency.output)
+			end
+		end
+	end
+end

data/lib/dependencies/apk.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'English'
+
+require 'dependency'
+
+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?
+			system("which apk")
+		end
+	end
+end

data/lib/dependencies/apt.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'dependency'
+
+module Dependencies
+	class Apt < Dependency
+		def met?
+			execute("dpkg-query --show --showformat '${db:Status-Status}\n' #{name} | grep -q ^installed")
+		end
+
+		def meet
+			execute("apt-get install -y #{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"
+		end
+	end
+end

data/lib/dependencies/brew.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'dependency'
+
+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

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

data/lib/dependencies/custom.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'dependency'
+
+module Dependencies
+	class Custom < Dependency
+		def met?
+			# we always want to try to meet this dependency
+			false
+		end
+
+		def meet
+			# this dependency is just a custom, idempotent command
+			execute(name)
+		end
+
+		def unmeet
+			true
+		end
+	end
+end

data/lib/dependencies/docker.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'dependency'
+
+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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'dependency'
+require 'options'
+
+module Dependencies
+	class Gem < Dependency
+		def met?
+			execute("gem list -i '^#{name}$'")
+		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}")
+			else
+				execute("gem install #{name}")
+			end
+		end
+
+		def unmeet
+			# do nothing; we don't want to uninstall packages and reinstall them every time
+			true
+		end
+	end
+end

data/lib/dependencies/terraform.rb

@@ -0,0 +1,23 @@
+# 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

data/lib/dependency.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'English'
+
+require 'output'
+
+class Dependency
+	DESCRIPTION_TYPE_WIDTH = 8
+
+	attr_reader :name, :output, :exit_code
+
+	def initialize(name)
+		@name = name
+	end
+
+	def met?
+		raise NotImplementedError
+	end
+
+	def meet
+		raise NotImplementedError
+	end
+
+	def unmeet
+		raise NotImplementedError
+	end
+
+	# should_meet? can be used to implement dependencies that should only be met on some platforms,
+	# e.g. brew on Macs and apt on Linux
+	# it can be used to base a decision on anything else that can be read from the environment at
+	# runtime
+	def should_meet?
+		true
+	end
+
+	# if true, this type of resource must always have `meet` and `unmeet` called;
+	# useful for resources that can't easily be checked to see if they're met
+	def always_act?
+		false
+	end
+
+	def type
+		self.class.name.split('::').last
+	end
+
+	def success?
+		@exit_code.nil? ? true : @exit_code.zero?
+	end
+
+	private
+
+	def execute(cmd)
+		@output, status = Open3.capture2e(cmd)
+		@exit_code = status.exitstatus
+
+		success?
+	end
+end

data/lib/ops.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'yaml'
+require 'require_all'
+
+require 'action'
+require 'output'
+require 'options'
+require_rel "builtins"
+
+# executes commands defined in local `ops.yml`
+class Ops
+	class UnknownActionError < StandardError; end
+
+	CONFIG_FILE = "ops.yml"
+
+	INVALID_SYNTAX_EXIT_CODE = 1
+
+	def initialize(argv)
+		@action_name = argv[0]
+		@args = argv[1..-1]
+
+		Options.set(config["options"] || {})
+	end
+
+	def run
+		exit(INVALID_SYNTAX_EXIT_CODE) unless syntax_valid?
+
+		return builtin.run if builtin
+
+		Output.warn("Running '#{action}' from #{CONFIG_FILE}...")
+		action.run
+	rescue UnknownActionError => e
+		Output.error("Error: #{e}")
+	end
+
+	private
+
+	def syntax_valid?
+		if @action_name.nil?
+			# TODO: output to stderr
+			puts "Usage: ops <action>"
+			false
+		else
+			true
+		end
+	end
+
+	def builtin
+		@builtin ||= Builtins.const_get(builtin_class_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
+		@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]
+
+			raise UnknownActionError, "Unknown action: #{@action_name}"
+		end
+	end
+
+	def actions
+		config["actions"]
+	end
+
+	def config
+		@config ||= begin
+			Output.warn("File '#{CONFIG_FILE}' does not exist.") unless File.exist?(CONFIG_FILE)
+			YAML.load_file(CONFIG_FILE)
+		rescue StandardError
+			{}
+		end
+	end
+
+	def aliases
+		@aliases ||= begin
+			actions.each_with_object({}) do |(_name, body), alias_hash|
+				alias_hash[body["alias"]] = body if body.include?("alias")
+			end
+		end
+	end
+end
+
+Ops.new(ARGV).run if $PROGRAM_NAME == __FILE__

data/lib/options.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Options
+	class << self
+		def get(path)
+			@options.dig(*path.split('.'))
+		end
+
+		def set(options)
+			@options = options
+		end
+	end
+end

data/lib/output.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+class Output
+	@out = STDOUT
+	@err = STDERR
+
+	STATUS_WIDTH = "50"
+
+	OKAY = "OK"
+	SKIPPED = "SKIPPED"
+	FAILED = "FAILED"
+
+	# used to silence output, e.g. in testing
+	class DummyOutput
+		def print(*_); end
+
+		def puts(*_); end
+	end
+
+	class << self
+		def status(name)
+			@out.print(format("%-#{STATUS_WIDTH}<name>s ", name: name))
+		end
+
+		def okay
+			@out.puts(OKAY.green)
+		end
+
+		def skipped
+			@out.puts(SKIPPED.yellow)
+		end
+
+		def failed
+			@out.puts(FAILED.red)
+		end
+
+		def warn(msg)
+			@err.puts(msg.yellow)
+		end
+
+		def error(msg)
+			@err.puts(msg.red)
+		end
+
+		def out(msg)
+			@out.puts(msg)
+		end
+
+		def print(msg)
+			@out.print(msg)
+		end
+
+		def silence
+			@out = @err = dummy_output
+		end
+
+		def dummy_output
+			@dummy_output ||= DummyOutput.new
+		end
+	end
+end

data/loader.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# for convenience, add "lib" to the load path
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/lib"))

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: ops_team
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- nickthecook@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+description: 
+email: 
+executables:
+- ops
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- bin/ops
+- bin/tag
+- etc/ops.template.yml
+- etc/ruby.template.yml
+- etc/terraform.template.yml
+- lib/action.rb
+- lib/builtin.rb
+- lib/builtins/down.rb
+- lib/builtins/env.rb
+- lib/builtins/helpers/dependency_handler.rb
+- lib/builtins/init.rb
+- lib/builtins/up.rb
+- lib/dependencies/apk.rb
+- lib/dependencies/apt.rb
+- lib/dependencies/brew.rb
+- lib/dependencies/cask.rb
+- lib/dependencies/custom.rb
+- lib/dependencies/docker.rb
+- lib/dependencies/gem.rb
+- lib/dependencies/terraform.rb
+- lib/dependency.rb
+- lib/ops.rb
+- lib/options.rb
+- lib/output.rb
+- loader.rb
+homepage: 
+licenses:
+- GPL-3.0-only
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: ops_team handles basic operations tasks for your project, driven by YAML
+  config
+test_files: []