MeeGo wiki - User contributions [en]

Quality/TestSuite/oFono Modem API Test Specification

2011-02-03T08:49:58Z

Klaakso: /* Software Coverage */

== Introduction ==
Blts-ofono package (0.1.17) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.36.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call
* oFono - Change Radio Access Technology

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://meego.gitorious.org/meego-quality-assurance/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function

|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution (Not supported in test cases 1-6, 27-31, 45 and 46.)
|-
|| --cleanup || Clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|-
|| oFono - Change Radio Access Technology ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

NOTE: Test tries to load configuration file from /etc/blts/ by default if no specific path is given.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -C /usr/share/blts-ofono-tests/blts-ofono.cnf -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|-
|| 0.3 || 17-Dec-2010 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to document format and improved instructions
|-
|| 0.4 || 21-Jan-2011 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to argument switches
|-
|| 0.5 || 03-Feb-2011 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updated version numbers and removed obsolete at modem coverage
|}

Quality/TestSuite/oFono Modem API Test Specification

2011-02-03T08:47:18Z

Klaakso: /* Change History */

== Introduction ==
Blts-ofono package (0.1.17) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.36.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call
* oFono - Change Radio Access Technology

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function

|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution (Not supported in test cases 1-6, 27-31, 45 and 46.)
|-
|| --cleanup || Clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|-
|| oFono - Change Radio Access Technology ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

NOTE: Test tries to load configuration file from /etc/blts/ by default if no specific path is given.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -C /usr/share/blts-ofono-tests/blts-ofono.cnf -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|-
|| 0.3 || 17-Dec-2010 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to document format and improved instructions
|-
|| 0.4 || 21-Jan-2011 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to argument switches
|-
|| 0.5 || 03-Feb-2011 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updated version numbers and removed obsolete at modem coverage
|}

Quality/TestSuite/oFono Modem API Test Specification

2011-02-03T08:45:48Z

Klaakso: /* Software Coverage */

== Introduction ==
Blts-ofono package (0.1.17) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.36.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call
* oFono - Change Radio Access Technology

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function

|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution (Not supported in test cases 1-6, 27-31, 45 and 46.)
|-
|| --cleanup || Clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|-
|| oFono - Change Radio Access Technology ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

NOTE: Test tries to load configuration file from /etc/blts/ by default if no specific path is given.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -C /usr/share/blts-ofono-tests/blts-ofono.cnf -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|-
|| 0.3 || 17-Dec-2010 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to document format and improved instructions
|-
|| 0.4 || 21-Jan-2011 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to argument switches
|}

Quality/TestSuite/oFono Modem API Test Specification

2011-02-03T08:44:43Z

Klaakso: /* Introduction */

== Introduction ==
Blts-ofono package (0.1.17) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.36.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call
* oFono - Change Radio Access Technology

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function

|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution (Not supported in test cases 1-6, 27-31, 45 and 46.)
|-
|| --cleanup || Clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|-
|| oFono - Change Radio Access Technology ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

NOTE: Test tries to load configuration file from /etc/blts/ by default if no specific path is given.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -C /usr/share/blts-ofono-tests/blts-ofono.cnf -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|-
|| 0.3 || 17-Dec-2010 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to document format and improved instructions
|-
|| 0.4 || 21-Jan-2011 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to argument switches
|}

Quality/TestSuite/oFono Modem API Test Specification

2011-01-21T12:23:44Z

Klaakso: /* Change History */

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function

|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution (Not supported in test cases 1-6, 27-31, 45 and 46.)
|-
|| --cleanup || Clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

NOTE: Test tries to load configuration file from /etc/blts/ by default if no specific path is given.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -C /usr/share/blts-ofono-tests/blts-ofono.cnf -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|-
|| 0.3 || 17-Dec-2010 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to document format and improved instructions
|-
|| 0.4 || 21-Jan-2011 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to argument switches
|}

Quality/TestSuite/oFono Modem API Test Specification

2011-01-21T12:23:25Z

Klaakso: /* Change History */

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function

|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution (Not supported in test cases 1-6, 27-31, 45 and 46.)
|-
|| --cleanup || Clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

NOTE: Test tries to load configuration file from /etc/blts/ by default if no specific path is given.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -C /usr/share/blts-ofono-tests/blts-ofono.cnf -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|-
|| 0.3 || 17-Dec-2010 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to document format and improved instructions
|}
|| 0.4 || 21-Jan-2011 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to argument switches
|}

Quality/TestSuite/oFono Modem API Test Specification

2011-01-21T12:22:26Z

Klaakso: /* Test case arguments */

Quality/TestSuite/Building BLTS Packages

2010-12-17T13:52:51Z

Klaakso:

The source package includes the [[../BLTS Pack Script | pack.sh]] script, which is used for building RPM and Debian packages and source tar packages. To build an RPM package with the script, execute this command in the top level source directory of asset:

./pack.sh -r

To get help about the packaging script, execute

./pack.sh -h

The asset can also be built manually by executing:

./autogen.sh
./configure
make

Quality/TestSuite/Building BLTS Packages

2010-12-17T13:46:43Z

Klaakso:

The source package includes the [[../BLTS Pack Script | pack.sh]] script, which is used for building RPM and Debian packages and source tar packages. To build an RPM package with the script, execute this command in the top level source directory of test asset:

./pack.sh -r

To get help about the packaging script, execute

./pack.sh -h

The asset can also be built manually by executing:

./autogen.sh
./configure
make

Quality/TestSuite/oFono Modem API Test Specification

2010-12-17T09:01:40Z

Klaakso: /* Change History */

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function

|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

NOTE: Test tries to load configuration file from /etc/blts/ by default if no specific path is given.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -C /usr/share/blts-ofono-tests/blts-ofono.cnf -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|-
|| 0.3 || 17-Dec-2010 || [mailto:kari.laakso@digia.com Kari Laakso] || Draft || Updates to document format and improved instructions
|}

Quality/TestSuite/oFono Modem API Test Specification

2010-12-17T09:00:38Z

Klaakso: /* Configuration file examples */

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function

|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

NOTE: Test tries to load configuration file from /etc/blts/ by default if no specific path is given.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -C /usr/share/blts-ofono-tests/blts-ofono.cnf -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|}

Quality/TestSuite/MCTS

2010-12-17T08:57:31Z

Klaakso:

== MeeGo Core Test Suite (MCTS)==
=== Overview ===

* MCTS Development Guideline [[/MCTS_Development_Guideline | MCTS Development Guideline]] 
* Discussion about [[/MCTS_API_analysis | API analysis]] for MCTS functional test design
* Interested in contributing to MCTS ? Look at [[/MCTS_Start_Contributing | How to start contributing]]

=== Test Suite Code & API Coverage Analysis Repositories ===
You can get the code here: http://gitorious.org/qa-tools/mcts 
You can get the coverage analysis documents here: http://gitorious.org/qa-tools/mcts-coverage

=== MCTS Releases ===
MCTS is released typically in a biweekly cycle. The release process
is described in [[/MCTS_Release_Process | MCTS Release Process.]]

You can find information about the completed and planned MCTS releases from [[/MCTS_Releases | MCTS Releases.]]

=== Test Suite Status For Middleware (New) ===

{| cellspacing="0" border="1"
|-
!| '''Domain'''
!| '''Component'''
!| [http://wiki.meego.com/Quality/Plans/MeeGo_Core_Test_Plan Test Coverage]
!| '''% Ready'''
!| '''Auto %'''
!| [http://gitorious.org/qa-tools/mcts MCTS package]
!| '''Maintainer'''
!| '''Target Due'''
|-
| rowspan = "6" | Security

| Accounts || || || || WIP || ||

|-
| Single Sign-On || || || || WIP || ||

|-
| Integrity Protection Framework || || || || WIP || ||

|-
| Certificate Manager || || || || WIP || ||

|-
| SW Distribution Security || || || || WIP || ||

|-
| Access Control Framework || || || || WIP || ||

|-
| rowspan = "4" | System

| System Control || || || || WIP || ||

|-
| Resource Policy || Average || || || WIP || ||

|-
| Context Framework || Through || || || WIP || ||

|-
| Sensor Framework || Average || || || mcts-blts-sensor-frontend mcts-blts-sensor-plugins || ||

|-
| Location
| [[../GeoClue Test Plan | Location Framework]] || light ||100% ||100% || mcts-geoclue-tests || [mailto:shaofeng.tang@intel.com Shaofeng Tang] ||

|-
| rowspan = "5" | PIM

| Calendar Engine || Average || || || WIP || ||

|-
| Contacts Engine || Average || || || WIP || ||

|-
| Email Engine || Average || || || WIP || ||

|-
| Backup Framework || Average || || || WIP || ||

|-
| Synchronization Framework || Average || || || WIP || ||

|-
| rowspan = "3" | Multimedia

| Gstreamer || light || || || mcts-mwts-gstreamer mcts-mwts-gcamera || ||

|-
| [[../PulseAudio Test Plan | PulseAudio ]]|| light ||100% ||100% || mcts-pulseaudio-tests mcts-blts-alsa-core || [mailto:hao.h.chen@intel.com Hao Chen] || Dec. 17 for test plan

|-
| UPnP || light ||100% ||0% || mcts-gupnp-tests || [mailto:daniel.tao@intel.com Daniel Tao] ||

|-
| rowspan = "4"| Communications
| Telephony & IM || light || || || mcts-mwts-telepathy || ||

|-
| [[/OFono Test Plan |Cellular Framework]] || Through ||100% ||36% || mcts-ofono-tests mcts-blts-ofono || [mailto:elva.fu@intel.com Elva Fu]||

|-
| [[/ConnMan Test Plan | ConnMan]] || Through ||100% ||43% || mcts-connman-tests || [mailto:jeff.zheng@intel.com Jeff Zheng] ||

|-
| [[/MeeGo Bluez Test Plan |Bluetooth]] || Average ||100% ||16% || mcts-bluez-tests mcts-blts-bluetooth || [mailto:jingke.zhang@intel.com Jingke] ||

|-
| rowspan = "3" | Qt
| Qt || || || || mcts-mwts-network mcts-mwts-telepathy || ||

|-
| Qt WebKit || || || || N/A || ||

|-
| Qt Web Runtime || || || || N/A || ||

|-
| rowspan = "9" | Qt Mobility
| QtM contacts || || || || WIP || ||

|-
| QtM Location || || || || mcts-mwts-location || ||

|-
| QtM Messaging || || || || mcts-mwts-messaging || ||

|-
| QtM Publish & Subscribe || || || || WIP || ||

|-
| QtM Sensors || || || || mcts-mwts-sensors || ||

|-
| QtM Service Framework || || || || WIP || ||

|-
| QtM Versit || || || || WIP || ||

|-
| QtM Multimedia || || || || mcts-mwts-multimedia || ||

|-
| QtM System Info || || || || WIP || ||

|-
| rowspan = "3" | [[../MeeGo_Graphics_Test_Plan | Graphics]]
| OpenGL ES || Average ||100% ||13% || mcts-qtgfx-tests mcts-blts-openles2-perf || [mailto:kui.zheng@intel.com Kui Zheng] ||

|-
| Font Management || || || || N/A || ||

|-
| X11 || Light ||100% ||100% || mcts-x-tests mcts-rendercheck-tests mcts-blts-fbdev || [mailto:kui.zheng@intel.com Kui Zheng] ||

|-
| Data Management || Content Framework || Through || || || mcts-tracker-tests || ||

|-
| SW Management
| [[ Package_Manager | Package Management and Update]] || light || || || mcts-packagekit-tests || [mailto:huajun.li@intel.com Huajun Li] || .

|-
| Kernel

| Linux Kernel || || || || mcts-blts-usb mcts-blts-input-devices mcts-mwts-filesystem || ||

|}

=== Released Middleware Test Asset Descriptions ===
[[../MWTS Asset Descriptions | Released Middleware Test Asset Descriptions]]

=== Test Suite Status For OS Base===
{|cellspacing="0" border="1"
!|Category
!|Component
!|Test Coverage
!|Planned #
!|Ready #
!|Auto %
!|Major Contacts
!|Due

|-
| rowspan = "17" | OS Base|| [[../Audio Driver Test Specification | Audio Driver]] || '''Light''' ||31||31||0% || [mailto:EXT-jussi.saavalainen@nokia.com Jussi Saavalainen]||tbd

|-
| [[../Bluetooth Driver Test Specification | Bluetooth Driver]] || '''Light''' || 23 || 23 || 0% ||[mailto:EXT-jussi.saavalainen@nokia.com Jussi Saavalainen]||tbd

|-
| [[../Camera Driver Test Specification | Camera Driver]] || '''Light''' || 12 || 12 || 0% ||[mailto:EXT-jussi.saavalainen@nokia.com Jussi Saavalainen]||tbd

|-
| [[../Functional Key Driver Test Plan | Functional Key Driver]] || '''Open''' || tbd || || || || tbd

|-
| [[../Framebuffer Test Specification | Framebuffer Driver]] || '''Light''' || 22 || 11 || 0% || [mailto:mika.niinisto@digia.com Mika Niinistö] ||tbd

|-
| [[../GPS Driver Test Plan | GPS Driver]] || '''Light''' || || || ||Jussi Saavalainen||tbd

|-
| [[../Input Devices Driver Test Specification | Input Devices Driver]] || '''Light''' || 3 || 3 || 0% || ||tbd

|-
| [[../oFono Modem API Test Specification | Modem Driver]] || '''Light''' || N/A || N/A || N/A || ||tbd

|-
| [[../SD-MMC Driver Test Plan | SD/MMC Driver]] || '''Light''' || 33 || 33 || 0% ||Jussi Saavalainen ||Sep.3.2010

|-
| [[../Sensor Test Front-end | Sensor Driver]] || '''N/A''' || N/A || N/A || N/A || Pasi Matilainen ||tbd

|-
| [[../Touch Screen Driver Test Plan | Touch Screen Driver]] || '''Light''' || || || || Juhani Taipale||tbd

|-
| [[../Touchpad Driver Test Plan | Touchpad Driver]] || '''Open''' || tbd || || || ||tbd

|-
| [[../USB Driver Test Specification | USB Driver]] || '''Light''' || 35 || 35 || 0% ||[mailto:EXT-jussi.saavalainen@nokia.com Jussi Saavalainen] ||tbd

|-
| [[../Video Playback Driver Test Specification | Video Playback Driver]] || '''Average''' || 6 || 6 || 0% ||[mailto:kimmo.myllyvirta@digia.com Kimmo Myllyvirta] ||tbd

|-
| [[../Watchdog Driver Test Specification | Watchdog Driver]] || '''Average''' || 3 || 3 || 0% || [mailto:kimmo.myllyvirta@digia.com Kimmo Myllyvirta] ||tbd

|-
| [[../WIFI Driver Test Specification | WIFI Driver]] || '''Light''' || 10 || 10 || 0% ||Jussi Saavalainen ||tbd

|-
| [[../X11 Test Specification | X11]] || '''Light''' || 11 || 11 || 0% || [mailto:kimmo.myllyvirta@digia.com Kimmo Myllyvirta] ||tbd
|}

Quality/TestSuite/oFono Modem API Test Specification

2010-12-16T14:21:34Z

Klaakso: /* Test case arguments */

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function

|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456 -C /usr/share/blts-ofono-tests/blts-ofono.cnf</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|}

Quality/TestSuite/oFono Modem API Test Specification

2010-12-16T14:18:33Z

Klaakso: /* Test asset specific instructions */

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-ofono-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -l || Used log file, Used log file, default blts_ofono_log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -C || Used configuration file and path, for example /usr/share/blts-ofono-tests/blts-ofono.cnf
|-
|| -? || Help message
|-
|| -xml, -axml || Create result XML. -axml appends results to an existing XML file.
|-
|| -auto || Silent logging for test automation. Only the results are printed to stdout.
|-
|| -v || Verbose logging (default)
|-
|| -vv || Even more verbose logging
|-
!|Optional switch
!|Function
|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456 -C /usr/share/blts-ofono-tests/blts-ofono.cnf</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|}

Quality/TestSuite/oFono Modem API Test Specification

2010-12-16T14:17:14Z

Klaakso: /* N900 specific */

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

Compile blts-ofono-tests with corresponding environment

<code>$ dpkg-buildpackge</code>

and install package to DUT. You'll need to have SIM card in DUT with correct pin number entered. Now you can execute tests from command prompt Execute from host end command line:

<code>$ blts-ofono </code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -l || Used log file, Used log file, default blts_ofono_log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -C || Used configuration file and path, for example /usr/share/blts-ofono-tests/blts-ofono.cnf
|-
|| -? || Help message
|-
|| -xml, -axml || Create result XML. -axml appends results to an existing XML file.
|-
|| -auto || Silent logging for test automation. Only the results are printed to stdout.
|-
|| -v || Verbose logging (default)
|-
|| -vv || Even more verbose logging
|-
!|Optional switch
!|Function
|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456 -C /usr/share/blts-ofono-tests/blts-ofono.cnf</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|}

Quality/TestSuite/oFono Modem API Test Specification

2010-12-16T14:16:43Z

Klaakso: /* Test cases with variables */

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

Compile blts-ofono-tests with corresponding environment

<code>$ dpkg-buildpackge</code>

and install package to DUT. You'll need to have SIM card in DUT with correct pin number entered. Now you can execute tests from command prompt Execute from host end command line:

<code>$ blts-ofono </code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -l || Used log file, Used log file, default blts_ofono_log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -C || Used configuration file and path, for example /usr/share/blts-ofono-tests/blts-ofono.cnf
|-
|| -? || Help message
|-
|| -xml, -axml || Create result XML. -axml appends results to an existing XML file.
|-
|| -auto || Silent logging for test automation. Only the results are printed to stdout.
|-
|| -v || Verbose logging (default)
|-
|| -vv || Even more verbose logging
|-
!|Optional switch
!|Function
|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456 -C /usr/share/blts-ofono-tests/blts-ofono.cnf</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

=== N900 specific ===
Before executing tests run <code>kill-telepathy</code> and after executing run <code>enable-telepathy</code> and boot device.

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|}

Quality/TestSuite/oFono Modem API Test Specification

2010-12-16T14:15:23Z

Klaakso:

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

Compile blts-ofono-tests with corresponding environment

<code>$ dpkg-buildpackge</code>

and install package to DUT. You'll need to have SIM card in DUT with correct pin number entered. Now you can execute tests from command prompt Execute from host end command line:

<code>$ blts-ofono </code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -l || Used log file, Used log file, default blts_ofono_log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -C || Used configuration file and path, for example /usr/share/blts-ofono-tests/blts-ofono.cnf
|-
|| -? || Help message
|-
|| -xml, -axml || Create result XML. -axml appends results to an existing XML file.
|-
|| -auto || Silent logging for test automation. Only the results are printed to stdout.
|-
|| -v || Verbose logging (default)
|-
|| -vv || Even more verbose logging
|-
!|Optional switch
!|Function
|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Running test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Test cases with variables ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456 -C /usr/share/blts-ofono-tests/blts-ofono.cnf</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

=== N900 specific ===
Before executing tests run <code>kill-telepathy</code> and after executing run <code>enable-telepathy</code> and boot device.

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|}

Quality/TestSuite/oFono Modem API Test Specification

2010-12-16T14:12:37Z

Klaakso:

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel
* dbus-devel
* dbus-glib-devel
* glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Executing tests ===

Compile blts-ofono-tests with corresponding environment

<code>$ dpkg-buildpackge</code>

and install package to DUT. You'll need to have SIM card in DUT with correct pin number entered. Now you can execute tests from command prompt Execute from host end command line:

