Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Summary: This glossary defines terminology used within CAST AIP. Note that it does not include terms which are associated with external concepts, or terms generally used globally. Such information should be obtained from related external documentation help system.

A

Analysis Unit

A set of source code files to analyze. For Java, this can be an Eclipse Project, or a directory containing Web Server resources (JSP files).

Analysis Service database

An Analysis Service database stores all analysis results: components, diagnosis findings and violations. Assessment results for all Technical Modules are also stored in an Analysis Service:

Alternative name: Local, Local Site, Knowledge Base

Application

A union of Analysis Units that defines the scope of source code for analysis.

Artifact

An artifact is a component and is used in the context of CAST AIP metrics to indicate the low-level programming elements used to measure application size and complexity.

Assessment Model

A specification of metrics, quality rules, calculation rules and quality criteria to assess source code quality and risks.

Back to top

B

Bookmark

A Diagnosis Finding that locates text in a component.

Business Criteria

Business Criteria are strategic quality indicators, either business oriented, or development oriented. They rely on the measurement of compliance with a set of Technical Criteria that assess the impact on the application development business – as Health Factors – or the compliance to development practices – as Rule Compliance. Their grade is based upon the weights of contributing Technical Criteria grades.

Business Health Factor

Business Health Factors are business-oriented strategic quality indicators. They rely on the measure of compliance with a set of Technical Criteria that assess the impact on the application development business.

Back to top

C

Central or Central Site

See Dashboard Service database.

Compliance Ratio

For a Quality Rule, this is a ratio of Successful Checks (= Total Checks minus Failed Checks) and Total Checks. A Compliance Ratio is transformed into a Grade/Score with 4 thresholds (each pair of thresholds define a linear function).

Component

A code fragment or a schema fragment. Fragments are specific to a programming language or a schema language, and specific to analyzers.

Alternative name: Object

Critical Violation

See Violation.

Back to top

D

Dashboard Service database

The role of the Dashboard Service database is to store:

  • Analysis results (components, violations, diagnosis findings) for each Snapshot
  • Assessment results for each Snapshot
  • Assessment Model for each Snapshot
  • Assessment results at the level of Functional Module and Application
  • The majority of Sizing Results
Alternative name: Central or Central Site

Defective Component

A defective component is a Component in violation with a Quality Rule.

Delivery Unit

An organization, such as a contractor or a department, in charge of the delivery of applications. A delivery unit defines the scope of applications for analysis.

Diagnosis Finding

Diagnosis Findings pinpoint statements or properties of the defective component violating a Quality Rule pattern. A Diagnosis Findings can be a Bookmark or a counter. Do not confuse with a Violation.

Diagnosis Procedure

An SQL procedure producing Diagnosis Findings.

Diagnosis Value

A diagnosis value is a specific Diagnosis Finding reported as a value: a counter or a name to reference a source code;

Alternative name: Associated Value

Back to top

F

Failed Checks

Number of defective components for a Quality Rule.

  • For an Application, this number is the sum of Failed Checks of all Functional Modules defined in the Application, regardless of whether a component belongs to multiple Functional Modules. In the case of overlapping of Functional Modules, this number is therefore an approximation.
  • For a Functional Module, and non-overlapping Analysis Units, this value is the number of defective components 

Functional Module

Functional Modules are used in CAST AIP to define a logical break down of Application source code into smaller units. Examples are a user defined module or an automatic module such as a "full content module" or a module generated for an Analysis Unit.

Back to top

K

Knowledge Base

See Analysis Service database.

Back to top

L

LISA (Large Intermediate Storage Area)

A location (i.e. a folder) on your local hard drive that is designated for use by the CAST Management Studio to store miscellaneous files generated during the analysis process.

  • These files will still exist once the analysis is complete.
  • This location is used more particularly in the J2EE and .NET technologies to store data generated when the User Input Data Flow Security Analysis feature is activated.
  • The location must be capable of receiving a large amount of data (several hundred MB).
  • This folder is similar in nature to the Internet Explorer cache.

LTSA (Large Temporary Storage Area)

A location (i.e. a folder) on your local hard drive that is designated for use by the CAST Management Studio to store temporary files generated during the analysis process.

  • These files will be removed once the analysis is complete.
  • This folder is similar in nature to the Windows %TEMP% folder.

Local or Local Site

See Analysis Service database.

Back to top

M

Module

Modules are executable software components or tightly coupled sets of executable software components (one or more), developed and deployed together, that deliver some of the steps needed by an Application to operate. The modules that together make up application code units. CAST scores can be seen as a result of the second unit of analysis within the application.  

