viaduct-archfile 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63f065bff9e330794305661626db5882365e9de7
+  data.tar.gz: 2c74bd94f4ed158f077aac456a11fe8490525de6
+SHA512:
+  metadata.gz: 1298d266fd0fdff314433c978b2b9ac565a2170ef0e57a9ae1630f94036d92b02c3363b37f23ef77450af1a6643f7fec3827255f85945c8b11c34b61e7b01b78
+  data.tar.gz: 379a2bb11cd71be16aa6e245f90391aadd68a562d7bbc429ce81d2d04aa7d84cc48997a9f6e8adad4f9a091aaef82dd0adeefa6e58e48fb50671fd02d46cc98c

data/README.md

@@ -0,0 +1,27 @@
+# Viaduct Archfile Lint
+
+This library is here to help validate the contents of a Viaduct Archfile.
+
+## What is an Archfile?
+
+An Archfile is a system specification for an application. It belongs in the root of an application
+and Viaduct will use its contents to determine how it should be deployed when it is set up. They
+are only used for initial provisioning into the Viaduct system.
+
+A new Archfile for a running application can be downloaded at anytime.
+
+## What does an Archfile look like?
+
+An Archfile is a YAML document which contains a number of properties. The best place to determine
+what it looks like would be to refer to our examples.
+
+## How can I test the validity of an Archfile?
+
+To test that your Archfile is appropriate, you can install this library and follow the instructions 
+below. Our backend systems also use this library to validate Archfiles so if it passes here, it'll
+pass when you create your application.
+
+```
+$ gem install viaduct-archfile-lint
+$ vdt-archfile-check path/to/Archfile
+```

data/bin/vdt-archfile-check

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'viaduct/archfile'
+
+path = ARGV[0] || './Archfile'
+if File.exist?(path)
+  archfile = Viaduct::Archfile.new(File.read(path))
+  errors = archfile.validate
+  if errors.empty?
+    puts
+    puts "    \e[32mCongratulations. That Archfile looks excellent and should work well!\e[0m"
+    puts 
+    puts "    Just head over to \e[35mhttps://my.viaduct.io\e[0m to create your new application."
+    puts "    Don't forget to add your Archfile to your repository so we can find it."
+    puts
+  else
+    puts
+    puts "    \e[31mOh no. It seems there's a problem with your Archfile!\e[0m"
+    puts
+    errors.each do |field, value|
+      puts "    * #{field ? field + ' ' : nil}\e[33m#{value}\e[0m"
+    end
+    puts
+  end
+else
+  $stderr.puts "\e[31m!! Couldn't find Viaduct Archfile at #{path}\e[0m"
+  exit 1
+end

data/lib/viaduct/archfile.rb