<code>$ blts-ofono </code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -l || Used log file, Used log file, default blts_ofono_log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -C || Used configuration file and path, for example /usr/share/blts-ofono-tests/blts-ofono.cnf
|-
|| -? || Help message
|-
|| -xml, -axml || Create result XML. -axml appends results to an existing XML file.
|-
|| -auto || Silent logging for test automation. Only the results are printed to stdout.
|-
|| -v || Verbose logging (default)
|-
|| -vv || Even more verbose logging
|-
!|Optional switch
!|Function
|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Test cases with variables ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456 -C /usr/share/blts-ofono-tests/blts-ofono.cnf</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

=== N900 specific ===
Before executing tests run <code>kill-telepathy</code> and after executing run <code>enable-telepathy</code> and boot device.

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|}

Quality/TestSuite/oFono Modem API Test Specification

2010-12-16T14:10:16Z

Klaakso:

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Hardware setup and test environment ===

==== Setting up oFono ====
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

==== Setting up phonesim ====

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Executing tests ===

Compile blts-ofono-tests with corresponding environment

<code>$ dpkg-buildpackge</code>

and install package to DUT. You'll need to have SIM card in DUT with correct pin number entered. Now you can execute tests from command prompt Execute from host end command line:

<code>$ blts-ofono </code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -l || Used log file, Used log file, default blts_ofono_log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -C || Used configuration file and path, for example /usr/share/blts-ofono-tests/blts-ofono.cnf
|-
|| -? || Help message
|-
|| -xml, -axml || Create result XML. -axml appends results to an existing XML file.
|-
|| -auto || Silent logging for test automation. Only the results are printed to stdout.
|-
|| -v || Verbose logging (default)
|-
|| -vv || Even more verbose logging
|-
!|Optional switch
!|Function
|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Test cases with variables ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456 -C /usr/share/blts-ofono-tests/blts-ofono.cnf</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

=== N900 specific ===
Before executing tests run <code>kill-telepathy</code> and after executing run <code>enable-telepathy</code> and boot device.

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|}

Quality/TestSuite/MCTS

2010-12-16T14:05:50Z

Klaakso: /* Test Suite Status For OS Base */

== MeeGo Core Test Suite (MCTS)==
=== Overview ===

* MCTS Development Guideline [[/MCTS_Development_Guideline | MCTS Development Guideline]] 
* Discussion about [[/MCTS_API_analysis | API analysis]] for MCTS functional test design
* Interested in contributing to MCTS ? Look at [[/MCTS_Start_Contributing | How to start contributing]]

=== Test Suite Code & API Coverage Analysis Repositories ===
You can get the code here: http://gitorious.org/qa-tools/mcts 
You can get the coverage analysis documents here: http://gitorious.org/qa-tools/mcts-coverage

=== MCTS Releases ===
MCTS is released typically in a biweekly cycle. The release process
is described in [[/MCTS_Release_Process | MCTS Release Process.]]

You can find information about the completed and planned MCTS releases from [[/MCTS_Releases | MCTS Releases.]]

=== Test Suite Status For Middleware (New) ===

{| cellspacing="0" border="1"
|-
!| '''Domain'''
!| '''Component'''
!| [http://wiki.meego.com/Quality/Plans/MeeGo_Core_Test_Plan Test Coverage]
!| '''% Ready'''
!| '''Auto %'''
!| [http://gitorious.org/qa-tools/mcts MCTS package]
!| '''Maintainer'''
!| '''Target Due'''
|-
| rowspan = "6" | Security

| Accounts || || || || WIP || ||

|-
| Single Sign-On || || || || WIP || ||

|-
| Integrity Protection Framework || || || || WIP || ||

|-
| Certificate Manager || || || || WIP || ||

|-
| SW Distribution Security || || || || WIP || ||

|-
| Access Control Framework || || || || WIP || ||

|-
| rowspan = "4" | System

| System Control || || || || WIP || ||

|-
| Resource Policy || Average || || || WIP || ||

|-
| Context Framework || Through || || || WIP || ||

|-
| Sensor Framework || Average || || || mcts-blts-sensor-frontend mcts-blts-sensor-plugins || ||

|-
| Location
| [[../GeoClue Test Plan | Location Framework]] || light ||100% ||100% || mcts-geoclue-tests || [mailto:shaofeng.tang@intel.com Shaofeng Tang] ||

|-
| rowspan = "5" | PIM

| Calendar Engine || Average || || || WIP || ||

|-
| Contacts Engine || Average || || || WIP || ||

|-
| Email Engine || Average || || || WIP || ||

|-
| Backup Framework || Average || || || WIP || ||

|-
| Synchronization Framework || Average || || || WIP || ||

|-
| rowspan = "3" | Multimedia

| Gstreamer || light || || || mcts-mwts-gstreamer mcts-mwts-gcamera || ||

|-
| PulseAudio || light ||100% ||100% || mcts-pulseaudio-tests mcts-blts-alsa-core || [mailto:hao.h.chen@intel.com Hao Chen] || Dec. 17 for test plan

|-
| UPnP || light ||100% ||0% || mcts-gupnp-tests || [mailto:daniel.tao@intel.com Daniel Tao] ||

|-
| rowspan = "4"| Communications
| Telephony & IM || light || || || mcts-mwts-telepathy || ||

|-
| [[/OFono Test Plan |Cellular Framework]] || Through ||100% ||36% || mcts-ofono-tests mcts-blts-ofono || [mailto:elva.fu@intel.com Elva Fu]||

|-
| [[/ConnMan Test Plan | ConnMan]] || Through ||100% ||43% || mcts-connman-tests || [mailto:jeff.zheng@intel.com Jeff Zheng] ||

|-
| [[/MeeGo Bluez Test Plan |Bluetooth]] || Average ||100% ||16% || mcts-bluez-tests mcts-blts-bluetooth || [mailto:jingke.zhang@intel.com Jingke] ||

|-
| rowspan = "3" | Qt
| Qt || || || || mcts-mwts-network mcts-mwts-telepathy || ||

|-
| Qt WebKit || || || || N/A || ||

|-
| Qt Web Runtime || || || || N/A || ||

|-
| rowspan = "9" | Qt Mobility
| QtM contacts || || || || WIP || ||

|-
| QtM Location || || || || mcts-mwts-location || ||

|-
| QtM Messaging || || || || mcts-mwts-messaging || ||

|-
| QtM Publish & Subscribe || || || || WIP || ||

|-
| QtM Sensors || || || || mcts-mwts-sensors || ||

|-
| QtM Service Framework || || || || WIP || ||

|-
| QtM Versit || || || || WIP || ||

|-
| QtM Multimedia || || || || mcts-mwts-multimedia || ||

|-
| QtM System Info || || || || WIP || ||

|-
| rowspan = "3" | [[../MeeGo_Graphics_Test_Plan | Graphics]]
| OpenGL ES || Average ||100% ||13% || mcts-qtgfx-tests mcts-blts-openles2-perf || [mailto:kui.zheng@intel.com Kui Zheng] ||

|-
| Font Management || || || || N/A || ||

|-
| X11 || Light ||100% ||100% || mcts-x-tests mcts-rendercheck-tests mcts-blts-fbdev || [mailto:kui.zheng@intel.com Kui Zheng] ||

|-
| Data Management || Content Framework || Through || || || mcts-tracker-tests || ||

|-
| SW Management
| Package Manager || light || || || mcts-packagekit-tests || [mailto:huajun.li@intel.com Huajun Li] || Dec. 17 for test plan

|-
| Kernel

| Linux Kernel || || || || mcts-blts-usb mcts-blts-input-devices mcts-mwts-filesystem || ||

|}

=== Released Middleware Test Asset Descriptions ===
[[../MWTS Asset Descriptions | Released Middleware Test Asset Descriptions]]

=== Test Suite Status For OS Base===
{|cellspacing="0" border="1"
!|Category
!|Component
!|Test Coverage
!|Planned #
!|Ready #
!|Auto %
!|Major Contacts
!|Due

|-
| rowspan = "16" | OS Base|| [[../Audio Driver Test Specification | Audio Driver]] || '''Light''' ||31||31||0% || [mailto:EXT-jussi.saavalainen@nokia.com Jussi Saavalainen]||tbd

|-
| [[../Bluetooth Driver Test Specification | Bluetooth Driver]] || '''Light''' || 23 || 23 || 0% ||[mailto:EXT-jussi.saavalainen@nokia.com Jussi Saavalainen]||tbd

|-
| [[../Camera Driver Test Specification | Camera Driver]] || '''Light''' || 12 || 12 || 0% ||[mailto:EXT-jussi.saavalainen@nokia.com Jussi Saavalainen]||tbd

|-
| [[../Functional Key Driver Test Plan | Functional Key Driver]] || '''Open''' || tbd || || || || tbd

|-
| [[../GPS Driver Test Plan | GPS Driver]] || '''Light''' || || || ||Jussi Saavalainen||tbd

|-
| [[../Input Devices Driver Test Specification | Input Devices Driver]] || '''Light''' || 3 || 3 || 0% || ||tbd

|-
| [[../oFono Modem API Test Specification | Modem Devices Driver]] || '''Light''' || N/A || N/A || N/A || ||tbd

|-
| [[../SD-MMC Driver Test Plan | SD/MMC Driver]] || '''Light''' || 33 || 33 || 0% ||Jussi Saavalainen ||Sep.3.2010

|-
| [[../Sensor Test Front-end | Sensor Driver]] || '''N/A''' || N/A || N/A || N/A || Pasi Matilainen ||tbd

|-
| [[../Touch Screen Driver Test Plan | Touch Screen Driver]] || '''Light''' || || || || Juhani Taipale||tbd

|-
| [[../Touchpad Driver Test Plan | Touchpad Driver]] || '''Open''' || tbd || || || ||tbd

|-
| [[../USB Driver Test Specification | USB Driver]] || '''Light''' || 35 || 35 || 0% ||[mailto:EXT-jussi.saavalainen@nokia.com Jussi Saavalainen] ||tbd

|-
| [[../Video Playback Driver Test Specification | Video Playback Driver]] || '''Average''' || 6 || 6 || 0% ||[mailto:kimmo.myllyvirta@digia.com Kimmo Myllyvirta] ||tbd

|-
| [[../Watchdog Driver Test Specification | Watchdog Driver]] || '''Average''' || 3 || 3 || 0% || [mailto:kimmo.myllyvirta@digia.com Kimmo Myllyvirta] ||tbd

|-
| [[../WIFI Driver Test Specification | WIFI Driver]] || '''Light''' || 10 || 10 || 0% ||Jussi Saavalainen ||tbd

|-
| [[../X11 Test Specification | X11]] || '''Light''' || 11 || 11 || 0% || [mailto:kimmo.myllyvirta@digia.com Kimmo Myllyvirta] ||tbd

|-
| [[../Framebuffer Test Specification | Framebuffer Driver]] || '''Light''' || 22 || 11 || 0% || [mailto:mika.niinisto@digia.com Mika Niinistö] ||tbd
|}

Quality/TestSuite/oFono Modem API Test Specification

2010-12-16T14:04:17Z

Klaakso:

== Introduction ==
Blts-ofono package (0.1.14) is meant to test oFono framework. Currently testing is done over D-Bus as well as those test coming with oFono. Difference is that these are written with C.

Currently supported version of oFono is 0.33.

== Test Coverage ==

The test cases are:
* oFono - Information Query: Tries specific interfaces from modem. Phonebook, network and modem interface.
* oFono - Register to network: Registers device in network
* oFono - De-register from network: De-registers device from network
* oFono - Enable modems: Enables as in powers up all modems in device
* oFono - Set modems online: Makes modems go Online, aka turn off Flight mode
* oFono - Set modems offline: Makes modems go Offline, aka turn on Flight mode
* oFono - Create voicecall with hidden caller ID: Tests if call can be made with hidden ID
* oFono - Create voicecall: Call creation test
* oFono - Answer to voicecall and hangup: Voicecall answer test
* oFono - Answer to voicecall and hangup all: Tests hangup all functionality
* oFono - Answer to voicecall and wait another call: Voicecall answer and waiting state test
* oFono - Answer to voicecall and deflect: Deflect incoming call
* oFono - Answer to voicecall and remote hang up: Tests that remote hangup works
* oFono - Cancel voicecall: Cancels incoming voicecall
* oFono - Transfer: To see that you can join two calls together and leave out yourself
* oFono - Swap: Putting calls on hold and back to active state
* oFono - Release and answer: Answer to incoming call and disconnecting other active call
* oFono - Hold and answer: Answer to incoming call while other call active
* oFono - Call and send DTMF: Sends DMTF tones
* oFono - Disable forwardings: Disables forward rules
* oFono - Unconditional forwarding: Sets unconditional forwarding
* oFono - Forward if busy: Sets forward rule when busy
* oFono - Forward if no reply: Sets forward rule when no reply
* oFono - Forward if not reachable: Sets forward rule if not reachable
* oFono - Send SMS: Sending SMS message
* oFono - Receive SMS: Receiving SMS
* oFono - Change PIN: Changes SIM pin codes (pin, pin2,...)
* oFono - Enter PIN: Enters PIN code and enables SIM if not done
* oFono - Reset PIN: Uses PUK code to reset PIN code
* oFono - Lock PIN: Lock specific PIN code
* oFono - Unlock PIN: Unlocks specific PIN code
* oFono - Set microphone volume: Microphone volume change in middle of call
* oFono - Set speaker volume: Speaker volume change in middle of call
* oFono - Set muted: Sets call muted in middle of call
* oFono - Call meters read: Read call meters status
* oFono - Call meters set: Sets call meters unit conversion, currency code and call meter maximum
* oFono - Call meters reset: Resets all call meters to zero
* oFono - Call meters near max warning: Creates call and waits if call meter maximum warning signal is received
* oFono - Check barring properties: Show current barring settings
* oFono - Disable barrings: Disables barring rules
* oFono - Disable incoming barrings: Disables barring from incoming calls
* oFono - Disable outgoing barrings: Disables barring from outgoing calls
* oFono - Change password for barrings: Changes PIN code for barrings
* oFono - Call barrings test: Tests different barring rules setting
* oFono - List all properties: Goes thought all possible interfaces and properties that oFono has
* oFono - Propose scan: Ask networks statuses
* oFono - SMSC number test: Test proper SMSC number validation
* oFono - Multiparty call test: Test multiparty call case
* oFono - Private call test: Tests creation of private chat out of multiparty call

=== Software Coverage ===
Current D-Bus API coverage for oFono tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/oFono-dbus-coverage.ods oFono-coverage-dbus.ods]]

Current oFono AT modem API coverage for oFono tests:
* oFono-coverage-at-modem.ods

=== Hardware Coverage ===
Blts-ofono tests oFono framework more than it tests actual hardware. Different hardware may have different modems and you must specify which modem to use with oFono by setting up oFono correctly.

=== Limitations ===
Test suite functionality depends on implementation of used modem driver in oFono. Some test cases may fail if driver implementation does not support such behaviour.

NOTE: All following installation and execution instructions for oFono and phonesim are for reference only. Later releases may work differently and it is advised to follow the installation and usage guidelines provided with both software packages as baseline for all testing.

=== Future Improvements ===
More coverage with tests for oFono.

== Running the tests ==

=== Setting up oFono ===
If test environment or device comes with oFono pre-installed, this section can be skipped.

In case oFono is not available, it is possible to either install binaries from repositories (if supported by test environment) or by downloading and building source codes from oFono.org.

To build oFono, follow these steps (replace <code>/directory</code> with the directory where make install should put the files):

:<code>$ ./configure --prefix=/directory</code> 
:<code>$ make</code> 
:<code>$ make install</code> 

Edit <code>/directory/etc/ofono/modem.conf</code> and add suitable configuration according to the DUT modem HW. The following example is for N900.

:<code>[isimodem]</code> 
:<code>Driver=isimodem</code> 

NOTE: You can also try to uncomment and enable oFono to use AT command based generic driver.

Prepare DUT:

# Copy everything from /directory to device root
# Copy all tests from test/ directory to device
# Copy src/ofono.conf to device /etc/dbus-1/system.d/
# Start oFono daemon (use -n and -d parameters for debug information):

:<code>$ ofonod -n -d</code>

=== Setting up phonesim ===

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is possible to run virtually all the test cases with phonesim. Phonesim basically emulates a modem device and network operation. It includes a GUI for testing for example creating voice calls and sending sms messages.

NOTE: Phonesim requires at least kernel version 2.6.28 with phonet support.

To use phonesim with oFono, follow the instructions below:

* Download and install oFono from source packages as described above with following differences
* Edit <code>/etc/ofono/modem.conf</code> and uncomment following lines

:<code>[phonesim]</code> 
:<code>Driver=phonesim</code> 
:<code>Address=127.0.0.1</code> 
:<code>Port=12345</code> 

* Copy modem.conf to /usr/local/etc/ofono/ (this depends on your configure --prefix settings)
* Do not run oFono yet!

* Download phonesim source package from ofono.org
* Build phonesim (You will need g++ and Qt packages, download and install as needed)

:<code>$ ./configure</code> 
:<code>$ make</code> 

* Run phonesim directly from src/ (terminal session will freeze and nothing visible happens)

:<code>$ ./phonesim -p 12345 -gui default.xml</code> 

* Run oFono directly from src/ with debugging mode (terminal session will freeze)

:<code>$ ./ofonod -n -d </code> 

* poke phonesim virtual modem to powered state via dbus:

:<code>$ dbus-send --system --print-reply --type=method_call --dest=org.ofono /phonesim org.ofono.Modem.SetProperty string:"Powered" variant:boolean:true</code>

or alternatively you may try to enable modem with oFono python script available with oFono source package

:<code>$ ./enable-modem</code> 

Phonesim GUI should now pop into screen. Tests can be executed as usual and you can make incoming calls and messages using phonesim GUI.

=== Executing tests ===

Compile blts-ofono-tests with corresponding environment

<code>$ dpkg-buildpackge</code>

and install package to DUT. You'll need to have SIM card in DUT with correct pin number entered. Now you can execute tests from command prompt Execute from host end command line:

<code>$ blts-ofono </code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -l || Used log file, Used log file, default blts_ofono_log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -C || Used configuration file and path, for example /usr/share/blts-ofono-tests/blts-ofono.cnf
|-
|| -? || Help message
|-
|| -xml, -axml || Create result XML. -axml appends results to an existing XML file.
|-
|| -auto || Silent logging for test automation. Only the results are printed to stdout.
|-
|| -v || Verbose logging (default)
|-
|| -vv || Even more verbose logging
|-
!|Optional switch
!|Function
|-
|| -r || Recipient address / phone number for voice call/SMS
|-
|| -m || SMS center address for SMS send
|-
|| -f || Number to forward calls in forward cases
|-
|| -h || Hangup timeout
|-
|| -n || New PIN code
|-
|| -o || Old (current) PIN code
|-
|| -y || PIN code type ("pin", "pin2", "puk", ..)
|-
|| -V || Call volume for Microphone/Speaker (0-100%)
|-
|| -a || Accumulated Call Meter maximum value
|-
|| -p || Price Per Unit conversion value
|-
|| -c || Three character currency code
|-
|| -t || Set timeout for test case execution
|-
|| --dontcleanup || Don't clean up call state before/after tests
|}

=== Test cases ===

Test cases must be run with root priviliges.

NOTE: Running cases always (if --dontcleanup switch is not used) resets call forwardings and call barrings with each test case use -o switch to give blts-ofono access to do so or use configuration file. If no pin code is given then default 3579 will be used.

