summaryrefslogtreecommitdiffstats
path: root/bootstrap/vagrant-onap/CONTRIBUTING.md
blob: 6f2897ce384f38f51e688ae8e23a3c12cb209463 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
First off, thank you for considering contributing to ONAP on Vagrant project.
It's people like you that make it such a great tool.

ONAP on Vagrant is an open source project and we love to receive contributions
from our community — you! There are many ways to contribute, from writing
tutorials or blog posts, improving the documentation, submitting bug reports and
feature requests or writing code which can be incorporated into ONAP on Vagrant
itself.

Unit Testing
============

The **_tests_** folder contains ~~scripts~~ _test suites_ that ensure the proper
implementation of the _functions_ created on **_lib_** folder.  In order to
execute the Unit Tests defined for this project, you must run the following
command:

    $ ./tools/run.sh testing [test_suite] [function]

or using PowerShell

    PS C:\> Set-ExecutionPolicy Bypass -Scope CurrentUser
    PS C:\> .\tools\Run.ps1 testing [test_suite] [function]

Examples
--------

    $ ./tools/run.sh testing # Executes all the Unit Tests
    $ ./tools/run.sh testing functions # Executes all the Unit Tests of Functions Test Suite
    $ ./tools/run.sh testing functions install_maven # Executes the install_maven Unit Test of Functions Test Suite