puppet-validator 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27540dfa278a0cc463d85b7ed95420957b9f061f
-  data.tar.gz: 5d0c51971ca899cbddef2b63164722f18a0c8d68
+  metadata.gz: 6b24ee105fe4fa68c0d60cf4593248232f523aef
+  data.tar.gz: f62cee3a178109d601c0612238fafbebcd366f35
 SHA512:
-  metadata.gz: dfc4006d55991a8d84d381ef4be02a95e5df9e12164699509ed70e79b07cd68ccfbc5fa8059495748977d0ee5809c701ee435f6358a27f85f2744b04ec9a83f0
-  data.tar.gz: 753d447bf1e0cbcfc967da5fad07eecd85b2f3004eb37e58b230d8a0fa9fefca6c23f127532a85d22193eb38a0ef8f789aa5e34501af6cfab74534c7a3fce459
+  metadata.gz: 2a671e7c893f4230cb78d4e8a51dd93a2cf75c5143e170042e30809bae8950649baf56731b42bfb9570964bf8bc20e04631fa31fbe67d01f58424356b9525048
+  data.tar.gz: f9efab3576309a27cb89a13ec5c4615acc8b13c4e42045801fc3436f8ec6ddd51836c71b65edc66e8aec3094e5fe5454021ac7287c278c2dd72da36d0cd44d92

data/bin/puppet-validator

@@ -16,11 +16,11 @@ 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.
+         -- 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.
+         -- Copies the files needed to create a puppet-validator theme into $CWD.
+            This will overwrite existing files.
 
 "
 

data/lib/puppet-validator.rb

@@ -19,9 +19,10 @@ class PuppetValidator < Sinatra::Base
   def initialize(app=nil)
     super(app)
 
+    Puppet.initialize_settings if Puppet.version.to_i >= 3
+
     # 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)
@@ -46,6 +47,9 @@ class PuppetValidator < Sinatra::Base
   end
 
   get '/' do
+    @disabled = settings.disabled_lint_checks
+    @checks   = puppet_lint_checks
+
     erb :index
   end
 
@@ -55,7 +59,7 @@ class PuppetValidator < Sinatra::Base
 
     if request.body.size <= MAXSIZE
       result = validate params['code']
-      lint   = lint params['code'] if params['lint'] == 'on'
+      lint   = lint(params['code'], params['checks']) if params['lint'] == 'on'
       lint ||= {} # but make sure we have a data object to iterate
 
       @code          = params['code']
@@ -95,10 +99,17 @@ class PuppetValidator < Sinatra::Base
 
     def validate(data)
       begin
+        Puppet.settings[:app_management] = true if Gem::Version.new(Puppet.version) >= Gem::Version.new('4.3.2')
+
         Puppet[:code] = data
-        validation_environment = Puppet.lookup(:current_environment)
 
-        validation_environment.check_for_reparse
+        if Puppet::Node::Environment.respond_to?(:create)
+          validation_environment = Puppet::Node::Environment.create(:production, [])
+          validation_environment.check_for_reparse
+        else
+          validation_environment = Puppet::Node::Environment.new(:production)
+        end
+
         validation_environment.known_resource_types.clear
 
         {:status => true, :message => 'Syntax OK'}
@@ -111,10 +122,24 @@ class PuppetValidator < Sinatra::Base
       end
     end
 
-    def lint(data)
+    def lint(data, checks=nil)
       begin
-        settings.disabled_lint_checks.each do |check|
-          PuppetLint.configuration.send("disable_#{check}")
+        if checks
+          logger.info "Disabling checks: #{(puppet_lint_checks - checks).inspect}"
+
+          checks.each do |check|
+            PuppetLint.configuration.send("enable_#{check}")
+          end
+
+          (puppet_lint_checks - checks).each do |check|
+            PuppetLint.configuration.send("disable_#{check}")
+          end
+        else
+          logger.info "Disabling checks: #{settings.disabled_lint_checks.inspect}"
+
+          settings.disabled_lint_checks.each do |check|
+            PuppetLint.configuration.send("disable_#{check}")
+          end
         end
 
         linter = PuppetLint.new
