Package: testarchiver
TestArchiverTestArchiver is a tool for archiving your test results to a SQL database.AndEpimetheusis the tool for browsing the results you archived.Testing framework supportFrameworkStatusFixture test statusParser optionRobot FrameworkSupportedDonerobotMochaSupportedDonemocha-junitpytestSupportedDonepytest-junitPHPUnitSupportedDonephp-junitJUnitExperimentalMissingjunitxUnitExperimentalMissingxunitMSTestExperimentalMissingmstestExperimental status here means that there is a parser that can take in e.g. generic JUnit formatted output but there is no specific test set or any extensive testing or active development for the parser.Contributions for output parsers or listeners for different testing frameworks are appreciated. Contributing simply a fixture test set (that can be used to generate output files for developing a specific parser) is extremely helpful for any new framework.Installationsudo -H python3 -m pip install testarchiverSupported databasesSQLiteSQLitedefault database for the archiver and is mainly useful for testing and demo purposes. Sqlite3 driver is part of the python standard library so there are no additional dependencies for trying out the archiver.PostgreSQLPostgreSQLis the currently supported database for real projects. For exampleEpimetheusservice uses a PosrgreSQL database. For accessing PostgreSQL databases the script uses psycopg2 module:pip install psycopg2-binary(comes with pip install)Basic usageThe output files from different testing frameworks can be parsed into a database usingtest_archiver/output_parser.pyscript.testarchiver --database test_archive.db output.xmlAssuming thatoutput.xmlis a output file generated by Robot Framework (the default parser option), this will create a SQLite database file namedtest_archive.dbthat contains the results.The archiver script can also be invoked from the module:python3 -m test_archiver.output_parser --database test_archive.db output.xmlFor list of other options:testarchiver --helppositional arguments:
  output_files          list of test output files to parse in to the test
                        archive

optional arguments:
  -h, --help            show this help message and exit
  --version, -v         show program's version number and exit
  --config CONFIG_FILE  Path to JSON config file containing database
                        credentials and other configurations. Options given on
                        command line will override options set in a config
                        file.
  --format {robot,robotframework,xunit,junit,mocha-junit,pytest-junit,mstest,php-junit}
                        output format (default: robotframework)
  --repository REPOSITORY
                        The repository of the test cases. Used to
                        differentiate between test with same name in different
                        projects.
  --team TEAM           Team name for the test series
  --series SERIES       Name of the test series (and optionally build number
                        'SERIES_NAME#BUILD_NUM' or build id
                        'SERIES_NAME#BUILD_ID')
  --metadata NAME:VALUE
                        Adds given metadata to the test run. Expected format:
                        'NAME:VALUE'

Database connection:
  --dbengine DB_ENGINE  Database engine, postgresql or sqlite (default)
  --database DATABASE   database name
  --host HOST           database host name
  --user USER           database user
  --pw PASSWORD, --password PASSWORD
                        database password
  --port PORT           database port (default: 5432)
  --dont-require-ssl    Disable the default behavior to require ssl from the
                        target database.

Schema updates:
  --allow-minor-schema-updates
                        Allow TestArchiver to perform MINOR (backwards
                        compatible) schema updates the test archive
  --allow-major-schema-updates
                        Allow TestArchiver to perform MAJOR (backwards
                        incompatible) schema updates the test archive

Clean history:
  If any of the following options are used the archiver will delete the oldest
  result data. What data is kept can be controlled with these --keep-X options
  that can also be mixed. If deletion targets are not specified with --clean-X
  options all test run data is cleaned. --keep-X options should be used when
  using --clean-X options otherwise entire history is cleared.

  --keep-builds KEEP_BUILDS
                        Delete old result data but keep the data for at least
                        given number of builds in each series.
  --keep-months KEEP_MONTHS
                        Delete old result data but keep data that was archived
                        more recently than given number of months ago
  --keep-after KEEP_AFTER
                        Delete old result data but keep data that was archived
                        more recently than given date in ISO 8601 format
                        yyyy-mm-dd.
  --clean-team CLEAN_TEAM
                        Delete results only archived under given team name. Use
                        this with --keep-X options. Otherwise will delete
                        entire history
  --clean-logs          Delete oldest log messages but not test results or runs.
                        Use this with --keep-X options. Otherwise will delete
                        entire log history
  --clean-logs-below {TRACE,DEBUG,INFO,WARN}
                        Delete oldest log messages that are bellow given log
                        level but not test results or runs. Use this with
                        --keep-X options. Otherwise will delete entire log
                        history
  --clean-keyword-stats
                        Delete oldest keyword statistics data but not test
                        results or runs. Use this with --keep-X options.
                        Otherwise will delete entire log history

Limit archived data:
  --no-keywords         Do not archive keyword data
  --no-keyword-stats    Do not archive keyword statistics
  --ignore-logs-below {TRACE,DEBUG,INFO,WARN}
                        Sets a cut off level for archived log messages. By
                        default archives all available log messages.
  --ignore-logs         Do not archive any log messages
  --max_log_message_length MAX_LOG_MESSAGE_LENGTH
                        Specify how many characters of the log message that is
                        archived. full: archives the complete log. positive
                        integers: archives number of characters from the
                        beginning. negative integers: archives number of
                        characters from the end.

Adjust timestamps:
  --time-adjust-secs TIME_ADJUST_SECS
                        Adjust time in timestamps by given seconds. This can
                        be used to change time to utc before writing the
                        results to database, especially if the test system
                        uses local time, such as robot framework. For example
                        if test were run in Finland (GMT+3) in summer (+1hr),
                        calculate total hours by minutes and seconds and
                        invert to adjust in correct direction, i.e.
                        -(3+1)*60*60, so --time-adjust-secs -14400. This
                        option is useful if you are archiving in a different
                        location to where tests are run.If you are running
                        tests and archiving in same timezone, time-adjust-
                        with-system-timezone may be a better option. This
                        option may be used in conjunction with --time-adjust-
                        with-system-timezone if desired.
  --time-adjust-with-system-timezone
                        Adjust the time in timestamps by the system timezone
                        (including daylight savings adjust). If you are
                        archiving tests in the same timezone as you are
                        running tests, setting this option will ensure time
                        written to the database is in UTC/GMT time. This
                        assumes that if multiple computers are used that their
                        timezone and daylight savings settings are identical.
                        Take care also that you do not run tests just before a
                        daylight savings time adjust and archive just after,
                        as times will be out by one hour. This could easily
                        happen if long running tests cross a timezone adjust
                        boundary. This option may be used in conjunction with
                        --time-adjust-secs.

