aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEnric Balletbo i Serra <enric.balletbo@collabora.com>2020-01-09 17:12:53 +0100
committerEnric Balletbo i Serra <enric.balletbo@collabora.com>2020-01-09 17:12:53 +0100
commitf64abf78be62b079a5a8408bd85e509026670dcd (patch)
tree3b970fd00b2a2df164b85b83d2714814d3b716a4
parent4949031ec64eb5994e1dceca28aa1068c8d12a3d (diff)
downloadcros-ec-tests-f64abf78be62b079a5a8408bd85e509026670dcd.tar.gz
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: Enric Balletbo i Serra <enric.balletbo@collabora.com>
-rw-r--r--README.md6
-rw-r--r--cros-ec-tests.yaml (renamed from crostests.yaml)4
-rw-r--r--docs/source/development/testguide.rst12
-rw-r--r--docs/source/index.rst4
-rw-r--r--docs/source/install.rst18
-rw-r--r--setup.py6
6 files changed, 26 insertions, 24 deletions
diff --git a/README.md b/README.md
index 9c93f28..69b3806 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
-# 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.
diff --git a/crostests.yaml b/cros-ec-tests.yaml
index 74a70b2..90445e1 100644
--- a/crostests.yaml
+++ b/cros-ec-tests.yaml
@@ -1,6 +1,6 @@
metadata:
- name: crostests
- description: "cros test plan"
+ name: cros-ec-tests
+ description: "cros-ec test plan"
environment:
- lava-test-shell
diff --git a/docs/source/development/testguide.rst b/docs/source/development/testguide.rst
index d82525d..3f28735 100644
--- a/docs/source/development/testguide.rst
+++ b/docs/source/development/testguide.rst
@@ -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
diff --git a/docs/source/index.rst b/docs/source/index.rst
index f718018..6803a22 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -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.
diff --git a/docs/source/install.rst b/docs/source/install.rst
index 244acd4..2d7b869 100644
--- a/docs/source/install.rst
+++ b/docs/source/install.rst
@@ -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
diff --git a/setup.py b/setup.py
index 1998c5b..92e4ed7 100644
--- a/setup.py
+++ b/setup.py
@@ -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",