Useful Constants

This module contains multiple constants collections typically used when communicating metrics and findings with Teamscale.

class ArchitectureFormats(value)

Bases: str, Enum

Architecture formats that Teamscale understands.

FILE_LIST = 'FILE_LIST'

TEAMSCALE_ARCHITECTURE = 'TEAMSCALE_ARCHITECTURE'

class Assessment(value)

Bases: str, Enum

Constants to be used as assessment levels.

BASELINE = 'BASELINE'

GREEN = 'GREEN'

ORANGE = 'ORANGE'

RED = 'RED'

UNKNOWN = 'UNKNOWN'

YELLOW = 'YELLOW'

class AssessmentMetricColors(value)

Bases: str, Enum

Constants used for colors in assessment metrics.

GREEN = 'GREEN'

RED = 'RED'

YELLOW = 'YELLOW'

class ConnectorType(value)

Bases: str, Enum

Connector types.

ADO_GIT = 'Azure DevOps Git'

FILE_SYSTEM = 'File System'

GERRIT = 'Gerrit'

GIT = 'Git'

MULTI_VERSION_FILE_SYSTEM = 'Multi-Version File System'

SVN = 'Subversion'

TFS = 'Azure DevOps TFVC (TFS)'

class CoverageFormats(value)

Bases: str, Enum

Possible coverage formats that Teamscale can interpret.

BULLSEYE = 'BULLSEYE'

CLOVER = 'CLOVER'

COBERTURA = 'COBERTURA'

CTC = 'CTC'

DOT_COVER = 'DOT_COVER'

GCOV = 'GCOV'

GOLANG_COVERAGE = 'GOLANG_COVERAGE'

IEC_COVERAGE = 'IEC_COVERAGE'

ISTANBUL = 'ISTANBUL'

JACOCO = 'JACOCO'

LAUTERBACH_TRACE32 = 'LAUTERBACH_TRACE32'

LCOV = 'LCOV'

LLVM = 'LLVM'

MS_COVERAGE = 'MS_COVERAGE'

OPEN_COVER = 'OPEN_COVER'

ROSLYN = 'ROSLYN'

SAP_COVERAGE = 'SAP_COVERAGE'

SIMPLE = 'SIMPLE'

TEAMSCALE_COMPACT_COVERAGE = 'TEAMSCALE_COMPACT_COVERAGE'

TESTWISE_COVERAGE = 'TESTWISE_COVERAGE'

VS_COVERAGE = 'VS_COVERAGE'

XCODE = 'XCODE'

XR_BABOON = 'XR_BABOON'

class Enablement(value)

Bases: str, Enum

The enablement describes which rating a finding should receive.

AUTO = 'AUTO'

The assessment provided by the concrete finding is used.

OFF = 'OFF'

The finding is disabled by default.

RED = 'RED'

The finding should always be rated red.

YELLOW = 'YELLOW'

The finding should always be rated yellow.

class MetricAggregation(value)

Bases: str, Enum

Class that contains valid aggregation strategies.

MAX = 'MAX'

MIN = 'MIN'

SUM = 'SUM'

class MetricProperties(value)

Bases: str, Enum

Possible properties used in metric definitions.

LOW_IS_BAD = 'LOW_IS_BAD'

Normally high values are considered bad, use this to inverse.

QUALITY_NEUTRAL = 'QUALITY_NEUTRAL'

Quality neutral metrics can not be assessed/rated (e.g. number of files)

RATIO_METRIC = 'RATIO_METRIC'

Metric is a percentage value between 0 and 1.

SIZE_METRIC = 'SIZE_METRIC'

Normal number counting metric.

class MetricValueType(value)

Bases: str, Enum

Metric value types.

ASSESSMENT = 'ASSESSMENT'

NUMERIC = 'NUMERIC'

TIMESTAMP = 'TIMESTAMP'

class ReportFormats(value)

Bases: str, Enum

Report formats that Teamscale understands.

ASTREE = 'ASTREE'

CLANG = 'CLANG'

CPPCHECK = 'CPPCHECK'

CS_COMPILER_WARNING = 'CS_COMPILER_WARNING'

FINDBUGS = 'FINDBUGS'

FXCOP = 'FXCOP'

GENERIC_FINDINGS = 'GENERIC_FINDINGS'

JQASSISTANT = 'JQASSISTANT'

MODEL_ADVISOR = 'MODEL_ADVISOR'

MYPY = 'MYPY'

PARASOFT_CPP_TEST = 'PARASOFT_CPP_TEST'

PCLINT = 'PCLINT'

PYLINT = 'PYLINT'

SAP_CODE_INSPECTOR = 'SAP_CODE_INSPECTOR'

SPCOP = 'SPCOP'

class TaskResolution(value)

Bases: str, Enum

Different resolutions used in tasks

FIXED = 'FIXED'

INFEASIBLE = 'INFEASIBLE'

NONE = 'NONE'

TOO_MUCH_EFFORT = 'TOO_MUCH_EFFORT'

class TaskStatus(value)

Bases: str, Enum

Different statuses a task in Teamscale can have

DISCARDED = 'DISCARDED'

OPEN = 'OPEN'

RESOLVED = 'RESOLVED'

VERIFIED = 'VERIFIED'

class UnitTestReportFormats(value)

Bases: str, Enum

Reports for unit test results that Teamscale understands.

JUNIT = 'JUNIT'

MS_TEST = 'MS_TEST'

NUNIT = 'NUNIT'

TESTWISE_COVERAGE = 'TESTWISE_COVERAGE'

XCRESULT_JSON = 'XCRESULT_JSON'

XUNIT = 'XUNIT'