Test cases marked with '''bold''' are able to be executed with variable data. See Test cases with variables.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| oFono - Information Query ||
|-
|| oFono - Register to network ||
|-
|| oFono - De-register from network ||
|-
|| oFono - Enable modems ||
|-
|| oFono - Set modems online ||
|-
|| oFono - Set modems offline ||
|-
|| '''oFono - Create voicecall''' || -r <number> chooses recipient
|-
|| ''' oFono - Create voicecall with hidden caller ID''' || -r <number> : Use <number> as call receiver
|-
|| oFono - Answer to voicecall and hangup || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and hangup all || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and wait another call || when "Start listening calls" is printed, call to DUT
|-
|| '''oFono - Answer to voicecall and deflect''' || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Answer to voicecall and remote hangup || when "Start listening calls" is printed, call to DUT, wait a moment and hang up
|-
|| oFono - Cancel voicecall || when "Start listening calls" is printed, call to DUT
|-
|| oFono - Transfer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Swap || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Release and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| oFono - Hold and answer || when "Start listening calls" is printed, call to DUT from two different number
|-
|| '''oFono - Call and send DTMF''' || -r <number> : Use <number> as deflect call receiver, -t <timeout> : Use <timeout> how long call is active.
|-
|| '''oFono - Disable forwardings''' || Disable all forwardings. Run this after any other forwarding case
|-
|| '''oFono - Unconditional forwarding''' || Forward all incoming calls, -f <number> chooses recipient
|-
|| '''oFono - Forward if busy''' || DUT makes call to given number, verify functionality by calling to DUT. -f <number> chooses recipient
|-
|| '''oFono - Forward if no reply''' || Forwards calls if not call is not replied, -f <number> chooses recipient
|-
|| '''oFono - Forward if not reachable''' || Forward call when DUT not reachable, -f <number> chooses recipient
|-
|| '''oFono - Send SMS''' || -r <number> chooses recipient , -m <number> chooses service centre (optional on NTN)
|-
|| oFono - Receive SMS || When "Waiting for message..." is printed, send SMS to DUT
|-
|| '''oFono - Change PIN''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN, -y <type> : Password type (pin, pin2,...) </nowiki>
|-
|| '''oFono - Enter PIN''' || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Reset PIN''' || <nowiki>-n <code> : PIN, -o <code> : PUK, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Lock PIN || <nowiki> -o <code> : PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| oFono - Unlock PIN || <nowiki> -o <code> : Old PIN code, -y <type> : Password type (pin, pin2,...)</nowiki>
|-
|| '''oFono - Set microphone volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent
|-
|| '''oFono - Set speaker volume''' || -r <number> : Use <number> as call receiver, -v <volume> : Use <volume> as volume percent.
|-
|| oFono - Set muted || -r <number> : Use <number> as call receiver
|-
|| oFono - Call meters read || -r <number> : Use <number> as call receiver
|-
|| '''oFono - Call meters set''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN, -a <value> : Use <value> as accumulated call meter maximum - optional, -p <value> : Use <value> as price per unit conversion - optional, -c <code> : Use <code> as three character currency code - optional</nowiki>
|-
|| '''oFono - Call meters reset''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| '''oFono - Call meters near max warning''' || <nowiki> -r <number> : Use <number> as call receiver, -o <code> : Old (current) PIN</nowiki>
|-
|| oFono - Check barring properties ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Disable incoming barrings''' ||
|-
|| '''oFono - Disable outgoing barrings''' ||
|-
|| '''oFono - Disable barrings''' ||
|-
|| '''oFono - Change password for barrings''' || <nowiki> -n <code> : New PIN, -o <code> : Old PIN</nowiki>
|-
|| '''oFono - Call barrings test''' || Tries to set barrings. It would be wise to execute "disable barrings" after this.
|-
|| oFono - List all properties ||
|-
|| oFono - Propose scan ||
|-
|| oFono - SMSC number test ||
|-
|| oFono - Multiparty call test ||
|-
|| oFono - Private call test ||
|}

=== Test cases with variables ===
To run test case with variable data you need to specify where configuration file is located. You can edit the configuration file yourself.

To run "oFono - Call and send DTMF" case you can use:

<code>blts-ofono -l /var/log/tests/oFono%20-%20Call%20and%20send%20DTMF.log -en "oFono - Call and send DTMF" -r 123456 -C /usr/share/blts-ofono-tests/blts-ofono.cnf</code>

Example of DTMF case variation:
<pre>
##############
# DTMF cases #
##############

[parameter]
name dtmf_length
const 1 5
[end_parameter]

[parameter]
name dtmf_chars
const "1" "2" "3" "4" "5" "6" "7" "8" "9" "0" "*" "#"
[end_parameter]

[parameter]
name dtmf_negative_chars
const "A" "B" "C" "D" "E" "F"
[end_parameter]

[parameter]
name dtmf_tones
generate dtmf_generator dtmf_chars dtmf_length
[end_parameter]

[test]
name "oFono - Call and send DTMF"
params remote_address dtmf_tones
[end_test]
</pre>

=== N900 specific ===
Before executing tests run <code>kill-telepathy</code> and after executing run <code>enable-telepathy</code> and boot device.

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| oFono.org || [http://ofono.org/ oFono website]]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 18-Nov-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Test case list and argument switches updated
|}

Quality/TestSuite/Sensor Test Front-end

2010-12-16T13:57:30Z

Klaakso: /* Building the test asset */

== Introduction ==

[[File:Blts_sensors_framework_architecture.png]]

The BLTS sensor test framework consists of the front-end test runner application, implemented in the blts-sensors-frontend package, and sensor test plug-ins, which are implemented in separate packages. The front-end implements a set of generic tests that are parameterized to execute sensor-specific tests. The sensor test plug-ins provide the front-end with access to sensor data by implementing a plug-in API, and specify in a configuration file how test cases are run. The front-end in turn loads sensor test plug-ins, and runs the test cases as configured.

This document describes the sensor test framework from a user's point of view. For information about developing sensor test plug-ins, see [[../Sensor plug-in API]]. For information about specific sensor test plug-ins, see the plug-in documentation.

== Running the tests ==

=== Hardware setup and test environment ===

The sensor test front-end does not have any requirements for the hardware on the test device, but individual sensor test plug-ins may have additional hardware requirements.

The test enviroment must have the following packages installed:

* libbltscommon1

=== Building the test asset ===

The build environment must have the following packages installed:

* libbltscommon1-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Test asset specific instructions ===

The test package can be installed in the device with the command

rpm -ivh blts-sensors-frontend_{version}.rpm

=== Executing tests ===

Before any tests can be executed, a sensor test plug-in must be installed on the device. Once a plug-in is installed, tests can be executed from command line:

blts-sensors-frontend -p <path_to_plug-in> -C <path_to_config>

Arguments:

{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function
|-
| -p || Specify the plug-in to test. This is the full path of the sensor plug-in .so.
|}

Sensor test plug-ins are installed to <tt>/usr/lib/tests/blts-sensor-plugins</tt>, and plug-in configuration files are installed to <tt>/etc/blts</tt>. For example, when using the example sensor test plug-in, the command line for running the tests would look like this:

blts-sensors-frontend -p /usr/lib/tests/blts-sensor-plugins/libbltssensor_example.so -C /etc/blts/blts-sensor-example.cnf

Test cases must be run with root privileges.

Documentation for sensor-specific test cases is provided by individual sensor test plug-in packages.

== References ==

{| cellspacing="0" border="1"
| blts-sensors-frontend || [http://gitorious.org/qa-tools/mcts/trees/master/mcts-blts/blts-sensors-frontend blts-sensors-frontend sources]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
| 0.1 || 7-Dec-2010 || [mailto:pasi.matilainen@digia.com Pasi Matilainen] || Draft || Page created
|}

Quality/TestSuite/WIFI Driver Test Specification

2010-12-16T13:35:43Z

Klaakso: /* Building packages */

== Introduction ==
nl80211 is the 802.11 netlink interface and cfg80211 is the linux wireless configuration API.

nl80211 is used to configure a cfg80211 device and together they are intended to replace Wireless-Extensions in the future.

== Test Coverage ==

=== Software Coverage ===
blts-wlan-core package (0.1.3) is testing nl80211 commands and also some Wireless-Extensions ioctls and events but only when corresponding nl80211 implementations are not available.

Current BLTS WLAN test coverage matrix:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/WLAN-core-coverage.ods WLAN-core-coverage.ods]]

=== Hardware Coverage ===

Linux wireless cards/drivers that support nl80211/cfg80211 (and Wireless Extensions).

=== Limitations ===

=== Future Improvements ===
Future test cases may include further tests for nl80211 commands which are not covered yet.

== Running the tests ==

=== Hardware setup and test environment ===
Required hardware for testing over the air:

;*test device, running the test asset
;*WLAN Access Point, for AP-using tests
;*a second test device or other supported device for "ad-hoc" (IBSS) tests.

Multiple access points with different static configurations can be used instead of changing the AP configuration directly. The access point used must support DHCP discovery, either by itself or via a suitable network arrangement. SSIDs, keys and passphrases used must be entered in the test configuration file.

The adhoc tests "Establish new adhoc network" and "Join established adhoc network" are counterparts and require two adhoc mode capable test devices, both running the test case.

The test environment must have following packages installed:
;*libbltscommon1

'''Setting up software simulator - mac80211_hwsim'''

If there is no suitable HW available for test execution or there is a need for verifying test case functionality, it is also possible to run some test cases with mac80211_hwsim.

mac80211_hwsim is a software simulator of 802.11 radios for mac80211. It is a Linux kernel module that can be used to simulate arbitrary number of IEEE 802.11 radios for mac80211.

The following steps are needed to use mac80211_hwsim to simulate radios and run test cases

1) build mac80211_hwsim as part of kernel configuration

2) load the kernel module (parameter 'radios' can be used to select how many radios are simulated - default 2)
<pre>
$ modprobe mac80211_hwsim
</pre>

Read further instruction about mac80211_hwsim usage from mac80211_hwsim web page (http://wireless.kernel.org/en/users/Drivers/mac80211_hwsim)

To simulate AP where the other station can associate to, the hostapd daemon (http://w1.fi/hostapd/) with a proper configuration file can be used
<pre>
$ hostapd hostapd.conf
</pre>

===Building packages===

The build environment must have the following packages installed:

* libbltscommon-devel
* libnl-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

===Configuration package===

The wlan-core-tests package is dependent on blts-wlan-core-tests-config configuration file package. The packaging script pach.sh creates RPM package blts-wlan-core-tests-config-example_{version}.rpm and it must be installed first. The configuration file /etc/blts/blts-wlan-core-tests.cnf is copied in the test device during RPM installation.

The configuration file package can be installed in the device with a command:
blts-wlan-core-tests-config-example_{version}.rpm

===Test asset specific instructions===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-wlan-core-tests_{version}.rpm
</pre>

'''Test case execution instructions:'''

The Enumerate hardware and Enumerate supported features tests run on a single device and do not require any existing access points. Enumerate hardware case can be configured to search expected phys (e.g. phy0) from the test device.

The configuration file used must be modified to match the test environment. SSIDs, keys and passphrases used must be entered in the test configuration file before testing.

Disconnect with AP loss test case waits about 60 seconds after connection is established that tester will turn off the AP where connection is made.
The test case shows tester a text "Turn off AP to pass this test" and will only continue if AP is turned off, otherwise timeout occurs and test case fails.

Test cases using established adhoc network are counter parts and these test cases must be executed at the same time with two devices, so that the establishing side must be executed first and the joining side soon after that. The name and used channel for established adhoc network can be configured in the configuration file. The SSID used here must be unique (no networks with a same name in the test environment) otherwise these tests fail.

===Test case arguments===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function
|-
|| -p || Enables profiling of ioctl calls
|-
|| -v || Verbose logging
|-
|| -S || (Power)Save mode on
|-
|| --nltrace || Print out raw Netlink commands as they are issued
|}

===Running test cases===

Test cases execution must be done with root privileges.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| Core-WLAN-Enumerate hardware ||
|-
|| Core-WLAN-Enumerate supported features ||
|-
|| Core-WLAN-Scan for specific AP ||
|-
|| Core-WLAN-Associate with open AP ||
|-
|| Core-WLAN-Associate with WEP encryption ||
|-
|| Core-WLAN-Scan and associate on max power save || overrides command line parameter -S (power save)
|-
|| Core-WLAN-Associate with WPA2-PSK AP ||
|-
|| Core-WLAN-Disconnect with deauthenticate ||
|-
|| Core-WLAN-Disconnect with disassociate ||
|-
|| Core-WLAN-Disconnect with AP loss || Turn off AP manually when "Turn off AP to pass this test" is printed
|-
|| Core-WLAN-Disconnect from adhoc network || requires existing open adhoc network where to connect
|-
|| Core-WLAN-Establish new adhoc network ||
|-
|| Core-WLAN-Join established adhoc network || remote must be running establish new adhoc network test case
|}

'''Test case descriptions and execution commands:'''

;* Core-WLAN-Enumerate hardware
: * Check that expected PHYs are found, then dump all PHYs, interfaces, and available configuration data
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Enumerate hardware"</code>

;* Core-WLAN-Enumerate supported features
: * Dump commands and parameters that are supported by device/driver
: * <code>$ blts-wlan-core-tests -en "<code>$ blts-wlan-core-tests -en "Core-WLAN-Enumerate hardware"</code>"</code>

;* Core-WLAN-Scan for specific AP
: * Trigger a new scan with a given ssid and verify that AP is actually found
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Scan for specific AP"</code>

;* Core-WLAN-Associate with open AP
: * Scan for open AP with a given ssid, after that do authentication and association requests, finally disconnect
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Associate with open AP"</code>

;* Core-WLAN-Associate with WEP encryption
: * Scan for AP with a given ssid, after that set WEP encryption keys and do connection request, send DHCP discover and finally disconnect
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Associate with WEP encryption"</code>

;* Core-WLAN-Scan and associate on max power save
: * Set max power save on and scan for open AP with a given ssid, after that connect and finally disconnect.
: * NOTE: overrides command line parameter -S (power save)
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Scan and associate on max power save"</code>

;* Core-WLAN-Associate with WPA2-PSK AP
: * Scan for AP with a given SSID, and associate. Perform WPA2 key exchange using pre-shared key.
: * Verify connection using DHCP discover and finally disconnect.
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Associate with WPA2-PSK AP"</code>

;* Core-WLAN-Disconnect with deauthenticate
: * Scan for open AP with a given ssid, after that do connection request, send DHCP discover and finally disconnect using
: * deauthenticate command while waiting until disconnect event is received.
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Disconnect with deauthenticate"</code>

;* Core-WLAN-Disconnect with disassociate
: * Scan for open AP with a given ssid, after that do connection request, send DHCP discover and finally disconnect using
: * disassociate command while waiting until disconnect event is received.
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Disconnect with disassociate"</code>

;* Core-WLAN-Disconnect with AP loss
: * Scan for open AP with a given ssid, after that do connection request, send DHCP discover and start waiting until disconnect event is received.
: * NOTE: Manual test where AP must be turned off in about 60 seconds before test case can be continued.
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Disconnect with AP loss"</code>

;* Core-WLAN-Disconnect from adhoc network
: * Scan for open adhoc network with a given ssid, after that join a IBSS and verify connection by sending test data and using scan
: * request, after that leave IBSS and verify that device is properly disconnected from adhoc network. NOTE: The requirement for this test
: * case is existing adhoc network where DUT can be joined or optionally wlan station that supports adhoc connections. NOTE2: if there is no
: * existing adhoc network in the test environment "Core-WLAN-Establish new adhoc network" can be also used as a counterpart for this test case.
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Disconnect from adhoc network"</code>

;* Core-WLAN-Establish new adhoc network
: * Estabish new IBSS with no encryption, after that start receiving test data packets and compare payload with expected data. This test case
: * fails if adhoc network with same SSID already exists. NOTE: This test case requires either "Core-WLAN-Join established adhoc network" or
: * optionally "Core-WLAN-Disconnect from adhoc network" as a counterpart and must be run first.
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Establish new adhoc network"</code>

;* Core-WLAN-Join established adhoc network
: * Scan for open adhoc network with a given ssid, after that join a IBSS and verify connection by sending test data that is verified in
: * the other DUT. NOTE: This test case requires "Core-WLAN-Establish new adhoc network" as a counterpart and must be run after it.
: * <code>$ blts-wlan-core-tests -en "Core-WLAN-Join established adhoc network"</code>

===Configuration file examples===

To run test cases with variable data you need to specify where configuration file is located or if no configuration file is given, test driver tries to use default /etc/blts/blts-wlan-core-tests.cnf

The configuration file must be edited to match your test environment.

Access point SSID parameters in blts-wlan-core.cnf configuration file:

;*open_ssid - SSID for an existing open AP
;*wep_ssid - SSID for an existing WEP-encrypted AP
;*wpa_ssid - SSID for an existing WPA-encrypted AP
;*adhoc_ssid - SSID for an existing open adhoc network
;*adhoc_ssid2 - SSID for established open adhoc network (adhoc network created during test runs)

To run "Core-WLAN-Associate with WEP encryption" case for example, execute the command:

<code>blts-wlan-core-tests -l /var/log/tests/Core-WLAN-Associate_with_WEP_encryption.log -en "Core-WLAN-Associate with WEP encryption" -C /etc/blts/blts-wlan-core-tests.cnf</code>

Example of WEP encryption case variation:
<pre>
# Parameter configuration for blts-wlan-core

# Valid wlan devices for HW.
[parameter]
name wlan_device
const "wlan0" "wlan1"
[end_parameter]

# SSID for an existing AP (change this to match your environment)
[parameter]
name ssid
const "test-1"
[end_parameter]

# WEP keys - wep key format "i:t:key", space separated
# i = index (0 - 3)
# t = type (a: = ASCII wep key / h: HEX wep key)
# e.g.
# first 0 index ascii wep key abcdef -> 0:a:abcdef
[parameter]
name wep_keys
const "0:a:abcde"
[end_parameter]

# WEP key index (0 - 3) - default key to transmit
[parameter]
name wep_tx_keyidx
const 0
[end_parameter]

# Tests

