panamax_template_validator 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03c5deb9ecb1660cb51a5277d75ff09f57f06dfb
+  data.tar.gz: 37919827546114e7b6f80091e3a9c9da6a7e43df
+SHA512:
+  metadata.gz: 055212f2c01f845e555800388475e0c33dcae747d9462ce715c368918962be4da75f3b29a224d22e2d6e12c822b89897b524404c0b9f24f4e5c644e7104683c5
+  data.tar.gz: a8534cb070f9f42275ea836ee48fff181f7147a931d8ddb7802cfb5d7f1fe9bc707b04450791f78d0b284b8894e7507537d5780745d0fde1e8969ecdc1b9cd9b

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in panamax_template_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex
+
+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,60 @@
+# Panamax: Docker Management for Humans
+
+[Panamax](http://panamax.io) is a containerized app creator with an open-source app marketplace hosted in GitHub. Panamax provides a friendly interface for users of Docker, Fleet & CoreOS. With Panamax, you can easily create, share, and deploy any containerized app no matter how complex it might be. Learn more at [Panamax.io](http://panamax.io) or browse the [Panamax Wiki](https://github.com/CenturyLinkLabs/panamax-ui/wiki).
+
+
+# Panamax Template Validator
+
+Validator for panamax templates. Runs a quick sanity check against .pmx files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'panamax_template_validator', git: 'https://github.com/CenturyLinkLabs/panamax-template-validator.git'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install panamax_template_validator
+
+## Usage
+
+##### validate a single file:
+```
+PanamaxTemplateValidator.validate('/path/to/your_template.pmx')
+```
+
+##### validate a collection of files:
+```
+PanamaxTemplateValidator.validate_file_list(['/path/to/your_template.pmx', '/path/to/another_template.pmx'])
+```
+
+##### validate all *.pmx files in the current working directory:
+
+```
+PanamaxTemplateValidator.validate_repo
+```
+
+##### we generally create a default rake task in our template repos that our CI solution will execute, for example:
+
+``` 
+# Rakefile
+require 'rake'
+require 'panamax_template_validator'
+
+task :default do
+  PanamaxTemplateValidator.validate_repo
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/panamax_template_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 a new Pull Request

data/lib/panamax_template_validator.rb

@@ -0,0 +1,43 @@
+require 'panamax_template_validator/version'
+require 'panamax_template_validator/repo'
+require 'panamax_template_validator/template_file'
+require 'panamax_template_validator/template'
+require 'panamax_template_validator/image'
+require 'refinements/string_colorization'
+
+using StringColorization
+
+module PanamaxTemplateValidator
+  def self.validate(file)
+    template_file = TemplateFile.new(file)
+    template_file.validate
+
+    if template_file.errors.empty?
+      puts 'VALID!'.green
+      exit 0
+    else
+      exit 1
+    end
+  end
+
+  def self.validate_file_list(files)
+    errors = []
+
+    files.each do |file|
+      template_file = TemplateFile.new(file)
+      template_file.validate
+      errors += template_file.errors
+    end
+
+    if errors.empty?
+      puts 'THESE FILES ARE ALL VALID!'.green
+      exit 0
+    else
+      exit 1
+    end
+  end
+
+  def self.validate_repo
+    Repo.new.validate
+  end
+end

data/lib/panamax_template_validator/image.rb

@@ -0,0 +1,98 @@
+require 'net/http'
+
+module PanamaxTemplateValidator
+  class Image
+    attr_reader :errors
+
+    def initialize(image_attrs, image_names)
+      @image_attrs = image_attrs
+      @image_names = image_names
+      @errors = []
+    end
+
+    def validate
+      validate_presence_of('name')
+      validate_presence_of('source')
+      validate_source_exists_publicly
+      validate_presence_of_container_ports
+      validate_uniqueness_of_host_ports
+      validate_volumes_have_container_path
+      validate_presence_of_env_var
+      validate_presence_of_link_alias
+      validate_linked_service_exists
+    end
+
+    private
+
+    def validate_linked_service_exists
+      Array(@image_attrs['links']).each_with_index do |link, i|
+        unless @image_names.include? link['service']
+          @errors << "#{@image_attrs['name']}'s link ##{i + 1} is linked to a service (#{link['service']}) that does not exist in this template"
+        end
+      end
+    end
+
+    def validate_presence_of_link_alias
+      Array(@image_attrs['links']).each_with_index do |link, i|
+        if link['alias'].to_s == ''
+          @errors << "#{@image_attrs['name']}'s link ##{i + 1} does not have an alias"
+        end
+      end
+    end
+
+    def validate_source_exists_publicly
+      source = @image_attrs['source'].split(':')[0]
+      res1 = Net::HTTP.get_response(URI("https://registry.hub.docker.com/u/#{source}/")).code
+      res2 = Net::HTTP.get_response(URI("https://registry.hub.docker.com/_/#{source}/")).code
+
+      unless [res1, res2].include?('200')
+        @errors << "#{@image_attrs['name']}'s source does not exist publicly in the docker index"
+      end
+    end
+
+    def validate_presence_of_env_var
+      Array(@image_attrs['environment']).each do |env|
+        if env['variable'].to_s == ''
+          @errors << 'each environment entry should have a variable (name)'
+        end
+      end
+    end
+
+    def validate_volumes_have_container_path
+      Array(@image_attrs['volumes']).each do |vol|
+        if vol['container_path'].to_s == ''
+          @errors << 'each volume must have a container path'
+        end
+      end
+    end
+
+    def validate_presence_of_container_ports
+      Array(@image_attrs['ports']).each do |port|
+        if port['container_port'].to_s == ''
+          @errors << 'each port must have a container port'
+        end
+      end
+    end
+
+    def validate_uniqueness_of_host_ports
+      host_ports = Array(@image_attrs['ports']).map { |p| p['host_port'] }.compact
+
+      if host_ports.length != host_ports.uniq.length
+        @errors << 'host ports must be unique'
+      end
+    end
+
+    def validate_presence_of(key)
+      if @image_attrs[key].nil? || @image_attrs[key] == ''
+        @errors << "image: #{@image_attrs['name']}'s #{key} is required"
+      end
+    end
+
+    def validate_length_of(key, inequality, length)
+      return unless @image_attrs[key]
+      unless @image_attrs[key].length.send(inequality, length)
+        @errors << "image: #{@image_attrs['name']}'s #{key} should #{inequality} #{length}"
+      end
+    end
+  end
+end

data/lib/panamax_template_validator/repo.rb

@@ -0,0 +1,28 @@
+require 'refinements/string_colorization'
+
+using StringColorization
+
+module PanamaxTemplateValidator
+  class Repo
+
+    def initialize
+      @errors = []
+    end
+
+    def validate
+      puts ' --- Validating .pmx files in working directory --- '
+      Dir.glob('*.pmx') do |file|
+        file = TemplateFile.new(file)
+        file.validate
+        @errors += file.errors
+      end
+
+      if @errors.empty?
+        puts 'THIS REPO IS VALID!'.green
+        exit 0
+      else
+        exit 1
+      end
+    end
+  end
+end

data/lib/panamax_template_validator/template.rb

@@ -0,0 +1,38 @@
+module PanamaxTemplateValidator
+  class Template
+    attr_reader :errors
+
+    def initialize(template_attrs)
+      @template_attrs = template_attrs
+      @errors = []
+    end
+
+    def validate
+      validate_presence_of('name')
+      validate_presence_of('description')
+      validate_presence_of('documentation')
+      validate_length_of('documentation', '>', 40)
+      image_names = @template_attrs['images'].map { |image| image['name'] }
+      @template_attrs['images'].each do |image_attrs|
+        image = Image.new(image_attrs, image_names)
+        image.validate
+        @errors += image.errors
+      end
+    end
+
+    private
+
+    def validate_presence_of(key)
+      if @template_attrs[key].nil? || @template_attrs[key] == ''
+        @errors << "template #{key} is required"
+      end
+    end
+
+    def validate_length_of(key, inequality, length)
+      return unless @template_attrs[key]
+      unless @template_attrs[key].length.send(inequality, length)
+        @errors << "template #{key} should #{inequality} #{length}"
+      end
+    end
+  end
+end

data/lib/panamax_template_validator/template_file.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+require 'refinements/string_colorization'
+
+using StringColorization
+
+module PanamaxTemplateValidator
+  class TemplateFile
+
+    attr_reader :errors
+
+    def initialize(file)
+      @file = file
+      @errors = []
+    end
+
+    def validate
+      if template = load_template(@file)
+        template_validator = Template.new(template)
+        template_validator.validate
+        errors = template_validator.errors
+        if errors.empty?
+          puts "#{@file} is valid".green
+        else
+          puts "#{@file} has the following errors:".red
+          puts errors.map { |x| x.red }
+          @errors += errors
+        end
+      else
+        no_exist = "#{@file} does not exist"
+        puts no_exist
+        @errors << no_exist
+      end
+    end
+
+    private
+
+    def load_template(path)
+      YAML.load_file(path)
+    rescue Errno::ENOENT
+      false
+    end
+  end
+end

data/lib/panamax_template_validator/version.rb

@@ -0,0 +1,3 @@
+module PanamaxTemplateValidator
+  VERSION = "0.0.2"
+end

data/lib/refinements/string_colorization.rb

@@ -0,0 +1,16 @@
+module StringColorization
+  refine String do
+    def colorize(color_code)
+      "\e[#{color_code}m#{self}\e[0m"
+    end
+
+    def red
+      colorize(31)
+    end
+
+    def green
+      colorize(32)
+    end
+  end
+end
+

data/panamax_template_validator.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'panamax_template_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "panamax_template_validator"
+  spec.version       = PanamaxTemplateValidator::VERSION
+  spec.authors       = ["Centurylink Labs"]
+  spec.email         = ["alex.welch@centurylink.com"]
+  spec.summary       = %q{Validates panamax template files}
+  spec.homepage      = "https://github.com/CenturyLinkLabs/panamax-template-validator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  # 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.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: panamax_template_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Centurylink Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: 
+email:
+- alex.welch@centurylink.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/panamax_template_validator.rb
+- lib/panamax_template_validator/image.rb
+- lib/panamax_template_validator/repo.rb
+- lib/panamax_template_validator/template.rb
+- lib/panamax_template_validator/template_file.rb
+- lib/panamax_template_validator/version.rb
+- lib/refinements/string_colorization.rb
+- panamax_template_validator.gemspec
+homepage: https://github.com/CenturyLinkLabs/panamax-template-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.2
+signing_key: 
+specification_version: 4
+summary: Validates panamax template files
+test_files: []