puppet-validator 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cea136416dcebfe0a0e26c4ff72b773fc7bcc95c
-  data.tar.gz: 13bfdd508f645c116b919e4aa0125b9d50fced0d
+  metadata.gz: 505eaa74e80d90d673367e5237c3dc6dee2f9b86
+  data.tar.gz: 3ee36dd07b1cc6019d596f0eab88a07b47fb0067
 SHA512:
-  metadata.gz: 4a47dc7f551f17777f58791061fec247d5dc88e36c354ed67c02d0e9c80d24ea5c8edc3204d5572290bba6f79a9fab121e8eda6186d07228f22a0c2e85802fc1
-  data.tar.gz: c6a53e3d6262d85dc4e29474b0696e4016ca7cf6077335c05d3dc9057f9ca221896a8350b45d63c0e96e0f1287d7e37c321a30b53f65d1e239569ac42d8db321
+  metadata.gz: 95dc142ef8c243b021dc156267da2820e24d2cdc2bf68d31c1f14c19f3dc5ce7b0e36bcb8449bc4a5b0205d2f6a4a0134183423dc6aade720a428943cb347ef9
+  data.tar.gz: e944ffdf8cb3d6d555b3c58ad0fd89973a7b32bef5f32577633c953fd5e72fc6ea17a5a754eb8e0502bc6f95cfd2c5bceea3e390d063d36ac56ab49904f6b5cc

data/README.md

@@ -16,11 +16,11 @@ Puppet Validator is completely themeable, albeit rather primitively.
 
 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.