[test]
name "Core-WLAN-Associate with WEP encryption"
params wlan_device ssid wep_keys wep_tx_keyidx
[end_test]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| linuxwireless.org || [http://linuxwireless.org/en/developers/Documentation/nl80211/ nl80211 website]
|-
|| blts-wlan-core || [http://gitorious.org/qa-tools/mcts/trees/master/mcts-blts/blts-wlan-core/ blts-wlan-core tests]
|-
|| mac80211_hwsim || [http://wireless.kernel.org/en/users/Drivers/mac80211_hwsim mac80211_hwsim software simulator]
|-
|| hostapd || [http://w1.fi/hostapd/ hostapd daemon]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 3-Dec-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Page created (refers to blts-wlan-core test package 0.1.3)
|}

Quality/TestSuite/Watchdog Driver Test Specification

2010-12-16T13:33:15Z

Klaakso: /* Building packages */

== Introduction ==

A Watchdog Timer (WDT) is a hardware circuit that can reset the computer system in case of a software fault.
The blts-watchdog test module includes tests for watchdog devices via kernel's watchdog driver. Basically the
watchdog timer is 'pinged' by an application (usually by a user space watchdog daemon), and if a 'ping' is not
received within certain time, the watchdog device resets the device.

== Test Coverage ==

=== Software Coverage ===

The test driver module accesses watchdog driver via /dev/watchdog device. The watchdog is controlled with ioctls;
* WDIOC_GETTIMEOUT: Get current watchdog timeout
* WDIOC_SETTIMEOUT: Set current watchdog timeout
* WDIOC_GETSUPPORT: Get information about the watchdog device
* WDIOC_KEEPALIVE: Keep alive ping

=== Hardware Coverage ===

Hardware watchdog timers.

=== Limitations ===

Only one process can use the watchdog timer at a time, so the test module cannot access the watchdog device if there
is some watchdog daemon, or some other process using the watchdog running.

=== Future Improvements ===

TBD

== Running the tests ==

=== Hardware setup and test environment ===

The test device must include a watchdog device, and the driver for the watchdog device must be loaded. The test environment must have the following packages installed:

* '''libbltscommon1'''

=== Building packages ===

The build environment must have the following packages installed:

* libbltscommon-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Configuration package ===

The watchdog test package does not require any separate configuration package.

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-watchdog-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments:
{{:Quality/TestSuite/Common_General_Switch}}

=== Running test cases ===

Test cases must be executed with root privileges.

Test case descriptions and execution instructions:

* '''Core-Watchdog presence check'''
** Simple existence check for watchdog
** <code>blts-watchdog-tests -en "Core-Watchdog presence check"</code>

* '''Core-Open and close watchdog'''
** Open watchdog device node, query information
** <code>blts-watchdog-tests -en "Core-Open and close watchdog"</code>

* '''Core-Send keepalive messages'''
** Set keepalive timeout, send keepalive messages to watchdog for ten seconds. Note that the device should reboot after the test case finishes.
** <code>blts-watchdog-tests -en "Core-Send keepalive messages"</code>

== Module Design and Architecture ==

The test module can be compiled to a self-sufficient command line program. Debian and RPM packaging is provided.

== References ==

{|cellspacing="0" border="1"
|-
| Watchdog API || [http://www.mjmwired.net/kernel/Documentation/watchdog/watchdog-api.txt Watchdog Driver api]
|-
| blts-watchdog || [http://gitorious.org/qa-tools/mcts/trees/master/mcts-blts/blts-watchdog blts-watchdog sources]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
| 0.1 || 10-Dec-2010 || [mailto:pasi.matilainen@digia.com Pasi Matilainen] || Draft || Page created
|}

Quality/TestSuite/Pixel Format Library

2010-12-16T13:31:50Z

Klaakso: /* Building packages */

== Introduction ==

Blts-pixelformat package (0.1.4) provides a pixel format conversion API for the BLTS test assets.

The conversion code is based on the libswscale library of the FFMPEG project (http://www.ffmpeg.org), with modifications to remove unnecessary code. Support for additional V4L2 pixel formats has also been added.

=== Limitations ===

For some pixel formats, only limited conversion support is available:

;* V4L2_PIX_FMT_SBGGR8, V4L2_PIX_FMT_SBGGR16, V4L2_PIX_FMT_SGRBG10 (Bayer formats)
: * Can be converted only to V4L2_PIX_FMT_RGB24
: * Cannot be used as target formats
;* V4L2_PIX_FMT_RGB555X, V4L2_PIX_FMT_RGB565X (big-endian 15- & 16-bit RGB)
: * Can be converted to different YUV formats and to V4L2_PIX_FMT_RGB24
: * Cannot be used as target formats

=== Building packages ===

The build environment must have the following packages installed:

* libbltscommon-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

===Using the pixel format conversion library with blts tests===

Some of blts test packages have dependency to the blts-pixelformat package and blts-pixelformat package itself has dependency to the blts-common package.

The test environment must have following packages installed:
;*libbltscommon1

The library package can be installed in the device by executing the command:

<pre>
rpm -ivh libbltspixelformat1_{version}.rpm
</pre>

===Using the pixel format conversion API===

The development package can be installed by executing the command:

<pre>
rpm -ivh libbltspixelformat-devel_{version}.rpm
</pre>

The pixel format conversion API is defined in the file '''blts-pixelformat.h''' and at the moment there is only one conversion function to use '''convert_buffer()''':

<pre>
#include <blts-pixelformat.h>
#include <linux/videodev2.h> //for pixel format identifiers

int convert_buffer(int width, int height, const unsigned char* srcbuffer, __u32 srcformat, unsigned char** dstbuffer, __u32 dstformat);
</pre>

convert_buffer() converts the image data in srcbuffer from the source pixel format to the destination pixel format. After a successful conversion, dstbuffer contains a pointer to the converted image buffer. The buffer is allocated dynamically in the conversion function, and must be freed by the caller.

After a successful conversion, dstbuffer contains a pointer to the converted image, and the function returns the size of the converted image in bytes.

If the conversion fails, an error code is returned:
;*-1 The source or destination format is not supported
;*-2 Internal conversion error

The pixel formats are specified with V4L2 pixel format identifiers. The supported formats are:

;*V4L2_PIX_FMT_RGB332
;*V4L2_PIX_FMT_RGB444
;*V4L2_PIX_FMT_RGB555
;*V4L2_PIX_FMT_RGB565
;*V4L2_PIX_FMT_RGB555X
;*V4L2_PIX_FMT_RGB565X
;*V4L2_PIX_FMT_RGB24
;*V4L2_PIX_FMT_BGR24
;*V4L2_PIX_FMT_BGR32
;*V4L2_PIX_FMT_RGB32
;*V4L2_PIX_FMT_GREY
;*V4L2_PIX_FMT_Y16
;*V4L2_PIX_FMT_YUYV
;*V4L2_PIX_FMT_UYVY
;*V4L2_PIX_FMT_Y41P
;*V4L2_PIX_FMT_YVU420
;*V4L2_PIX_FMT_YVU410
;*V4L2_PIX_FMT_YUV422P
;*V4L2_PIX_FMT_YUV411P
;*V4L2_PIX_FMT_NV12
;*V4L2_PIX_FMT_SBGGR8
;*V4L2_PIX_FMT_SBGGR16
;*V4L2_PIX_FMT_SGRBG10
;*V4L2_PIX_FMT_YUV444
;*V4L2_PIX_FMT_YUV555
;*V4L2_PIX_FMT_YUV565
;*V4L2_PIX_FMT_YUV32

== Module Design and Architecture ==

Both Debian and RPM packaging is provided.

The blts-pixelformat package consists of libbltspixelformat1 runtime library and libbltspixelformat-devel development library.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| blts-pixelformat || [http://gitorious.org/qa-tools/mcts/trees/master/mcts-blts/blts-pixelformat/ blts-pixelformat library]
|-
|| www.ffmpeg.org || [http://www.ffmpeg.org/ FFmpeg project]
|-
|| linux.bytesex.org || [http://linux.bytesex.org/v4l2 video4linux website]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 15-Dec-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Page created (refers to blts-pixelformat package 0.1.4)
|}

Quality/TestSuite/Video Playback Driver Test Specification

2010-12-16T13:30:43Z

Klaakso: /* Building packages */

== Introduction ==
The X Window System (commonly X or X11) is a computer software system and network protocol that provides a graphical user interface (GUI). Base X Window System is extended by X Extension libraries (mainly from freedesktop.org and XFree86 projects).

The blts-xvideo test driver (0.0.7) includes functional and performance tests specifically for XVideo extension.

== Test Coverage ==

The test driver currently covers X11 XVideo extension:
* XVideo - Presence check: Simple XVideo extension presence check
* XVideo - Enumerate adapters: List all information from all XVideo adapters
* XVideo - XvPutImage benchmark: Tests XvPutImage performance and functionality. Uses various resolutions, pixel formats and port attributes depending on configuration file.
* XVideo - XvShmPutImage benchmark: Tests XvShmPutImage performance and functionality. Uses various resolutions, pixel formats and port attributes depending on configuration file.
* XVideo - PutImage with QueryBestSize: Functional test for QueryBestImage. Queries best size with different input and output resolutions and tries to display images with the returned size.
* XVideo - Notify events: Functional test for XvPortNotify/XvVideoNotify. Requests events and tries to trigger events from a different process

=== Software Coverage ===
Current coverage for tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/XVideo-coverage.ods XVideo-coverage.ods]]

=== Hardware Coverage ===
Mainly display devices (and GPU).

== Running the tests ==

=== Hardware setup and test environment ===

The test environment must have following packages installed:
;*libbltscommon1
;*[[../Pixel Format Library‎ | libbltspixelformat1]]
;*libX11
;*libXv

=== Building packages ===

The build environment must have the following packages installed:

* libbltscommon-devel
* [[../Pixel Format Library‎ | libbltspixelformat-devel]]
* libX11-devel
* libXv-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Configuration package ===

The blts-xvideo-tests package is dependent on blts-xvideo-tests-config configuration file package. The packaging script pack.sh creates RPM package blts-xvideo-tests-config-example_{version}.rpm and it must be installed first. The configuration file /etc/blts/blts-xvideo-tests.cnf is copied in the test device during RPM installation.

The configuration file package can be installed in the device by executing the command:

<pre>
rpm -ivh blts-xvideo-tests-config-example_{version}.rpm
</pre>

=== Test asset specific instructions ===

The test package can be installed in the device by executing the command:

<pre>
rpm -ivh blts-xvideo-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}

Test cases must be run with root privileges.

=== Test cases ===
Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| XVideo - Presence check || verified components are listed in file blts-xvideo-req-files.cfg
|-
|| XVideo - Enumerate adapters ||
|-
|| XVideo - XvPutImage benchmark ||
|-
|| XVideo - XvShmPutImage benchmark ||
|-
|| XVideo - PutImage with QueryBestSize ||
|-
|| XVideo - Notify events ||
|}

'''Test case descriptions and execution commands:'''

;* XVideo - Presence check
: * Simple XVideo extension presence check
: * <code>$ blts-xvideo-tests -en "XVideo - Presence check"</code>

;* XVideo - Enumerate adapters
: * List all information from all XVideo adapters
: * <code>$ blts-xvideo-tests -en "XVideo - Enumerate adapters"</code>

;* XVideo - XvPutImage benchmark
: * Tests XvPutImage performance and functionality.
: * Uses various resolutions, pixel formats and port attributes depending on configuration file.
: * <code>$ blts-xvideo-tests -en "XVideo - XvPutImage benchmark"</code>

;* XVideo - XvShmPutImage benchmark
: * Tests XvShmPutImage performance and functionality.
: * Uses various resolutions, pixel formats and port attributes depending on configuration file.
: * <code>$ blts-xvideo-tests -en "XVideo - XvShmPutImage benchmark"</code>

;* XVideo - PutImage with QueryBestSize
: * Functional test for QueryBestImage.
: * Queries best size with different input and output resolutions and tries to display images with the returned size.
: * <code>$ blts-xvideo-tests -en "XVideo - PutImage with QueryBestSize"</code>

;* XVideo - Notify events
: * Functional test for XvPortNotify/XvVideoNotify. Requests events and tries to trigger events from a different process.
: * <code>$ blts-xvideo-tests -en "XVideo - Notify events"</code>

=== Configuration file examples ===
Configuration file contains used parameters for benchmarks. To run test case with variable data you need to specify where configuration file is located or if no configuration file is given, test driver tries to use default /etc/blts/blts-xvideo-tests.cnf

To run "X11-XVideo PutImage with QueryBestSize" case you can use:
<code>blts-xvideo-tests -l /var/log/tests/X11-XVideo_PutImage_with_QueryBestSize.log -en "X11-XVideo PutImage with QueryBestSize" -C example-blts-xvideo.cnf</code>

<pre>
######################
# General parameters #
######################

# defines generated video material resolution
[parameter]
name input_resolution
const "800x600" "1600x1200"
[end_parameter]

# if output resolution is 0x0, resolution will be root window's size
[parameter]
name output_resolution
const "0x0" "1600x1200"
[end_parameter]

# duration of tests
[parameter]
name duration
const 5
[end_parameter]

# used X screen(s)
[parameter]
name screen
const 0
[end_parameter]

# used XVideo adaptor(s)
[parameter]
name adaptor
const 0
[end_parameter]

# Possible choices for test images:
# random: three frames of random pixels
# vh_lines: two frames, horizontal and vertical lines
# checkerboard: two frames, b/w checkerboard
# moving_arrow: white arrow moving from left to right and pointing up
# fps_check: two frames, blocks change between black and white
# colorgradient: red, green and blue gradients
# graygradient: full screen grayscale, from black (left) to right
# colorgradient_scroll: red, green and blue gradients, moves from left to right
# graygradient_scroll: full screen grayscale, moves from left to right
[parameter]
name test_images
const "colorgradient_scroll"
[end_parameter]

# used pixel formats (fourcc)
[parameter]
name format
const "YUY2" "YV12" "I420" "UYVY"
[end_parameter]

# used port attributes for XVideo adaptor
[parameter]
name port_attributes
const "XV_VSYNC 0 XV_BRIGHTNESS 0 XV_CONTRAST 0"
[end_parameter]

# These are for QueryBestSize and Notify events -tests

[parameter]
name fute_format
const "YUY2"
[end_parameter]

[parameter]
name fute_port_attributes
const "XV_VSYNC 0"
[end_parameter]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| X11 || [http://www.x.org/wiki/ X11 home page]
|-
|| freedesktop.org || [http://www.freedesktop.org/ freedesktop.org home page]
|-
|| XFree86 || [http://www.xfree86.org XFree86 home page]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 8-Dec-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Documentation updated to refer blts-xvideo test package 0.0.7
|}

Quality/TestSuite/USB Driver Test Specification

2010-12-16T13:29:28Z

Klaakso: /* Building packages */

== Introduction ==

blts-usb package (0.0.14) is test driver using USB host and peripheral devices.

USB peripheral test cases are made between host (e.g. PC) and peripheral gadget (e.g. N900). Both ends have their own drivers which communicate and transfer data between different endpoints.

== Test Coverage ==

Each test case must be run independently and devices must be preset according to case requirements using provided setup test cases. In practice, this means for example data transfer requires preconnected host enabled USB cable and host mode supporting device is connected to system. Each test case prints out required user interaction to terminal.
* USB - Setup host driver
* USB - Setup peripheral driver
* USB - Read test
* USB - Write test

=== Software Coverage ===

Current coverage for USB tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/USB-core-coverage.ods USB-coverage.ods]]

=== Hardware Coverage ===

Configurable USB endpoint transfer test cases.

=== Limitations ===
* Drivers must be initialized before running other test cases.
* All other gadget drivers MUST be unloaded before test execution in used DUT!
* All USB cables MUST be disconnected when executing initializations!

=== Future Improvements ===
* Automated test execution and peripheral DUT driver selection.
* Official unique USB driver ID.

== Running the tests ==

=== Hardware setup and test execution order ===

Required hardware:
* Supported USB cable
* Device with USB host capability (e.g. PC)
* Device with USB peripheral capability (e.g. Nokia N810/N900)

How to setup test environment:
# Make sure usb cable is disconnected between devices
# Set up host side (e.g. PC) by running test 'USB - Setup host driver'
# Set up gadget side (peripheral device) by running test 'USB - Setup peripheral driver'
# Connect cable
# Execute tests

NOTE: Before executing test cases it must be determined if used devices are capable of acting as peripheral or host. This depends on USB controller chips of devices and necessary information should be available from device vendors. 

To run test cases, execute the command:

<code>$ blts_usb_testrunner -C [config file] -e [test number]</code>

The test environment must have following packages installed:
;*libbltscommon1

===Building packages===

The build environment must have the following packages installed:

* libbltscommon-devel
* kernel-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Configuration package ===

The blts-usb package is dependent on blts-usb-tests-config configuration file package. The packaging script pack.sh creates RPM package blts-usb-tests-config-example_{version}.rpm and it must be installed first. The configuration files are copied in the test device during RPM installation.

The configuration file package can be installed in the device with a command:

<pre>
rpm -ivh blts-usb-tests-config-example_{version}.rpm
</pre>

This test asset uses two configuration files: One for generic test execution options and one for endpoint configuration. Endpoint configuration file is linked to base configuration files thus only base file path is given as parameter. Configuration files must be used, as they contain endpoint configuration for driver.

Currently following example base configuration file is included in the package:
* blts-usb-testrunner-default.cnf

The base files are linked to endpoint configuration files and following example is provided with test package:
* ep-configuration-default.cfg

NOTE: Supported endpoint configurations differ from device to device and they should be modified according to test execution requirements. These configuration files are provided as examples and should not be used as such during proper test execution.

For further instructions on creating and using configuration files, see [http://wiki.meego.com/Quality/TestSuite/USB_Driver_Test_Specification#Configuration_file_examples Configuration file examples].

===Test asset specific instructions===

The test package can be installed in the device by executing the command:

<pre>
rpm -ivh blts-usb-tests_{version}.rpm
</pre>

'''Common test execution guidelines'''

NOTE:
* Default config files are installed to /etc/blts
* Drivers must be initialized before running other test cases.
* All USB cables MUST be disconnected when executing initializations!

NOTE:
All other gadget drivers MUST be unloaded before test execution in used DUT!

You can use command lsmod to determine which modules are loaded in memory:

<code>$ lsmod</code>

See if some gadget driver is found. For example g_file_storage is a mass storage module, but this depends on used HW and SW. The module can be unloaded with following command:

<code>$ modprobe -r g_file_storage</code>

=== Test case arguments ===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function
|-
|| -h || Use given host driver (default: blts_usb_host), for example -h blts_usb_host
|-
|| -p || Use given peripheral driver (default: blts_gadget), for example -h blts_gadget
|}

=== Running test cases ===
Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| USB - Setup host driver* ||
|-
|| USB - Setup peripheral driver# || Use configuration file to create specific setup, bulk endpoints are created by default
|-
|| USB - Read test* || Read data from endpoints
|-
|| USB - Write test* || Write data to endpoints
|}
''* This test is run on host device.'' 
''# This test is run on peripheral device.''

'''Test case descriptions and execution commands:'''

;* USB - Setup host driver
: * Setup host driver for test execution. Command line parameter:
: * -h <name> : Use <name> as host driver (default: blts_usb_host)
: * <code>$ blts-usb-tests -en "USB - Setup host driver"</code>

;* USB - Setup peripheral driver
: * Setup peripheral driver for test execution. Command line parameter:
: * -p <name> : Use <name> as peripheral driver (default: blts_gadget)
: * <code>$ blts-usb-tests -en "USB - Setup peripheral driver"</code>

;* USB - Read test
: * Read data from available endpoints. Command line parameter:
: * -h <name> : Use <name> as host driver (default: blts_usb_host)
: * <code>$ blts-usb-tests -en "USB - Read test"</code>

;* USB - Write test
: * Write data to available endpoints. Command line parameter:
: * -h <name> : Use <name> as host driver (default: blts_usb_host)
: * <code>$ blts-usb-tests -en "USB - Write test"</code>

=== Configuration file examples ===
The test asset allows you to change all endpoint parameters via configuration files. Since the USB (2.0) specification only states the valid range for different settings, it is possible to give any values as long as they fit inside these ranges. The test asset allows experimenting with different configurations and "triangulation" of what works and what does not. Naturally there are certain HW related restrictions such as total transfer capacity which obviously cannot be exceeded with endpoint configuration. Basic test asset configurations is done with base configuration files, such as provided <code>blts-usb-testrunner-default.cnf</code>:

<pre>
# USB test case configuration for parameters

######################
# General parameters #
######################

[parameter]
name host_driver
const "blts_usb_host"
[end_parameter]

[parameter]
name host_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name peripheral_driver
const "blts_gadget"
[end_parameter]

[parameter]
name peripheral_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name data_transfer_timeout
const "10000"
[end_parameter]

[parameter]
name usb_transfer_size
const 4096
[end_parameter]

##########################
# Endpoint configuration #
##########################

[parameter]
name ep_configuration_file
const "/etc/blts/ep-configuration-default.cfg"
[end_parameter]

################
# Driver setup #
################

[test]
name "USB - Setup host driver"
params host_driver host_driver_path
[end_test]

[test]
name "USB - Setup peripheral driver"
params peripheral_driver peripheral_driver_path usb_transfer_size ep_configuration_file
[end_test]

#######################
# Data transfer cases #
#######################

[test]
name "USB - Read test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]

[test]
name "USB - Write test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]
</pre>

To change the endpoint configuration, you will have to edit ep-configuration files. For example, provided <code>ep-configuration-default.cfg</code> looks like this by default:
<pre>
# device_speed used_speed max_power
high any 50
# endpoint type direction max_packet_size interval
1 bulk in 512 9
2 bulk out 512 9
</pre>
The lines starting with # are comments and document provided parameters. Device_speed is the highest speed used device is supposed to be able handle (any/low/full/high) and used_speed the operational speed during test execution. This can be used to force the device to use lower speed than normally would be used. To add new pair of bulk endpoints simply add following lines to the file:
<pre>
3 bulk in 512 9
4 bulk out 512 9
</pre>
Do note that you can put different endpoint types to the same configuration so there can be any combination of bulk, interrupt and isochronous endpoints as long as device supports this.

== Module Design and Architecture ==

Both Debian and RPM package is provided. The package includes both host and peripheral drivers in addition to test runner. This package can be installed on all devices under testing, although functionality depends on used hardware.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
| USB Specification || [http://www.usb.org/developers/docs/ USB documentation]
|-
|| blts-usb || [http://gitorious.org/qa-tools/mcts/trees/master/mcts-blts/blts-usb/ blts-usb tests]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 8-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 15-Dec-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Page updated to refer blts usb test package 0.0.14
|}

Quality/TestSuite/Input Devices Driver Test Specification

2010-12-16T13:28:23Z

Klaakso: /* Building packages */

== Introduction ==

The blts-input-devices (0.0.2) test driver is intended for testing input devices using kernel's input subsystem. The input subsystem basically exposes the raw input events to userspace through a collection of character device nodes — one character device node per logical input device.

== Test Coverage ==

Test cases are:
* Input - Enumerate devices: Queries information (version, capabilities, name etc.) from all the input devices defined in configuration file.
* Input - Single touch: The test case expects user to touch 4 quadrants of the screen, one at a time. Position and received events are verified.
* Input - Multi-touch: The test case expects user to touch 2 quadrants of the screen simultaneously. Position and received events are verified.

=== Software Coverage ===
Current coverage for tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/Input-coverage.ods Input-coverage.ods]]

=== Hardware Coverage ===
Hardware coverage includes mainly touchscreen. Enumerate devices -test case can be used to verify existence and basic functionality of any input device.

== Running the tests ==

=== Hardware setup and test environment ===

The test environment must have following packages installed:
;*libbltscommon1
;*libX11

=== Building packages ===

The build environment must have the following packages installed:

* libbltscommon-devel
* libX11-devel
* kernel-headers

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Configuration package ===

The blts-input-devices-tests package is dependent on blts-input-devices-tests-config configuration file package. The packaging script pack.sh creates RPM package blts-input-devices-tests-config-example_{version}.rpm and it must be installed first. The configuration file /etc/blts/blts-input-devices-tests.cnf is copied in the test device during RPM installation.

The configuration file package can be installed in the device by executing the command:

<pre>
rpm -ivh blts-input-devices-tests-config-example_{version}.rpm
</pre>

=== Test asset specific instructions ===

The test package can be installed in the device by executing the command:

<pre>
rpm -ivh blts-input-devices-tests_{version}.rpm
</pre>

=== Test case arguments ===

Arguments: 

{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function
|-
|| -g || Do not grab the devices exclusively
|-
|| -d || Debug specific device. This is for development purposes.
|}

Test cases must be run with root privileges.

=== Test cases ===
Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| Input - Enumerate devices ||
|-
|| Input - Single touch ||
|-
|| Input - Multi-touch ||
|}

'''Test case descriptions and execution commands:'''

;* Input - Enumerate devices
: * Checks existence of input devices, and queries information from them.
: * <code>$ blts-input-devices-tests -en "Input - Enumerate devices"</code>

;* Input - Single touch
: * Touchscreen test with single touch point. The test case expects user to touch 4 quadrants of the screen, one at a time.
: * <code>$ blts-input-devices-tests -en "Input - Single touch"</code>

;* Input - Multi-touch
: * Touchscreen test with 2 (or more) touch points. The test case expects user to touch 2 quadrants of the screen simultaneously.
: * <code>$ blts-input-devices-tests -en "Input - Multi-touch"</code>

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located or if no configuration file is given, test driver tries to use default /etc/blts/blts-input-devices-tests.cnf

To run "Input - Enumerate devices" case you can use:
<code>blts-input-devices-tests -l /var/log/tests/Enumerate_devices.log -en "Input - Enumerate devices" -C blts-input-devices-tests.cnf</code>

Input devices are platform specific. Modify the configuration file with correct input devices and settings if needed.

<pre>
# Input devices to test (currently used only by Enumerate devices -test case)
# Give either an absolute path (for example "/dev/input/event1"), or just
# name of the device node (for example, "event1").
[parameter]
name input_devices
const "event1 event3 event4"
[end_parameter]

# Used pointer device (currently only touchscreen devices are supported, for
# example mice will not work)
[parameter]
name pointer_device
const "event4"
[end_parameter]

# Screen orientation; 0 = TS and screen coordinate system is the same,
# 1 = swap X and Y axis
[parameter]
name scr_orientation
const 0
[end_parameter]

# Screen size in pixels
[parameter]
name scr_size
const "864x480"
[end_parameter]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| Linux kernel || [http://www.kernel.org/ Kernel sources]
|-
|| blts-input-devices || [http://gitorious.org/qa-tools/mcts/trees/master/mcts-blts/blts-input-devices/ blts-input-devices tests]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 10-Dec-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Page created (refers to blts-input-devices test package 0.0.2)
|}

Quality/TestSuite/Camera Driver Test Specification

2010-12-16T13:27:08Z

Klaakso: /* Building packages */

== Introduction ==

V4L2 API is a kernel interface for analog radio and video capture and output drivers.

Blts-v4l2 package (0.3.8) is meant to test V4L2 functionality. The blts-v4l2 package tests camera driver functionality by checking e.g. capabilities and controls. There is also tests that stream frames (using XVideo) and take snapshots (saved as JPG pictures) using different resolutions. Some of these test cases also measure FPS rates. The audio part of the V4L2 API is not in the scope.

== Test Coverage ==

The test cases are:
* Core-Camera-Open device: Try to open a V4L2 device
* Core-Camera-Read device: Open V4L2 device to requested width and height
* Core-Camera-Check device controls: Enumerate through V4L2 device controls
* Core-Camera-Check device capabilites: Check and print V4L2 device capabilities
* Core-Camera-Check device formats: Enumerate and print V4L2 device formats
* Core-Camera-Measure device stepping down resolution: Step down resolutions and calculate FPS using V4L2 device
* Core-Camera-Stream from device to screen: Stream frames from V4L2 device to screen using XVideo
* Core-Camera-Measure device FPS with defined resolution: Use a given resolution and calculate FPS using V4L2 device
* Core-Camera-Take picture as JPEG with device: Take one frame from V4L2 device and create a JPG file
* Core-Camera-Device enumeration: Enumerate V4L2 input and output devices and print supported standards
* Core-Camera-Stream from device and crop corners: Stream frames from V4L2 device to screen using XVideo and use cropping
* Core-Camera-Read from device using poll: As "Measure device FPS", but use poll() to detect device readiness.
* Core-Camera-Test standard control settings: Enumerate all standard controls, and test each available control with suitable values
* Core-Camera-Test extended control settings: Enumerate all extended controls, and test each available control with suitable values
* Core-Camera-Check device FD priority: Init a device and check if it supports priorities
* Core-Camera-Stream from device and vary frame rate: Stream frames from V4L2 device to screen and vary frame rates and calculate FPS
* Core-Camera-Get stream quality setting: Stream frames from V4L2 and get the quality setting
* Core-Camera-Set stream quality setting to high: Set stream quality setting to high, stream from the device and check the setting is used
* Core-Camera-Check debug capability: Get state from driver to kernel log, API function doesn't need to be supported
* Core-Camera-Select output and stream: Selects and tests possible outputs of device
* Core-Camera-Select input and stream: Selects and tests possible inputs of device.
* Core-Camera-Test input device standards: Loops through V4L2 input devices and tests video standards

=== Software Coverage ===
Current IOCTL coverage for v4l2 tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/V4L2-coverage.ods V4l2-coverage.ods]]

