i-MSCP backend - Unit tests

**Nuxwin** · Jul 25th 2015

Hello community;

We are on the point to add unit tests for the i-MSCP backend. If you want help us, feel free to fork the 1.2.x branch and do some PR.

How to process exactly?

For now, we want cover the lilbraries which are stored inside the engine/PerlLib/iMSCP directory. We've already added several unit tests for the iMSCP::Dir library. You can find them by looking at https://github.com/i-MSCP/imsc…st/Perl/Test/iMSCP/Dir.pm

How to run unit tests manually?

You can run the unit tests as follow

Shell-Script

# cd /usr/local/src/imscp# perl ./test/perlunit.pl

If all goes well (all tests are ok), you must get a result such as:

Shell-Script

Running unit tests from Test::iMSCP::Dir...ok 1 - require iMSCP::Dir;ok 2 - iMSCP::Dir::getFiles() die on missing dirname parameterok 3 - iMSCP::Dir::getFiles() die if cannot open dirnameok 4 - iMSCP::Dir::getFiles() return expected filenamesok 5 - iMSCP::Dir::getFiles() return expected filtered file typeok 6 - iMSCP::Dir::getDirs() die on missing dirname parameterok 7 - iMSCP::Dir::getDirs() die if cannot open dirnameok 8 - iMSCP::Dir::getDirs() return expected dirnamesok 9 - iMSCP::Dir::getAll() die on missing dirname parameterok 10 - iMSCP::Dir::getAll() die if cannot open dirnameok 11 - iMSCP::Dir::getAll() return expected dirnames and filenamesok 12 - iMSCP::Dir::isEmpty() die on missing dirname parameterok 13 - iMSCP::Dir::isEmpty() die if cannot open dirnameok 14 - iMSCP::Dir::isEmpty() return false if dirname is not emptyok 15 - iMSCP::Dir::make() die on missing dirname attributeok 16 - iMSCP::Dir::make() die if dirname already exists as fileok 17 - iMSCP::Dir::make() can create dirok 18 - iMSCP::Dir::make() can create pathok 19 - iMSCP::Dir::remove() die on missing dirname parameterok 20 - iMSCP::Dir::remove() can remove dirok 21 - iMSCP::Dir::remove() can remove path1..21

but if something fail (a test fail), you must get a result such as:

Shell-Script

Running unit tests from Test::iMSCP::Dir...
ok 1 - require iMSCP::Dir;
ok 2 - iMSCP::Dir::getFiles() die on missing dirname parameter
ok 3 - iMSCP::Dir::getFiles() die if cannot open dirname
ok 4 - iMSCP::Dir::getFiles() return expected filenames
ok 5 - iMSCP::Dir::getFiles() return expected filtered file type
ok 6 - iMSCP::Dir::getDirs() die on missing dirname parameter
ok 7 - iMSCP::Dir::getDirs() die if cannot open dirname
ok 8 - iMSCP::Dir::getDirs() return expected dirnames
ok 9 - iMSCP::Dir::getAll() die on missing dirname parameter
ok 10 - iMSCP::Dir::getAll() die if cannot open dirname
ok 11 - iMSCP::Dir::getAll() return expected dirnames and filenames
ok 12 - iMSCP::Dir::isEmpty() die on missing dirname parameter
ok 13 - iMSCP::Dir::isEmpty() die if cannot open dirname
ok 14 - iMSCP::Dir::isEmpty() return false if dirname is not empty
ok 15 - iMSCP::Dir::make() die on missing dirname attribute
ok 16 - iMSCP::Dir::make() die if dirname already exists as file
not ok 17 - iMSCP::Dir::make() can create dir
# Failed test 'iMSCP::Dir::make() can create dir'
# at /usr/local/src/imscp/test/Perl/Test/iMSCP/Dir.pm line 303.
ok 18 - iMSCP::Dir::make() can create path
ok 19 - iMSCP::Dir::remove() die on missing dirname parameter
ok 20 - iMSCP::Dir::remove() can remove dir
ok 21 - iMSCP::Dir::remove() can remove path
1..21
# Looks like you failed 1 test of 21.

Display More

~~Be aware that for now, it is assumed that your imscp archve is stored under the /usr/local/src directory.~~

The unit tests are run automatically on every commit and/or PR (pull request). Any pull request causing a build failure won't be accepted.

