puppet-validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27540dfa278a0cc463d85b7ed95420957b9f061f
+  data.tar.gz: 5d0c51971ca899cbddef2b63164722f18a0c8d68
+SHA512:
+  metadata.gz: dfc4006d55991a8d84d381ef4be02a95e5df9e12164699509ed70e79b07cd68ccfbc5fa8059495748977d0ee5809c701ee435f6358a27f85f2744b04ec9a83f0
+  data.tar.gz: 753d447bf1e0cbcfc967da5fad07eecd85b2f3004eb37e58b230d8a0fa9fefca6c23f127532a85d22193eb38a0ef8f789aa5e34501af6cfab74534c7a3fce459

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2015 Puppet Labs, eduteam@puppetlabs.com
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,149 @@
+# Puppet Validator:
+## Puppet Code Validation as a service
+
+Puppet Validator is a simple web service that accepts arbitrary code submissions and
+validates it the way `puppet parser validate` would. It can optionally also
+run `puppet-lint` checks on the code and display both results together.
+
+Puppet Validator is completely themeable, albeit rather primitively.
+
+### Usage:
+
+#### Running the service directly
+
+    puppet-validator [-p <port>] [-l [logfile]] [-t <themedir>] [-d]
+     ↳ Runs the Puppet Validator code validation service.
+
+This is the simplest way to run Puppet Validator. It has no external dependencies, other
+than the handful of gems it uses. This command will start the service. It will
+not daemonize itself, though a `systemd` init script is provided that will take
+care of that for you. It will default to running on port 9000, and will serve
+content directly out of its installation directory. You can override and customize
+the web content by passing the `-t` or `--theme` command-line argument. See
+[Creating your own theme](#creating-your-own-theme) below.
+
+Options:
+
+    -d, --debug                      Display or log debugging messages
+    -l, --logfile [LOGFILE]          Path to logfile. Defaults to no logging, or
+                                        /var/log/puppet-validator if no filename is passed.
+    -p, --port PORT                  Port to listen on. Defaults to 9000.
+    -t, --theme THEMEDIR             Path to the theme directory.
+
+    -h, --help                       Displays this help
+
+#### Integrating with Middleware
+
+If you plan to run this as a public service, then you may want to run it under
+middleware, such as Phusion Passenger, for performance and scalability. The
+specific implementation will depend on your choice of webserver and middleware.
+
+To configure Puppet Validator on Apache and Passenger, you'll need to
+<a href="https://www.phusionpassenger.com/library/install/apache/install/oss/el7/">
+install and configure the appropriate packages</a>. Then you'll need to configure
+a virtual host to contain the application.
+
+``` Apache
+# /etc/httpd/conf.d/puppet-validator.conf
+Listen 9090
+<VirtualHost *:9090>
+    ServerName 54.201.129.11
+    DocumentRoot /etc/puppet-validator/public
+    <Directory /etc/puppet-validator/public>
+        Require all granted
+        Allow from all
+        Options -MultiViews
+    </Directory>
+</VirtualHost>
+```
+
+The `DocumentRoot` and `Directory` directives can point directly to the `public`
+directory *within the gem installation directory*, or it can point to the `public`
+directory of a custom theme you've created. See
+[Creating your own theme](#creating-your-own-theme) below. The two directives
+should point to the same directory.
+
+In the directory directly above the `public` directory referenced above, you
+should have a `config.ru` file. This file will actually bootstrap and start the
+application. An example file exists in the root of the gem installation directory.
+It looks similar to the file below and may be customized to pass in any options
+you'd like.
+
+``` Ruby
+# /etc/puppet-validator/config.ru
+require 'rubygems'
+require 'puppet-validator'
+
+logger       = Logger.new('/var/log/puppet-validator')
+logger.level = Logger::WARN
+
+PuppetValidator.set :root, File.dirname(__FILE__)
+PuppetValidator.set :logger, logger
+
+run PuppetValidator
+```
+
+#### Creating your own theme
+
+Creating a Puppet Validator theme is as simple as copying the content files to a directory
+and customizing them. The `init` subcommand will do this for you. Note that the
+command *will overwrite* existing files, but it will warn you before it does so.
+
+    root@master:~ # mkdir /etc/puppet-validator
+    root@master:~ # cd /etc/puppet-validator/
+    root@master:/etc/puppet-validator # puppet-validator init
+    Initializing directory as new Puppet Validator theme...
+    root@master:/etc/puppet-validator # tree
+    .
+    ├── LICENSE
+    ├── README.md
+    ├── config.ru
+    ├── public
+    │   ├── info.png
+    │   ├── prism-default.css
+    │   ├── prism.js
+    │   ├── styles.css
+    │   └── testing.html
+    └── views
+        ├── index.erb
+        └── result.erb
+
+Once you've created your theme, you can start the Puppet Validator service using the `-t`
+or `--theme` command line arguments to tell Puppet Validator where to find your content.
+
+    root@master:~ # puppet-validator -t /etc/puppet-validator/
+
+Alternatively, you can edit your webserver virtual host configuration to point
+to the *public* directory within your new theme, as in the example shown above.
+
+#### Disabling `puppet-lint` checks
+
+Puppet-lint is an incredibly valuable tool. That said, some of the checks it runs
+may not apply to your environment. It's easy to disable these checks, either on
+the command-line, or in the `config.ru` file. By default, Puppet Validator will just run
+all available checks.
+
+Checks can be disabled either as a comma-separated list of checks:
+
+    root@master:~ # puppet-validator --disable 80chars,double_quoted_strings
+
+Or in a file with one check per line.
+
+    root@master:~ # puppet-validator --disable /etc/puppet-validator/disabled_checks
+    root@master:~ # cat /etc/puppet-validator/disabled_checks
+    80chars
+    double_quoted_strings
+
+This can also be done in your `config.ru`. Specifying a list would look like this:
+
+``` Ruby
+PuppetValidator.set :disabled_lint_checks, ['80chars', 'double_quoted_strings']
+
+```
+
+And loading the disabled checks from a file would look like:
+
+``` Ruby
+PuppetValidator.set :disabled_lint_checks, '/etc/puppet-validator/disabled_checks'
+
+```

data/bin/puppet-validator

@@ -0,0 +1,78 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'puppet-validator'
+
+gemroot = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+options = {
+  :port           => 9000,
+  :host           => '0.0.0.0',
+  :bind           => '0.0.0.0',
+  :root           => gemroot,
+}
+logfile  = $stderr
+loglevel = Logger::WARN
+
+optparse = OptionParser.new { |opts|
+    opts.banner = "Usage : puppet-validator [-p <port>] [-l [logfile]] [-t <themedir>] [-d]
+         ↳ Runs the Puppet Validator code validation service.
+
+        puppet-validator init
+         ↳ Copies the files needed to create a puppet-validator theme into $CWD.
+           This will overwrite existing files.
+
+"
+
+    opts.on("-d", "--debug", "Display or log debugging messages") do
+        loglevel = Logger::DEBUG
+    end
+
+    opts.on("--disable DISABLED_CHECKS", "Lint checks to disable. Either comma-separated list or filename.") do |arg|
+        puts "Disabling #{arg}"
+        options[:disabled_lint_checks] = arg
+    end
+
+    opts.on("-l [LOGFILE]", "--logfile [LOGFILE]", "Path to logfile. Defaults to no logging, or /var/log/puppet-validator if no filename is passed.") do |arg|
+        logfile = arg || '/var/log/puppet-validator'
+    end
+
+    opts.on("-p PORT", "--port", "Port to listen on. Defaults to 9000.") do |arg|
+        options[:port] = arg
+    end
+
+    opts.on("-t THEMEDIR", "--theme THEMEDIR", "Path to the theme directory.") do |arg|
+        options[:root] = arg
+    end
+
+    opts.separator('')
+
+    opts.on("-h", "--help", "Displays this help") do
+        puts
+        puts opts
+        puts
+        exit
+    end
+}
+optparse.parse!
+
+if ARGV.first == 'init'
+  puts 'Initializing directory as new puppet-validator theme...'
+  unless (Dir.glob '**/*').empty?
+    puts '-- Overwriting existing files. Press Ctrl-C to cancel or <Enter> to continue.'
+    STDIN.gets
+  end
+
+  FileUtils.cp   "#{gemroot}/config.ru", '.'
+  FileUtils.cp   "#{gemroot}/LICENSE", '.'
+  FileUtils.cp   "#{gemroot}/README.md", '.'
+  FileUtils.cp_r "#{gemroot}/public", '.'
+  FileUtils.cp_r "#{gemroot}/views", '.'
+
+else
+  logger           = Logger.new(logfile)
+  logger.level     = loglevel
+  options[:logger] = logger
+
+  PuppetValidator.run! options
+end

data/config.ru

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'puppet-validator'
+
+logger       = Logger.new('/var/log/puppet-validator')
+logger.level = Logger::WARN
+
+PuppetValidator.set :root, File.dirname(__FILE__)
+PuppetValidator.set :logger, logger
+PuppetValidator.set :disabled_lint_checks, ['80chars']
+
+run PuppetValidator

data/lib/puppet-validator.rb

@@ -0,0 +1,132 @@
+require 'logger'
+require 'sinatra/base'
+require 'puppet'
+require 'puppet/parser'
+require 'puppet-lint'
+
+# something like 3,000 lines of code
+MAXSIZE = 100000
+CONTEXT = 3
+
+class PuppetValidator < Sinatra::Base
+  set :logging, true
+  set :strict, true
+
+  before {
+    env["rack.logger"] = settings.logger if settings.logger
+  }
+
+  def initialize(app=nil)
+    super(app)
+
+    # there must be a better way
+    if settings.respond_to? :disabled_lint_checks
+
+      # can pass in an array, a filename, or a list of checks
+      if settings.disabled_lint_checks.class == String
+        path = File.expand_path(settings.disabled_lint_checks)
+        if File.file? path
+          data = File.readlines(path).map {|line| line.chomp }
+          data.reject! {|line| line.empty? or line.start_with? '#' }
+
+          settings.disabled_lint_checks = data
+        else
+          settings.disabled_lint_checks = settings.disabled_lint_checks.split(',')
+        end
+      end
+
+    else
+      # this seems... gross, but I don't know a better way to make sure this
+      # option exists whether it was passed in or not.
+      def settings.disabled_lint_checks
+        []
+      end
+    end
+
+  end
+
+  get '/' do
+    erb :index
+  end
+
+  post '/validate' do
+    logger.info "Validating code from #{request.ip}."
+    logger.debug "validating #{request.ip}: #{params['code']}"
+
+    if request.body.size <= MAXSIZE
+      result = validate params['code']
+      lint   = lint params['code'] if params['lint'] == 'on'
+      lint ||= {} # but make sure we have a data object to iterate
+
+      @code          = params['code']
+      @message       = result[:message]
+      @status        = result[:status] ? :success : :fail
+      @line          = result[:line]
+      @column        = result[:pos]
+      @lint_warnings = ! lint.empty?
+
+      # initial highlighting for the potential syntax error
+      if @line
+        start   = [@line - CONTEXT, 1].max
+        initial = {"#{start}-#{@line}" => nil}
+      else
+        initial = {}
+      end
+
+      # then add all the lint warnings and tooltip
+      @highlights = lint.inject(initial) do |acc, item|
+        acc.merge({item[:line] => "#{item[:kind].upcase}: #{item[:message]}"})
+      end.to_json
+
+    else
+      @message = "Submitted code size is #{request.body.size}, which is larger than the maximum size of #{MAXSIZE}."
+      @status  = :fail
+      logger.error @message
+    end
+
+    erb :result
+  end
+
+  not_found do
+    halt 404, "You shall not pass! (page not found)\n"
+  end
+
+  helpers do
+
+    def validate(data)
+      begin
+        Puppet[:code] = data
+        validation_environment = Puppet.lookup(:current_environment)
+
+        validation_environment.check_for_reparse
+        validation_environment.known_resource_types.clear
+
+        {:status => true, :message => 'Syntax OK'}
+      rescue => detail
+        logger.warn detail.message
+        err = {:status => false, :message => detail.message}
+        err[:line] = detail.line if detail.methods.include? :line
+        err[:pos]  = detail.pos  if detail.methods.include? :pos
+        err
+      end
+    end
+
+    def lint(data)
+      begin
+        settings.disabled_lint_checks.each do |check|
+          PuppetLint.configuration.send("disable_#{check}")
+        end
+
+        linter = PuppetLint.new
+        linter.code = data
+        linter.run
+        linter.print_problems
+      rescue => detail
+        logger.warn detail.message
+        nil
+      end
+    end
+
+
+  end
+end

data/public/prism-default.css

@@ -0,0 +1,227 @@
+/* http://prismjs.com/download.html?themes=prism&languages=puppet&plugins=line-highlight+line-numbers */
+/**
+ * prism.js default theme for JavaScript, CSS and HTML
+ * Based on dabblet (http://dabblet.com)
+ * @author Lea Verou
+ */
+
+code[class*="language-"],
+pre[class*="language-"] {
+	color: black;
+	background: none;
+	text-shadow: 0 1px white;
+	font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
+	direction: ltr;
+	text-align: left;
+	white-space: pre;
+	word-spacing: normal;
+	word-break: normal;
+	word-wrap: normal;
+	line-height: 1.5;
+
+	-moz-tab-size: 4;
+	-o-tab-size: 4;
+	tab-size: 4;
+
+	-webkit-hyphens: none;
+	-moz-hyphens: none;
+	-ms-hyphens: none;
+	hyphens: none;
+}
+
+pre[class*="language-"]::-moz-selection, pre[class*="language-"] ::-moz-selection,
+code[class*="language-"]::-moz-selection, code[class*="language-"] ::-moz-selection {
+	text-shadow: none;
+	background: #b3d4fc;
+}
+
+pre[class*="language-"]::selection, pre[class*="language-"] ::selection,
+code[class*="language-"]::selection, code[class*="language-"] ::selection {
+	text-shadow: none;
+	background: #b3d4fc;
+}
+
+@media print {
+	code[class*="language-"],
+	pre[class*="language-"] {
+		text-shadow: none;
+	}
+}
+
+/* Code blocks */
+pre[class*="language-"] {
+	padding: 1em;
+	margin: .5em 0;
+	overflow: auto;
+}
+
+:not(pre) > code[class*="language-"],
+pre[class*="language-"] {
+	background: #f5f2f0;
+}
+
+/* Inline code */
+:not(pre) > code[class*="language-"] {
+	padding: .1em;
+	border-radius: .3em;
+	white-space: normal;
+}
+
+.token.comment,
+.token.prolog,
+.token.doctype,
+.token.cdata {
+	color: slategray;
+}
+
+.token.punctuation {
+	color: #999;
+}
+
+.namespace {
+	opacity: .7;
+}
+
+.token.property,
+.token.tag,
+.token.boolean,
+.token.number,
+.token.constant,
+.token.symbol,
+.token.deleted {
+	color: #905;
+}
+
+.token.selector,
+.token.attr-name,
+.token.string,
+.token.char,
+.token.builtin,
+.token.inserted {
+	color: #690;
+}
+
+.token.operator,
+.token.entity,
+.token.url,
+.language-css .token.string,
+.style .token.string {
+	color: #a67f59;
+	background: hsla(0, 0%, 100%, .5);
+}
+
+.token.atrule,
+.token.attr-value,
+.token.keyword {
+	color: #07a;
+}
+
+.token.function {
+	color: #DD4A68;
+}
+
+.token.regex,
+.token.important,
+.token.variable {
+	color: #e90;
+}
+
+.token.important,
+.token.bold {
+	font-weight: bold;
+}
+.token.italic {
+	font-style: italic;
+}
+
+.token.entity {
+	cursor: help;
+}
+
+pre[data-line] {
+	position: relative;
+	padding: 1em 0 1em 3em;
+}
+
+.line-highlight {
+	position: absolute;
+	left: 0;
+	right: 0;
+	padding: inherit 0;
+	margin-top: 1em; /* Same as .prism’s padding-top */
+
+	background: hsla(24, 20%, 50%,.08);
+	background: -moz-linear-gradient(left, hsla(24, 20%, 50%,.1) 70%, hsla(24, 20%, 50%,0));
+	background: -webkit-linear-gradient(left, hsla(24, 20%, 50%,.1) 70%, hsla(24, 20%, 50%,0));
+	background: -o-linear-gradient(left, hsla(24, 20%, 50%,.1) 70%, hsla(24, 20%, 50%,0));
+	background: linear-gradient(left, hsla(24, 20%, 50%,.1) 70%, hsla(24, 20%, 50%,0));
+	
+	pointer-events: none;
+	
+	line-height: inherit;
+	white-space: pre;
+}
+
+	.line-highlight:before,
+	.line-highlight[data-end]:after {
+		content: attr(data-start);
+		position: absolute;
+		top: .4em;
+		left: .6em;
+		min-width: 1em;
+		padding: 0 .5em;
+		background-color: hsla(24, 20%, 50%,.4);
+		color: hsl(24, 20%, 95%);
+		font: bold 65%/1.5 sans-serif;
+		text-align: center;
+		vertical-align: .3em;
+		border-radius: 999px;
+		text-shadow: none;
+		box-shadow: 0 1px white;
+	}
+	
+	.line-highlight[data-end]:after {
+		content: attr(data-end);
+		top: auto;
+		bottom: .4em;
+	}
+pre.line-numbers {
+	position: relative;
+	padding-left: 3.8em;
+	counter-reset: linenumber;
+}
+
+pre.line-numbers > code {
+	position: relative;
+}
+
+.line-numbers .line-numbers-rows {
+	position: absolute;
+	pointer-events: none;
+	top: 0;
+	font-size: 100%;
+	left: -3.8em;
+	width: 3em; /* works for line-numbers below 1000 lines */
+	letter-spacing: -1px;
+	border-right: 1px solid #999;
+
+	-webkit-user-select: none;
+	-moz-user-select: none;
+	-ms-user-select: none;
+	user-select: none;
+
+}
+
+	.line-numbers-rows > span {
+		pointer-events: none;
+		display: block;
+		counter-increment: linenumber;
+	}
+
+		.line-numbers-rows > span:before {
+			content: counter(linenumber);
+			color: #999;
+			display: block;
+			padding-right: 0.8em;
+			text-align: right;
+		}