@@ -127,6 +152,10 @@ class PuppetValidator < Sinatra::Base
       end
     end
 
+    def puppet_lint_checks
+      # sanitize because reasonss
+      PuppetLint.configuration.checks.map {|check| check.to_s}
+    end
 
   end
 end

data/public/scripts.js

@@ -0,0 +1,37 @@
+function toggleChecks() {
+  var enabled = $('input#lint').is(":checked");
+
+  $('ul#checks input').attr('disabled', ! enabled);
+}
+
+function toggleMenu() {
+  $('#checks-menu').slideToggle();
+  return false;
+}
+
+$( document ).ready(function() {
+  toggleChecks();
+
+  $("textarea#code").keydown(function(e) {
+      if(e.keyCode === 9) { // tab was pressed
+          // get caret position/selection
+          var start = this.selectionStart;
+          var end = this.selectionEnd;
+
+          var $this = $(this);
+          var value = $this.val();
+
+          // set textarea value to: text before caret + tab + text after caret
+          $this.val(value.substring(0, start)
+                      + "\t"
+                      + value.substring(end));
+
+          // put caret at right position again (add one for the tab)
+          this.selectionStart = this.selectionEnd = start + 1;
+
+          // prevent the loss of focus
+          e.preventDefault();
+      }
+  });
+
+});

data/public/styles.css

@@ -1,7 +1,12 @@
 body {
+  min-width: 690px;
   padding: 0 2em;
 }
 
