Add README file

        [Issue#]       SSDWSSP-528
        [Bug/Feature]  Added README file.
        [Cause]        N/A
        [Solution]     N/A
        [Verification] N/A

Change-Id: I450c156bc8a133808babd7321ef9e4ddc11e5553

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..62fc8c1
--- /dev/null
+++ b/README
@@ -0,0 +1,65 @@
+README for security-tests project
+
+The project security-tests is designed for testing other packages:
+
+-libsmack
+-libprivilege-control
+-security-server
+
+The test runner framework used by this project is dpl/test. For more
+information about dpl see project wrt-commons.
+
+The tests designed for each project are grouped in separate folders:
+1, libprivilege-control
+    Sorces in folder tests/libprivilege-control-tests
+    Test cases defined in tests/libprivilege-control-tests/test.cases.cpp
+2, libsmack
+    Sources in folder tests/libsmack-tests
+    Test cases defined in tests/libsmack-tests/test.cases.cpp
+3, security server
+    Sources in folders tests/security-server-tests
+    Test cases for different aspects of package divided into several
+    security_server_tests_*.cpp files inside that folder.
+
+Tests are run on the tested device by executing security-tests-all.sh or each
+test suite separately:
+- libsmack-test,
+- libprivilege-control-test,
+- security-server-tests-client-smack,
+- security-server-tests-label,
+- security-server-tests-pid-reuser,
+- security-server-tests-server,
+- security-server-tests-api-speed,
+- security-server-tests-password,
+- security-server-tests-dbus.
+
+Each test suite may be run with options:
+  --output=<output type> --output=<output type> ...
+      possible output types:
+        --output=csv
+        --output=html
+        --output=tap
+        --output=text
+        --output=xml
+      example:
+        test-binary --output=text --output=xml --file=output.xml
+  --regexp='regexp'  Only selected tests which names match regexp run
+  --start=<test id> Start from concrete test id  --group=<group name>
+      Run tests only from one group
+  --runignored   Run also ignored tests
+  --list     Show a list of Test IDs
+  --listgroups   Show a list of Test Group names
+  --only-from-xml=<xml file>     Run only testcases specified in XML file
+       XML name is taken from attribute id="part1_part2" as whole.
+       If part1 is not found (no _) then it is implicitily set according to
+       suite part1 from binary tests
+  --listingroup=<group name>     Show a list of Test IDS in one group
+  --allowchildlogs   Allow to print logs from child process on screen.
+       When active child process will be able to print logs on stdout and
+       stderr. Both descriptors will be closed after test.
+  --help     print help
+
+Apart from unit tests, the package also provides scripts designed to check:
+- CPU usage by SMACK related processes. (test-performance-check.sh, which
+  internally uses the perf binary, and gives output to stdout.)
+- Time of last booting of the system. (boot-time-measure.bash)