dh-proteus 0.1.3

data/lib/proteus/generators/context.rb

@@ -0,0 +1,57 @@
+module Proteus
+  module Generators
+    module Context
+      def self.included(thor_class)
+        thor_class.class_eval do
+
+          desc "context CONTEXT", "Generate a new context"
+          def context(context)
+
+            if context !~ /^([a-z0-9])+(_{1}[a-z0-9]+)*$/
+              say "The name of your context has to be valid snake case. For example: 'foo_bar'", :red
+              exit 1
+            end
+
+            context_directory = File.join(context_path(context))
+            empty_directory(context_directory)
+            empty_directory(File.join(context_directory, 'environments'))
+            empty_directory(File.join(context_directory, 'modules'))
+
+            template_binding = Proteus::Templates::TemplateBinding.new(
+              context: context,
+              environment: nil,
+              module_name: nil
+            )
+
+            ['main', 'variables'].each do |template_name|
+              template(
+                "context/#{template_name}.tf.erb",
+                File.join(
+                  context_directory,
+                  "#{template_name}.tf"
+                ),
+                context: template_binding.get_binding
+              )
+            end
+
+            gitignore = File.join(destination_root, ".gitignore")
+
+            if File.file?(gitignore)
+              matches = File.readlines(gitignore).select do |line|
+                line.match(/\/contexts\/#{context}\/backend.tf/)
+              end
+            end
+
+            if !File.file?(gitignore) || matches.none?
+              File.open(gitignore, 'a') do |file|
+                file.puts "/contexts/#{context}/backend.tf"
+              end
+            end
+
+            say "Context #{context} created. Go ahead and create environments and modules.", :green
+          end
+        end
+      end
+    end
+  end
+end

data/lib/proteus/generators/environment.rb

@@ -0,0 +1,42 @@
+module Proteus
+  module Generators
+    module Environment
+      def self.included(thor_class)
+        thor_class.class_eval do
+
+          desc "environment ENVIRONMENT", "Generate configuration for a new environment / region"
+          option :context, type: :string, aliases: "-c", default: "default"
+          option :environment, type: :string, aliases: "-e", required: true
+          def environment
+
+            if options[:context] !~ /^([a-z0-9])+(_{1}[a-z0-9]+)*$/
+              say "The name of your context has to be valid snake case. For example: 'foo_bar'", :red
+              exit 1
+            end
+
+            if options[:environment] !~ /^([a-z0-9])+(_{1}[a-z0-9]+)*$/
+              say "The name of your environment has to be valid snake case. For example: 'foo_bar'", :red
+              exit 1
+            end
+
+            template_binding = Proteus::Templates::TemplateBinding.new(
+              environment: options[:environment],
+              context: options[:context],
+              module_name: nil
+            )
+
+            template(
+              'environment/terraform.tfvars.erb',
+              File.join(destination_root,
+              'contexts',
+              options[:context],
+              'environments',
+              "terraform.#{options[:environment]}.tfvars"),
+              context: template_binding.get_binding
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/proteus/generators/init.rb

@@ -0,0 +1,40 @@
+module Proteus
+  module Generators
+    module Init
+      def self.included(thor_class)
+        thor_class.class_eval do
+
+          desc 'init', 'Initializes a new proteus root directory in the current working directory'
+          def init
+
+            say 'Creating config directory.', :green
+            empty_directory(config_dir)
+
+            say 'Creating sample config.', :green
+            template(
+              'config/config.yaml.erb',
+              File.join(
+                config_dir,
+                'config.yaml'
+              )
+            )
+
+            say 'Creating contexts directory.', :green
+            empty_directory(contexts_path)
+
+            confirm(question: 'Do you want to create a default proteus context?', color: :green, exit_on_no: false) do
+              invoke 'proteus:generate:context', ['default']
+            end
+
+            confirm(question: 'Do you want to create a sample proteus environment?', color: :green, exit_on_no: false) do
+              invoke 'proteus:generate:environment', [], context: 'default', environment: 'staging'
+            end
+
+            say "proteus root directory created.", :green
+            say "Please customize config/config.yaml. Then go ahead and create some modules.", :green
+          end
+        end
+      end
+    end
+  end
+end

data/lib/proteus/generators/module.rb

@@ -0,0 +1,69 @@
+module Proteus
+  module Generators
+    module Module
+      def self.included(thor_class)
+        thor_class.class_eval do
+
+          desc "module", "Generate a new module"
+          option :context, type: :string, aliases: "-c", default: "default"
+          option :module_name, type: :string, aliases: "-m", required: true
+          def module
+
+            unless File.directory?(context_path(options[:context]))
+              say "The context #{options[:context]} does not exist.", :red
+            end
+
+            # check for valid module name
+            if options[:module_name] !~ /^([a-z0-9])+(_{1}[a-z0-9]+)*$/
+              say "The name of your module has to be valid snake case. For example: 'foo_bar'", :red
+              exit 1
+            end
+
+            template_binding = Proteus::Templates::TemplateBinding.new(
+              context: nil,
+              environment: nil,
+              module_name: options[:module_name],
+            )
+
+            module_directory = File.join(modules_path(options[:context]), options[:module_name])
+            empty_directory(module_directory)
+
+            template('module/io.tf.erb', File.join(module_directory, 'io.tf'), context: template_binding.get_binding)
+            template('module/module.tf.erb', File.join(module_directory, "#{options[:module_name]}.tf"), context: template_binding.get_binding)
+
+
+            confirm(question: "Will this module be included iteratively?", color: :green, exit_on_no: false) do
+
+              empty_directory(File.join(module_directory, 'config'))
+              empty_directory(File.join(module_directory, 'config', 'global_resources'))
+              empty_directory(File.join(module_directory, 'config', 'templates'))
+
+              confirm(question: "Do you want to implement validators for this module?", color: :green, exit_on_no: false) do
+              template_binding = Proteus::Templates::TemplateBinding.new(
+                context: nil,
+                environment: nil,
+                module_name: options[:module_name].split('_').collect(&:capitalize).join,
+              )
+                template('module/validator.rb.erb', File.join(module_directory, 'config', "validator.rb"), context: template_binding.get_binding)
+              end
+
+              say("Go ahead and create a configuration file for your environment in #{options[:module_name]}/config/your_environment.yaml", :green)
+
+              # add /contexts/context/module_name.tf to gitignore
+              gitignore = File.join(destination_root, ".gitignore")
+              matches = File.readlines(gitignore).select do |line|
+                line.match(/\/contexts\/#{options[:context]}\/#{options[:module_name]}/)
+              end
+
+              if matches.none?
+                File.open(gitignore, 'a') do |file|
+                  file.puts "/contexts/#{options[:context]}/#{options[:module_name]}.tf"
+                end
+              end
+            end
+          end # #module
+        end # class_eval
+      end # self.included
+    end # module Module
+  end # module Generators
+end

data/lib/proteus/generators/templates/config/config.yaml.erb

@@ -0,0 +1,22 @@
+providers:
+  - name: 'aws'
+    environments:
+      - match: 'production' # must match the name of one of your proteus environments
+        profile: 'your_aws_profile'
+      - match: 'staging'
+        profile: 'your_aws_staging_profile'
+
+slack_webhooks:
+  - match: 'production' # must match the name of one of your proteus environments
+    url: 'YOUR_PRODUCTION_SLACK_HOOK_URL'
+  - match: 'staging'
+    url: 'YOUR_STAGING_SLACK_HOOK_URL'
+
+
+backend:
+  key_prefix: 'your-prefix-' # prefix for state files in the backend
+  # NOTE: Create this bucket in your AWS account and enable versioning
+  bucket:
+    name: 'your_bucket_name'
+    region: 'eu-west-1'
+    profile: 'your_aws_profile'

data/lib/proteus/generators/templates/context/main.tf.erb

@@ -0,0 +1,7 @@
+# Main manifest for context <%= @context %>
+#
+provider "aws" {
+  profile = "${var.aws_profile}"
+  region  = "${var.region}"
+}
+

data/lib/proteus/generators/templates/context/variables.tf.erb

@@ -0,0 +1,3 @@
+variable "region" {}
+
+variable "aws_profile" {}

data/lib/proteus/generators/templates/environment/terraform.tfvars.erb

@@ -0,0 +1,6 @@
+# Context <%= @context %>
+
+# must not contain underscores
+environment = "<%= @environment.gsub('_', '-') %>"
+
+region = "eu-west-1"

data/lib/proteus/generators/templates/module/io.tf.erb

@@ -0,0 +1 @@
+# place your input and output variables in this file

data/lib/proteus/generators/templates/module/module.tf.erb

@@ -0,0 +1 @@
+# Main config file for module "<%= @module_name %>"

data/lib/proteus/generators/templates/module/validator.rb.erb

@@ -0,0 +1,9 @@
+module Proteus
+  module Validators
+    class <%= @module_name %>Validator < BaseValidator
+      def validate
+        # put your validations here
+      end
+    end
+  end
+end

data/lib/proteus/global_commands/validate.rb

@@ -0,0 +1,45 @@
+require 'proteus/modules/manager'
+require 'proteus/helpers'
+
+module Proteus
+  module GlobalCommands
+    module Validate
+
+      include Proteus::Helpers
+
+      def self.included(thor_class)
+        thor_class.class_eval do
+          desc "validate", "Renders templates for all contexts and environments"
+
+          long_desc <<-LONGDESC
+            Renders templates for all environments, reporting validation errors.
+          LONGDESC
+          def validate
+            self.class.contexts.each do |context|
+              context.environments.each do |environment|
+                module_manager = Proteus::Modules::Manager.new(context: context.name, environment: environment)
+                module_manager.render_modules
+
+                terraform = ENV.key?("TERRAFORM_BINARY") ? ENV["TERRAFORM_BINARY"] : "terraform"
+
+                validate_command = <<~VALIDATE_COMMAND
+                  cd #{context_path(context.name)} \
+                  && #{terraform} init -backend=false \
+                  && #{terraform} get \
+                  && #{terraform} validate -var-file=#{var_file(context.name, environment)} -var 'aws_profile=needs_to_be_set'
+                VALIDATE_COMMAND
+
+                `#{validate_command.squeeze(' ')}`
+
+                say "Validated (context: #{context.name}, environment: #{environment}) #{"\u2714".encode('utf-8')}", :green
+                exit 1 if $?.exitstatus == 1
+                module_manager.clean
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/proteus/helpers.rb

@@ -0,0 +1,91 @@
+require 'pty'
+require 'json'
+require 'net/http'
+require 'proteus/helpers/path_helpers'
+require 'date'
+require 'etc'
+
+module Proteus
+  module Helpers
+    include Proteus::Helpers::PathHelpers
+
+    ERROR = :red
+    DEFAULT = :green
+
+    def alert(message)
+      say "#{message}", :on_red
+    end
+
+    def limit(resources)
+      resources ? resources.inject("") {
+        |memo, resource| "#{memo} -target=#{resource}" } : ""
+    end
+
+    def confirm(question:, color:, exit_on_no: true, exit_code: 1)
+      if ask(question, color, limited_to: ["yes", "no"]) == "yes"
+        yield if block_given?
+      else
+        if exit_on_no
+          say "Exiting.", ERROR
+          exit exit_code
+        end
+      end
+    end
+
+    def current_user
+      Etc.getpwnam(Etc.getlogin).gecos
+    end
+
+    def slack_webhook
+      hook = config[:slack_webhooks].find do |h|
+        environment =~ /#{h[:match]}/
+      end
+
+      hook ? hook[:url] : nil
+    end
+
+    def slack_notification(context:, environment:, message:)
+      webhook_url = slack_webhook
+
+      if webhook_url
+        time = DateTime.now.strftime("%Y/%m/%d - %H:%M")
+        slack_payload = {
+          text: "[#{context} - #{environment} - #{time}] #{current_user} #{message}"
+        }.to_json
+
+        uri = URI(webhook_url)
+
+        request = Net::HTTP::Post.new(uri)
+        request.body = slack_payload
+
+        request_options = {
+          use_ssl: uri.scheme == "https",
+        }
+
+        Net::HTTP::start(uri.hostname, uri.port, request_options) do |http|
+          http.request(request)
+        end
+      end
+    end
+
+    def syscall(command, dryrun: false, capture: false, suppress: false)
+      say "Executing: #{command}\n\n", :green
+
+      output = ""
+
+      if not dryrun
+        begin
+          PTY.spawn(command) do |stdout, stdin, pid|
+            stdout.each do |line|
+              output << line
+              puts line unless suppress
+            end
+          end
+        rescue Errno::EIO # GNU/Linux raises EIO.
+          nil
+        end
+      end
+      return output
+    end
+  end
+end

data/lib/proteus/helpers/path_helpers.rb

@@ -0,0 +1,90 @@
+module Proteus
+  module Helpers
+    module PathHelpers
+      include Thor::Shell
+
+      def root_path
+        if ARGV.size == 1 && ARGV[0] == 'init'
+          return Dir.pwd
+        end
+
+        path = ENV['PROTEUS_ROOT'].present? ? ENV['PROTEUS_ROOT'] : Dir.pwd
+
+        unless File.directory?(File.join(path, 'contexts'))
+          say "Can't find a contexts directory in #{path}. Exiting.", :red
+          exit 1
+        end
+
+        unless File.directory?(File.join(path, 'config'))
+          say "Can't find a config directory in #{path}. Exiting.", :red
+          exit 1
+        end
+
+        File.expand_path(path)
+      end
+
+      def config_dir
+        File.join(root_path, 'config')
+      end
+
+      def config_path
+        File.join(config_dir, 'config.yaml')
+      end
+
+      def contexts_path
+        File.join(root_path, 'contexts')
+      end
+
+      def context_path(context)
+        File.join(contexts_path, context)
+      end
+
+      def context_temp_directory(context)
+        File.join(context_path(context), '.tmp')
+      end
+
+      alias_method :context_root_path, :context_path
+
+      def environments_path(context)
+        File.join(context_path(context), 'environments')
+      end
+
+      def var_file(context, environment)
+        File.join(environments_path(context), "terraform.#{environment}.tfvars")
+      end
+
+      def plan_file(context, environment)
+        File.join(context_temp_directory(context), "terraform.#{environment}.tfplan")
+      end
+
+      def state_file(context, environment)
+        File.join(context_root_path(context), '.terraform',  'terraform.tfstate')
+      end
+
+      def module_path(context, module_name)
+        File.join(modules_path(context), module_name)
+      end
+
+      def modules_path(context)
+        File.join(context_path(context), 'modules')
+      end
+
+
+      def module_config_path(context, module_name)
+        File.join(module_path(context, module_name), 'config')
+      end
+
+      def module_templates_path(context, module_name)
+        File.join(module_path(context, module_name), 'config', 'templates')
+      end
+
+      def module_io_file(context, module_name)
+        File.read(File.join(module_path(context, module_name), 'io.tf'))
+      end
+
+      def module_hooks_path(context, module_name)
+        File.join(module_config_path(context, module_name), 'hooks')
+      end
+    end
+  end
+end