nasl-pedant 0.0.5 → 0.0.6

data/README.md

@@ -0,0 +1,45 @@
+Pedant, a static analysis tool for NASL
+=======================================
+
+Installing
+----------
+If you have Ruby 1.9.3+ and Rubygems installed, you can simply do:
+`gem install nasl-pedant`
+
+Using
+-----
+To check a script, run this: `pedant check scriptname.nasl`.
+You can check `.inc` files the same way.
+
+See a `[WARN]` but there's no explanation of the problem? Try adding `-v`.
+
+Checking multiple files together is not currently supported (and has some
+semantics questions to be sorted out first). Currently, using xargs is the best
+way to check multiple files. For example, for checking all the plugins in a
+directory:
+
+    find . -maxdepth 1 -name '*.nasl' | while read fname; do
+      echo $fname
+      pedant check $fname
+      echo
+    done > pedant_results_$(date +%s)
+
+Bugs
+----
+
+1. Choosing which checks to run does not currently work (`-c` flag)
+1. Checking multiple files together does not currently work
+1. Only works for up to 5.2 code (will not fix, the `nasl`
+  interpreter can now export an AST)
+1. Some of the checks have inconsistent titles in terms of "truthiness"
+1. No filename is output per-file, which makes checking multiple files difficult
+
+Todo
+----
+
+1. Iron out some of the semantics:
+   - What is `test mode` used for?
+   - Currently files are all checked independently: what should be done when
+     we're given `.inc` and `.nasl` files in one invocation?
+1. Add a control-flow graph?
+1. Add some kind of taint tracking?

data/lib/pedant/check.rb

@@ -51,10 +51,7 @@ module Pedant
 
       # Run all the dependencies for this check if we're in test mode.
       return unless @kb[:test_mode]
-      self.class.depends.each do |cls|
-        chk = cls.new(@kb)
-        chk.run
-      end
+      Check.run_checks_in_dependency_order(kb, self.class.depends)
     end
 
     def self.list
@@ -91,6 +88,35 @@ module Pedant
       end
     end
 
+    def self.run_checks_in_dependency_order(kb, checks)
+      # Try to run each pending check, until we've run all our checks or
+      # deadlocked.
+      fatal = false
+      until checks.empty? || fatal
+        # Find all of the checks that can run right now.
+        ready = checks.select { |cls| cls.ready?(kb) }
+        break if ready.empty?
+
+        # Run all of the checks that are ready.
+        ready.each do |cls|
+          # Create a new check instance.
+          chk = cls.new(kb)
+          checks.delete(cls)
+
+          chk.run
+
+          # Yield the results of the finished check
+          yield chk if block_given?
+
+          # Fatal errors mean that no further checks should be processed.
+          if chk.result == :fatal
+            fatal = true
+            break
+          end
+        end
+      end
+    end
+
     def report(level, text=nil)
       unless text.nil?
         if @@levels.index(level).nil?

data/lib/pedant/checks/files_parse_without_errors.rb

@@ -30,7 +30,7 @@ module Pedant
       super + [:file_mode, :base, :main]
     end
 
-    def provides
+    def self.provides
       super + [:codes, :trees]
     end
 

data/lib/pedant/commands/check.rb

@@ -77,7 +77,7 @@ module Pedant
             usage(e.message)
           end
 
-          options[:checks] << cls
+          ([cls] + cls.depends).each { |cls| options[:checks] << cls }
         end
 
         opts.on('-h', '--help', 'Display this help screen.') do
@@ -128,48 +128,27 @@ module Pedant
     end
 
     def self.run_one(opts, path)
+      puts Rainbow("CHECKING: #{path}").cyan
       # Get a list of the checks we're going to be running.
       if not opts[:checks].empty?
         pending = opts[:checks].to_a
       else
-        pending = Check.all
+        pending = Array.new(Check.all)
       end
 
       # Initialize the knowledge base where checks can store information for
       # other checks.
       kb = KnowledgeBase.new(:file_mode, path)
 
-      # Try to run each pending check, until we've run all our checks or
-      # deadlocked.
-      fatal = false
-      until pending.empty? || fatal
-        # Find all of the checks that can run right now.
-        ready = pending.select { |cls| cls.ready?(kb) }
-        break if ready.empty?
-
-        # Run all of the checks that are ready.
-        ready.each do |cls|
-          # Create a new check instance.
-          chk = cls.new(kb)
-          pending.delete(cls)
-
-          chk.run
-
-          # Fatal errors mean that no further checks should be processed.
-          if chk.result == :fatal
-            fatal = true
-            break
-          end
-
-          # Display the results of the check.
-          puts chk.report(opts[:verbosity])
-        end
+      Check.run_checks_in_dependency_order(kb, pending) do |chk|
+        puts chk.report(opts[:verbosity])
       end
 
       # Notify the user if any checks did not run due to unsatisfied
       # dependencies or a fatal error occurring before they had the chance to
       # run.
       pending.each { |cls| puts cls.new(kb).report(opts[:verbosity]) }
+      puts
     end
   end
 end

data/lib/pedant/version.rb

@@ -1,3 +1,3 @@
 module Pedant
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nasl-pedant
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -79,6 +79,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - bin/pedant
 - lib/pedant.rb
@@ -136,18 +137,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 333689523
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 333689523
 requirements: []
 rubyforge_project: nasl-pedant
 rubygems_version: 1.8.23
@@ -168,3 +163,4 @@ test_files:
 - test/unit/checks/test_flipped_operands_on_match_or_substring.rb
 - test/unit/checks/test_plugin_type_not_specified.rb
 - test/unit/checks/test_script_family_not_specified.rb
+has_rdoc: