README file for performance test of dotnet launcher


[*] SUMMARY
-------------------------------------------------------------------------------
Performance test is a tool to calcuate launching time.
This tool is performed on the host where the device is connected with sdb

[*] PREPARATIONS
-------------------------------------------------------------------------------
The test consists of two files.
    - performance_test.sh : main executable script
    - timestamp.sh        : used by "performance_test.sh"
The files should be in the same directory in host.

For running automatic test, you have to locate ".tpk" files in specific directory
More detail, it describes in "USAGE" section.

This test need below package
    - inotify-tools
If the package is not exist, it will try to install the package.

The host can connect device with sdb.


[*] TEST MODES
-------------------------------------------------------------------------------
There are two modes in performance test
    - auto test mode
    - manual test mode

Each mode has the following characteristics.
[Auto test mode]
    This mode automatically installs applications and measures and records performance.
    This mode need ".tpk" packaged dotnet application. It should located in "tpk" directory.
    So, files locates likes below.
        .
        ├── performance_test.sh
        ├── README
        ├── timestamp.sh
        └── tpk
            └── <tpk_application_file_name>.tpk
    There can be several tpk files. And tpk files can be freely added or deleted by the user.
[Manual test mode]
    This mode measures the execution time when the user executes the installed applications.
    After executing this mode, the user runs and terminates the application.
    And then, result of launching time and making report file.


[*] USAGE
-------------------------------------------------------------------------------
The test has two modes.
    - automatic test
    - manual test

Each test can be run through shell below options.
    -a --auto   : execute automatic test
    -m --manual : execute manual test

In the auto test mode does not require user input.
In the manual test mode, the user executes / terminates the application after executing the test.


[*] TEST RESULT
-------------------------------------------------------------------------------
Test results are generated as files in the "result/" directory.
The resulting file name is determined by the date and time, likes "result/result_YYYYMMDD_HHmm.log"

Test results consist of launching time(ms) and applicatoin id.
example of result :
    T(ms)	APP ID
    680	    org.tizen.example.BasicSampleXamarine.Tizen
    710	    org.tizen.example.XamarinApplication1.Tizen
    1460	org.tizen.example.EmailUI.Tizen
    770	    org.tizen.example.FormsTizenGallery.Tizen
    2390	org.tizen.example.SNSUI.Tizen


[*] ERROR CASE
-------------------------------------------------------------------------------
Some system can be occur error with some points.
In this section, we would like to share some solutions to solve the problems.

[>] Inotify-tools - 'max_user_watchers' error

    [ERROR CASE]
    Failed to watch stream.log; upper limit on inotify watches reached!
    Please increase the amount of inotify watches allowed per user via `/proc/sys/fs/inotify/max_user_watches'.

    execute below command for expand max_user_watchers for inotify-tool

    [SOLVE]
    echo 32768 | sudo tee /proc/sys/fs/inotify/max_user_watches
    echo fs.inotify.max_user_watches=32768 | sudo tee -a /etc/sysctl.conf
    sudo sysctl -p