Thanks you for your help.

**Nuxwin** · Jul 26th 2015

Travis CI in action:

travis01.png travis02.png

**Cool** · Jul 26th 2015

get:

Code

1..20
Can't locate iMSCP/Dir.pm in @INC (you may need to install the iMSCP::Dir module) (@INC contains: /usr/local/src/imscp/engine/PerlLib /etc/perl /usr/local/lib/x86_64-linux-gnu/perl/5.20.2 /usr/local/share/perl/5.20.2 /usr/lib/x86_64-linux-gnu/perl5/5.20 /usr/share/perl5 /usr/lib/x86_64-linux-gnu/perl/5.20 /usr/share/perl/5.20 /usr/local/lib/site_perl .) at engine/PerlLib/test/iMSCP/DirTests.pm line 5.
BEGIN failed--compilation aborted at engine/PerlLib/test/iMSCP/DirTests.pm line 5.
# Looks like your test exited with 2 before it could output anything.

**Nuxwin** · Jul 26th 2015

@Cool, I'm fixing that on the travis branch atm I'll update the first thread once done.

**Nuxwin** · Jul 26th 2015

@Cool

You can retry now with 1.2.x branch. My previous posts were updated accordingly
Normally, all should be ok now. At least, Travic CI seem happy:

Shell-Script

-imscp-bot/#i-mscp-dev- [imscp] nuxwin pushed 1 new commit to 1.2.x: https://github.com/i-MSCP/imscp/commit/a7db623db6105365792fde12401d438a066526ad
-imscp-bot/#i-mscp-dev- imscp/1.2.x a7db623 Laurent Declercq: Fixed: Travis CI
* travis-ci (~travis-ci@ec2-23-20-159-253.compute-1.amazonaws.com) a rejoint #i-mscp-dev
<travis-ci> i-MSCP/imscp#15 (1.2.x - a7db623 : Laurent Declercq): The build passed.
<travis-ci> Change view : https://github.com/i-MSCP/imscp/compare/6d7e5d231d47...a7db623db610
<travis-ci> Build details : https://travis-ci.org/i-MSCP/imscp/builds/72657826
* travis-ci (~travis-ci@ec2-23-20-159-253.compute-1.amazonaws.com) a quitté #i-mscp-dev

**Cool** · Jul 26th 2015

Code

Running unit tests from Test::iMSCP::Dir...
ok 1 - require iMSCP::Dir;
ok 2 - iMSCP::Dir::getFiles() die on missing dirname parameter
ok 3 - iMSCP::Dir::getFiles() die if cannot open dirname
ok 4 - iMSCP::Dir::getFiles() return expected filenames
ok 5 - iMSCP::Dir::getFiles() return expected filtered file type
ok 6 - iMSCP::Dir::getDirs() die on missing dirname parameter
ok 7 - iMSCP::Dir::getDirs() die if cannot open dirname
ok 8 - iMSCP::Dir::getDirs() return expected dirnames
ok 9 - iMSCP::Dir::getAll() die on missing dirname parameter
ok 10 - iMSCP::Dir::getAll() die if cannot open dirname
ok 11 - iMSCP::Dir::getAll() return expected dirnames and filenames
ok 12 - iMSCP::Dir::isEmpty() die on missing dirname parameter
ok 13 - iMSCP::Dir::isEmpty() die if cannot open dirname
ok 14 - iMSCP::Dir::isEmpty() return false if dirname is not empty
ok 15 - iMSCP::Dir::make() die on missing dirname attribute
ok 16 - iMSCP::Dir::make() die if dirname already exists as file
ok 17 - iMSCP::Dir::make() can create dir
ok 18 - iMSCP::Dir::make() can create path
ok 19 - iMSCP::Dir::remove() die on missing dirname parameter
ok 20 - iMSCP::Dir::remove() can remove dir
ok 21 - iMSCP::Dir::remove() can remove path
1..21

Display More

**Cool** · Jul 29th 2015

Code

