Documentation
¶
Overview ¶
Package tool provides interfaces which tools must implement in order to be accepted into the Impendulo tool suite. These interfaces specify how a tool is run; what result it returns; and how the result is displayed.
Index ¶
- func AccessError(e error) bool
- func IsCompileError(e error) bool
- func IsEndError(e error) bool
- func IsTimeout(e error) bool
- func MemoryError(e error) bool
- func Supported(l Language) bool
- type CompileError
- type Compiler
- type EndError
- type Language
- type Result
- type StartError
- type T
- type Target
- type TimeoutError
- type XMLError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AccessError ¶
AccessError checks whether an error is an access error.
func IsCompileError ¶
IsCompileError checks whether an error is a CompileError.
func MemoryError ¶
MemoryError checks whether an error is a memory error.
Types ¶
type CompileError ¶
type CompileError struct {
// contains filtered or unexported fields
}
CompileError is used to indicate that compilation failed.
type EndError ¶
type EndError struct {
// contains filtered or unexported fields
}
EndError is an error used to indicate that a command gave an error upon completion.
type Result ¶
type Result struct {
StdOut, StdErr []byte
}
Result is the result of RunCommand.
func RunCommand ¶
RunCommand executes a given command given by args and stdin. It terminates when the command finishes execution or times out. A Result containing the command's output is returned.
type StartError ¶
type StartError struct {
// contains filtered or unexported fields
}
StartError is an error used to indicate that a command failed to start.
type T ¶
type T interface {
//Name retrieves the Tool's name.
Name() string
//Lang retrieves the language which the Tool is used for.
Lang() Language
//Run runs the tool on a given file.
Run(fileId bson.ObjectId, target *Target) (result.Tooler, error)
}
T is an interface which represents various analysis tools used in Impendulo.
type Target ¶
Target stores information about the target file.
func (*Target) Executable ¶
Executable retrieves the path to the compiled executable with its package.
type TimeoutError ¶
type TimeoutError struct {
// contains filtered or unexported fields
}
TimeoutError is an error used to indicate that a command timed out.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package checkstyle is the Checkstyle static analysis tool's implementation of an Impendulo tool.
|
Package checkstyle is the Checkstyle static analysis tool's implementation of an Impendulo tool. |
|
Package diff is used to run diffs on source files and provide the result in HTML.
|
Package diff is used to run diffs on source files and provide the result in HTML. |
|
Package findbugs is the Findbugs static analysis tool's implementation of an Imendulo tool.
|
Package findbugs is the Findbugs static analysis tool's implementation of an Imendulo tool. |
|
Package javac is the OpenJDK Java compiler's implementation of an Impendulo tool.
|
Package javac is the OpenJDK Java compiler's implementation of an Impendulo tool. |
|
Package jpf is the Java Pathfinder verification system's implementation of an Impendulo tool.
|
Package jpf is the Java Pathfinder verification system's implementation of an Impendulo tool. |
|
Package JUnit is the JUnit Java testing framework's implementation of an Impendulo tool.
|
Package JUnit is the JUnit Java testing framework's implementation of an Impendulo tool. |
|
Package mongo is used to export/import collections from/to a mongo database.
|
Package mongo is used to export/import collections from/to a mongo database. |
|
Package pmd is the PMD static analysis tool's implementation of an Impendulo tool.
|
Package pmd is the PMD static analysis tool's implementation of an Impendulo tool. |