+not daemonize itself, though a [`systemd` init script is provided](#running-standalone-with-systemd)
+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:
 
@@ -77,8 +77,10 @@ require 'puppet-validator'
 logger       = Logger.new('/var/log/puppet-validator')
 logger.level = Logger::WARN
 
+PuppetValidator.set :puppet_versions, Dir.glob('*').select {|f| File.symlink? f and File.readlink(f) == '.' }
 PuppetValidator.set :root, File.dirname(__FILE__)
 PuppetValidator.set :logger, logger
+PuppetValidator.set :disabled_lint_checks, ['80chars']
 
 run PuppetValidator
 ```
@@ -147,3 +149,113 @@ And loading the disabled checks from a file would look like:
 PuppetValidator.set :disabled_lint_checks, '/etc/puppet-validator/disabled_checks'
 
 ```
+
+#### Validating code against multiple Puppet versions
+
+It is not very straightforward to load multiple versions of a library gem in Ruby.
+This makes it virtually impossible to validate multiple versions of the language
+directly in the tool. However, Passenger has allowed you to load different Ruby
+versions in different `Location` blocks since version 4.0 by loading separate
+threads for each.
+
+We can take advantage of that by configuring multiple Ruby environments using `rvm`
+or `rbenv` and installing different gemsets. A simple Puppet module to do this
+is included in the repository, with the caveat that it was designed to fully own
+a single-purpose VM and has so far only been tested on CentOS 7.
+
+If configuring manually, you'll need to create a gemset for each Puppet version
+you want to validate, with something like the following.
+
+    root@master:~ # rvm install ruby-1.9.3-p551
+    Searching for binary rubies, this might take some time.
+    [...]
+    root@master:~ # rvm use 1.9
+    Using /usr/local/rvm/gems/ruby-1.9.3-p551
+    root@master:~ # rvm gemset create puppet2.7.4
+    ruby-1.9.3-p551 - #gemset created /usr/local/rvm/gems/ruby-1.9.3-p551@puppet2.7.4
+    ruby-1.9.3-p551 - #generating puppet2.7.4 wrappers........
+    root@master:~ # rvm gemset use puppet2.7.4
+    Using ruby-1.9.3-p551 with gemset puppet2.7.4
+    root@master:~ # gem install puppet -v 2.7.4
+    [...]
+    root@master:~ # gem install puppet-validator
+    [...]
+    root@master:~ # passenger-config --ruby-command
+    passenger-config was invoked through the following Ruby interpreter:
+      Command: /usr/local/rvm/gems/ruby-1.9.3-p551@puppet2.7.4/wrappers/ruby
+      Version: ruby 1.9.3p551 (2014-11-13 revision 48407) [x86_64-linux]
+      To use in Apache: PassengerRuby /usr/local/rvm/gems/ruby-1.9.3-p551@puppet2.7.4/wrappers/ruby
+      To use in Nginx : passenger_ruby /usr/local/rvm/gems/ruby-1.9.3-p551@puppet2.7.4/wrappers/ruby
+      To use with Standalone: /usr/local/rvm/gems/ruby-1.9.3-p551@puppet2.7.4/wrappers/ruby /usr/bin/passenger start
+    
+    
+    ## Notes for RVM users
+    Do you want to know which command to use for a different Ruby interpreter? 'rvm use' that Ruby interpreter, then re-run 'passenger-config about ruby-command'.
+    
+Make a note of the `PassengerRuby` command for each gemset. You'll use it in the next step.
+
+You will need a `Location` block in your Apache `VirtualHost` for each versioned
+Puppet gemset you created above. The example file below shows blocks for three
+Puppet versions with the current version installed into the default directory.
+
+``` Apache
+<VirtualHost *:80>
+  ServerName vhost.example.com
+  DocumentRoot "/var/www/puppet-validator/public"
+
+  # The default root will validate against the current Puppet version
+  <Directory "/var/www/puppet-validator/public">
+    Options -MultiViews
+    AllowOverride All
+    Require all granted
+  </Directory>
+
+  Alias /2.7.4 /var/www/puppet-validator/2.7.4/public
+  <Location /2.7.4>
+    PassengerBaseURI /2.7.4
+    PassengerAppRoot /var/www/puppet-validator/2.7.4
+    PassengerRuby "/usr/local/rvm/gems/ruby-1.9.3-p551@puppet2.7.4/wrappers/ruby"
+  </Location>
+
+  Alias /3.6.2 /var/www/puppet-validator/3.6.2/public
+  <Location /3.6.2>
+    PassengerBaseURI /3.6.2
+    PassengerAppRoot /var/www/puppet-validator/3.6.2
+    PassengerRuby "/usr/local/rvm/gems/ruby-1.9.3-p551@puppet3.6.2/wrappers/ruby"
+  </Location>
+
+  ## Logging
+  ErrorLog "/var/log/httpd/vhost.example.com_error.log"
+  ServerSignature Off
+  CustomLog "/var/log/httpd/vhost.example.com_access.log" combined
+</VirtualHost>
+```
+
+There is one final trick. Passenger requires a unique filesystem location for its
+`AppRoot`. However, it will respect symlinks, so let's create one for each version:
+
+    root@master:~ # cd /var/www/puppet-validator
+    root@master:~ # ln -s . 2.7.4
+    root@master:~ # ln -s . 3.6.2
+
+Now restart Apache and you're all gravy.
+
+#### Running standalone with `systemd`
+
+A simple `systemd` init script might look something like:
+
+    # /usr/lib/systemd/system/puppet-validator.service
+    [Unit]
+    Description=Puppet Validator
+    After=network.target
+
+    [Service]
+    ExecStart=puppet-validator
+    Restart=on-failure
+    KillSignal=SIGINT
+
+    [Install]
+    WantedBy=multi-user.target
+
+Customize the command line as needed. You might include a `--theme` or `--port`
+argument, or you might provide the full path to an `rvm` installed gem.

data/config.ru

@@ -4,6 +4,7 @@ require 'puppet-validator'
 logger       = Logger.new('/var/log/puppet-validator')
 logger.level = Logger::WARN
 
+PuppetValidator.set :puppet_versions, Dir.glob('*').select {|f| File.symlink? f and File.readlink(f) == '.' }
 PuppetValidator.set :root, File.dirname(__FILE__)
 PuppetValidator.set :logger, logger
 PuppetValidator.set :disabled_lint_checks, ['80chars']

data/lib/puppet-validator.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'logger'
 require 'sinatra/base'
 require 'puppet'
@@ -19,7 +20,7 @@ class PuppetValidator < Sinatra::Base
   def initialize(app=nil)
     super(app)
 
-    Puppet.initialize_settings if Puppet.version.to_i >= 3
+    Puppet.initialize_settings if Puppet.version.to_i == 3 and Puppet.settings[:confdir].nil?
 
     # there must be a better way
     if settings.respond_to? :disabled_lint_checks
@@ -44,9 +45,19 @@ class PuppetValidator < Sinatra::Base
       end
     end
 
+    if settings.respond_to? :puppet_versions
+      # put our supported versions in reverse semver order
+      settings.puppet_versions = settings.puppet_versions.sort_by { |v| Gem::Version.new(v) }.reverse
+    else
+      def settings.puppet_versions
+        []
+      end
+    end
+
   end
 
   get '/' do
+    @versions = [Puppet.version] + settings.puppet_versions
     @disabled = settings.disabled_lint_checks
     @checks   = puppet_lint_checks
 
@@ -62,6 +73,7 @@ class PuppetValidator < Sinatra::Base
       lint   = lint(params['code'], params['checks']) if params['lint'] == 'on'
       lint ||= {} # but make sure we have a data object to iterate
 
+      @version       = Puppet.version
       @code          = params['code']
       @message       = result[:message]
       @status        = result[:status] ? :success : :fail

data/public/scripts.js

@@ -34,4 +34,14 @@ $( document ).ready(function() {
       }
   });
 