@@ -0,0 +1,196 @@
+require 'yaml'
+
+module Viaduct
+  class Archfile
+    
+    APPLICATION_STACKS = ['ruby2.0']
+    SHARED_DATABASE_TYPES = ['mysql']
+    START_DETECTOR_MODULES = ['none', 'log_string', 'timer']
+    COMMAND_EVENTS = ['build', 'start', 'firstrun']
+    
+    PATH_REGEX = /\A[a-z0-9\_\-\/\.]+\z/
+    
+    
+    #
+    # Create a new Archfile object from raw yaml
+    #
+    def initialize(yaml)
+      @yaml = yaml
+    end
+
+    #
+    # Store errors
+    #
+    def errors
+      @errors ||= []
+    end
+    
+    #
+    # Store the current namespace we're working in
+    #
+    def namespace(hash, *ns)
+      @current_hash = hash
+      @current_namespace = ns
+    end
+    
+    # 
+    # Add an error
+    #
+    def add_error(key, message)
+      errors << [key.nil? ? nil : "#{@current_namespace.join('.')}.#{key}", message]
+    end
+    
+    #
+    # Validate that the object is valid, returning an array of errors
+    # or an empty array if there are no errors.
+    #
+    def validate
+      @errors = []
+      
+      #
+      # Load the YAML
+      #
+      begin
+        spec = YAML.load(@yaml)
+      rescue Psych::SyntaxError => e
+        errors << [nil, "YAML document could not be read (#{e.message})"]
+        return @errors
+      end
+      
+      #
+      # Check settings
+      #
+      namespace spec['settings'], 'settings'
+      ensure_boolean('sleep_inactive_web_processes')
+      ensure_boolean('serve_static_files')
+      ensure_matches(/\A[a-z0-9\_\-\/]+\z/, 'document_root')
+      
+      #
+      # Check that we have some processes to begin with
+      #
+      unless spec['processes'].is_a?(Array) && spec['processes'].length > 0
+        add_error nil, "You must have at least one process"
+      end
+      
+      #
+      # Check processes
+      #
+      if spec['processes'].is_a?(Array)
+        spec['processes'].each_with_index do |process, index|
+          namespace process, 'processes', index
+          ensure_string('command')
+          ensure_inclusion(APPLICATION_STACKS, 'stack')
+          ensure_integer('quantity')
+          ensure_matches(PATH_REGEX, 'name')
+          ensure_integer('kill_after') if process['kill_after']
+          if sm = process['start_monitor']
+            namespace sm, 'processes', index, 'start_monitor'
+            ensure_inclusion(START_DETECTOR_MODULES, 'module')
+            ensure_integer('timer') if sm['module'] == 'timer'
+            ensure_string('string') if sm['module'] == 'log_string'
+          end
+        end
+      end
+      
+      #
+      # Check shared databases
+      #
+      if spec['shared_databases'].is_a?(Array)
+        spec['shared_databases'].each_with_index do |db, index|
+          namespace db, 'shared_databases', index
+          ensure_inclusion(SHARED_DATABASE_TYPES, 'type')
+          ensure_string('label')
+        end
+      end
+      
+      #
+      # Check Environment Variables
+      #
+      if spec['environment_variables'].is_a?(Array)
+        spec['environment_variables'].each_with_index do |ev, index|
+          namespace ev, 'environment_variables', index
+          ensure_string('key', 'value')
+        end
+      end
+      
+      #
+      # Check persistent directories
+      #
+      if spec['persistent_directories'].is_a?(Array)
+        spec['persistent_directories'].each_with_index do |pd, index|
+          namespace pd, 'persistent_directories', index
+          ensure_matches(PATH_REGEX, 'path')
+        end
+      end
+      
+      #
+      # Check commands
+      #
+      if spec['commands'].is_a?(Array)
+        spec['commands'].each_with_index do |command, index|
+          namespace command, 'commands', index
+          ensure_inclusion APPLICATION_STACKS, 'stack'
+          ensure_inclusion COMMAND_EVENTS, 'event'
+          ensure_string 'command'
+          ensure_integer 'success_exit_code'
+        end
+      end
+      
+      #
+      # Check config files
+      #
+      if spec['config_files'].is_a?(Array)
+        spec['config_files'].each_with_index do |cf, index|
+          namespace cf, 'config_files', index
+          ensure_matches PATH_REGEX, 'path'
+          ensure_string 'content'
+        end
+      end
+      
+      errors
+    end
+    
+    private
+    
+    def value_for(item)
+      @current_hash[item]
+    end
+    
+    def ensure_boolean(*items)
+      items.each do |item|
+        value = value_for(item)
+        add_error item, "must be a boolean" unless value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      end
+    end
+    
+    def ensure_string(*items)
+      items.each do |item|
+        value = value_for(item)
+        add_error item, "must be a string" unless value.is_a?(String) && value.length > 0
+      end
+    end
+    
+    def ensure_matches(regex, *items)
+      items.each do |item|
+        value = value_for(item)
+        unless value.is_a?(String) && value =~ regex
+          add_error item, "must match #{regex.to_s}"
+        end
+      end
+    end
+    
+    def ensure_integer(*items)
+      items.each do |item|
+        value = value_for(item)
+        add_error item, "must be a number" unless value.is_a?(Fixnum)
+      end
+    end
+    
+    def ensure_inclusion(options, *items)
+      items.each do |item|
+        add_error item, "must be one of #{options}" unless options.include?(value_for(item))
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: viaduct-archfile
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies: []
+description: A validation tool for checking the validity of a Viaduct Archfile
+email:
+- adam@viaduct.io
+executables:
+- vdt-archfile-check
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/vdt-archfile-check
+- lib/viaduct/archfile.rb
+- README.md
+homepage: http://viaduct.io
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A validation tool for checking the validity of a Viaduct Archfile
+test_files: []
+has_rdoc: