UserPyModules.CustomChecks.api package

Submodules

UserPyModules.CustomChecks.api.AbstractAnalysisPackageCheck module

class UserPyModules.CustomChecks.api.AbstractAnalysisPackageCheck.AbstractAnalysisPackageCheck

Bases: AbstractCheck

Base class for all AnalysisPackage checks.

Run(analysisPackage)

Checks the given analysis package and returns the checked results.

UserPyModules.CustomChecks.api.AbstractCheck module

class UserPyModules.CustomChecks.api.AbstractCheck.AbstractCheck

Bases: ABC

Base class for all checks. The ‘GetName’ and ‘check’ methods need to be implemented in the actual checks.

abstract GetName() → str

Will always be implemented in the custom check as return type(self).__name__ and returns the name of the class type. Belongs to the CustomChecks interface for ecu.test.

Returns

Run(test_item)

Executes the checks. Uses the template method ‘check’, which must be implemented in the check modules. Belongs to the CustomChecks interface for ecu.test.

Parameters

test_item: item from Object API

generic test item; Package, Project or AnalysisPackage

Returns

list of CheckResult (empty if no violation was found)

abstract check(test_item, parameters) → List

Needs to be implemented in the custom check (template method)

Parameters

test_item: item from Object API

generic test item; Package, Project or AnalysisPackage

parameters: any

the Parameters entry from config.yaml

Returns

list of CheckResult (empty if no violation was found)

UserPyModules.CustomChecks.api.AbstractPackageCheck module

class UserPyModules.CustomChecks.api.AbstractPackageCheck.AbstractPackageCheck

Bases: AbstractCheck

Base class for all Package checks.

Run(package)

Checks the given package and returns the checked results.

UserPyModules.CustomChecks.api.AbstractProjectCheck module

class UserPyModules.CustomChecks.api.AbstractProjectCheck.AbstractProjectCheck

Bases: AbstractCheck

Base class for all Project checks.

Run(project)

Checks the given project and returns the checked results.

UserPyModules.CustomChecks.api.CheckResult module

class UserPyModules.CustomChecks.api.CheckResult.CheckResult(message: str)

Bases: object

A check result for check violations.

message: str

Module contents