Class TptHtmlFileReader

Namespace

MES.MQC.DataSourceLibrary.Adapters.Files

Assembly

MES.MQC.DataSourceLibrary.dll

public class TptHtmlFileReader : FileReader

Inheritance

object

AdapterBase

FileReader

TptHtmlFileReader

Inherited Members

FileReader.Priority

FileReader.HumanReadableFileCount

FileReader.HumanReadableFileExtensions

FileReader.HumanReadableStartFileNames

FileReader.ReportDateTimeExpected

FileReader.ReadWithHumanReadableFiles(FileReaderContext, AdapterReadResult, IEnumerable<string>)

FileReader.GetHumanReadableFilePath(FileReaderContext)

FileReader.GetHumanReadableFilePaths(FileReaderContext)

FileReader.Validate(FileReaderContext)

FileReader.Execute(FileReaderContext, bool)

AdapterBase.Options

AdapterBase.TransformStringToValue(string)

AdapterBase.TransformStringToDateTime(string)

AdapterBase.TransformStringToDateTime(AdapterContext, string)

AdapterBase.ThrowWarningForEmptyDataProperty(AdapterDataBase, AdapterContextBase, string, string)

AdapterBase.ReadFilePathsInZipFile(string)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

DataSource

The Data Source of the Adapter. If a report file contains data from multiple data sources, this property has to be to "Unknown" and the DataSource of each AdapterData object has to be defined.

public override string DataSource { get; }

Property Value

string

Description

Description of the Adapter that is visible in the Adapter Dialog as a popover. If the adapter is an API Connector, the description is also shown in the Add/Edit DataSource dialog, when the API Connector is selected. Absolute links get transformed into HTML Link Tags, line breaks (\n) get transformed into HTML line breaks (<br>), HTML tags are not allowed.

public override string Description { get; }

Property Value

string

FileExtensions

File Extensions of the Adapter. This property has to be defined and must have at least one file extension. The Adapter is only used for FilePaths with the defined file extensions. The IsValid method is not called unless the file extension matches.

public override List<string> FileExtensions { get; }

Property Value

List<string>

Name

Unique Name of the Adapter. Defaults to the ClassName (without Adapter / FileReader / ApiConnector suffix), can be overridden with a user defined Name.

public override string Name { get; }

Property Value

string

Methods

IsValid(FileReaderContext)

Check if the 'title' element is equal to 'TPT Report: Overview'

protected override bool IsValid(FileReaderContext context)

Parameters

context FileReaderContext

Context of file

Returns

bool

true if file is a valid TPT report file

Examples

Read(FileReaderContext)

Fetch Info from table with class='table-wide': read artifact path from second td where td is 'System Under Test' or 'SUT', read report date time from second td where td is 'Date' or 'SUT'. Fetch measurement from table with caption 'Platform Information': res second td of tr as measurement where first td is 'Variable 'TestRun'''

protected override AdapterReadResult Read(FileReaderContext context)

Parameters

context FileReaderContext

Context of file

Returns

AdapterReadResult

All Data is stored in an AdapterData Model object

Examples

Date	07-Dec-2020

Platform Information

Variable 'TestRun'

SIL

ReadAssessletFindings(FileReaderContext, HtmlDocument, DateTime?, string, string, bool, List<AdapterData>, List<Requirement>, List<TptAssesslet>, AdapterFinding[], AdapterFinding[])

public static List<AdapterFinding> ReadAssessletFindings(FileReaderContext context, HtmlDocument document, DateTime? dateTime, string artifactPath, string measurementName, bool hasRequirementLinkInfo, List<AdapterData> data, List<TptHtmlFileReader.Requirement> requirements, List<TptHtmlFileReader.TptAssesslet> assesslets = null, AdapterFinding[] requirementFindings = null, AdapterFinding[] testcaseFindings = null)

Parameters

context FileReaderContext

document HtmlDocument

dateTime DateTime?

artifactPath string

measurementName string

hasRequirementLinkInfo bool

data List<AdapterData>

requirements List<TptHtmlFileReader.Requirement>

assesslets List<TptHtmlFileReader.TptAssesslet>

requirementFindings AdapterFinding[]

testcaseFindings AdapterFinding[]

Returns

List<AdapterFinding>

ReadAssesslets(FileReaderContext, List<AdapterData>, HtmlDocument, DateTime?, string, string, List<Requirement>)

public static List<TptHtmlFileReader.TptAssesslet> ReadAssesslets(FileReaderContext context, List<AdapterData> data, HtmlDocument document, DateTime? dateTime, string artifactPath, string measurementName, List<TptHtmlFileReader.Requirement> requirements)

Parameters

context FileReaderContext

data List<AdapterData>

document HtmlDocument

dateTime DateTime?

artifactPath string

measurementName string

requirements List<TptHtmlFileReader.Requirement>

Returns

List<TptHtmlFileReader.TptAssesslet>

ReadRequirementCoverage(HtmlDocument, DateTime?, string, string, bool, List<Requirement>)

Read table with 'Requirement Coverage Summary' caption and define these measure 'Requirements Status' with variables: Passed, Failed, ExecutionError, DontKnow, NotCovered Requirement Count.Testable => number of all variables of 'Requirements Status' measure. From 'requirement.html' file: read 'Requirements Results' table and 'Requirements Assesslet Results' tables: Requirement Count.Total => if it is reports from PikeTec then it is : number of requirements fetch from 'Requirements Results' table plus requirements not covered by testCases for other reports : number of requirement ids fetch from 'Requirements Results' table

public static List<AdapterData> ReadRequirementCoverage(HtmlDocument document, DateTime? dateTime, string artifactPath, string measurement, bool hasRequirementLinkInfo, List<TptHtmlFileReader.Requirement> requirements)

Parameters

document HtmlDocument

content of report

dateTime DateTime?

date of report

artifactPath string

name of artifact

measurement string

name of measurement

hasRequirementLinkInfo bool

requirements List<TptHtmlFileReader.Requirement>

from requirement.html file

Returns

List<AdapterData>

ReadRequirementFindings(FileReaderContext, List<AdapterData>, DateTime?, string, string, List<Requirement>)

Read all requirement findings found in the "Requirements Results" table in the requirement.html file.

public static List<AdapterFinding> ReadRequirementFindings(FileReaderContext context, List<AdapterData> data, DateTime? dateTime, string artifactPath, string measurementName, List<TptHtmlFileReader.Requirement> requirements)

Parameters

context FileReaderContext

context for reading the report

data List<AdapterData>

data read from report

dateTime DateTime?

date of the report

artifactPath string

artifact name

measurementName string

measurement name

requirements List<TptHtmlFileReader.Requirement>

Returns

List<AdapterFinding>

List of the findings found. Returns empty list if non are found.

ReadRequirementReport(string, out bool)

public static List<TptHtmlFileReader.Requirement> ReadRequirementReport(string filePath, out bool hasRequirementLinkInfo)

Parameters

filePath string

hasRequirementLinkInfo bool

Returns

List<TptHtmlFileReader.Requirement>