Rename crostests to cros-ec-tests

This test suite is meant for test the Chrome OS Embedded Controller and
all its drivers, rename the project to cros-ec-tests to make it explicit
that the focus is the Chrome OS Embedded Controller.
Signed-off-by: default avatarEnric Balletbo i Serra <enric.balletbo@collabora.com>
parent 4949031e
# Chromebooks Test Suite
# Chrome OS EC Test Suite
The main purpose of this test suite is to ensure that Chromebooks specific
hardware and drivers do not regress by future changes in the kernel.
hardware and drivers do not regress by future changes in the kernel. The
main focus of this test suite is the Chrome OS Embedded Controller and all
its related drivers.
metadata:
name: crostests
description: "cros test plan"
name: cros-ec-tests
description: "cros-ec test plan"
environment:
- lava-test-shell
......
......@@ -3,12 +3,12 @@ Testing Guidelines
******************
This section describes the testing framework and format standards for tests in
``crostests`` packages.
``cros-ec-tests`` packages.
Testing Framework
*****************
The testing framework used by ``crostests`` is the `unittest`_ framework.
The testing framework used by ``cros-ec-tests`` is the `unittest`_ framework.
.. _unittest: https://docs.python.org/3/library/unittest.html
......@@ -17,14 +17,14 @@ Running Tests
The first thing you should do is download latest source version::
git clone https://gitlab.collabora.com/chromiumos/crostests.git
cd crostests
git clone git://git.kernel.org/pub/scm/linux/kernel/git/chrome-platform/cros-ec-tests.git
cd cros-ec-tests
At the root of the project, add the current directory in the PYTHONPATH::
export PYTHONPATH=${PYTHONPATH}:${PWD}
There are currently different ways to invoke ``crostests``. Each method
There are currently different ways to invoke ``cros-ec-tests``. Each method
invokes `unittest`_ to run the tests but offers different options when
calling. To run the tests, you will need to make sure you have the `unittest`_
package is installed.
......@@ -83,7 +83,7 @@ The result is::
Check the return value of func() for an example argument.
----------------------------------------------------------------------
Traceback (most recent call last):
File "~/crostests/cros/tests/example.py", line 13, in test_answer
File "~/cros-ec-tests/cros/tests/example.py", line 13, in test_answer
self.assertEqual(func(3), 5)
AssertionError: 4 != 5
......
......@@ -9,11 +9,11 @@
Chromebooks Test Suite Documentation
####################################
The ``crostests`` package is a framework for fully automated testing. It is
The ``cros-ec-tests`` package is a framework for fully automated testing. It is
designed primarily to test the Linux Kernel under KernelCI with the main focus
on Chromebooks devices.
``crostests`` is composed of a number of modules that will help you to do stand
``cros-ec-tests`` is composed of a number of modules that will help you to do stand
alone tests or setup a fully automated test on KernelCI, depending on what you
are up to.
......
......@@ -5,23 +5,23 @@ Installation
Requirements
============
``crostests`` has the following strict requirements:
``cros-ec-tests`` has the following strict requirements:
- `Python <https://www.python.org/>`_ 3.5 or later
- `unittest2 <https://docs.python.org/3/library/unittest.html>`_ 1.1.0 or later
Installing ``crostests``
Installing ``cros-ec-tests``
========================
To install ``crostests`` with `pip <https://pip.pypa.io>`_, run::
To install ``cros-ec-tests`` with `pip <https://pip.pypa.io>`_, run::
pip install git+https://gitlab.collabora.com/chromiumos/crostests.git
pip install git+https://gitlab.collabora.com/chromiumos/cros-ec-tests.git
Testing an Installed ``crostests``
Testing an Installed ``cros-ec-tests``
----------------------------------
The easiest way to test if your installed version of ``crostests`` is running
The easiest way to test if your installed version of ``cros-ec-tests`` is running
correctly is to use one of the runner function::
python3 -m cros.runners.lava_runner
......@@ -34,19 +34,19 @@ Building Documentation
Dependencies
^^^^^^^^^^^^
Building the documentation requires the ``crostests`` source code and some
Building the documentation requires the ``cros-ec-tests`` source code and some
additional packages. The easiest way to install the extra dependencies for
documentation is to install the distribution packages:
* `Sphinx <http://www.sphinx-doc.org/>`_ - the main package we use to build
the documentation
* `python3-sphinx-rtd-theme <https://github.com/readthedocs/sphinx_rtd_theme>`_ -
the default 'bootstrap' theme used by ``crostests``
the default 'bootstrap' theme used by ``cros-ec-tests``
Building
^^^^^^^^
The easy way is to execute the command (from the ``crostests`` source
The easy way is to execute the command (from the ``cros-ec-tests`` source
directory)::
cd docs
......
......@@ -7,14 +7,14 @@ with open("README.md", "r") as fh:
long_description = fh.read()
setuptools.setup(
name="crostests",
description="Chromebooks Test Suite",
name="cros-ec-tests",
description="Chrome OS Embedded Controller Test Suite",
version="0.1",
long_description=long_description,
long_description_content_type="text/markdown",
author="Fabien Lahoudere, Enric Balletbo",
author_email="aragua@collabora.com, enric.balletbo@collabora.com",
url="https://gitlab.collabora.com/chromiumos/crostests",
url="https://git.kernel.org/pub/scm/linux/kernel/git/chrome-platform/cros-ec-tests.git",
packages=setuptools.find_packages(),
classifiers=[
"Intended Audience :: Developers",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment