VaRA research tool

Module for the research tool VaRA that describes the VaRA code base layout and how to configure and setup VaRA.

varats.tools.research_tools.vara.set_vara_cmake_variables(install_prefix, post_out=<function <lambda>>)

Set all wanted/needed cmake flags.

Return type:

None

class varats.tools.research_tools.vara.VaRACodeBase(base_dir)

Bases: CodeBase

Layout of the VaRA code base: setting up vara-llvm-project fork, VaRA, and optionally phasar for static analysis.

setup_vara_remotes()

Sets up VaRA specific upstream remotes for projects that were forked.

Return type:

None

setup_build_link()

Setup build-config folder link for VaRA’s default build setup scripts.

Return type:

None

checkout_vara_version(version, use_dev_branches)

Checkout out a specific version of VaRA.

Parameters:

• version (int) – major version number, e.g., 100 or 110

• use_dev_branches (bool) – true, if one wants the current development version

Return type:

None

setup_submodules()

Set up the git submodules of all sub projects.

Return type:

None

pull()

Pull and update all SubProject s.

Return type:

None

fetch(sub_prj_name, remote=None, extra_args=None)

Fetch the SubProject corresponding to the passed subproject name.

Return type:

None

get_tags(sub_prj_name, extra_args=None)

Get a list of available git tags of the SubProject corresponding to the passed subproject name.

Return type:

List[str]

class varats.tools.research_tools.vara.VaRA(base_dir)

Bases: ResearchTool[VaRACodeBase]

Research tool implementation for VaRA.

Find the main repo online on github: https://github.com/se-sic/VaRA

classmethod get_dependencies()

Returns the dependencies for this research tool.

Return type:

Dependencies

static source_location()

Returns the source location of the research tool.

Return type:

Path

static has_source_location()

Checks if a source location of the research tool is configured.

Return type:

bool

static install_location()

Returns the install location of the research tool.

Return type:

Path

static has_install_location()

Checks if a install location of the research tool is configured.

Return type:

bool

setup(source_folder, install_prefix, version)

Setup the research tool VaRA with it’s code base. This method sets up all relevant config variables, downloads repositories via the CodeBase, checkouts the correct branches and prepares the research tool to be built.

Parameters:

• source_folder (Optional[Path]) – location to store the code base in

• install_prefix (Path) – Installation prefix path

• version (Optional[int]) – Version to setup

Return type:

None

find_highest_sub_prj_version(sub_prj_name)

Returns the highest release version number for the specified SubProject name.

Return type:

int

is_up_to_date()

Returns true if VaRA’s major release version is up to date.

Return type:

bool

upgrade()

Upgrade the research tool to a newer version.

Return type:

None

build(build_type, install_location, build_folder_suffix)

Build/Compile VaRA in the specified build_type. This method leaves VaRA in a finished state, i.e., being ready to be installed.

Parameters:

build_type (BuildType) – which type of build should be used, e.g., debug, development or release

Return type:

None

get_install_binaries()

Returns a list of binaries to check when validating the installation.

Return type:

List[str]

verify_install(install_location)

Verify if VaRA was correctly installed.

Return type:

bool

Returns:

True, if the tool was correctly installed

verify_build(build_type, build_folder_suffix)

Verifies whether vara was built correctly for the given target.

Parameters:

build_type (BuildType) – which type of build should be used, e.g., debug, development or release

Return type:

bool

Returns:

True iff all tests from check_vara pass

container_install_dependencies(stage_builder)

Add layers for installing this research tool’s dependencies to the given container.

Parameters:

stage_builder (StageBuilder) – the builder object for the current container stage

Return type:

None

container_install_tool(stage_builder)

Add layers for installing this research tool to the given container.

Parameters:

stage_builder (StageBuilder) – the builder object for the current container stage

Return type:

None

container_tool_env(stage_builder)

Tool-specific container configuration in the form of environment variables.

Parameters:

stage_builder (StageBuilder) – the builder object for the current container stage

Return type:

Dict[str, List[str]]

Returns:

a dictionary of environment variables and their values