#
# Running unit tests from Test::iMSCP::Rights package...
#
# Subtest: Test::iMSCP::Rights unit tests
1..14
ok 1 - require iMSCP::Rights;
ok 2 - iMSCP::Rights::setRights() die on missing option
ok 3 - iMSCP::Rights::setRights() die on unallowed mixed options
ok 4 - iMSCP::Rights() die on inexistent target
ok 5 - iMSCP::Rights::setRights() die on inexistent user
ok 6 - iMSCP::Rights::setRights() die on inexistent group
ok 7 - iMSCP::Rights::setRights() set expected mode
ok 8 - iMSCP::Rights::setRights() set exepcted mode recursively
ok 9 - iMSCP::Rights::setRights() set expected dirmode
ok 10 - iMSCP::Rights::setRights() set expected filemode
ok 11 - iMSCP::Rights::setRights() set expected user
ok 12 - iMSCP::Rights::setRights() set expected user recursively
ok 13 - iMSCP::Rights::setRights() set expected group
ok 14 - iMSCP::Rights::setRights() set expected group recursively
ok 1 - Test::iMSCP::Rights unit tests
#
# Running unit tests from Test::iMSCP::Dir package...
#
# Subtest: Test::iMSCP::Dir unit tests
1..42
ok 1 - require iMSCP::Dir;
ok 2 - 'iMSCP::Dir::new()' isa 'iMSCP::Dir'
ok 3 - iMSCP::Dir::new() die on missing dirname option
ok 4 - iMSCP::Dir::mode() die on missing mode parameter
ok 5 - iMSCP::Dir::mode() die on inexistent dirname
ok 6 - iMSCP::Dir::mode() set expected mode on dirname
ok 7 - iMSCP::Dir::owner() die on missing owner parameter
ok 8 - iMSCP::Dir::owner() die on missing group parameter
ok 9 - iMSCP::Dir::owner() die on inexistent user
ok 10 - iMSCP::Dir::owner() die on inexistent group
ok 11 - iMSCP::Dir::owner() set expected owner and group on dirname
ok 12 - iMSCP::Dir::getFiles() die if cannot open dirname
ok 13 - iMSCP::Dir::getFiles() return expected filenames
ok 14 - iMSCP::Dir::getFiles() return expected filtered file type
ok 15 - iMSCP::Dir::getDirs() die if cannot open dirname
ok 16 - iMSCP::Dir::getDirs() return expected dirnames
ok 17 - iMSCP::Dir::getAll() die if cannot open dirname
ok 18 - iMSCP::Dir::getAll() return expected dirnames and filenames
ok 19 - iMSCP::Dir::isEmpty() die if cannot open dirname
ok 20 - iMSCP::Dir::isEmpty() return true if dirname is empty
ok 21 - iMSCP::Dir::isEmpty() return false if dirname is not empty
ok 22 - iMSCP::Dir::make() die if dirname already exists as file
ok 23 - iMSCP::Dir::make() can create dirname
ok 24 - iMSCP::Dir::make() can create dirpath
ok 25 - iMSCP::Dir::make() set expected owner on newly created dirname
ok 26 - iMSCP::Dir::make() set expected group on newly created dirname
ok 27 - iMSCP::Dir::make() set expected mode on newly created dirname
ok 28 - iMSCP::Dir::make() set expected owner on existent dirname
ok 29 - iMSCP::Dir::Make() set expected group on existent dirname
ok 30 - iMSCP::Dir::make() set expected mode on existent dirname
ok 31 - iMSCP::Dir::remove() can remove dirname
ok 32 - iMSCP::Dir::remove() can remove dirpath
ok 33 - iMSCP::Dir::rcopy() die on missing destdir parameter
ok 34 - iMSCP::Dir::rcopy() die if cannot open dirname
ok 35 - iMSCP::Dir::rcopy() die if destdir do not exists
ok 36 - iMSCP::Dir::rcopy() can copy dirname to destdir
ok 37 - iMSCP::Dir::rcopy can copy dirname to destdir with preserve option
ok 38 - iMSCP::Dir::rcopy() preserve file attributes
ok 39 - iMSCP::Dir::rcopy() do not preserve file attributes
ok 40 - iMSCP::Dir::moveDir() die on missing destdir parameter
ok 41 - iMSCP::Dir::moveDir() die on inexistent dirname
ok 42 - iMSCP::Dir::moveDir() can move dirname to destdir
ok 2 - Test::iMSCP::Dir unit tests
1..2

Display More

i-MSCP backend - Unit tests

Share

Daily visitors