Files
platformio-core/docs/userguide/cmd_test.rst

69 lines
1.7 KiB
ReStructuredText
Raw Normal View History

.. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. _cmd_test:
platformio test
===============
.. contents::
Usage
-----
.. code-block:: bash
platformio test [OPTIONS]
Description
-----------
Run tests from PlatformIO based project. More details about PlatformIO
:ref:`unit_testing`.
This command allows you to apply the tests for the environments specified
in :ref:`projectconf`.
Options
-------
.. program:: platformio test
.. option::
-e, --environment
Process specified environments. More details :option:`platformio run --environment`
.. option::
--upload-port
Upload port of embedded board. To print all available ports use
:ref:`cmd_serialports` command.
If upload port is not specified, PlatformIO will try to detect it automatically.
.. option::
-d, --project-dir
Specify the path to project directory. By default, ``--project-dir`` is equal
to current working directory (``CWD``).
.. option::
-v, --verbose
Shows details about the results of processing environments. More details
:option:`platformio run --verbose`
Examples
--------
For the examples please follow to :ref:`unit_testing` page.