=== Hardware Coverage ===
At the moment test cases are configured to test main and front cameras. The audio functionality of the test device is excluded.

=== Limitations ===
* Test suite functionality depends on implementation of used device driver in v4l2.

=== Future Improvements ===
* More coverage with tests for v4l2.

== Running the tests ==

=== Hardware setup and test environment ===

The test environment must have following packages installed:
;*libbltscommon1
;*[[../Pixel Format Library‎ | libbltspixelformat1]]
;*libjpeg
;*libX11
;*libXv

=== Building packages ===

The build environment must have the following packages installed:

* libbltscommon-devel
* [[../Pixel Format Library‎ | libbltspixelformat-devel]]
* libjpeg-devel
* libX11-devel
* libXv-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

=== Configuration package ===

The blts-v4l2-tests package is dependent on blts-v4l2-tests-config configuration file package. The packaging script pack.sh creates RPM package blts-v4l2-tests-config-example_{version}.rpm and it must be installed first. The configuration file /etc/blts/blts-v4l2-tests.cnf is copied in the test device during RPM installation.

The configuration file package can be installed in the device with a command:

<pre>
rpm -ivh blts-v4l2-tests-config-example_{version}.rpm
</pre>

=== Test asset specific instructions ===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-v4l2-tests_{version}.rpm
</pre>

The control setting test cases support external image verification tool.

'''Image verification'''

The standard and extended control tests support verification of the camera snapshot image using an external tool. Image verification is enabled by specifying values for the <code>image_save_path</code> and <code>image_verify_tool</code> global configuration parameters, and by giving the -i command line flag when running the test. Once a camera snapshot has been saved for a certain control setting, the tool given in <code>image_verify_tool</code> is run with a command line like this:
<code>verify_tool <snapshot image name> <control name> <V4L2 control id> <control value></code>

The verification tool should return zero when the image is verified successfully, and a non-zero value when the verification fails. The output of the tool is appended to the log file of the test.

'''Control value limits and test values'''

The minimum and maximum values reported by the V4L2 driver can be compared with values specified in the configuration file. The test succeeds if the values match exactly, and fails otherwise. The minimum and maximum values are specified as global configuration parameters, with a special naming format:

<code>dev<number of device>_<escaped control name>_min = <minimum value></code>
<code>dev<number of device>_<escaped control name>_max = <maximum value></code>

As the global configuration value identifiers cannot contain spaces or any of the /()[] characters, which may be present in the name of a V4L2 control, the control name must be escaped by replacing spaces with underscores, and by removing any prohibited characters from the name. For example, values for the control named <code>Exposure Time (us)</code> on the device <code>/dev/video0</code> could be provided like this:

<code>dev0_Exposure_Time_us_min = 1000</code>
<code>dev0_Exposure_Time_us_max = 100000</code>

By default, the control tests use the minimum and maximum values reported by the V4L2 driver to test a control. Additional test values can be provided as global configuration parameters in the configuration file, using a format similar to the min/max format:

<code>dev<number of device>_<escaped control name>_testvalues = "<space-delimited list of values>"</code>

For example:

<code>dev0_Exposure_Time_us_testvalues = "25000 50000 75000"</code>

=== Test case arguments ===

Arguments: 

{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function
|-
|| -p || Print ioctl profiling data
|-
|| -i || Save camera snapshot images to disk in control settings tests, and optionally verify them. Image save path and the verification tool are specified by the <code>image_save_path</code> and <code>image_verify_tool</code> configuration parameters.
|}

Test cases must be run with root privileges.

=== Test cases ===
Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| Core-Camera-Open device ||
|-
|| Core-Camera-Read device ||
|-
|| Core-Camera-Check device controls ||
|-
|| Core-Camera-Check device capabilites ||
|-
|| Core-Camera-Check device formats ||
|-
|| Core-Camera-Measure device stepping down resolution ||
|-
|| Core-Camera-Stream from device to screen ||
|-
|| Core-Camera-Measure device FPS with defined resolution ||
|-
|| Core-Camera-Take picture as JPEG with device ||
|-
|| Core-Camera-Device enumeration ||
|-
|| Core-Camera-Stream from device and crop corners ||
|-
|| Core-Camera-Read from device using poll ||
|-
|| Core-Camera-Test standard control settings || supports external image verification tool
|-
|| Core-Camera-Test extended control settings || supports external image verification tool
|-
|| Core-Camera-Check device FD priority ||
|-
|| Core-Camera-Stream from device and vary frame rate ||
|-
|| Core-Camera-Get stream quality setting ||
|-
|| Core-Camera-Set stream quality setting to high ||
|-
|| Core-Camera-Check debug capability || not necessary supported by driver
|-
|| Core-Camera-Select output and stream ||
|-
|| Core-Camera-Select input and stream ||
|-
|| Core-Camera-Test input device standards ||
|}

'''Test case descriptions and execution commands:'''

;* Core-Camera-Open device
: * Try to open a V4L2 device
: * <code>$ blts-v4l2-tests -en "Core-Camera-Open device"</code>

;* Core-Camera-Read device
: * Open V4L2 device to requested width and height
: * <code>$ blts-v4l2-tests -en "Core-Camera-Read device"</code>

;* Core-Camera-Check device controls
: * Enumerate through V4L2 device controls
: * <code>$ blts-v4l2-tests -en "Core-Camera-Check device controls"</code>

;* Core-Camera-Check device capabilites
: * Check and print V4L2 device capabilities
: * <code>$ blts-v4l2-tests -en "Core-Camera-Check device capabilites"</code>

;* Core-Camera-Check device formats
: * Enumerate and print V4L2 device formats
: * <code>$ blts-v4l2-tests -en "Core-Camera-Check device formats"</code>

;* Core-Camera-Measure device stepping down resolution
: * Step down resolutions and calculate FPS using V4L2 device
: * <code>$ blts-v4l2-tests -en "Core-Camera-Measure device stepping down resolution"</code>

;* Core-Camera-Stream from device to screen
: * Stream frames from V4L2 device to screen using XVideo
: * <code>$ blts-v4l2-tests -en "Core-Camera-Stream from device to screen"</code>

;* Core-Camera-Measure device FPS with defined resolution
: * Use a given resolution and calculate FPS using V4L2 device
: * <code>$ blts-v4l2-tests -en "Core-Camera-Measure device FPS with defined resolution"</code>

;* Core-Camera-Take picture as JPEG with device
: * Take one frame from V4L2 device and create a JPG file
: * <code>$ blts-v4l2-tests -en "Core-Camera-Take picture as JPEG with device"</code>

;* Core-Camera-Device enumeration
: * Enumerate V4L2 input and output devices and print supported standards
: * <code>$ blts-v4l2-tests -en "Core-Camera-Device enumeration"</code>

;* Core-Camera-Stream from device and crop corners
: * Stream frames from V4L2 device to screen using XVideo and use cropping
: * <code>$ blts-v4l2-tests -en "Core-Camera-Stream from device and crop corners"</code>

;* Core-Camera-Read from device using poll
: * Read/stream frames from device as with measure device FPS case, but use
: * poll() instead of select() to find out when the device is ready.
: * <code>$ blts-v4l2-tests -en "Core-Camera-Read from device using poll"</code>

;* Core-Camera-Test standard control settings
: * Enumerate all standard controls, and test each available control with
: * min/max values and any configured values.
: * <code>$ blts-v4l2-tests -en "Core-Camera-Test standard control settings"</code>

;* Core-Camera-Test extended control settings
: * Enumerate all extended controls, and test each available control with
: * min/max values and any configured values.
: * <code>$ blts-v4l2-tests -en "Core-Camera-Test extended control settings"</code>

;* Core-Camera-Check device FD priority
: * Init a device and check if it supports priorities - VIDIOC_G_PRIORITY
: * <code>$ blts-v4l2-tests -en "Core-Camera-Check device FD priority"</code>

;* Core-Camera-Stream from device and vary frame rate
: * Stream frames from V4L2 device to screen using default frame rate and
: * calculate FPS, change frame rate and repeat streaming to compare FPS values.
: * <code>$ blts-v4l2-tests -en "Core-Camera-Stream from device and vary frame rate"</code>

;* Core-Camera-Get stream quality setting
: * Stream frames from V4L2 device and get a default quality setting
: * <code>$ blts-v4l2-tests -en "Core-Camera-Get stream quality setting"</code>

;* Core-Camera-Set stream quality setting to high
: * Stream frames from V4L2 device, set stream quality setting to high, stream from the device and check that high setting is used
: * <code>$ blts-v4l2-tests -en "Core-Camera-Set stream quality setting to high"</code>

;* Core-Camera-Check debug capability
: * Requests the driver to dump current state to kernel log. This API
: * call is specified so that driver doesn't have to support this.
: * <code>$ blts-v4l2-tests -en "Core-Camera-Check debug capability"</code>

;* Core-Camera-Select input and stream
: * Tries different inputs and streams from those to the screen.
: * If no input available with device this test will force test - VIDIOC_S_INPUT
: * <code>$ blts-v4l2-tests -en "Core-Camera-Select input and stream"</code>

;* Core-Camera-Select output and stream
: * Tries different outputs of device.
: * If no output available with device this test will force test - VIDIOC_S_OUTPUT
: * <code>$ blts-v4l2-tests -en "Core-Camera-Select output and stream"</code>

;* Core-Camera-Test input device standards
: * Loops through V4L2 input devices and tries to get current video standard,
: * then enumerates and sets supported standards one by one.
: * <code>$ blts-v4l2-tests -en "Core-Camera-Test input device standards"</code>

=== Configuration file examples ===
To run test case with variable data you need to specify where configuration file is located or if no configuration file is given, test driver tries to use default /etc/blts/blts-v4l2-tests.cnf

Edit the configuration file yourself if necessary.

To run "Core-Camera-Stream from device to screen" case you can use:
<code>blts-v4l2-tests -l /var/log/tests/Core-Camera-Stream_from_device_to_screen.log -en "Core-Camera-Stream from device to screen" -C example-blts-v4l2.cnf </code>

Example of Stream case variation (example-blts-v4l2.cnf):

<pre>
# Valid video devices for HW.
[parameter]
name video_device
const "/dev/video0" "/dev/video1"
[end_parameter]

[parameter]
name io_method_stream
const "MMAP" "userptr"
[end_parameter]

# Pixel formats (fourcc, as kernel v4l2 entries)
[parameter]
name camera_pixel_format
const "YUYV"
[end_parameter]

[parameter]
name camera_resolution_stream_all
const "4016x3016" "2400x1812" "848x480" "640x480" "320x240"
[end_parameter]

[test]
name "Core-Camera-Stream from device to screen"
params video_device camera_pixel_format io_method_stream camera_resolution_stream_all
[end_test]
</pre>

