The sleeptenmin example test contains `self.report_state` which should
not be called directly and it defines variable which is not used.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

While going through the dependency list (requirements*.txt files) and
performing our self tests out of virtual environments, I noticed that
some tests are run outside the virtual environments.

The reason is that, even though the virtual environment is activated
for the test session (and say, `which python` gives `/venv/bin/python`),
we have hard coded `/usr/bin/python` in most places.

According to the some discussions on the virtualenv project itself[1],
a quick solution is to revert to the also common `/usr/bin/env python`
way of pointing to the Python interpreter.

[1] - https://github.com/pypa/virtualenv/issues/124Signed-off-by: NCleber Rosa <crosa@redhat.com>

Summarize the test params to help people understand and run and
adjust test variants via multiplexer easily.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The runTest method has been obsoleted and everyone should be using
"test*" method(s) instead. This patch removes the support and replaces
the default and example entry points to "test".
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Only avocado.Test is of general interest to test writers. For that reason
the entire test module has been moved to the avocado.core namespace.

The recommended way to go about writing instrumented tests is something like:

   from avocado import Test
   class MyTest(Test):
      def test_foo(self):
         do_stuff()

Changes from v2:
* Fixed references in docstrings
* Fixed refrences of avocado.test in Writing Test Guide docs

Changes from v1:
* Fixed comment typo on commit message
* Fixed old reference of avocado.test (then test.Test) instead of
  avocado then Test in GDB docs.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This patch modifies all example tests to use the new API. It uses the
default path, which is `*`, which matches the mux-entry paths ONLY.
In order to get the values it's necessarily to inject the YAML files
into the mux-entry path, by default `/test`, eg:

    avocado run sleeptest -m /test:examples/tests/sleeptest.py.data/
    sleeptest.yaml

It might seen as a bit more complicated to execute, but it's definitely
easier for maintaining and combining existing YAML files. To execute
matrix of tests you simply inject them into 2 different `/test` children,
eg: `-m /test/by_length:lengths.yaml /test/by_method:methods.yaml`.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Export avocado.core.job.main as avocado.main, so that make it look
like an API for test developers to use.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Move avocado.job to avocado.core.job, in conformance to our
purpose of keeping things not related to test developers,
inside avocado.core, isolated from users.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

We decided to use params.get(key, default) rather than flat dictionary
in test header. This way should be easier to read to code without the
need to look up and also use different defaults for different namespaces
(or even code branches).
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

We're going one step ahead to unittest  compatibility.
Now we obsolete action() method and use runTest().
Then what is runTest() will be run().

Update the selftests and tests regarding this modification.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Now that we don't enforce a silly correspondence test
module name -> class name, we can call our test classes
whatever we want as long as it inherits from avocado.test.Test.

Let's then rename our tests to something more CamelCase.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Remove the license text from files inside docs, examples and selftest,
to keep the license text only in relevant parts of the project.

References:

* https://fedoraproject.org/wiki/Packaging:LicensingGuidelines
* https://www.gnu.org/licenses/gpl-howto.htmlSigned-off-by: NRudá Moura <rmoura@redhat.com>

We have tests/ and selftests/ in avocado (the test runner).
The former includes examples of tests that make use of the
avocado API, and are also used to test avocado via CI.

This is confusing, as it doesn't make it clear to users that
tests are not part of the avocado framework. Since we have a
directory called examples with some other files (multiplexer,
plugins), move the tests to there (and keep using them in the CI).
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

The check_progress() idea is too simplistic for what we aim for,
so let's remove it to prevent test writers from depending on it.

Also, rename communicate_state() to report_state().
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Which doesn't hold any logic, but serves as an example.

To watch the intended behavior in action, I recommend running the
"one_hundred_cycles" variant of this tests.

The test runner will show that the test is running (yellow throbber
spinning), and once each six seconds (+1% into the test run) a green
throbber will be shown.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Including number of sleep cycles, sleep cycle length and finally
the sleep method, either using the python time.sleep() or running
the shell "sleep" command.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

We want avocado tests to not require specific directories,
the user should be able to arrange them in the dir structure
they see fit. Also, if a test requires data, we suppose their
data dir is located in the same directory as the source file,
with the name:

[modulename].data

Re arrange the test dir to reflect this new structure.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Sleep for 600 seconds, to see how avocado behaves under such
circumstances.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Instead of using self.params.set_default() manually for
each default value, allow test writers to set a
default_params attribute with default params, and
set them at test class init time. This way we keep
things even shorter, while allowing avocado tests
to be used stand alone.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Tell the multiplex config file we're using floats as
the sleep_length value.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Modify sleeptest to pick any params from self.params.
Also, introduce a sample multiplex file, sleeptest.mplx,
an example of how to write a multiplex file to fulfill
matrix defining goals.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

I went through all python files in avocado code, and
some changes were made:

* Files entirely written by the current avocado dev
team were changed to be GPL v2+
* Files with a significant portion of code derived
from autotest remain GPL v2 strict, and original
authorship was re-established
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Introduce the job.main() entry point in all avocado
test modules. This way all of them can be
executed. The functionality depends on
having avocado installed system wide, though.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Separate loggers for the entry points and utilities/tests.
Make the former log to the console, and the latter, to
the log files.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>