nasl-pedant 0.0.1

data/lib/pedant/checks/files_parse_without_error.rb

@@ -0,0 +1,101 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Pedant
+  class CheckFilesParseWithoutErrors < Check
+    def self.requires
+      super + [:file_mode, :base, :main]
+    end
+
+    def provides
+      super + [:codes, :trees]
+    end
+
+    def run
+      def import(path)
+        # All files should be relative to the main file's base in practice.
+        path = @kb[:base] + path
+
+        # Since there are potentially several ways to write the path leading to
+        # a file, we'll use the basename as the key for hashes. This will
+        # prevent parsing the same file multiple times.
+        file = path.basename
+
+        # Mark a placeholder key in the KB for this file. This will prevent us
+        # from trying to parse a library more than once if there is a failure.
+        @kb[:codes][file] = :pending
+        @kb[:trees][file] = :pending
+
+        begin
+          contents = File.open(path, "rb").read
+          @kb[:codes][file] = contents
+          report(:info, "Read contents of #{path}.")
+        rescue
+          report(:error, "Failed to read contents #{path}.")
+          return fatal
+        end
+
+        begin
+          tree = Nasl::Parser.new.parse(contents, path)
+          @kb[:trees][file] = tree
+          report(:info, "Parsed contents of #{path}.")
+        rescue
+          # XXX-MAK: Incorporate the error from the parser, as it gives full,
+          # coloured context.
+          report(:error, "Failed to parse #{path}.")
+          return fatal
+        end
+      end
+
+      # This check will pass by default.
+      pass
+
+      # Initialize the keys written by this check.
+      @kb[:codes] = {}
+      @kb[:trees] = {}
+
+      # Load up the main file.
+      import(@kb[:main])
+
+      return
+
+      while true
+        # Get the list of all Includes, and prune any that have already had the
+        # files they reference parsed.
+        libs = Nasl::Include.all.map do |inc|
+          (@kb[:base] + inc.filename.text).basename
+        end
+
+        libs.delete_if { |lib| lib == @kb[:main] || @kb[:trees].has_key?(lib) }
+
+        break if libs.empty?
+
+        # Try and parse each library, continuing on failures.
+        libs.each { |lib| import(lib) }
+      end
+    end
+  end
+end

data/lib/pedant/checks/parse_test_code.rb

@@ -0,0 +1,63 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Pedant
+  class CheckParseTestCode < Check
+    def self.requires
+      super + [:codes, :main, :test_mode]
+    end
+
+    def self.provides
+      super + [:trees]
+    end
+
+    def run
+      def import(path)
+        # Since there are potentially several ways to write the path leading to
+        # a file, we'll use the basename as the key for hashes. This will
+        # prevent parsing the same file multiple times.
+        file = path.basename
+
+        # Mark a placeholder key in the KB for this file. This will prevent us
+        # from trying to parse a library more than once if there is a failure.
+        @kb[:trees][file] = :pending
+
+        tree = Nasl::Parser.new.parse(@kb[:codes][file], path)
+        @kb[:trees][file] = tree
+        report(:info, "Parsed contents of #{path}.")
+      end
+
+      # This check will pass by default.
+      pass
+
+      # Initialize the keys written by this check.
+      @kb[:trees] = {}
+
+      # Load up the main file.
+      import(@kb[:main])
+    end
+  end
+end

data/lib/pedant/checks/plugin_type_not_specified.rb

@@ -0,0 +1,79 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Pedant
+  class CheckPluginTypeNotSpecified < Check
+    def self.requires
+      super + [:main, :trees]
+    end
+
+    def run
+      # This check only applies to plugins.
+      return skip unless @kb[:main].extname == '.nasl'
+
+      args = []
+
+      tree = @kb[:trees][@kb[:main]]
+
+      tree.all(:Call).each do |node|
+        next unless node.name.name == 'script_set_attribute'
+        next unless node.arg.has_key? 'attribute'
+
+        # Pull out the attribute argument.
+        arg = node.arg['attribute']
+        next if !arg.is_a? Nasl::String
+        next if arg.text != 'plugin_type'
+
+        # Pull out the value argument.
+        arg = node.arg['value']
+        next if !arg.is_a? Nasl::String
+
+        # Ensure that the plugin type is valid.
+        unless ['combined', 'local', 'remote'].include? arg.text
+          report(:info, "Plugin is of unknown type #{arg.text}:\n#{arg.context(node)}")
+          return fail
+        end
+
+        args << [arg, node]
+      end
+
+      case args.length
+      when 0
+        report(:error, "Plugin does not specify a type.")
+        fail
+      when 1
+        arg = args.first[0]
+        call = args.first[1]
+        report(:info, "Plugin is of type #{arg.text}:\n#{arg.context(call)}")
+        pass
+      else
+        report(:error, "Plugin specifies multiple types.")
+        args.each { |arg, call| report(:error, arg.context(call)) }
+        fail
+      end
+    end
+  end
+end

data/lib/pedant/cli.rb

