Signed-off-by: NCleber Rosa <crosa@redhat.com>

This documents the relevant changes on the new CIT plugin
implementation.
Signed-off-by: NJan Richter <jarichte@redhat.com>
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Because of the drop in the documentation build test, in
4ecf0b3c.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Due to the build services we use (COPR) and some specific issues with
modularity, let's disable the use of python3-aexpect and consequently
the docker runner plugin for now.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Some aspects of the test runner, including how it applies timeouts and
the specific type of timeout, relies on the absence of a status to
determine that a test process may or may be alive.

At least one test, test_kill_stopped_sleep fom
selftests.functional.test_basic.RunnerSimpleTest will fail because the
runner applies a different type of timeout on TestStatus.finish().

This is far from ideal, but it's how a lot of the current runner
implementation works, and given the current timing, it's better
to keep the behavior consistent, tests passing, and disrupt the
internals on a new development cycle.

This reverts commit ac776472.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

The recently introduced feature on job category would produce warnings
that wouldn't be visible in the logs because the log initialization is
done later (requires a log directory to be defined).

Let's create the category after the log has been sucessfully
initialized, and while at it, also show the warning in the UI.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

The test can be asked to report its state, or it can do it itself.
Given that the test knows when it enters each phase, let's ask it to
report it.

Because the *state* is now reported, it's possible for a test to
finish (for instance by killing itself) without setting a valid (user
visible) status, such as "PASS", "FAIL", etc.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The avocado test runner mostly "flies blind" when it comes to the
individual test phases, that is, it doesn't know if a test is
currently being initialized, running its setup, running the test
method itself or its teardown.

With this, the runner gets access to that information, and can act
differently based on this knowledge.  One use case is to allow for
different timeouts on different test phases.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

examples/tests/gendata.py: drop "bsod" example tests

This is a really bad example of a test, in the sense that it requires
a huge library just to draw an image.

Let's drop it, given that the remaining example works just as well.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Python 3.8 support: fix SyntaxWarning on avocado.utils.cpu

This adds a command line option "--job-category" that allows one
running tests to quickly category this job in a directory.

A symbolic link is used to point to the (relative) path of the
complete job result directory.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

We're checking for identity with literal integers.  Let's fix the

 SyntaxWarning: "is" with a literal. Did you mean "=="

given by Python 3.8 and later.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This is only used, optioanlly, on a very small part of an example
test, so let's remove it and make bootstrapping for running tests
quicker and simpler.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

It looks like the same block of code was used to read the requirements
file.  Let's rename it and avoid confusion.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

In my experience, a very small percentage of the changes actually
introduce Sphinx based documentation.  Say, a feature may be composed
of 10 patches, and at the end of the series, the feature is
documented.

Requiring the documentation to be build all the time takes a toll on
both local and remote systems CI systems.  Let's make the testing
slimmer, and rely on readthedocs.org to tell if any issues are
introduced.

Instead, let's deal with eventual issues before a release is cut.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Linking to the default page, which will tell the user if a new version
is available, and allow the user to choose any other version.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

And use the avocado module entry point, instead of any specific
script.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NMerlin Mathesius <mmathesi@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

The former command line option is an old version, and the "--show"
form is preferred.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This is actually an ancient option, and the preferred syntax has been
"--show=none" for a while.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Plugin interfaces: port to Python 3 ABC syntax

Introduce Data Drainer (avocado.utils.datadrainer) [v4]

Signed-off-by: NCleber Rosa <crosa@redhat.com>

These were intended to keep compatibility with other plugins,
but given that we're past an LTS release, it's desirable to
remove them.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

When the chosen value can't be changed, bacause of some constrain. The function randomly choose diferent valueWhen the chosen value couldn't be changed, because of some constraints. The function randomly chose different value, which is not expected behavior. Now when this event occurs, the function raises ValueError exception and it's handled.
Signed-off-by: NJan Richter <jarichte@redhat.com>

These utilities include some useful file operations, RPM management.

Some modifications on the originally migrated code include correct imports,
a couple of typos, adding proper license headers, dropping duplicate functionality,
among others.
Signed-off-by: NPlamen Dimitrov <pdimitrov@pevogam.com>