== Module Design and Architecture ==

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| linux.bytesex.org || [http://linux.bytesex.org/v4l2 video4linux website]
|-
|| www.linuxtv.org || [http://www.linuxtv.org The LinuxTV project website]
|-
| blts-v4l2 || [http://gitorious.org/qa-tools/mcts/trees/master/mcts-blts/blts-v4l2 blts-v4l2 tests]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 8-Dec-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Documentation updated to refer blts-v4l2 test package 0.3.8
|}

Quality/TestSuite/Bluetooth Driver Test Specification

2010-12-16T11:59:31Z

Klaakso: /* Building packages */

== Introduction ==
Bluez is the current official Bluetooth protocol stack on Linux. It consists of kernel modules and a userspace library, with a set of tools for low-level configuration. It is used (roughly) analogously to the network subsystem, using sockets for communication.

The blts-bluetooth test package (0.2.9) includes functional tests for the Bluez stack, currently consisting of device scan and simple L2CAP and RFCOMM connectivity tests, a test for link-level (only) connection using HCI and simple HCI transfer/receive ACL test data package test. A test case for probing the system for installed Bluetooth drivers and Bluez userspace components is included. Pairing (without services from system Bluetooth daemon) is also tested.

== Test Coverage ==

=== Software Coverage ===
The test package uses Bluez sockets with the libbluetooth functions <code>hci_get_route(), hci_open_dev(), hci_inquiry() </code> and <code>hci_read_remote_name()</code>. The L2CAP tests also check some connection parameters with direct hci_send_req() calls. HCI link-level connection is tested with <code>hci_create_connection()</code> and <code>hci_disconnect()</code>. HCI transfer/receive ACL data tests utilize hci_filter structs and socket() function with parameters AF_BLUETOOTH, SOCK_RAW and BTPROTO_HCI while receiving ACL test data. Incoming connections are audited by tracing the sequence with hcidump and analysing the trace.

The HCI name change test cases utilize hci library functions <code>hci_read_local_name(), hci_write_local_name()</code> to change and reset name of the device and <code>hci_read_remote_name()</code> function to verify changed name. The class change test cases utilize hci library functions <code>hci_read_class_of_dev()</code> and <code>hci_write_class_of_dev()</code> to change and reset the class of the device and <code>hci_inquiry()</code> function to verify changed device class.

The HCI controller information test cases utilize hci library functions <code>hci_read_{local/remote}_version(), hci_read_{local/remote}_features(), hci_read_{local/remote}_ext_features()</code> to collect data and the connected link information test cases utilize hci library functions <code>hci_read_rssi(), hci_read_link_quality(), hci_read_transmit_power_level(), hci_read_afh_map(), hci_read_clock(), hci_read_clock_offset()</code> to collect data.

The pairing test performs authentication and pairing for a connected link, according to the Bluetooth specification. Due to possible interference from the Bluetooth daemon in the system, it is shut down for the duration of the test, and the test needs to perform simplified device initialisation.

Current coverage of the Bluetooth HCI API:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/BT-HCI-coverage.ods BT-HCI-coverage.ods]]

=== Hardware Coverage ===

Hardware coverage includes the data path through the default Bluetooth adapter to the antenna.

=== Limitations ===
While the device scan does list all found devices, the actual validation of the result is left to the tester.

=== Future Improvements ===
Future test cases may include further tests for HCI link control, and exploring different connection parameter combinations in existing tests. Testing protocols and profiles further up in the Bluetooth stack is currently beyond scope for the test suite.

== Running the tests ==

=== Hardware setup and test environment ===
The tests require two test devices with Bluetooth adapters, both running the test program. Several test cases are meant to run in pairs; see below.

hciconfig can be used to find out the required mac addresses:

<code>$ hciconfig</code>

This will print out all active bluetooth devices and their addresses. The output is
similar to following:

<pre>
hci0: Type: USB
BD Address: 00:15:83:18:C0:30 ACL MTU: 310:10 SCO MTU: 64:8
UP RUNNING PSCAN
RX bytes:1007 acl:0 sco:0 events:30 errors:0
TX bytes:367 acl:0 sco:0 commands:28 errors:0
</pre>

The test environment must have following packages installed:
;*libbltscommon1
;*bluez
;*bluez-hcidump

===Building packages===

The build environment must have the following packages installed:

* libbltscommon-devel
* bluez-libs-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

===Configuration package===

The bluetooth test package is not dependent on any configuration file package like some other blts test packages. The configuration file /etc/blts/blts-bluetooth-tests.cnf is copied in the test device during RPM installation.

===Test asset specific instructions===

The test package can be installed in the device with a command:

<pre>
rpm -ivh blts-bluetooth-tests_{version}.rpm
</pre>

'''Test case execution instructions for high-level cases:'''

The Scan and Software check tests run on a single device, and don't require extra hardware. Having visible Bluetooth devices present during the Scan test may help evaluating the test results.

The L2CAP and RFCOMM test cases are executed with one device running the test "<code>Core-Bluetooth receive L2CAP connection</code>" or "<code>Core-Bluetooth receive RFCOMM connection</code>", and the other the corresponding client test cases.

'''Test case execution instructions for HCI test cases: '''

When executing HCI tests, the first step is to verify that hci device is available by typing hciconfig and then try to open and initialize it with command hciconfig hciX up.

Some of the HCI test cases are counter parts to other HCI test cases and these must be executed at the same time with two devices so that the changing/receiving side must be executed first.

<code>Change name with HCI <-> Verify name with remote HCI</code> 
The verify test case connects to the other bluetooth device and verifies that the device name is expected one while the changing side is waiting until other bluetooth device is verified name change.

<code>Change class with HCI <-> Verify class with remote HCI</code> 
The verify test case connects to the other bluetooth device and verifies that the class of the device is expected one while the changing side is waiting until other bluetooth device is verified class change.

<code>HCI transfer ACL data package <-> HCI receive ACL data package</code> 
The transfer test case sends ACL test data packet containing predefined test data while the receive test case waits and receives the ACL test data packet and verifies the content.

<code>Read HCI controller information local <-> Read HCI controller information remote</code> 
The remote test case collects information about other bluetooth device, connect to that device and sends collected information package while the local test case waits and receives the information package and verifies that locally collected information matches with received data.

<code>Read connected link information local <-> Read connected link information remote</code> 
The remote test case connects to other bluetooth device using multiple L2CAP channels, collects information about connected link and sends collected information package while the local test case waits and receives the information package and verifies that locally collected information matches with received data.

<code>Authentication with pairing as master / slave</code> 
As initiating device (master), the test case connects to another Bluetooth device and requests authentication, triggering pairing. The pairing sequence is completed with a predetermined PIN. The slave device waits for the connection and attempts pairing as the request arrives. Either end of the test can be substituted with any Bluetooth device supporting the functionality. '''The device(s) running this test case must not have the Bluetooth daemon (bluetoothd) running.'''

===Test case arguments===

Arguments: 
{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function
|-
|| -m || remote/server MAC address (format: "00:00:00:00:00")
|}

===Running test cases===

Test cases execution must be done with root privileges.

Test cases marked with '''bold''' require that remote device MAC is defined in configuration file or -m command line
parameter is given. NOTE: hciconfig tool can be used to check BD Address in the remote device.

Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| Core-Bluetooth scan || validation of the scan results is left to the tester
|-
|| Core-Bluetooth drivers and userspace check || verified components are listed in file blts-bluetooth-req_files.cfg
|-
|| Core-Bluetooth receive L2CAP connection ||
|-
|| '''Core-Bluetooth connect with L2CAP || remote must be running receive L2CAP connection test
|-
|| '''Core-Bluetooth ping-pong transfer with L2CAP || remote must be running receive L2CAP connection test
|-
|| Core-Bluetooth receive RFCOMM connection ||
|-
|| '''Core-Bluetooth connect with RFCOMM || remote must be running receive RFCOMM connection test
|-
|| '''Core-Bluetooth ping-pong transfer with RFCOMM || remote must be running receive RFCOMM connection test
|-
|| '''Core-Bluetooth connect with HCI ||
|-
|| '''Core-Bluetooth transfer ACL data with HCI || remote must be running receive ACL data test
|-
|| Core-Bluetooth receive ACL data with HCI ||
|-
|| Core-Bluetooth change name with HCI ||
|-
|| '''Core-Bluetooth verify name with remote HCI || remote must be running change name test
|-
|| Core-Bluetooth change class with HCI ||
|-
|| '''Core-Bluetooth verify class with remote HCI || remote must be running change class test
|-
|| '''Core-Bluetooth reset connection with HCI ||
|-
|| Core-Bluetooth audit incoming HCI connection || use e.g connect with HCI or reset connection with HCI test case as pair
|-
|| Core-Bluetooth Read HCI controller information local ||
|-
|| '''Core-Bluetooth Read HCI controller information remote || remote must be running controller information local test case
|-
|| Core-Bluetooth Read connected link information local ||
|-
|| '''Core-Bluetooth Read connected link information remote || remote must be running connected link information local test case
|-
|| '''Core-Bluetooth authentication with pairing as master || requires that bluetoothd is stopped on the test device
|-
|| Core-Bluetooth authentication with pairing as slave || requires that bluetoothd is stopped on the test device
|}

'''Test case descriptions and execution commands:'''

;* Core-Bluetooth scan Parameters ( no parameters )
: * Perform inquiry with first available Bluetooth adapter, resolving names for any found remote devices.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth scan"</code>

;* Core-Bluetooth drivers and userspace check Parameters ( no parameters )
: * Verify that Bluez-related components are available and correctly installed on the system.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth drivers and userspace check"</code>

;* Core-Bluetooth receive L2CAP connection Parameters ( no parameters )
: * Start test server for use with L2CAP tests. The server stops after one client connection has been served.
: * This test requires "Core-Bluetooth connect with L2CAP" as counterpart and must be executed first.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth receive L2CAP connection"</code>

;* Core-Bluetooth connect with L2CAP Parameters <server-mac>
: * Connect with L2CAP to test server running on device <server-mac>, then disconnect.
: * This test requires "Core-Bluetooth receive L2CAP connection" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth connect with L2CAP" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth ping-pong transfer with L2CAP Parameters <server-mac>
: * Connect with L2CAP to test server running on device <server-mac>, transmit a short message and verify the returned reply, then disconnect.
: * This test requires "Core-Bluetooth receive L2CAP connection" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth ping-pong transfer with L2CAP" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth receive RFCOMM connection Parameters ( no parameters )
: * Start test server for use with RFCOMM tests. The server stops after one client connection has been served.
: * This test requires "Core-Bluetooth connect with RFCOMM" as counterpart and must be executed first.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth receive RFCOMM connection"</code>

;* Core-Bluetooth connect with RFCOMM Parameters <server-mac>
: * Connect with RFCOMM to test server running on device <server-mac>, then disconnect.
: * This test requires "Core-Bluetooth receive RFCOMM connection" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth connect with RFCOMM" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth ping-pong transfer with RFCOMM Parameters <server-mac>
: * Connect with RFCOMM to test server running on device <server-mac>, transmit a short message and verify the returned reply, then disconnect.
: * This test requires "Core-Bluetooth receive RFCOMM connection" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth ping-pong transfer with RFCOMM" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth connect with HCI Parameters <remote-mac>
: * Connect just the link to device <remote-mac>, wait a while, the disconnect.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth connect with HCI" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth receive ACL data with HCI Parameters ( no parameters )
: * Start receiving ACL data packets from hci device until ACL test data packet arrives.
: * This test requires "Core-Bluetooth transfer ACL data with HCI" as counterpart and must be executed first.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth receive ACL data with HCI"</code>

;* Core-Bluetooth transfer ACL data with HCI Parameters <remote-mac>
: * Connect to device <remote-mac>, and send ACL data packet.
: * This test requires "Core-Bluetooth receive ACL data with HCI" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth transfer ACL data with HCI" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth change name with HCI Parameters ( no parameters )
: * Change local name and wait until other Bluetooth device is verified name change.
: * This test requires "Core-Bluetooth verify name with remote HCI" as counterpart and must be executed first.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth change name with HCI"</code>

;* Core-Bluetooth verify name with remote HCI Parameters <remote-mac>
: * Connect to device <remote-mac>, and verify name of the device.
: * This test requires "Core-Bluetooth change name with HCI" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth verify name with remote HCI" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth change class with HCI Parameters ( no parameters )
: * Change class of device and wait until other Bluetooth device is verified class change.
: * This test requires "Core-Bluetooth verify class with remote HCI" as counterpart and must be executed first.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth change class with HCI"</code>

;* Core-Bluetooth verify class with remote HCI Parameters <remote-mac>
: * Connect to device <remote-mac>, and verify class of the device.
: * This test requires "Core-Bluetooth change class with HCI" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth verify class with remote HCI" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth reset connection with HCI Parameters <remote-mac>
: * Connect, reset connection and connect again to <remote-mac>, wait a while and disconnect.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth reset connection with HCI" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth audit incoming HCI connection Parameters ( no parameters )
: * Wait for incoming connection and trace HCI events and commands. Sequence is audited for test pass/fail. Test requires tester to establish some level of Bluetooth connection to the device; for example, starting pairing with a mobile handset and cancelling out is enough. Running any connect test from the counterpart also works. Start this test case first in the test device and after that, when test case is waiting incoming connection, do the pairing step or execute some other HCI connection test case e.g. "Core-Bluetooth connect with HCI".
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth audit incoming HCI connection"</code>

;* Core-Bluetooth Read HCI controller information local Parameters ( no parameters )
: * Read information about local device, create L2CAP socket and wait for information packet from remote device. Verify that locally collected information matches with received data.
: * This test requires "Core-Bluetooth Read HCI controller information remote" as counterpart and must be executed first.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth Read HCI controller information local"</code>

;* Core-Bluetooth Read HCI controller information remote Parameters <remote-mac>
: * Collect information about remote device (other DUT), connect to device <remote-mac>, and send collected information package with L2CAP connection to remote side.
: * This test requires "Core-Bluetooth Read HCI controller information local" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth Read HCI controller information remote" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth Read connected link information local Parameters ( no parameters )
: * Create L2CAP sockets with multiple channels, read information about connected links, and wait for link information packet from remote device. Verify that locally collected link information matches with received data.
: * This test requires "Core-Bluetooth Read connected link information remote" as counterpart and must be executed first.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth Read connected link information local"</code>

;* Core-Bluetooth Read connected link information remote Parameters <remote-mac>
: * Connect to device <remote-mac> using multiple channels (other DUT), collect information about connected links, and send collected link information package with L2CAP connection to remote side.
: * This test requires "Core-Bluetooth Read connected link information local" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth Read connected link information remote" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth authentication with pairing as master Parameters <remote-mac>
: * Perform pairing with another bluetooth device. The device under test initiates the pairing.
: * Running this test requires stopping bluetoothd on the test device (as root, try <code>$ invoke-rc.d bluetooth stop</code> or <code>$ initctl stop bluetoothd</code> depending on distribution).
: * Set the <remote-mac> to the Bluetooth MAC of the other device.
: * Only one device needs to run the test software; the other can be any Bluetooth device (that can use the given PIN). In this case, the tester needs to enter the PIN manually within the timeout period on the other device. The PIN used is "1234". The timeout is 10 seconds for each test step. If both ends run the test (one as master, one as slave), this is taken care of automatically.
: * This test can be run with "Core-Bluetooth authentication with pairing as slave" as counterpart and must be executed when remote side is waiting.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth authentication with pairing as master" -m 00:00:00:00:00:00</code>

;* Core-Bluetooth authentication with pairing as slave Parameters (none)
: * Perform pairing with another bluetooth device. The device under test waits for incoming pairing request.
: * Running this test requires stopping bluetoothd on the test device (as root, try <code>$ invoke-rc.d bluetooth stop</code> or <code>$ initctl stop bluetoothd</code> depending on distribution).
: * Only one device needs to run the test software; the other can be any Bluetooth device (that can use the given PIN). In this case, the tester needs to enter the PIN manually within the timeout period on the other device. The PIN used is "1234". The timeout is 10 seconds for each test step. If both ends run the test (one as master, one as slave), this is taken care of automatically.
: * This test can be run with "Core-Bluetooth authentication with pairing as master" as counterpart and must be executed first.
: * <code>$ blts-bluetooth-tests -en "Core-Bluetooth authentication with pairing as slave"</code>

===Configuration file examples===

To run test cases with variable data you need to specify where configuration file is located or if no configuration file is given, test driver tries to use default /etc/blts/blts-bluetooth-tests.cnf

The configuration file must be edited to match your test environment (optionally command line parameter -m can be used to override mac_address parameter)

To run "Core-Bluetooth connect with HCI" case for example, execute the command:

<code>blts-bluetooth-tests -l /var/log/tests/Core-Bluetooth_connect_with_HCI.log -en "Core-Bluetooth connect with HCI" -m 00:00:00:00:00:00 -C /etc/blts/blts-bluetooth-tests.cnf</code>

Example of BT configuration file:
<pre>
# Parameter configuration for blts-bluetooth

# MAC address - used in test cases where another BT device is needed
# NOTE: command line parameter -m (mac_address) overrides this parameter

[globals]
mac_address "00:00:00:00:00:00"
[end_globals]
</pre>

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
|-
|| Bluez || [http://www.bluez.org/ Bluez stack home page]
|-
|| Bluetooth || [http://www.bluetooth.org/ Bluetooth]
|-
|| blts-bluetooth || [http://gitorious.org/qa-tools/mcts/trees/master/mcts-blts/blts-bluetooth/ blts-bluetooth tests]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 22-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|-
|| 0.2 || 8-Dec-2010 || [mailto:aki.nyman@digia.com Aki Nyman] || Draft || Documentation updated to refer blts-bluetooth test package 0.2.9
|}

Quality/TestSuite/Audio Driver Test Specification

2010-12-16T11:57:20Z

Klaakso: /* Building packages */

== Introduction ==

The Advanced Linux Sound Architecture (ALSA) provides audio and MIDI functionality to the Linux operating system.

== Test Coverage ==

=== Software Coverage ===

blts-alsa-core package uses the interface specified in asound.h to test kernel's sound core and drivers. ALSA's user space library (alsa-lib) is not used. In addition the test asset uses V4L2 API to control FM tuner.

Current BLTS ALSA core test coverage matrix:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/ALSA-core-coverage.ods ALSA-core-coverage.ods]]

=== Hardware Coverage ===

Hardware coverage includes audio devices (soundcard, FM radio, etc)

=== Limitations ===

The tests do not currently support verifying the sound passing through the audio path. Instead, the tester needs to listen to the produced audio to determine final results.

Support for various playback and capture parameters is missing, such as unsigned sample formats, and memory mapped non-interleaved access method. See section "Configuration file format" for supported parameters.

=== Future Improvements ===

Extend coverage, add support for various missing PCM settings.

Recorded PCM data should be stored to a file for external verification, or the data should be verified by the test asset automatically.

===Building packages===

The build environment must have the following packages installed:
;*libbltscommon-devel
;*kernel-headers
;*dbus-glib-devel
;*glib2-devel

{{:Quality/TestSuite/Building_BLTS_Packages}}

== Running the tests ==

The test environment must have following packages installed:
;*libbltscommon1

The test package and associated configuration pacakge can be installed in the device with a command:

<pre>
rpm -ivh blts-alsa-core-tests-{version}.rpm blts-alsa-core-tests-config-{platform}-{version}.rpm
</pre>

Configuration package/file is platform dependant, see section "Configuration"

Run as root:
<code> $ blts-alsa-core-tests</code>

This will execute the test cases using default configuration file, which is /etc/blts/blts-alsa-core.cnf

By default the test results are printed to terminal and also to /var/log/tests/blts_alsa_core.txt.