+  if ($('select#versions option').length == 1) {
+    $('select#versions').attr('disabled', true);
+  }
+  else {
+    $('select#versions').change(function() {
+      var action = ('/' + $( this ).val() + '/validate').replace(/^\/+/, '/');
+      $('form').attr('action', action );
+    });
+  }
+
 });

data/public/styles.css

@@ -40,28 +40,35 @@ div.line-highlight.with-tooltip {
     display: block;
   }
 
-div.results {
+.results {
   width: 65%;
   border: 1px solid black;
   border-radius: 0.25em;
   padding: 0.5em;
   margin: 0 auto;
 }
-  div.results.success {
+  .results legend {
+    text-align: right;
+    padding: 3px;
+    background-color: #dedede;
+    border: 1px solid #ccc;
+    border-radius: 3px;
+  }
+  .results.success {
     background-color: #61ff6e;
   }
-  div.results.fail {
+  .results.fail {
     background-color: #ffb6b6;
   }
 
-  div.results p {
+  .results p {
     margin: 0;
   }
-  div.results div.row:first-of-type {
+  .results div.row:first-of-type {
     margin-top: 0.5em;
   }
 
-  div.results span.label {
+  .results span.label {
     width: 7em;
     font-weight: bold;
     display: inline-block;
@@ -87,6 +94,11 @@ div.entry {
     width: 100%;
   }
 
+input#validate,
+select#versions {
+  margin-right: 2em;
+}
+
 a.button {
   font-size: small;
   background-color: #fff;

data/views/index.erb

@@ -11,7 +11,14 @@
   <form action="/validate" method="post">
     <div class="entry">
       <textarea name="code" id="code" cols="65" rows="25"></textarea>
-      <input type="submit" value="Validate">
+      <input type="submit" value="Validate" id="validate">
+      Puppet version
+      <select id="versions">
+        <% version = @versions.shift %><option value='/'><%= version %></option>
+        <% @versions.each do |version| %>
+        <option><%= version %></option>
+        <% end %>
+      </select>
       <label><input type="checkbox" name="lint" id="lint" onchange="toggleChecks();">Include <code>puppet-lint</code> style checks.</label>
       <a class="button" href="#" onclick="toggleMenu();">customize &#9662;</a>
       <fieldset id="checks-menu" class="menu">

data/views/result.erb

@@ -8,7 +8,8 @@
 </head>
   <body>
     <h1>Validation Results</h1>
-    <div class="results <%= @status %>">
+    <fieldset class="results <%= @status %>">
+      <legend>Puppet version <%= @version %></legend>
       <p><%= @message %></p>
       <% if @line %>
         <div class="row">
@@ -24,7 +25,7 @@
         <hr />
         <p>See inline <code>puppet-lint</code> warnings.</p>
       <% end %>
-    </div>
+    </fieldset>
     <pre data-line='<%= @highlights %>' class="line-numbers language-puppet"><code class="line-numbers language-puppet"><%= @code %></code></pre>
     <div class="links"><a href="javascript:history.back();">Try Again</a> &bull; <a href="/">Validate More Code</a></div>
     <p class="info">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-validator
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra