Skip to content
This repository was archived by the owner on Jul 25, 2024. It is now read-only.

[WIP] doc: A couple of typo fixes and requests for clarification #691

Draft
pfalcon wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

[WIP] doc: A couple of typo fixes and requests for clarification #691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc31025
doc: A couple of typo fixes.
pfalcon Apr 17, 2020
e0d3e0c
WIP doc/intro: Clarify some points.
pfalcon Apr 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions doc/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Suite, which is a basically used to group and analyze results together.
Every test suite must be associated with exactly one Environment, which
describes the environment in which the tests were executed, such as
hardware platform, hardware configuration, OS, build settings (e.g.
regular compilers vcs optimized compilers), etc. Results are always
regular compilers vs optimized compilers), etc. Results are always
organized by environments, so we can compare apples to apples.

Projects can have subscriptions, which are either users or manually-entered
Projects can have subscriptions, which are either users registered in the system or manually-entered
email addreses that should be notified about important events such as changing
test results. ProjectStatus records the most recent build of a project, against
which future results should be compared in search for important events to
Expand Down Expand Up @@ -176,15 +176,15 @@ storing test log in the Test object, passed JSON file can look as follows:

Both forms are supported. In case log entry is missing or simple JSON
format is used, logs for each Test object are empty. They can be filled
in using plugins.
in using plugins [at later time??].
Copy link
Collaborator

@chaws chaws Apr 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pfalcon yes! After results are fetched, enabled plugins will post-process tests seeking for extra logs. One example is a built-in plugin linux-log-parser, which searches job log for linux kernel oopsies, then create tests for each specific type of oops (kernel-panic, warning, bug, etc)

Copy link
Contributor

@mwasilew mwasilew Apr 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose to change it like this:
"They can be filled in using plugins in a post-processing step. This happens after all results are collected in SQUAD"


Metrics
~~~~~~~

Metrics must be posted as JSON, encoded in UTF-8. The JSON data must be
a hash (an object, strictly speaking). Metric names go in the keys, and
values must be either a single number, or an array of numbers. In the
case of an array of numbers, then their mean will be used as the metric
case of an array of numbers, then their mean [or average? elaborate] will be used as the metric
Copy link
Contributor

@mwasilew mwasilew Apr 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's mean: https://docs.python.org/3/library/statistics.html#statistics.mean

result; the whole set of results will be used where applicable, e.g. to
display ranges.

Expand Down Expand Up @@ -224,7 +224,9 @@ strings. The following fields are recognized:
* ``job_status``: string identifying the status of the project. SQUAD
makes no judgement about its value.
* ``job_url``: URL pointing to the original test run.
* ``resubmit_url``: URL that can be used to resubmit the test run.
* ``resubmit_url``: URL that can be used to resubmit the test run. [As in: this is
API-level URL, which, being accessed, would trigged a resubmit (auth is an obvious concern),
or this is UI-level page, which user can open, login if needed and press "Resubmit" button?]
Copy link
Collaborator

@chaws chaws Apr 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually the URL that was used to resubmit a job. For instance, if you visit a build's testjob tab, you get a list of testjobs and a blue button next to it that allow you to resubmit that job. Then the resubmit-url is that new url, mostly with a new job id in it.

* ``suite_versions``: a dictionary with version number strings for suite names
used in the tests and metrics data. For example, if you have test suites
called "foo" and "bar", their versions can be expressed having metadata that
Expand All @@ -242,7 +244,7 @@ If a metadata JSON file is not submitted, the above fields can be
submitted as POST parameters. If a metadata JSON file is submitted, no
POST parameters will be considered to be used as metadata.

When sending a proper metadata JSON file, other fields may also be
When sending a proper metadata JSON file, fields with other names may also be
submitted. They will be stored, but will not be handled in any specific
way.

Expand Down
2 changes: 1 addition & 1 deletion doc/plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ provides one SQUAD plugin. It is made of only two files: ``setup.py`` and
Built-in notification plugins
-----------------------------

SQUAD comes with two bult-in plugins available for immediate use.
SQUAD comes with two built-in plugins available for immediate use.

Github
~~~~~~
Expand Down