Possible arguments for blts_alsa_core_test;

{{:Quality/TestSuite/Common_General_Switch}}
{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|Optional Switch
!style="width:80%"|Function
|-
|| -p || Enables profiling of ioctl calls
|}

'''Test case descriptions and execution commands:'''

The test cases are:

;* ALSA presence check
: * checks needed /dev/snd* entries and modules
: * <code>$ blts-alsa-core-tests -en "ALSA presence check"</code>

;* Open and close PCM devices
: * opens and queries basic information from all available PCM devices
: * <code>$ blts-alsa-core-tests -en "Open and close PCM devices"</code>

;* Open and close timer
: * opens and queries basic information from ALSA timer
: * <code>$ blts-alsa-core-tests -en "Open and close timer"</code>

;* Open and close controls
: * opens and queries basic information from control devices
: * <code>$ blts-alsa-core-tests -en "Open and close controls"</code>

;* Open and close hwdeps
: * opens and queries basic information from hw dependency -devices
: * <code>$ blts-alsa-core-tests -en "Open and close hwdeps"</code>

;* Enumerate control elements
: * queries information of all control elements and their current settings from all control devices
: * <code>$ blts-alsa-core-tests -en "Enumerate control elements"</code>

;* Power management
: * sets and queries power state from all devices
: * <code>$ blts-alsa-core-tests -en "Power management"</code>

;* Enumerate devices with control interface
: * Queries information about all pcm, hw dep and rawmidi devices from control device
: * <code>$ blts-alsa-core-tests -en "Enumerate devices with control interface"</code>

;* Add and remove control element
: * Creates, replaces and removes user control element. Tests also element lock/unlock
: * <code>$ blts-alsa-core-tests -en "Add and remove control element"</code>

Rest of the test cases are generated from given configuration file, see next section.

=== Configuration ===

Configuration file defines ALSA mixer (control) settings and used playback and recording parameters. These settings depend on platform.

Configuration file example (Intel HDA based soundcard);

<pre>
[defaults]
[control]
card 0
set "Master Playback Volume" max
set "PCM Playback Volume" max
set "Master Playback Switch" off
set "Headphone Playback Switch" off
set "Front Playback Switch" off
set "Capture Switch" off
set "IEC958 Playback Switch" off
set "IEC958 Default PCM Playback Switch" off
[end_control]
[end_defaults]

[testset]
description "front headphone"
[control]
card 0
set "Master Playback Volume" max
set "PCM Playback Volume" max
set "Master Playback Switch" on
set "Headphone Playback Switch" on
set "Front Playback Switch" on
[end_control]

[playback]
card 0
device 0
rates 44100 96000 192000
formats S16_LE
channels 2
access INTERLEAVED MMAP_INTERLEAVED
hw_resampling 1
async SYNC
duration 5
freq 1000
[end_playback]
[end_testset]

[testset]
description "front mic with max volume"
[control]
card 0
set "Input Source" "Front Mic"
set "Capture Switch" on
set "Capture Volume" max
set "Front Mic Boost" min
[end_control]

[recording]
card 0
device 0
rates 44100 96000 192000
formats S16_LE
channels 2
access INTERLEAVED MMAP_INTERLEAVED
hw_resampling 1
duration 5
[end_recording]
[end_testset]
</pre>

The above configuration file produces following test cases:<code>
* PCM playback front headphone (0:0 44100 2 INTERLEAVED S16_LE SYNC)
* PCM playback front headphone (0:0 44100 2 MMAP_INTERLEAVED S16_LE SYNC)
* PCM playback front headphone (0:0 96000 2 INTERLEAVED S16_LE SYNC)
* PCM playback front headphone (0:0 96000 2 MMAP_INTERLEAVED S16_LE SYNC)
* PCM playback front headphone (0:0 192000 2 INTERLEAVED S16_LE SYNC)
* PCM playback front headphone (0:0 192000 2 MMAP_INTERLEAVED S16_LE SYNC)
* PCM recording front mic with max volume (0:0 44100 2 INTERLEAVED S16_LE)
* PCM recording front mic with max volume (0:0 44100 2 MMAP_INTERLEAVED S16_LE)
* PCM recording front mic with max volume (0:0 48000 2 INTERLEAVED S16_LE)
* PCM recording front mic with max volume (0:0 48000 2 MMAP_INTERLEAVED S16_LE)
* PCM recording front mic with max volume (0:0 96000 2 INTERLEAVED S16_LE)
* PCM recording front mic with max volume (0:0 96000 2 MMAP_INTERLEAVED S16_LE)
* PCM recording front mic with max volume (0:0 192000 2 INTERLEAVED S16_LE)
* PCM recording front mic with max volume (0:0 192000 2 MMAP_INTERLEAVED S16_LE)
</code>

Each [testset] can contain multiple [playback], [recording] and [control] sections. This allows simultaneous recording and playback cases, such as playback to phone's earpiece while recording from the mic. Simplified example;

<pre>
[testset]
description "playback and recording"
[control]
...
[end_control]

[playback]
...
[end_playback]

[recording]
...
[end_recording]
[end_testset]
</pre>

== Configuration file format ==

'''[defaults] section:'''

Defines default control element settings. These settings are applied before and after each test case. Defaults -section can contain only [control] section(s).

'''[testset] section: '''

Defines a set of settings for playback and/or recording tests. A configuration file can contain multiple testset sections, and settings within one section do not interfere with other testset sections. If testset section contains multiple playback/recording sections, the tests from each recording/playback section are executed in parallel.

Possible variables:
* description "<short description>": Description for the testset.

'''[control] section: '''

Defines mixer (control) settings. The settings are applied in the given order before playback or recording.

Possible variables:

* card X: Defines used soundcard. X can be from 0...available soundcards.
* set "<control element name>"|X max|min|on|off|Y: Sets given control element to given value. Control element can be defined by control element's name or id.

'''[playback]/[recording] section: '''

Defines PCM parameters for playback and recording.

Possible variables:
* card X: Used soundcard. X can be from 0...available soundcards.
* device X: Used PCM device. X can be from 0...available pcm devices.
* rates X Y Z... : Used samplerates as samples per second.
* formats X Y Z... : Used sample formats. Currently supported are:
** S8: Signed 8-bit.
** S16_LE: Signed 16-bit little endian.
** S24_LE: Signed 24-bit little endian.
** S32_LE: Signed 32-bit little endian.
* channels X Y Z... : Number of used channels.
* access X Y Z... : Used access methods. Currently supported are:
** INTERLEAVED: Samples from all channels are interleaved into single buffer.
** MMAP_INTERLEAVED: Same as above, but the buffer is memory mapped. For synchronous playback/recording only.
** NONINTERLEAVED: Samples from all channels are in separate buffers. Currently for playback only.
* hw_resampling X: Use hardware resampling.
* async X Y Z... : Use synchronous or asynchronous IO method (playback only). Currently supported values are:
** SYNC: Regular (synchronous) IO.
** ASYNC_SIGNAL: Asynchronous IO, where the kernel tells the test when the audio hardware is prepared to receive more data.
** ASYNC_TIMER: Asyncronous IO, where a constant stream of IO is done to the hardware, regulated by periodic timer signals.
* duration X: Duration in seconds.
* freq: Sine wave frequency (playback only).
* link X Y : Synchronize IO on this device with card X device Y. Only for async = SYNC.
* period_size: The interval between interrupts from the hardware (in frames). This affects used buffer sizes.
* volume: For playback only. In practice this defines the amplitude of generated sine wave. Value can be anything between 0 and 100.

Some of the variables allow multiple values, and the test cases are generated by simply creating all combinations from given values.

'''[bluetooth] section: '''

Defines Bluetooth audio settings. If a Bluetooth A2DP device is defined here, it will be connected for the duration of the test. Pairing a device is not supported as yet, and should be done before testing.

Note that just connecting to a device is usually not enough for sound output. In most cases platform-specific mixer settings are needed.

Possible variables:
* connect "nn:nn:nn:nn:nn:nn" : MAC of Bluetooth device supporting A2DP to connect to.
* pin "nnnn" : PIN for the device. (Pairing not implemented yet)

'''[tuner] section:'''

Defines v4l2 tuner settings.
Possible variables:
* device "" : Used tuner device, for example "/dev/radio0"
* freq X : Used frequency in kHz, or;
* scan_select X : Scan for channels and select channel X. This works only with devices with hardware frequency seek capability (VIDIOC_S_HW_FREQ_SEEK).

== Module Design and Architecture ==

The test module can be compiled to self-sufficient command line program. Both Debian and RPM packaging is also provided.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
| alsa-project.org || [http://www.alsa-project.org/main/index.php/Main_Page ALSA website]
|-
| V4L2 Tuner API || [http://v4l2spec.bytesex.org/spec/x394.htm V4L2 tuner API]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 14-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|}

Quality/TestSuite/X11 Test Specification

2010-12-16T10:57:14Z

Klaakso: /* Hardware setup and test environment */

Quality/TestSuite/BLTS Pack Script

2010-12-16T10:50:34Z

Klaakso: Created page with "=== Packaging script for a single BLTS test asset === Pack.sh is a packaging script for a single BLTS test asset. It can be used to build a tarball out of sources as well as bui…"

=== Packaging script for a single BLTS test asset ===

Pack.sh is a packaging script for a single BLTS test asset. It can be used to build a tarball out of sources as well as building a RPM or Debian package. Pack.sh is included with every test asset and only corresponding version should be used.

{|style="width:100%" cellspacing="0" border="1"
!style="width:20%"|General Switch
!style="width:80%"|Function
|-
| -o || Copy files (packages) to <dir>
|-
| -r || Build RPM package, fails if there's no .spec
|-
| -d || Build Debian package, fails if there's no debian/control
|-
| -h || Show help
|-
|}

Quality/TestSuite/Building BLTS Packages

2010-12-16T10:42:07Z

Klaakso:

The test asset sources include the [[../BLTS Pack Script | pack.sh]] script, which is used for building RPM and Debian packages and source tar packages. To build an RPM package with the script, execute this command in the top level source directory of test asset:

./pack.sh -r

To get help about the packaging script, execute

./pack.sh -h

The asset can also be built manually by executing:

./autogen.sh
./configure
make

Quality/TestSuite/X11 Test Specification

2010-12-16T10:37:12Z

Klaakso: /* Building the test asset */

Quality/TestSuite/Building BLTS Packages

2010-12-16T10:34:38Z

Klaakso: Created page with "The test asset sources include the pack.sh script, which is used for building RPM and Debian packages and source tar packages. To build an RPM package with the script, execute th…"

The test asset sources include the pack.sh script, which is used for building RPM and Debian packages and source tar packages. To build an RPM package with the script, execute this command in the top level source directory of test asset:

./pack.sh -r

To get help about the packaging script, execute

./pack.sh -h

The asset can also be built manually by executing:

./autogen.sh
./configure
make

Quality/TestSuite/USB Driver Test Specification

2010-09-28T08:23:07Z

Klaakso: /* Future Improvements */

== Introduction ==
USB peripheral test cases are made between host (e.g. PC) and peripheral gadget (e.g. N900). Both ends have their own drivers which communicate and transfer data between different endpoints.

== Test Coverage ==

Each test case must be run independently and devices must be preset according to case requirements using provided setup test cases. In practice, this means for example data transfer requires preconnected host enabled USB cable and host mode supporting device is connected to system. Each test case prints out required user interaction to terminal.
* USB - Setup host driver
* USB - Setup peripheral driver
* USB - Read test
* USB - Write test

=== Software Coverage ===

Current coverage for USB tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/USB-core-coverage.ods USB-coverage.ods]]

=== Hardware Coverage ===

USB bulk and isochronous endpoint transfer test cases. Those who know more about USB transfer can also alter endpoint configurations via configuration files. Example configurations are provided with the test package.

=== Limitations ===
* Drivers must be initialized before running other test cases.
* All other gadget drivers MUST be unloaded before test execution in used DUT!
* All USB cables MUST be disconnected when executing initializations!

=== Future Improvements ===
* Automated test execution and peripheral DUT driver selection.
* Official unique USB driver ID.

== Running the tests ==

=== Hardware setup and test execution order ===

Required hardware:
* Supported USB cable
* Device with USB host capability (e.g. PC)
* Device with USB peripheral capability (e.g. Nokia N810/N900)

How to setup test enviroment:
# Make sure usb cable is disconnected between devices
# Set up host side (e.g. PC) by running test 'USB - Setup host driver'
# Set up gadget side (peripheral device) by running test 'USB - Setup peripheral driver'
# Connect cable
# Execute tests

NOTE: Before executing test cases it must be determined if used devices are capable of acting as peripheral or host. This depends on USB controller chips of devices and necessary information should be available from device vendors. Furthermore, current gadget driver implementation is built over MUSB driver implementation available in Linux kernel. Possible different implementations by device vendors may cause incompatibility with this test driver. 
<code>$ blts_usb_testrunner -C [config file] -e [test number]</code>

=== Configuration files ===
This test asset uses two configuration files: One for generic test execution options and one for endpoint configuration. Endpoint configuration file is linked to base configuration files thus only base file path is given as parameter. Configuration files must be used, as they contain endpoint configuration for driver.

Currently following example base configuration files are included in the package:
* blts-usb-testrunner-bulk.cnf
* blts-usb-testrunner-int.cnf
* blts-usb-testrunner-isoc.cnf

The base files are linked to endpoint configuration files and following examples are provided with test package:
* ep-configuration-bulk.cfg
* ep-configuration-int.cfg
* ep-configuration-isoc.cfg

NOTE: Supported endpoint configurations differ from device to device and they should be modified according to test execution requirements. These configuration files are provided as examples and should not be used as such during proper test execution.

For further instructions on creating and using configuration files, see [http://wiki.meego.com/Quality/TestSuite/USB_Driver_Test_Specification#Configuration_file_examples Configuration file examples].

=== Common test execution guidelines ===

NOTE:
* Default config files are installed to /usr/share/blts-usb-tests/.
* Drivers must be initialized before running other test cases.
* All USB cables MUST be disconnected when executing initializations!

NOTE: All other gadget drivers MUST be unloaded before test execution in used DUT!

You can use command lsmod to determine which modules are loaded in memory:

<code>$ lsmod</code>

See if some gadget driver is found. For example g_file_storage is a mass storage module, but this depends on used HW and SW. The module can be unloaded with following command:

<code>$ modprobe -r g_file_storage</code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -C || Used parameter configuration file
|-
|| -l || Used log file, default blts_skeleton_run.log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -? || Help message
|-
|| -nc || Do not output log to terminal
|-
!|Optional switch
!|Function
|-
|| -h || Use given host driver (default: blts_usb_host), for example -h blts_usb_host
|-
|| -p || Use given peripheral driver (default: blts_gadget), for example -h blts_gadget
|}

=== Test cases ===
Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| USB - Setup host driver* ||
|-
|| USB - Setup peripheral driver# || Use configuration file to create specific setup, bulk endpoints are created by default
|-
|| USB - Read test* || Read data from endpoints
|-
|| USB - Write test* || Write data to endpoints
|}
''* This test is run on host device.'' 
''# This test is run on peripheral device.''

=== Configuration file examples ===
The test asset allows you to change all endpoint parameters via configuration files. Since the USB (2.0) specification only states the valid range for different settings, it is possible to give any values as long as they fit inside these ranges. The test asset allows experimenting with different configurations and "triangulation" of what works and what does not. Naturally there are certain HW related restrictions such as total transfer capacity which obviously cannot be exceeded with endpoint configuration. Basic test asset configurations is done with base configuration files, such as provided <code>blts-usb-testrunner-bulk.cnf</code>:

<pre>
# USB test case configuration for parameters

######################
# General parameters #
######################

[parameter]
name host_driver
const "blts_usb_host"
[end_parameter]

[parameter]
name host_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name peripheral_driver
const "blts_gadget"
[end_parameter]

[parameter]
name peripheral_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name data_transfer_timeout
const "10000"
[end_parameter]

[parameter]
name usb_transfer_size
const 4096
[end_parameter]

##########################
# Endpoint configuration #
##########################

[parameter]
name ep_configuration_file
const "/usr/share/blts-usb-tests/ep-configuration-bulk.cfg"
[end_parameter]

################
# Driver setup #
################

[test]
name "USB - Setup host driver"
params host_driver host_driver_path
[end_test]

[test]
name "USB - Setup peripheral driver"
params peripheral_driver peripheral_driver_path usb_transfer_size ep_configuration_file
[end_test]

#######################
# Data transfer cases #
#######################

[test]
name "USB - Read test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]

[test]
name "USB - Write test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]
</pre>

To change the endpoint configuration, you will have to edit ep-configuration files. For example, provided <code>ep-configuration-bulk.cfg</code> looks like this by default:
<pre>
# device_speed used_speed max_power
high any 50
# endpoint type direction max_packet_size interval
1 bulk in 512 9
2 bulk out 512 9
</pre>
The lines starting with # are comments and document provided parameters. Device_speed is the highest speed used device is supposed to be able handle (any/low/full/high) and used_speed the operational speed during test execution. This can be used to force the device to use lower speed than normally would be used. To add new pair of bulk endpoints simply add following lines to the file:
<pre>
3 bulk in 512 9
4 bulk out 512 9
</pre>
Do note that you can put different endpoint types to the same configuration so there can be any combination of bulk, interrupt and isochronous endpoints as long as device supports this.

== Module Design and Architecture ==

Debian package is provided which includes both host and peripheral drivers in addition to test runner. This package can be installed on all devices under testing, although functionality depends on used hardware.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
| USB Specification || [http://www.usb.org/developers/docs/ USB documentation]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 8-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|}

Quality/TestSuite/USB Driver Test Specification

2010-09-28T08:22:25Z

Klaakso: /* Hardware setup and test execution order */

== Introduction ==
USB peripheral test cases are made between host (e.g. PC) and peripheral gadget (e.g. N900). Both ends have their own drivers which communicate and transfer data between different endpoints.

== Test Coverage ==

Each test case must be run independently and devices must be preset according to case requirements using provided setup test cases. In practice, this means for example data transfer requires preconnected host enabled USB cable and host mode supporting device is connected to system. Each test case prints out required user interaction to terminal.
* USB - Setup host driver
* USB - Setup peripheral driver
* USB - Read test
* USB - Write test

=== Software Coverage ===

Current coverage for USB tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/USB-core-coverage.ods USB-coverage.ods]]

=== Hardware Coverage ===

USB bulk and isochronous endpoint transfer test cases. Those who know more about USB transfer can also alter endpoint configurations via configuration files. Example configurations are provided with the test package.

=== Limitations ===
* Drivers must be initialized before running other test cases.
* All other gadget drivers MUST be unloaded before test execution in used DUT!
* All USB cables MUST be disconnected when executing initializations!

=== Future Improvements ===
* Support for simultaneous data transfer on multiple endpoints.
* Automated test execution and peripheral DUT driver selection.
* Official unique USB driver ID.

== Running the tests ==

=== Hardware setup and test execution order ===

Required hardware:
* Supported USB cable
* Device with USB host capability (e.g. PC)
* Device with USB peripheral capability (e.g. Nokia N810/N900)

How to setup test enviroment:
# Make sure usb cable is disconnected between devices
# Set up host side (e.g. PC) by running test 'USB - Setup host driver'
# Set up gadget side (peripheral device) by running test 'USB - Setup peripheral driver'
# Connect cable
# Execute tests

