skip to navigation
skip to content

Not Logged In

IzVerifier 0.0.3.1

Static specification file verification for IzPack installers.

Latest Version: 0.0.4.1

IzVerifier
==========

Static spec file verification for IzPack installers.

Purpose
-------

IzVerifier is a tool that tests izpack installers for incorrectly defined or undefined conditions, variables, and strings. IzVerifier also parses the source code of any custom classes used by the installer to ensure that no undefined izpack specs are referenced. Finally, IzVerifier can also perform a graph search of the installers' conditions dependency trees to find cycles or missing items.

Compatibility
-------------

IzVerifier is a work-in-progress in its early stages, and currently compatible only with izpack v5 installers.

Installation
------------

Use pip to install:

$ pip install IzVerifier

Usage
-----

IzVerifier takes a dictionary of arguments in the following form:

args = {
'specs_path': path # Path to specs folder for installer.
'resources_path': path # Path to root resources folder for installer.
'pom': path # Path to the installer project's pom.xml file.
'sources': [path1, path2, ...] # Path(s) to associated source code roots.
}

Instantiate the IzVerifier, then call its verification methods:

>>> from IzVerifier.izverifier import IzVerifier
>>> izv = IzVerifier(args)
>>> izv.verify_all(verbosity=1)

IzVerifier methods:

verify_all(verbosity=0):
Run verification tests on all installer specs.
Returns a set of all references that are undefined.

verify(specification, verbosity=0):
Run verification tests on the given specification.
Returns a set of all references for the given spec that are undefined.

dependency_verification(verbosity=0):
Runs a condition dependencies graph search on all conditions referenced by the specs
of the installer.
Returns a set of tuples containing paths to missing dependencies.

get_referenced(specification):
Returns a mapping for the given specification of all referenced items (defined or undefined) to the files they are referenced in.
The verify(specification) method must have run prior to calling get_referenced for the mapping to be filled.
The mapping is in the form:
{
'id1': set([file1, file2, ...]),
'id2': set([filea, fileb, ...]),
...
}


Contributing
------------

Setting up to hack on IzVerifier is fairly simple:

+ Fork your own copy of the repo, then clone it locally.
+ From the root of the IzVerifier repo, pip install the project as an "editable":


$ pip install -e .

Now importing and calling IzVerifier as in the Usage guide above will use the version in your repo, so you can modify and immediately see the changes in your code without re-installing or upgrading the package.  
File Type Py Version Uploaded on Size
IzVerifier-0.0.3.1.tar.gz (md5) Source 2014-07-25 19KB
  • Downloads (All Versions):
  • 66 downloads in the last day
  • 348 downloads in the last week
  • 1067 downloads in the last month