+/* keeps the tooltip from clipping to the pre */
+pre[class*="language-"] {
+  overflow: visible;
+}
 div.line-highlight {
   /* Cannot use opacity, because that affects tooltip children as well */
   background-color: rgba(255, 181, 181, 0.25);
@@ -82,6 +87,34 @@ div.entry {
     width: 100%;
   }
 
+a.button {
+  font-size: small;
+  background-color: #fff;
+  padding: 0 2px;
+  border: 1px solid #fff;
+  border-radius: 3px;
+  text-decoration: none;
+}
+a.button:hover {
+  background-color: #efefef;
+  border-color: #bbb;
+}
+fieldset.menu {
+  display: none;
+  border-radius: 0.5em;
+}
+fieldset.menu ul {
+  list-style-type: none;
+  padding: 0;
+  margin: 0;
+  -moz-column-count: 2;
+  -moz-column-gap: 20px;
+  -webkit-column-count: 2;
+  -webkit-column-gap: 20px;
+  column-count: 2;
+  column-gap: 20px;
+}
+
 p.info {
     background: #fefefe url('info.png') no-repeat 5px 5px !important;
     border: 1px solid #efefef;

data/public/testing.html

@@ -2,16 +2,15 @@
 <head>
   <title>Puppet Validator</title>
   <link rel="stylesheet" href="styles.css">
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.0/jquery.min.js"></script>
 </head>
 <body>
   <h1>Testing Puppet Code</h1>
   <p>
-    This tool will validate the Puppet DSL syntax without compiling a catalog or syncing
-    any resources.  Be aware that this <em>only validates syntax</em>. If you have
-    variables that are incorrectly spelled or have a bad value, your code will still
-    be completely valid&mdash;and will not do what you want. See the
-    <a href="https://docs.puppetlabs.com/puppet/latest/reference/lang_visual_index.html">Puppet Language Guide</a>
-    if you need help understanding the syntax.
+    This tool will validate the Puppet DSL syntax. It won't actually compile a catalog or
+    enforce any configuration state. This means that this <em>only validates syntax</em>.
+    There are many ways in which a Puppet manifest may have valid syntax but be completely
+    incorrect for your purposes and not do what you intend.
   </p>
   <p>
     Some examples of flaws that will not be identified by this tool include:
@@ -24,13 +23,14 @@
     </ul>
   </p>
   <p>
-    Other tools do exist which can help make sure your code actually works as intended.
+    Many other resources exist which can help make sure your code actually works as intended.
     Some examples are:
     <ul>
-      <li><a href="https://github.com/rodjek/puppet-lint">Puppet Lint</a></li>
-      <li><a href="http://rspec-puppet.com/tutorial/">rspec-puppet</a></li>
-      <li><a href="https://github.com/puppetlabs/puppetlabs_spec_helper">Puppetlabs Spec Helper</a></li>
-      <li><a href="https://github.com/puppetlabs/beaker">Beaker</a></li>
+      <li><a href="https://docs.puppetlabs.com/puppet/latest/reference/lang_visual_index.html">the Puppet Language Guide</a></li>
+      <li><a href="https://github.com/rodjek/puppet-lint">Puppet Lint</a> style validation</li>
+      <li><a href="http://rspec-puppet.com/tutorial/">rspec-puppet</a> unit testing framework</li>
+      <li><a href="https://github.com/puppetlabs/puppetlabs_spec_helper">Puppetlabs Spec Helper</a> for rspec-puppet</li>
+      <li><a href="https://github.com/puppetlabs/beaker">Beaker</a> testing automation platform</li>
     </ul>
   </p>
   <div class="links"><a href="javascript:history.back();">Try Again</a> &bull; <a href="/">Validate More Code</a></div>

data/views/index.erb

@@ -2,23 +2,35 @@
 <head>
   <title>Puppet Validator</title>
   <link rel="stylesheet" href="styles.css">
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.0/jquery.min.js"></script>
+  <script src="scripts.js"></script>
 </head>
 <body>
   <h1>Puppet Code Validator</h1>
   <p>Paste Puppet code into the following textbox and check it for validity.</p>
-  <form id="code" action="/validate" method="post">
+  <form action="/validate" method="post">
     <div class="entry">
-      <textarea name="code" id="textarea" cols="65" rows="25"></textarea>
+      <textarea name="code" id="code" cols="65" rows="25"></textarea>
       <input type="submit" value="Validate">
-      <input type="checkbox" name="lint">Include <code>puppet-lint</code> style checks.
+      <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">
+        <legend>Enabled Lint Checks</legend>
+        <ul id="checks">
+          <% @checks.each do |check| %>
+          <li><label>
+            <input type="checkbox" name="checks[]" value="<%= check %>" id="check_<%= check %>" <% unless @disabled.include? check %>checked<% end %>><%= check %></input>
+          </label></li>
+          <% end %>
+        </ul>
+      </fieldset>
     </div>
   </form>
   <p class="info">
-    Be aware that this <em>only validates syntax</em>. It will not compile a
-    catalog or sync any resources. This means that, for example, it cannot
-    identify whether you have used the proper resource types, whether package
-    names are correct, or file paths exist.  See <a href="/testing.html">more
-    information on testing and validating Puppet code.</a>
+    Be aware that this <em>only validates syntax</em>. It will not compile or
+    enforce a catalog, which means that there are many mistakes that it cannot
+    identify. See <a href="/testing.html">more information on testing and
+    validating Puppet code.</a>
   </p>
 </body>
 </html>

data/views/result.erb

@@ -3,6 +3,7 @@
   <title>Puppet Validator</title>
   <link rel="stylesheet" href="prism-default.css">
   <link rel="stylesheet" href="styles.css">
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.0/jquery.min.js"></script>
   <script src="prism.js"></script>
 </head>
   <body>
@@ -27,11 +28,10 @@
     <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">
-      Be aware that this has <em>only validated syntax</em>. It will not compile a
-      catalog or sync any resources. This means that, for example, it cannot
-      identify whether you have used the proper resource types, whether package
-      names are correct, or file paths exist.  See <a href="/testing.html">more
-      information on testing and validating Puppet code.</a>
+      Be aware that this has <em>only validated syntax</em>. It will not compile or
+      enforce a catalog, which means that there are many mistakes that it cannot
+      identify. See <a href="/testing.html">more information on testing and
+      validating Puppet code.</a>
     </p>
   </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-validator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - public/info.png
 - public/prism-default.css
 - public/prism.js
+- public/scripts.js
 - public/styles.css
 - public/testing.html
 - views/index.erb