NOTE: Before executing test cases it must be determined if used devices are capable of acting as peripheral or host. This depends on USB controller chips of devices and necessary information should be available from device vendors. Furthermore, current gadget driver implementation is built over MUSB driver implementation available in Linux kernel. Possible different implementations by device vendors may cause incompatibility with this test driver. 
<code>$ blts_usb_testrunner -C [config file] -e [test number]</code>

=== Configuration files ===
This test asset uses two configuration files: One for generic test execution options and one for endpoint configuration. Endpoint configuration file is linked to base configuration files thus only base file path is given as parameter. Configuration files must be used, as they contain endpoint configuration for driver.

Currently following example base configuration files are included in the package:
* blts-usb-testrunner-bulk.cnf
* blts-usb-testrunner-int.cnf
* blts-usb-testrunner-isoc.cnf

The base files are linked to endpoint configuration files and following examples are provided with test package:
* ep-configuration-bulk.cfg
* ep-configuration-int.cfg
* ep-configuration-isoc.cfg

NOTE: Supported endpoint configurations differ from device to device and they should be modified according to test execution requirements. These configuration files are provided as examples and should not be used as such during proper test execution.

For further instructions on creating and using configuration files, see [http://wiki.meego.com/Quality/TestSuite/USB_Driver_Test_Specification#Configuration_file_examples Configuration file examples].

=== Common test execution guidelines ===

NOTE:
* Default config files are installed to /usr/share/blts-usb-tests/.
* Drivers must be initialized before running other test cases.
* All USB cables MUST be disconnected when executing initializations!

NOTE: All other gadget drivers MUST be unloaded before test execution in used DUT!

You can use command lsmod to determine which modules are loaded in memory:

<code>$ lsmod</code>

See if some gadget driver is found. For example g_file_storage is a mass storage module, but this depends on used HW and SW. The module can be unloaded with following command:

<code>$ modprobe -r g_file_storage</code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -C || Used parameter configuration file
|-
|| -l || Used log file, default blts_skeleton_run.log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -? || Help message
|-
|| -nc || Do not output log to terminal
|-
!|Optional switch
!|Function
|-
|| -h || Use given host driver (default: blts_usb_host), for example -h blts_usb_host
|-
|| -p || Use given peripheral driver (default: blts_gadget), for example -h blts_gadget
|}

=== Test cases ===
Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| USB - Setup host driver* ||
|-
|| USB - Setup peripheral driver# || Use configuration file to create specific setup, bulk endpoints are created by default
|-
|| USB - Read test* || Read data from endpoints
|-
|| USB - Write test* || Write data to endpoints
|}
''* This test is run on host device.'' 
''# This test is run on peripheral device.''

=== Configuration file examples ===
The test asset allows you to change all endpoint parameters via configuration files. Since the USB (2.0) specification only states the valid range for different settings, it is possible to give any values as long as they fit inside these ranges. The test asset allows experimenting with different configurations and "triangulation" of what works and what does not. Naturally there are certain HW related restrictions such as total transfer capacity which obviously cannot be exceeded with endpoint configuration. Basic test asset configurations is done with base configuration files, such as provided <code>blts-usb-testrunner-bulk.cnf</code>:

<pre>
# USB test case configuration for parameters

######################
# General parameters #
######################

[parameter]
name host_driver
const "blts_usb_host"
[end_parameter]

[parameter]
name host_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name peripheral_driver
const "blts_gadget"
[end_parameter]

[parameter]
name peripheral_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name data_transfer_timeout
const "10000"
[end_parameter]

[parameter]
name usb_transfer_size
const 4096
[end_parameter]

##########################
# Endpoint configuration #
##########################

[parameter]
name ep_configuration_file
const "/usr/share/blts-usb-tests/ep-configuration-bulk.cfg"
[end_parameter]

################
# Driver setup #
################

[test]
name "USB - Setup host driver"
params host_driver host_driver_path
[end_test]

[test]
name "USB - Setup peripheral driver"
params peripheral_driver peripheral_driver_path usb_transfer_size ep_configuration_file
[end_test]

#######################
# Data transfer cases #
#######################

[test]
name "USB - Read test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]

[test]
name "USB - Write test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]
</pre>

To change the endpoint configuration, you will have to edit ep-configuration files. For example, provided <code>ep-configuration-bulk.cfg</code> looks like this by default:
<pre>
# device_speed used_speed max_power
high any 50
# endpoint type direction max_packet_size interval
1 bulk in 512 9
2 bulk out 512 9
</pre>
The lines starting with # are comments and document provided parameters. Device_speed is the highest speed used device is supposed to be able handle (any/low/full/high) and used_speed the operational speed during test execution. This can be used to force the device to use lower speed than normally would be used. To add new pair of bulk endpoints simply add following lines to the file:
<pre>
3 bulk in 512 9
4 bulk out 512 9
</pre>
Do note that you can put different endpoint types to the same configuration so there can be any combination of bulk, interrupt and isochronous endpoints as long as device supports this.

== Module Design and Architecture ==

Debian package is provided which includes both host and peripheral drivers in addition to test runner. This package can be installed on all devices under testing, although functionality depends on used hardware.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
| USB Specification || [http://www.usb.org/developers/docs/ USB documentation]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 8-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|}

Quality/TestSuite/USB Driver Test Specification

2010-09-28T08:20:14Z

Klaakso: /* Configuration files */

== Introduction ==
USB peripheral test cases are made between host (e.g. PC) and peripheral gadget (e.g. N900). Both ends have their own drivers which communicate and transfer data between different endpoints.

== Test Coverage ==

Each test case must be run independently and devices must be preset according to case requirements using provided setup test cases. In practice, this means for example data transfer requires preconnected host enabled USB cable and host mode supporting device is connected to system. Each test case prints out required user interaction to terminal.
* USB - Setup host driver
* USB - Setup peripheral driver
* USB - Read test
* USB - Write test

=== Software Coverage ===

Current coverage for USB tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/USB-core-coverage.ods USB-coverage.ods]]

=== Hardware Coverage ===

USB bulk and isochronous endpoint transfer test cases. Those who know more about USB transfer can also alter endpoint configurations via configuration files. Example configurations are provided with the test package.

=== Limitations ===
* Drivers must be initialized before running other test cases.
* All other gadget drivers MUST be unloaded before test execution in used DUT!
* All USB cables MUST be disconnected when executing initializations!

=== Future Improvements ===
* Support for simultaneous data transfer on multiple endpoints.
* Automated test execution and peripheral DUT driver selection.
* Official unique USB driver ID.

== Running the tests ==

=== Hardware setup and test execution order ===

Required hardware:
* Supported USB cable
* Device with USB host capability (e.g. PC)
* Device with USB peripheral capability (e.g. N900)

How to setup test enviroment:
# Make sure usb cable is disconnected between devices
# Set up host side (e.g. PC) by running test 'USB - Setup host driver'
# Set up gadget side (peripheral device) by running test 'USB - Setup peripheral driver'
# Connect cable
# Execute tests

NOTE: Before executing test cases it must be determined if used devices are capable of acting as peripheral or host. This depends on USB controller chips of devices and necessary information should be available from device vendors. Furthermore, current gadget driver implementation is built over MUSB driver implementation available in Linux kernel. Possible different implementations by device vendors may cause incompatibility with this test driver. 
<code>$ blts_usb_testrunner -C [config file] -e [test number]</code>

=== Configuration files ===
This test asset uses two configuration files: One for generic test execution options and one for endpoint configuration. Endpoint configuration file is linked to base configuration files thus only base file path is given as parameter. Configuration files must be used, as they contain endpoint configuration for driver.

Currently following example base configuration files are included in the package:
* blts-usb-testrunner-bulk.cnf
* blts-usb-testrunner-int.cnf
* blts-usb-testrunner-isoc.cnf

The base files are linked to endpoint configuration files and following examples are provided with test package:
* ep-configuration-bulk.cfg
* ep-configuration-int.cfg
* ep-configuration-isoc.cfg

NOTE: Supported endpoint configurations differ from device to device and they should be modified according to test execution requirements. These configuration files are provided as examples and should not be used as such during proper test execution.

For further instructions on creating and using configuration files, see [http://wiki.meego.com/Quality/TestSuite/USB_Driver_Test_Specification#Configuration_file_examples Configuration file examples].

=== Common test execution guidelines ===

NOTE:
* Default config files are installed to /usr/share/blts-usb-tests/.
* Drivers must be initialized before running other test cases.
* All USB cables MUST be disconnected when executing initializations!

NOTE: All other gadget drivers MUST be unloaded before test execution in used DUT!

You can use command lsmod to determine which modules are loaded in memory:

<code>$ lsmod</code>

See if some gadget driver is found. For example g_file_storage is a mass storage module, but this depends on used HW and SW. The module can be unloaded with following command:

<code>$ modprobe -r g_file_storage</code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -C || Used parameter configuration file
|-
|| -l || Used log file, default blts_skeleton_run.log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -? || Help message
|-
|| -nc || Do not output log to terminal
|-
!|Optional switch
!|Function
|-
|| -h || Use given host driver (default: blts_usb_host), for example -h blts_usb_host
|-
|| -p || Use given peripheral driver (default: blts_gadget), for example -h blts_gadget
|}

=== Test cases ===
Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| USB - Setup host driver* ||
|-
|| USB - Setup peripheral driver# || Use configuration file to create specific setup, bulk endpoints are created by default
|-
|| USB - Read test* || Read data from endpoints
|-
|| USB - Write test* || Write data to endpoints
|}
''* This test is run on host device.'' 
''# This test is run on peripheral device.''

=== Configuration file examples ===
The test asset allows you to change all endpoint parameters via configuration files. Since the USB (2.0) specification only states the valid range for different settings, it is possible to give any values as long as they fit inside these ranges. The test asset allows experimenting with different configurations and "triangulation" of what works and what does not. Naturally there are certain HW related restrictions such as total transfer capacity which obviously cannot be exceeded with endpoint configuration. Basic test asset configurations is done with base configuration files, such as provided <code>blts-usb-testrunner-bulk.cnf</code>:

<pre>
# USB test case configuration for parameters

######################
# General parameters #
######################

[parameter]
name host_driver
const "blts_usb_host"
[end_parameter]

[parameter]
name host_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name peripheral_driver
const "blts_gadget"
[end_parameter]

[parameter]
name peripheral_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name data_transfer_timeout
const "10000"
[end_parameter]

[parameter]
name usb_transfer_size
const 4096
[end_parameter]

##########################
# Endpoint configuration #
##########################

[parameter]
name ep_configuration_file
const "/usr/share/blts-usb-tests/ep-configuration-bulk.cfg"
[end_parameter]

################
# Driver setup #
################

[test]
name "USB - Setup host driver"
params host_driver host_driver_path
[end_test]

[test]
name "USB - Setup peripheral driver"
params peripheral_driver peripheral_driver_path usb_transfer_size ep_configuration_file
[end_test]

#######################
# Data transfer cases #
#######################

[test]
name "USB - Read test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]

[test]
name "USB - Write test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]
</pre>

To change the endpoint configuration, you will have to edit ep-configuration files. For example, provided <code>ep-configuration-bulk.cfg</code> looks like this by default:
<pre>
# device_speed used_speed max_power
high any 50
# endpoint type direction max_packet_size interval
1 bulk in 512 9
2 bulk out 512 9
</pre>
The lines starting with # are comments and document provided parameters. Device_speed is the highest speed used device is supposed to be able handle (any/low/full/high) and used_speed the operational speed during test execution. This can be used to force the device to use lower speed than normally would be used. To add new pair of bulk endpoints simply add following lines to the file:
<pre>
3 bulk in 512 9
4 bulk out 512 9
</pre>
Do note that you can put different endpoint types to the same configuration so there can be any combination of bulk, interrupt and isochronous endpoints as long as device supports this.

== Module Design and Architecture ==

Debian package is provided which includes both host and peripheral drivers in addition to test runner. This package can be installed on all devices under testing, although functionality depends on used hardware.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
| USB Specification || [http://www.usb.org/developers/docs/ USB documentation]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 8-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|}

Quality/TestSuite/USB Driver Test Specification

2010-09-28T08:16:13Z

Klaakso: /* Configuration file examples */

== Introduction ==
USB peripheral test cases are made between host (e.g. PC) and peripheral gadget (e.g. N900). Both ends have their own drivers which communicate and transfer data between different endpoints.

== Test Coverage ==

Each test case must be run independently and devices must be preset according to case requirements using provided setup test cases. In practice, this means for example data transfer requires preconnected host enabled USB cable and host mode supporting device is connected to system. Each test case prints out required user interaction to terminal.
* USB - Setup host driver
* USB - Setup peripheral driver
* USB - Read test
* USB - Write test

=== Software Coverage ===

Current coverage for USB tests:
* [[http://gitorious.org/qa-tools/mcts-coverage/blobs/master/USB-core-coverage.ods USB-coverage.ods]]

=== Hardware Coverage ===

USB bulk and isochronous endpoint transfer test cases. Those who know more about USB transfer can also alter endpoint configurations via configuration files. Example configurations are provided with the test package.

=== Limitations ===
* Drivers must be initialized before running other test cases.
* All other gadget drivers MUST be unloaded before test execution in used DUT!
* All USB cables MUST be disconnected when executing initializations!

=== Future Improvements ===
* Support for simultaneous data transfer on multiple endpoints.
* Automated test execution and peripheral DUT driver selection.
* Official unique USB driver ID.

== Running the tests ==

=== Hardware setup and test execution order ===

Required hardware:
* Supported USB cable
* Device with USB host capability (e.g. PC)
* Device with USB peripheral capability (e.g. N900)

How to setup test enviroment:
# Make sure usb cable is disconnected between devices
# Set up host side (e.g. PC) by running test 'USB - Setup host driver'
# Set up gadget side (peripheral device) by running test 'USB - Setup peripheral driver'
# Connect cable
# Execute tests

NOTE: Before executing test cases it must be determined if used devices are capable of acting as peripheral or host. This depends on USB controller chips of devices and necessary information should be available from device vendors. Furthermore, current gadget driver implementation is built over MUSB driver implementation available in Linux kernel. Possible different implementations by device vendors may cause incompatibility with this test driver. 
<code>$ blts_usb_testrunner -C [config file] -e [test number]</code>

=== Configuration files ===
This test asset uses two configuration files: One for generic test execution options and one for endpoint configuration. Endpoint configuration file is linked to base configuration files thus only base file path is given as parameter. Configuration files must be used, as they contain endpoint configuration for driver.

Currently following example base configuration files are included in the package:
* blts-usb-testrunner-bulk.cnf
* blts-usb-testrunner-int.cnf
* blts-usb-testrunner-isoc.cnf

The base files are linked to endpoint configuration files and following examples are provided with test package:
* ep-configuration-bulk.cfg
* ep-configuration-int.cfg
* ep-configuration-isoc.cfg

NOTE: Supported endpoint configurations differ from device to device and they should be modified according to test execution requirements. These configuration files are provided as examples and should not be used as such during proper test execution.

=== Common test execution guidelines ===

NOTE:
* Default config files are installed to /usr/share/blts-usb-tests/.
* Drivers must be initialized before running other test cases.
* All USB cables MUST be disconnected when executing initializations!

NOTE: All other gadget drivers MUST be unloaded before test execution in used DUT!

You can use command lsmod to determine which modules are loaded in memory:

<code>$ lsmod</code>

See if some gadget driver is found. For example g_file_storage is a mass storage module, but this depends on used HW and SW. The module can be unloaded with following command:

<code>$ modprobe -r g_file_storage</code>

=== Test case arguments ===

Arguments: 

{|cellspacing="0" border="1"
!|Switch
!|Function

|-
|| -C || Used parameter configuration file
|-
|| -l || Used log file, default blts_skeleton_run.log
|-
|| -e || Execute single or multiple selected tests, for example -e 1,4,5.
|-
|| -en || Execute test by name, for example -en "My test X"
|-
|| -s || Show list of all tests
|-
|| -? || Help message
|-
|| -nc || Do not output log to terminal
|-
!|Optional switch
!|Function
|-
|| -h || Use given host driver (default: blts_usb_host), for example -h blts_usb_host
|-
|| -p || Use given peripheral driver (default: blts_gadget), for example -h blts_gadget
|}

=== Test cases ===
Test case execution notices:
{|cellspacing="0" border="1"
!|Case name
!|Notice
|-
|| USB - Setup host driver* ||
|-
|| USB - Setup peripheral driver# || Use configuration file to create specific setup, bulk endpoints are created by default
|-
|| USB - Read test* || Read data from endpoints
|-
|| USB - Write test* || Write data to endpoints
|}
''* This test is run on host device.'' 
''# This test is run on peripheral device.''

=== Configuration file examples ===
The test asset allows you to change all endpoint parameters via configuration files. Since the USB (2.0) specification only states the valid range for different settings, it is possible to give any values as long as they fit inside these ranges. The test asset allows experimenting with different configurations and "triangulation" of what works and what does not. Naturally there are certain HW related restrictions such as total transfer capacity which obviously cannot be exceeded with endpoint configuration. Basic test asset configurations is done with base configuration files, such as provided <code>blts-usb-testrunner-bulk.cnf</code>:

<pre>
# USB test case configuration for parameters

######################
# General parameters #
######################

[parameter]
name host_driver
const "blts_usb_host"
[end_parameter]

[parameter]
name host_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name peripheral_driver
const "blts_gadget"
[end_parameter]

[parameter]
name peripheral_driver_path
const "/usr/lib/tests/blts-usb-tests/"
[end_parameter]

[parameter]
name data_transfer_timeout
const "10000"
[end_parameter]

[parameter]
name usb_transfer_size
const 4096
[end_parameter]

##########################
# Endpoint configuration #
##########################

[parameter]
name ep_configuration_file
const "/usr/share/blts-usb-tests/ep-configuration-bulk.cfg"
[end_parameter]

################
# Driver setup #
################

[test]
name "USB - Setup host driver"
params host_driver host_driver_path
[end_test]

[test]
name "USB - Setup peripheral driver"
params peripheral_driver peripheral_driver_path usb_transfer_size ep_configuration_file
[end_test]

#######################
# Data transfer cases #
#######################

[test]
name "USB - Read test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]

[test]
name "USB - Write test"
params host_driver host_driver_path peripheral_driver peripheral_driver_path usb_transfer_size
[end_test]
</pre>

To change the endpoint configuration, you will have to edit ep-configuration files. For example, provided <code>ep-configuration-bulk.cfg</code> looks like this by default:
<pre>
# device_speed used_speed max_power
high any 50
# endpoint type direction max_packet_size interval
1 bulk in 512 9
2 bulk out 512 9
</pre>
The lines starting with # are comments and document provided parameters. Device_speed is the highest speed used device is supposed to be able handle (any/low/full/high) and used_speed the operational speed during test execution. This can be used to force the device to use lower speed than normally would be used. To add new pair of bulk endpoints simply add following lines to the file:
<pre>
3 bulk in 512 9
4 bulk out 512 9
</pre>
Do note that you can put different endpoint types to the same configuration so there can be any combination of bulk, interrupt and isochronous endpoints as long as device supports this.

== Module Design and Architecture ==

Debian package is provided which includes both host and peripheral drivers in addition to test runner. This package can be installed on all devices under testing, although functionality depends on used hardware.

=== Architecture diagram ===

== References ==
{|cellspacing="0" border="1"
| USB Specification || [http://www.usb.org/developers/docs/ USB documentation]
|}

== Change History ==
{|cellspacing="0" border="1"
!|Version
!|Date
!|Handled By
!|Status
!|Comments

|-
|| 0.1 || 8-sep-2010 || [mailto:ext-iekku.huttunen@nokia.com Iekku Huttunen] || Draft || Page created
|}