Maintainability Index

Determines the cost and difficulty/ease to maintain an application in the future. Increased maintainability index makes applications cheaper to maintain with more predictable results.

Metric

Metric (or Diagnostic), analyzed the code name given to the criteria. Metrics will be defined as the basic rules of the code in the analysis of the CAST.

Back to top

P

Propagated Risk Index (PRI)

Propagated Risk Index (PRI) is a measurement of the riskiest artifacts or objects of the application along the Health Factors of Robustness, Performance and Security. PRI takes into account the intrinsic risk of the component coupled with the level of use of the given object in the transaction. It systematically helps aggregate risk of the application in a relative manner allowing for identification, prioritization, and ultimately re-mediation of the riskiest objects.*

Back to top

Q

Quality Distribution

A Quality Distribution is an operational quality indicator, designed to assess a component based on the balance of the distribution of an attribute value among objects of the component. They rely on the distribution of tested objects according to one of their properties (e.g.: size) into four categories.

Quality Measure

A Quality Measure is an operational quality indicators, designed to assess a component based on a single measure value.

Quality Rule

A Quality Rules is an operational quality indicator, designed to assess a component based on the compliance to a coding or architecture practice. A Quality Rule is defined for a single (not unified) technology or a set of technologies (unified) and produces a grade between 1.0 (very high risk) and 4.0 (low risk) for an Application or a Functional Module.

Back to top

R

Result

An assessment result of an Application or a Functional Module.

Result Detail

Additional values, indicators, related to a Result:

  • intermediate calculation results
  • breakdown of a measure
  • related quantitative values

Back to top

S

Snapshot

A CAST Snapshot is a capture at one moment in time of the status of a set of executable software components (one or more). The scope of a Snapshot depends on the nature of the information that is captured. 

Security Health Factor

Determines the risk of security breaches for an application. Increased security ratings decrease the risk of security threats against the application.

Sizing Measure

A quantitative measure.

Source Code Delivery Folder

Location for storing successive and compressed versions of applications' source code as packaged by the Delivery Manager(s).

Source Code Deployment Folder

Location of the most recent version of the applications' source code for analysis in uncompressed format.

Back to top

T

Transaction Risk Index (TRI) 

TRI is an indicator of the riskiest transactions of the application. The TRI number reflects the cumulative risk of the transaction based on the risk in the individual  objects contributing to the transaction. The TRI is calculated as a function of the rules violated, their weight/criticality, and the frequency of the violation across all objects in the path of the transaction. TRI is a powerful metric to identify, prioritize and ultimately remediate riskiest transactions and their objects.

Technical Debt

Also known as Design Debt is the accumulated amount/cost of rework that will be necessary to correct and/or recover from the deviation between the current design of the system, versus that which is minimally complex yet sufficiently complete to ensure correctness & consistency for timely delivery. This effort grows more than linearly over time as a system becomes bigger and more complex.

Technical Criteria

Technical Criteria are operational quality indicators, designed to assess a technical area. They rely on the measurement of compliance with a set of Quality Rules, Distributions, and Measures that assess a technical domain or area. Their grade is based upon contributing Quality Rules, Quality Distributions and Quality Measures grades.

Back to top

U

Unify

Quality Rule unifying a set of alternative Quality Rules; each alternative Quality Rule is defined for a single technology. For example "7166 - Avoid Artifacts with High Cyclomatic Complexity" gathers all violations of quality rules (666,1118,1652,2296,2646,3138,3654,4148,4780,5134,5580,6186,6618,7112). Note that these rules (flagged with unify=false) are always disabled.

Back to top

V

Violation

A violation identifies a defective component breaking a Quality Rule pattern.

IMPORTANT: For a given component and a given Quality Rule pattern there is 0 or 1 violations. If a component breaks a rule N times, then each occurrence is detailed into the Diagnosis Findings structure with a value counter equal to N, and/or with N values, and/or with N code bookmarks.

A Critical Violation is a violation of a Quality Rule identified as critical regarding a Technical Criterion or a Business Criterion.

Violation Index

Violation Index (VI) assesses the overall quality of an object regarding a health concern (Robustness, Security,…), by a weighted aggregation on the violation it carries.

Violation Pattern

The Violation Pattern is the pattern that is searched for in the Analysis Service content (source code, cartography, etc.) to pinpoint Violations. The Violation Pattern should be described in the description field of the Quality Rule.

Back to top

 

  • No labels