ChangeEngine:
  --change-engine-url CHANGE_ENGINE_URL
                        Starts a listener that feeds results to ChangeEngine
  --execution-context EXECUTION_CONTEXT
                        To separate data from different build pipelines for
                        ChangeEngine prioritization. Example if same changes
                        or tests may be used to verify app in Android and iOS
                        platforms, then it would be good to separate the
                        result from different builds pipelines/platforms. The
                        ChangeEngine prioritization might not give correct
                        result if different results from different platforms
                        are mixed together.
  --changes CHANGES     Json file which contains information from the changed
                        files for each repo. The file should be formatted like
                        this: { "context": "The execution context, same as
                        --execution-context and command line will override
                        this setting.", "changes": [ { "name": "string
                        representing the changed item, for example file path",
                        "repository": "Repository (optional), for separating
                        between changed items with identical names.",
                        "item_type": "Separating items (optional) and for
                        filtering subsets when prioritising", "subtype":
                        "(optional, for separating items for filtering subsets
                        when prioritising" } ] }
  --execution-id EXECUTION_ID
                        Identifier or version of the tested application for
                        given execution-context. Stored in ChangeEngine and
                        returned by "last_update" query.Data modelSchema and data model(NOTICE: this points to latest version)The schema is versioned and new versions of TestArchiver might require schema updates.
Mismatches with testarchiver version and database schema will cause parsing to fail.
TestArchiver can perform the required schema updates if--allow-minor-schema-updatesor--allow-major-schema-updatesflags are used.
Some updates require only minor updates that should be backwards compatible for tools reading the archived data.
Other updates are major and change the schema in backwards incompatible way.Schema initialisation, schema updates and history cleaning can be run without parsing results usingtestarchive_schematoolor the module directlypython3 -m test_archiver.database.Useful metadataThere are meta data that are useful to add with the results. Some testing frameworks allow adding metadata to your test results and for those frameworks (e.g. Robot Framework) it is recommended to add that metadata already to the tests so the same information is also available in the results. Additional metadata can be added when parsing the results using the--metadataoption. Metadata given during the parsing is linked to the top level test suite.--metadata NAME:VALUETest series and teamsIn the data model, each test result file is represented as single test run. These test runs are linked and organized into builds in in different result series. Depending on the situation the series can be e.g. CI build jobs or different branches. By default if no series is specified the results are linked to a default series with autoincrementing build numbers. Different test runs (from different testing frameworks or parallel executions) that belong together can be organized into the same build. Different test series are additionally organized by team. Series name and build number/id are separated by#.Some examples using the--seriesand--teamoptions oftestarchiver--series ${JENKINS_JOB_NAME}#${BUILD_NUMBER}--series "UI tests"#<commit hash>--series ${CURRENT_BRANCH}#${BUILD_ID} --team Team-A--series manually_runEach build will have a build number in the series. If the build number is specified then that number is used. If the build number/id is omitted then the build number will be checked from the previous build in that series and incremented. If the build number/id is not a number it is considered a build identifier string. If that id is new to the series the build number is incremented just as if it no build number was specified. If the same build id is found in the same test series then the results are added under that same previously archived build.If the tests are executed in a CI environment the build number/id is an excellent way to link the archived results to the actual builds.The series can also be indicated using metadata. Any metadata with name prefixed withseriesare interpreted as series information. This is especially useful when using listeners. For example when using Robot Framework metadata--metadata team:A-Team --metadata series:JENKINS_JOB_NAME#BUILD_NUMBERTimestamp adjustmentSome test frameworks use local time in their timestamps. For archiving into databases this can be problematic if tests
are viewed and or run in different timezones. To address this two ways to adjust the time back to GMT/UTC are provided.The first allows the user to apply an adjustment of a fixed time in seconds of their choosing. This is useful for cases
where tests were already run and the place/timezone where they were run are known. This option is useful if you are
archiving in a different location to where tests are  run. The time value provided as an option is added to the
timestamp. Care must be taken with places where summer time is different (usually +1hr).For example if test were run in Finland (GMT+2), plus 1 hour in summer, calculate total hours by minutes and seconds
and invert to adjust in correct direction, i.e. -(2+1)6060, so --time-adjust-secs -10800 in summer time,
and -7200 otherwise.The second provides for automated adjustment based on the system timezone and/or daylight savings if it applies. This
is useful if the tests and archiving are performed in the same place and time.
This assumes that if multiple computers are used that their timezone and daylight savings settings are identical.
Care must also be taken that tests are not run just before a daylight savings time adjust and archived just after
as times will be out by one hour. This could easily happen if long running tests cross a timezone adjust boundary.
This can be set using --time-adjust-with-system-timezone.The ArchiverRobotListener allows for the second option if its adjust_with_system_timezone argument is set to True.To ensure any of the optional adjustments are traceable, two meta data values are added to the suites' test run.
If time-adjust-secs is set to a value, time_adjust_secs with that value is written to the suite_metadata table.
If--time-adjust-with-system-timezoneoption is included, then the addition of the time-adjust-secs and the
system timezone is written to the suite_metadata tables as time_adjust_secs_total.e.g with command lineoutput_parser.py --time-adjust-secs -3600 --time-adjust-with-system-timezone ...the following values would be added to suite_metadata table for (GMT+2)time_adjust_secs with value -3600time_adjust_secs_total with -10800.This example is mimicking adding daylight savings (1hr = 3600 secs) onto
a system offset secs of 7200 (GMT+2). i.e. if the computer being used had the 'daylight savings' setting
of and you want to manually add it during archiving.Cleaning old dataSince version 3.0.0 there is support for cleaning/deleting oldest archived data. These options allow limiting the growth of the history with various options that control what types of data are cleaned and how long history is kept.
Different --keep-X and --clean-X options can be mixed to select what data is kept after cleaning.
In most cases --keep-X options are used when ever --clean-X options are used.While history cleaning can be run with every results parsing update it is recomended to run cleaning operations separately.
Cleaning history can be run without parsing results usingtestarchive_schematoolor the module directlypython3 -m test_archiver.database.Some examplespython3 -m test_archiver.database --keep-months 6Will delete all results older than 6 monthspython3 -m test_archiver.database --keep-months 6 --clean-logs --clean-keyword-statsOnly deletes logs and keywords statistics older than 6 months. Test results are not effectedpython3 -m test_archiver.database --keep-builds 10 --keep-months 6Will delete all results older than 6 months but still keeping at least 10 last builds of each seriespython3 -m test_archiver.database --lean-team Team-AWill delete all results archived under Team-Apython3 -m test_archiver.database --clean-logsWill delete all log log messagesRelease notes3.0.0 (2023-05-11)Adds support for cleaning oldest test result data to delete in order to control the growth of test archivesMajor schema update #3:call_indexcolumn oftree_hierarchytable is converted from text to intergerAddsON DELETE CASCADErule fortest_series_mappingtable to facilitate deletion of build records when their test result data is deletedFixes error message in case of incompatible schema where schema is new then archiver2.6.2 (2023-05-11)Fixes error message when newer schema used in archive than for archiverPython 3.6 support no longer tested2.6.1 (2022-10-19)Fixes a bug/regression that caused data of log messages not to be archived.2.6.0 (2022-09-15)--max_log_message_lengthoption to control the length of log messages archived.
Defaults to 2000 chars. Negative values will archive log messages from the end.Ignores return statements without warnigns from Robot Framework 5.x inputs2.5.1 (2022-09-06)JUnit parsers updated to accept results where time value is missing from a testcaseXUnit parsers updated to accept results where time value is missing from a testcase2.5.0 (2022-06-23)Time adjustments effect also test_run's generated field and start_time of all itemsFixes pytest parser by always using keyword on failureThe port option is now used when connecting to databases2.4.0 (2021-04-28)Updates to support archiving Robot Framework 4.0Fixes bug in execution path calculation for log messages2.3.0 (2021-03-16)Better support for feeding changes and execution context for ChangeEngine--changesfor feeding changes information--execution-idIdentifier or version of the tested application for given execution-context. Stored in ChangeEngine and returned bylast_updatequery.2.2.0 (2020-12-21)Ability to adjust times as reported by timestamps in test results.--time-adjust-secsallows for manual adjustment of the timestamps with given value--time-adjust-with-system-timezoneallows for automatic adjustment of timestamps by timezone and/or daylight savings.Support for parsing PHPUnit outputChangeEngine:Listener ignores skipped testsAdds test type to all parsers--execution-contextoption for setting the execution context for the resultsdiff2change_context_list.py now uses the term change context instead of simply context for clarityAdds Dockerfiles for an empty database and database with sample data
generated from project's tests2.1.0 (2020-09-16)New options for controlling archiving of keywords and log messages--no-keywordsfor ignoring all keyword data--no-keyword-statsfor not collecting keyword statistics data--ignore-logsfor not collecting any log message data--ignore-logs-belowfor ignoring all log messages below the given log level2.0.0 (2020-09-04)Distribution as pip packagepip3 install testarchiverand it installs:testarchiverscript (aka: output_parser.py)testarchive_schematoolscript (aka: database.py)diff2change_context_list.pyscripttest_archivermoduleFunctionality for managing schema updatesTestArchiver version has to match with the schema versionTestArchiver can apply schema updates when explicitly allowedUpdates are divided to major and minor updatesMinor updates are backwards compatible for applications reading the databaseMajor updates are backwards incompatible for applications reading the databaseMajor schema update #1:Addsschema_updatestable for recording schema updatesAddsschema_versioncolumn totest_runtable to make schema incompatible with
old versions TestArchiverAdds index for log messages for query performanceRenamedoutput_parser.pycli option--change_engine_urlto--change-engine-urlRecord an execution path for test cases, suites and log messages.The path explains the position of the item in its test run.E.g.s1-s2-t3means the third test in the second subsuite of the top suite.Minor schema update #2:Addsexecution_pathcolumn totest_result,suite_resultandlog_messagetablesRenamed Robot Framework listenerArchiverListener.pyasArchiverRobotListener.pyfor clarity1.2.0 (2020-08-18)Important database integrity fix when using sqlite databaseRecord test criticality (Robot Framework specific)Redesign of configurations managementAllows using both config file and command line arguments uniformlyCLI arguments override options set in config file1.1.3 (2020-06-09)Performance fix for the schema existence checkImproved error messages:Error when trying to archive results that have already been archivedError when psycopg2 module is not found