heroku_formation_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8db25599dfeadbc6795f83b5aed596c79b409605
+  data.tar.gz: 82a4061b706961ca54aac6cbc99e49c181f6cb52
+SHA512:
+  metadata.gz: 715d92f138ff1f48a46da1a16b36a483dc74747eff5685fbdf435fce2b25d95599e0123747f649041fa26f34438a312efd6e88fd78b821c033ec505cebe1984b
+  data.tar.gz: 5183810cd82669c520bb10dbcbf4c63578e19e94eca32d5839bfb1a269373f0f90ce7d4f3874634ba7df0327f8a3bf192aa85361f992ca2d327626438a616cbe

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in heroku_formation_validator.gemspec
+gemspec
+
+gem "pry-byebug"
+gem "bundler"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tomo Nakano
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Heroku Formation Validator
+
+
+## Installation
+
+    $ gem install heroku_formation_validator
+
+## Usage
+
+### Create your formation.yml
+
+```
+auth:
+  user: <heroku email address>
+  token: <heroku token>
+
+common:
+  addons:
+    - "newrelic:stark"
+    - "redistogo:mini"
+    - "scheduler:standard"
+    - "sendgrid:bronze"
+  variables:
+    MONGO_DATABASE: "ABC"
+  papertrail: true
+
+groups:
+  api:
+    apps:
+      - <your app name on heroku>
+    variables:
+    - YOUR_VARIABLE: "ABC"
+```
+
+### Run it (Usually, in CI)
+
+```
+$ heroku_formation_validator formation.yml
+```
+
+- When no errors, you will get nothing with exit code 0
+- When errors, You will get errors with exit code 1
+
+## Contributing
+
+1. Fork it ( http://github.com/quipper/heroku_formation_validator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1,3 @@
+- more secure auth
+- better error message formater
+- tests..

data/bin/heroku_formation_validator

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'heroku_formation_validator'
+HerokuFormationValidator::Runner.execute(*ARGV)

data/formation.yml.sample

@@ -0,0 +1,20 @@
+auth:
+  user: <heroku email address>
+  token: <heroku token>
+
+common:
+  addons:
+    - "newrelic:stark"
+    - "redistogo:mini"
+    - "scheduler:standard"
+    - "sendgrid:bronze"
+  variables:
+    MONGO_DATABASE: "ABC"
+  papertrail: true
+
+groups:
+  api:
+    apps:
+      - <your app name on heroku>
+    variables:
+      - YOUR_VARIABLE: "ABC"

data/heroku_formation_validator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heroku_formation_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "heroku_formation_validator"
+  spec.version       = HerokuFormationValidator::VERSION
+  spec.authors       = ["Tomo Nakano"]
+  spec.email         = ["tomo@quipper.com"]
+  spec.summary       = %q{Heroku config/addons validator for multiple apps}
+  spec.description   = %q{Heroku config/addons validator for multiple apps. It checks addons / config varibales etc}
+  spec.homepage      = "https://github.com/quipper/heroku_formation_validator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1"
+
+  spec.add_dependency 'httparty', "~> 0.12"
+  spec.add_dependency 'activesupport', "~> 4"
+end

data/lib/heroku_formation_validator.rb

@@ -0,0 +1,45 @@
+require "heroku_formation_validator/version"
+require "heroku_formation_validator/heroku_api"
+require "heroku_formation_validator/runner"
+require "yaml"
+require "active_support/all"
+
+Dir[File.join(File.dirname(__FILE__), 'heroku_formation_validator', 'plugins', '*.rb')].each do |extension|
+  require extension
+end
+
+module HerokuFormationValidator
+  def self.run(config_file)
+    begin
+      cnf = YAML::load(File.open(config_file))
+    rescue Errno::ENOENT
+      $stderr.puts "File not found: #{config_file}"
+      return false
+    end
+    heroku_api = HerokuApi.new(cnf["auth"]["email"], cnf["auth"]["token"])
+
+    unless heroku_api.ping
+      $stderr.puts "Heroku API error. Heroku credential in config is not correct?"
+      return false
+    end
+
+    success = true
+    cnf["groups"].each do |group, validations|
+      apps = validations.delete("apps")
+      apps.each do |app|
+        errors = []
+        cnf["common"].merge(validations).each do |plugin, values|
+          plugin_klass = "HerokuFormationValidator::Plugins::#{plugin.camelize}".safe_constantize
+          errors += plugin_klass.run(heroku_api, app, values).map{|error| "#{plugin.camelize}: #{error}"}
+        end
+
+        if errors.length > 0
+          success = false
+          $stderr.puts "=== #{group} #{app} ==="
+          $stderr.puts errors.join("\n")
+        end
+      end
+    end
+    success
+  end
+end

data/lib/heroku_formation_validator/heroku_api.rb

@@ -0,0 +1,34 @@
+require "httparty"
+
+module HerokuFormationValidator
+  class HerokuApi
+    include HTTParty
+    base_uri 'https://api.heroku.com'
+    headers({"Accept" => "application/vnd.heroku+json; version=3"})
+    # debug_output $stderr
+
+    def initialize(email, token)
+      self.class.basic_auth email, token
+    end
+
+    def ping
+      apps.ok?
+    end
+
+    def apps
+      self.class.get("/apps")
+    end
+
+    def configvars(app_id_or_name)
+      self.class.get("/apps/#{app_id_or_name}/config-vars")
+    end
+
+    def addons(app_id_or_name)
+      self.class.get("/apps/#{app_id_or_name}/addons")
+    end
+
+    def logdrains(app_id_or_name)
+      self.class.get("/apps/#{app_id_or_name}/log-drains")
+    end
+  end
+end

data/lib/heroku_formation_validator/plugins/addons.rb

@@ -0,0 +1,16 @@
+module HerokuFormationValidator
+  module Plugins
+    class Addons
+      def self.run(heroku_api, app, values)
+        errors = []
+        addons = heroku_api.addons(app)
+        values.each do |expected_addon|
+          if !addons.detect{|addon| addon["plan"]["name"] == expected_addon}
+            errors << "\"#{expected_addon}\" is not installed"
+          end
+        end
+        errors
+      end
+    end
+  end
+end

data/lib/heroku_formation_validator/plugins/papertrail.rb

@@ -0,0 +1,14 @@
+module HerokuFormationValidator
+  module Plugins
+    class Papertrail
+      def self.run(heroku_api, app, values)
+        errors = []
+        drains = heroku_api.logdrains(app)
+        unless drains.detect{|drain| drain["url"] =~ /^syslog:\/\/logs.papertrailapp.com/}
+          errors << "not set in logdrains"
+        end
+        errors
+      end
+    end
+  end
+end

data/lib/heroku_formation_validator/plugins/variables.rb

@@ -0,0 +1,23 @@
+module HerokuFormationValidator
+  module Plugins
+    class Variables
+
+      def self.run(heroku_api, app, values)
+        errors = []
+        config = heroku_api.configvars(app)
+        values.each do |key, value|
+          if value.nil?
+            if config.has_key?(key)
+              errors << "\"#{key}\" is defined"
+            end
+          elsif !config.has_key?(key)
+            errors << "\"#{key}\" is not defined"
+          elsif config[key] != value
+            errors << "\"#{key}\" doesn't match. expected \"#{value}\" but \"#{config[key]}\""
+          end
+        end
+        errors
+      end
+    end
+  end
+end

data/lib/heroku_formation_validator/runner.rb

@@ -0,0 +1,29 @@
+module HerokuFormationValidator
+  class Runner
+    attr_reader :args
+
+    def initialize(*args)
+      @args = args
+      run
+    end
+
+    def self.execute(*args)
+      new(*args).execute
+    end
+
+    def run
+      if filename = @args[0]
+        exit HerokuFormationValidator.run(filename) ? 0 : 1
+      else
+        puts help_text
+        exit 1
+      end
+    end
+
+    def help_text
+      <<-help
+usage: heroku_formation_validator <config file name>
+help
+    end
+  end
+end

data/lib/heroku_formation_validator/version.rb

@@ -0,0 +1,3 @@
+module HerokuFormationValidator
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: heroku_formation_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomo Nakano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Heroku config/addons validator for multiple apps. It checks addons /
+  config varibales etc
+email:
+- tomo@quipper.com
+executables:
+- heroku_formation_validator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- bin/heroku_formation_validator
+- formation.yml.sample
+- heroku_formation_validator.gemspec
+- lib/heroku_formation_validator.rb
+- lib/heroku_formation_validator/heroku_api.rb
+- lib/heroku_formation_validator/plugins/addons.rb
+- lib/heroku_formation_validator/plugins/papertrail.rb
+- lib/heroku_formation_validator/plugins/variables.rb
+- lib/heroku_formation_validator/runner.rb
+- lib/heroku_formation_validator/version.rb
+homepage: https://github.com/quipper/heroku_formation_validator
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Heroku config/addons validator for multiple apps
+test_files: []