PacletAssurance`
PacletAssurance`

TestSummaryObject

TestSummaryObject[…]

gives an object that represents the results of TestSummary.

Details and Options

  • A TestSummaryObject is typically obtained as a result of TestSummary.
  • TestSummaryObject[…]["prop"] returns the value of "prop" for a given TestSummaryObject.
  • TestSummaryObject[…][{"prop1","prop2", …}] returns an association of values corresponding to several properties.
  • Possible properties for TestSummaryObject include:
  • "Name"name of the summary
    "AllTestsSucceeded"whether all tests ran without any failures or aborts
    "TestsCount"number of tests run
    "TestsSucceededCount"number of tests that succeeded
    "SuccessRate"percent of tests that succeeded
    "TestsFailedCount"number of tests that failed
    "TestsFailedWrongResultsCount"number of tests that failed with wrong results
    "TestsFailedWithMessagesCount"number of tests that failed by generating messages
    "TestsFailedWithErrorsCount"number of tests that failed due to errors
    "AbsoluteTimeUsed"total time running all tests in seconds
    "TimeElapsed"total time running all tests in human readable form
    "CPUTimeUsed"total CPU time used in running all the tests
    "MemoryUsed"total memory used in running all the tests
    "MeanTestSize"mean bytesize over all tests
    "SameInvocation"whether all the tests were run in the same invocation
    "AbsoluteTime"absolute time the summary was created in UTC time zone
    "Created"DateObject of creation time in $TimeZone
    "TimeCreated"TimeObject of time created in $TimeZone
    "UUID"a unique ID
  • In TestSummaryObject[…][statisticproperty] the composite statisticproperty is formed by concatenating combinations of statistic and property taken from:
  • statisticMin, Max, Mean, StandardDeviation, Variance, Skewness, Kurtosis
    propertyTimeElapsed, CPUTimeUsed, MemoryUsed, TestSize
  • So, for example, TestSummaryObject[…]["MeanTimeElapsed"] defines the property of the mean time elapsed over all tests included in the summary; TestSummaryObject[…]["MaxMemoryUsed"] defines the property of the maximum memory used by any test in the summary etc.
  • TestSummaryObject[…]["Properties"] returns a list of all available properties.
  • TestSummaryObject[…]["StatisticalProperties"] returns a list of properties containing summary statistics.
  • TestSummaryObject[…]["Statistics"] returns of list of statistics for statistical properties.
  • TestSummaryObject[…][All] returns an association of all properties and their values.

Examples

open allclose all

Basic Examples  (1)

Generate a summary of the core tests used to verify the functionality TestSummaryObject.

List all properties of the summary:

List the summary's statistical properties:

List the statistics that are available for statistical properties:

Show statistics for the property TestSize.

Possible Issues  (1)

Properties "TimeElapsed" and "AbsoluteTimeUsed" measure the same quantity but the former outputs as a quantity in human readable form whereas the latter outputs as a raw number of seconds.

Tech Notes
▪
  • Testing that Scales
    • ▪
  • Paclet Workflow
    • ▪
  • Using the Testing Framework