@@ -0,0 +1,82 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+require 'optparse'
+
+module Pedant
+  class Cli
+    def self.run
+      cfg = {}
+
+      Command.initialize!
+
+      optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: pedant [options] [command [args]]"
+
+        cfg[:verbose] = 0
+        opts.on('-v', '--verbose', 'Output more information') do
+          cfg[:verbose] += 1
+        end
+      end
+
+      optparse.parse!
+
+      # Sanity check the command line arguments.
+      if ARGV.empty?
+        puts "No command was specified."
+        puts
+        usage
+        exit 1
+      end
+
+      cmd = ARGV.shift
+      cls = Command.find(cmd)
+      if cls.nil? then
+        puts "Command '#{cmd}' not supported."
+        puts
+        usage
+        exit 1
+      end
+
+      # Run the command.
+      cls.run(cfg, ARGV)
+    end
+
+    def self.usage
+      puts "For the moment, you have to run Pedant from its top-level directory."
+      puts
+      puts "./bin/pedant [flags] [command] [filename ...]"
+      puts
+      puts "Flags:"
+      puts "    -v       Display more verbose (warning) messages. "
+      puts "    -vv      Display more verbose (informational) messages. "
+      puts
+      puts "Commands:"
+      puts "    check    Runs all included checks against the specified plugin(s)."
+      puts "    test     Runs the specified unit tests, all are selected by default."
+    end
+  end
+end

data/lib/pedant/command.rb

@@ -0,0 +1,96 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Pedant
+  class Command
+    def self.initialize!
+      Dir.glob(Pedant.lib + 'pedant/commands/*.rb').each {|f| load(f)}
+    end
+
+    def self.all
+      (@_all ||= [])
+    end
+
+    def self.inherited(cls)
+      all << cls
+    end
+
+    def self.find(cmd)
+      all.each do |cls|
+        return cls if cls.binding == cmd
+      end
+
+      nil
+    end
+
+    def self.banner(title, width=80)
+      # Create center of banner.
+      middle = "[ #{title} ]"
+
+      # Make sure width is a float.
+      width = width.to_f
+
+      # Create bars on either side.
+      leftover = (width - middle.length) / 2
+      left = '-' * leftover.floor
+      right = '-' * leftover.ceil
+
+      left + middle + right
+    end
+
+    def self.run(cfg, args)
+      # Separate plugins and libraries from the rest of the arguments.
+      paths = args.select { |arg| arg =~ /(\/|\.(inc|nasl))$/ }
+      args -= paths
+
+      # If we have no paths to process, there's a problem. Special purpose
+      # commands that don't require files to be declared should override this
+      # method.
+      if paths.empty?
+        puts "No directories (/), libraries (.inc), or plugins (.nasl) were specified."
+        exit 1
+      end
+
+      # Collect all the paths together, recursively.
+      dirents = []
+      paths.each do |path|
+        Pathname.new(path).find do |dirent|
+          if dirent.file? && dirent.extname =~ /inc|nasl/
+            dirents << dirent
+          end
+        end
+      end
+
+      # If the command is capable of handling all the paths at once, send them
+      # in a group, otherwise send them individually.
+      if self.respond_to? :analyze_all then
+        analyze_all(cfg, dirents, args)
+      else
+        dirents.each { |d| analyze(cfg, d, args) }
+      end
+    end
+  end
+end

data/lib/pedant/commands/check.rb

@@ -0,0 +1,76 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Pedant
+  class CommandCheck < Command
+    def self.binding
+      'check'
+    end
+
+    def self.analyze(cfg, path, args)
+      Check.initialize!
+
+      # Get a list of every existing check.
+      pending = Check.all
+
+      # 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(cfg[:verbose])
+        end
+      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(cfg[:verbose]) }
+    end
+  end
+end

data/lib/pedant/commands/test.rb

@@ -0,0 +1,37 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Pedant
+  class CommandTest < Command
+    def self.binding
+      'test'
+    end
+
+    def self.run(cfg, args)
+      Test.initialize!(args)
+    end
+  end
+end

data/lib/pedant/knowledge_base.rb

@@ -0,0 +1,42 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+module Pedant
+  class KnowledgeBase < Hash
+    def initialize(mode, path=nil)
+      self[mode] = true
+
+      case mode
+      when :file_mode
+        self[:base] = path.dirname
+        self[:main] = path.basename
+      when :test_mode
+        self[:base] = Pathname.new('/var/empty')
+        self[:main] = Pathname.new('test.nasl')
+      end
+    end
+  end
+end

data/lib/pedant/test.rb

@@ -0,0 +1,59 @@
+################################################################################
+# Copyright (c) 2011, Mak Kolybabi
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+################################################################################
+
+require 'test/unit'
+
+module Pedant
+  module Test
+    def self.initialize!(args)
+      # Run all tests by default.
+      args = ['unit/*', 'unit/*/*'] if args.empty?
+
+      # Run each test or category of tests specified on the command line.
+      args.each do |test|
+        Dir.glob(Pedant.test + (test + '.rb')).each { |f| load(f) }
+      end
+
+      Check.initialize!
+    end
+
+    def check(result, cls, code)
+      # Create a knowledge base.
+      kb = KnowledgeBase.new(:test_mode)
+
+      # Put test code into the knowledge base.
+      kb[:codes] = {}
+      kb[:codes][kb[:main]] = code
+
+      # Create a new instance of the check, which will execute all dependencies.
+      chk = Pedant.const_get(cls).new(kb)
+
+      # Run the test and ensure we got the expected result.
+      chk.run
+      assert_equal(result, chk.result)
+    end
+  end
+end

data/lib/pedant/version.rb

@@ -0,0 +1,3 @@
+module Pedant
+  VERSION = '0.0.1'
+end