#

# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of "Eclipse Public License v1.0"

# which accompanies this distribution, and is available

# at the URL "http://www.eclipse.org/legal/epl-v10.html".

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description: 

#

"""

Test the CPF root file parsing routines

"""

import unittest

import os

import shutil

from cone.public import api, persistence, utils

from cone.storage import filestorage

from cone.confml import persistentconfml, model, confmltree

from testautomation.base_testcase import BaseTestCase

ROOT_PATH = os.path.dirname(os.path.abspath(__file__))

ElementTree = utils.etree

testdata  = os.path.join(ROOT_PATH,'data')

simplerootxml = \

'''<?xml version="1.0" encoding="UTF-8"?>

<configuration xmlns="http://www.s60.com/xml/confml/1" xmlns:xi="http://www.w3.org/2001/xinclude" name="simple" version="1">

  <xi:include href="platform/s60/confml/test.confml#/"/>

</configuration>

'''

newincludexml = '''<?xml version="1.0" encoding="UTF-8"?>

<configuration xmlns="http://www.s60.com/xml/confml/1" xmlns:xi="http://www.w3.org/2001/XInclude" name="simple" version="1">

  <xi:include href="platform/s60/confml/test.confml"/>

</configuration>'''

complexrootxml = '''<?xml version="1.0" encoding="UTF-8"?>

<configuration xmlns="http://www.s60.com/xml/confml/1" xmlns:xi="http://www.w3.org/2001/xinclude" name="simple" version="1">

  <xi:include href="platform/s60/confml/test.confml#/"/>

  <xi:include href="platform/jallaa/confml/root.confml#/"/>

  <xi:include href="configB/confml/configB.confml#/"/>

  <xi:include href="ncp33/prod/confml/root.confml#/"/>

</configuration>'''

morestuff='''<?xml version="1.0" encoding="UTF-8"?>

<configuration id="conf_id" xmlns="http://www.s60.com/xml/confml/1" xmlns:xi="http://www.w3.org/2001/xinclude" name="foobar" version="1">

  <meta xmlns:cv="http://www.nokia.com/xml/cpf-id/1">

    <cv:configuration-property name="coreplat_name" value="abc_123" />

    <cv:configuration-property name="product_name" value="qwerty" />

    <owner>Variant1 creator</owner>

    <origin>somestorage:somelocation_123/and/path</origin>

    <target>proto_b2</target>

  </meta>

  <desc>This is a configuration for Product1 Region1 Variant1 </desc>

  <xi:include href="platform/s60/confml/root.confml"/>

  <xi:include href="ncp11/confml/jallaa.confml"/>

  <xi:include href="ncp11/prodX/confml/root.confml"/>

  <xi:include href="regional/japan/confml/root.confml"/>

</configuration>'''

actualconfml='''<?xml version="1.0" encoding="UTF-8"?>

<configuration xmlns="http://www.s60.com/xml/confml/1" name="accesspoints">

  <feature ref="KCRUidApEngineLV" name="KCRUidApEngineLV">

    <desc></desc>

    <setting ref="KApEngineLVFlags" name="KApEngineLVFlags"/>

  </feature>

  <feature ref="KCRUidApSettingsHandlerUiLV" name="KCRUidApSettingsHandlerUiLV">

    <desc></desc>

    <setting ref="KApSettingsHandlerUiLVFlags" name="KApSettingsHandlerUiLVFlags"/>

    <setting ref="KAIStatusPaneLayout" name="Status Pane Layout" type="selection">

      <desc>Status pane layout setting. 0 = normal, 1 = flat, 2 = hidden</desc>

      <option name="normal" value="0"/>

      <option name="flat" value="1"/>

      <option name="hidden" value="2"/>

    </setting>

  </feature>

  <feature name="Customer Menu" ref="CVC_OperatorMenu">

    <desc>Often referred to as the Operator Menu, the Customer Menu is an application that launches the browser as an embedded application with a predefined URL as parameter. The URL defines the xHTML Startup page that is shown when the Customer Menu application is launched, for example www.customername.com/index.html. The URL also defines the customer domain URL path, for example www.customername.com/. All user-browsed xHTML pages belonging to that path are automatically stored in the Customer Menu cache.The Customer Menu application can be configured as a shortcut just like any other application. In Main menu, the Customer Menu is placed by default to 11th position. When the Customer Menu is enabled, Help moves from position 11 to 12 and Apps moves from 12 to 13, which is not visible until the user scrolls the menu cursor.</desc>

       <setting name="Customer Menu icon" ref="CVC_OperatorMenuIconFile" type="file">

            <desc>Customer menu icon that will be present in Application Grid. Size: 65 x 65 pixels. Format: SVGT (preferred) or BMP. Color depth: 24 bit</desc>

        <localPath/>

        <targetPath readOnly="true"/>

      </setting>

  </feature>

  <data>

    <KCRUidApEngineLV>

      <KApEngineLVFlags>0</KApEngineLVFlags>

    </KCRUidApEngineLV>

    <KCRUidApSettingsHandlerUiLV>

      <KApSettingsHandlerUiLVFlags>0</KApSettingsHandlerUiLVFlags>

      <KAIStatusPaneLayout>0</KAIStatusPaneLayout>

    </KCRUidApSettingsHandlerUiLV>

    <CVC_OperatorMenu>

      <CVC_OperatorMenuIconFile>

        <localPath>UI/Customer Menu/Cache</localPath>

      </CVC_OperatorMenuIconFile>

    </CVC_OperatorMenu>

  </data>

  <rfs>

    <KCRUidApEngineLV>

      <KApEngineLVFlags>true</KApEngineLVFlags>

    </KCRUidApEngineLV>

    <KCRUidApSettingsHandlerUiLV>

      <KApSettingsHandlerUiLVFlags>false</KApSettingsHandlerUiLVFlags>

    </KCRUidApSettingsHandlerUiLV>

  </rfs>

</configuration>

'''

sequencesettings = \

'''<?xml version="1.0" encoding="utf-8"?><configuration xmlns="http://www.s60.com/xml/confml/1" name="BrowserBookmarks">

<feature name="BookmarkItems" ref="BookmarkItems">

  <setting name="BookmarkItem" ref="BookmarkItem" type="sequence">

    <setting name="Type Of Bookmark" ref="Type" type="selection">

      <desc>This defines the Type of the element created. To create a Folder item - select "Folder". To create a bookmark item - select "Item".</desc>

      <option name="Folder" value="Folder"/>

      <option name="Item" value="Item"/>

    </setting>

    <setting name="Name Of The New Entry" ref="Name" type="string">

      <desc>Text field containing name for the Folder or Bookmark.  Must be unique.</desc>

    </setting>

  </setting>

</feature>

<data>

  <BookmarkItems>

    <BookmarkItem template="true">

      <Type>Template</Type>

      <Name>Download Applications</Name>

    </BookmarkItem>

    <BookmarkItem>

      <Type>Folder1</Type>

      <Name>Download Applications</Name>

    </BookmarkItem>

    <BookmarkItem>

      <Type>Folder2</Type>

      <Name>Download Images</Name>

    </BookmarkItem>

    <BookmarkItem>

      <Type>Folder3</Type>

    </BookmarkItem>

  </BookmarkItems>

</data>

</configuration>

'''

simpleview = \

'''<?xml version="1.0" encoding="UTF-8"?>

<confml:configuration  xmlns:confml="http://www.s60.com/xml/confml/1" schemaLocation="http://www.s60.com/xml/confml/1 http://www.s60.com/xml/confml/1#//confml2">

  <feature ref="imaker" name="iMaker Image creation">

    <setting ref="imagetarget" name="IMAGE_TARGET" type="selection">

      <option name="core" value="0"/>

      <option name="rofs2" value="1"/>

      <option name="rofs3" value="2"/>

      <option name="rofs4" value="3"/>

      <option name="uda" value="4"/>

      <option name="rofs3_uda" value="4"/>

    </setting>

  </feature>

  <feature ref="imakerapi" name="iMaker API">

    <setting ref="imagetype" name="IMAGE_TYPE" type="selection">

      <option name="rnd" value="0"/>

      <option name="subcon" value="1"/>

      <option name="prd" value="2"/>

    </setting>

    <setting ref="rofs3version" name="ROFS3_VERSION" type="string"/>

    <setting ref="productname" name="PRODUCT_NAME" type="string"/>

    <setting ref="outputLocation" name="OUTPUT_LOCATION" type="string"/>

  </feature>

  <data>

    <imaker>

      <imagetarget>2</imagetarget>

    </imaker>

    <imakerapi>

      <imagetype>0</imagetype>

      <rofs3version>V .50.2009.04.0113 RND</rofs3version>

      <productname>myProduct</productname>

      <outputLocation>myProduct</outputLocation>

    </imakerapi>

  </data>

  <confml:view id="imakerimage" name="Image creation">

    <confml:desc>Image creation related settings</confml:desc>

    <confml:group name="Imageproperties / test">

      <confml:desc>Sample Description</confml:desc>

      <confml:setting ref="imakerapi/imagetype"/>

      <confml:setting ref="imakerapi/rofs3version"/>

      <confml:setting ref="imakerapi/productname"/>

      <confml:setting ref="imakerapi/outputLocation"/>

      <confml:setting ref="imaker/*"/>

    </confml:group>

  </confml:view>

</confml:configuration>

'''

overrideview = \

'''<?xml version="1.0" encoding="UTF-8"?>

<configuration  xmlns="http://www.s60.com/xml/confml/2" schemaLocation="http://www.s60.com/xml/confml/1 http://www.s60.com/xml/confml/1#//confml2">

  <feature ref="imakerapi" name="iMaker API">

    <setting ref="imagetype" name="IMAGE_TYPE" type="selection">

      <option name="rnd" value="0"/>

      <option name="subcon" value="1"/>

      <option name="prd" value="2"/>

    </setting>

    <setting ref="productname" name="PRODUCT_NAME" type="string"/>

    <setting ref="outputLocation" name="OUTPUT_LOCATION" type="string"/>

  </feature>

  <data>

    <imakerapi>

      <imagetype>0</imagetype>

      <productname>myProduct</productname>

      <outputLocation>myProduct</outputLocation>

    </imakerapi>

  </data>

  <view id="imakerimage" name="Image creation">

    <desc>Image creation related settings</desc>

    <group name="Imageproperties">

      <desc>Sample Description</desc>

      <setting ref="imakerapi/imagetype">

          <option name="prd_renamed" value="2"/>

      </setting>

      <setting ref="imakerapi/productname" name="New Product Name">

        <desc>test desc override</desc>

        <minLength value="2" />

      </setting>

      <setting ref="imakerapi/outputLocation" minOccurs="2"/>

    </group>

  </view>

</configuration>

'''

option_overrideview = \

'''<?xml version="1.0" encoding="UTF-8"?>

<configuration  xmlns="http://www.s60.com/xml/confml/2" schemaLocation="http://www.s60.com/xml/confml/1 http://www.s60.com/xml/confml/1#//confml2">

  <feature ref="imakerapi" name="iMaker API">

    <setting ref="imagetype" name="IMAGE_TYPE" type="selection">

      <option name="rnd" value="0"/>

      <option name="subcon" value="1"/>

      <option name="prd" value="2"/>

    </setting>

    <setting ref="productname" name="PRODUCT_NAME" type="string"/>

    <setting ref="outputLocation" name="OUTPUT_LOCATION" type="string"/>

  </feature>

  <data>

    <imakerapi>

      <imagetype>0</imagetype>

      <productname>myProduct</productname>

      <outputLocation>myProduct</outputLocation>

    </imakerapi>

  </data>

  <view id="imakerimage" name="Image creation">

    <desc>Image creation related settings</desc>

    <group name="Imageproperties">

      <desc>Sample Description</desc>

      <setting ref="imakerapi/imagetype">

          <option name="prd2" value="2"/>

          <option name="newoption" value="5"/>

      </setting>

      <setting ref="imakerapi/productname" name="New Product Name">

        <desc>test desc override</desc>

        <minLength value="2" />

      </setting>

      <setting ref="imakerapi/outputLocation" minOccurs="2"/>

    </group>

  </view>

</configuration>

'''

properties_overrideview = \

'''<?xml version="1.0" encoding="UTF-8"?>

<configuration  xmlns="http://www.s60.com/xml/confml/2" schemaLocation="http://www.s60.com/xml/confml/1 http://www.s60.com/xml/confml/1#//confml2">

  <feature ref="imakerapi" name="iMaker API">

    <setting ref="imagetype" name="IMAGE_TYPE" type="selection">

      <option name="rnd" value="0"/>

      <option name="subcon" value="1"/>

      <option name="prd" value="2"/>

      <property name="mime" value="image/svgt image/bmp"/>

    </setting>

    <setting ref="productname" name="PRODUCT_NAME" type="string"/>

    <setting ref="outputLocation" name="OUTPUT_LOCATION" type="string"/>

  </feature>

  <data>

    <imakerapi>

      <imagetype>0</imagetype>

      <productname>myProduct</productname>

      <outputLocation>myProduct</outputLocation>

    </imakerapi>

  </data>

  <view id="imakerimage" name="Image creation">

    <desc>Image creation related settings</desc>

    <group name="Imageproperties">

      <desc>Sample Description</desc>

      <setting ref="imakerapi/imagetype">

      <property name="mime" value="image/svgt image/jpg"/>

      <property name="mime2" value="image/svgt image/bmp"/>

      </setting>

      <setting ref="imakerapi/productname" name="New Product Name">

        <desc>test desc override</desc>

        <minLength value="2" />

      </setting>

      <setting ref="imakerapi/outputLocation" minOccurs="2"/>

    </group>

  </view>

</configuration>

'''

selectionsetting = \

'''<?xml version="1.0" encoding="UTF-8"?>

<configuration xmlns="http://www.s60.com/xml/confml/2" name="Test features for testing name-ID mappings"><feature ref="CTD_APs" name="GPRS Access Points" ><desc>GPRS connection method (CM) definitions</desc>

        <setting ref="AP"

                name="GPRS"

                type="sequence"

                minOccurs="0"

                maxOccurs="99"

                displayName="ConnectionName"

                mapValue="DestinationNetwork"

                mapKey="GPRS_AP_Name">

            <setting ref="GPRS_AP_Name" name="GPRS Access Point Name" type="string">

                <desc>The access point name for this GPRS connection</desc>

            </setting>

            <setting ref="ConnectionName" name="Connection Name" type="string">

                <desc>The access point name that is visible to the user.</desc>

            </setting>

            <setting ref="DestinationNetwork" name="Destination Network" type="selection">

                <desc>Select destination network for access point</desc>

                <option name="Internet" value="1"/>

                <option name="MMS" value="2"/>

                <option name="Wap Services" value="3"/>

            </setting>

            <setting ref="NetworkType" name="Network type" type="selection">

                <desc>Addressing that the network uses.</desc>

                <option name="IPv4" value="IPv4"/>

                <option name="IPv6" value="IPv6"/>

            </setting>

        </setting>

    </feature>

    <feature ref="TestApplication" name="Test internet application">

        <setting ref="ConfirmFromUser" name="Confirm internet access" type="boolean">

            <desc>Confirm the internet access from user?</desc>

        </setting>

        <setting ref="DefaultAP" name="Default access point" type="selection">

            <option map="CTD_APs/AP"></option>

        </setting>

    </feature>

    <data>

        <CTD_APs>

            <AP template="true">

                <DestinationNetwork>Internet</DestinationNetwork>

                <NetworkType>IPv4</NetworkType>

            </AP>

            <AP>

                <GPRS_AP_Name>Operator 1</GPRS_AP_Name>

                <ConnectionName>Operator Internet</ConnectionName>

                <DestinationNetwork>Internet</DestinationNetwork>

                <NetworkType>IPv4</NetworkType>

            </AP>

            <AP>

                <GPRS_AP_Name>Test</GPRS_AP_Name>

                <ConnectionName>Test Connection</ConnectionName>

                <DestinationNetwork>Internet</DestinationNetwork>

                <NetworkType>IPv4</NetworkType>

            </AP>

        </CTD_APs>

        <TestApplication>

            <ConfirmFromUser>true</ConfirmFromUser>

            <DefaultAP map="CTD_APs/AP[@key='Operator 1']"></DefaultAP>

        </TestApplication>

    </data>

</configuration>

'''

multiselection = \

'''<?xml version="1.0" encoding="UTF-8"?>

<configuration xmlns="http://www.s60.com/xml/confml/2" name="Test features for testing name-ID mappings">

  <feature ref="aFeature">

    <setting type="sequence" ref="exampleSequence" mapKey="id" mapValue="someName">

      <setting type="int" ref="id"/>

      <setting type="string" ref="someName"/>

      <setting type="string" ref="someData"/>

    </setting>

    <setting ref="selectionSetting" name="Selection Setting" type="selection">

      <option map="aFeature/exampleSequence"/>

    </setting>

    <setting ref="multiselectionSetting" name="Multi-selection Setting" type="multiSelection">

      <option name="default selection" value=""/>

      <option map="aFeature/exampleSequence"/>

    </setting>

    <setting ref="multiselectionSettingOverride" name="Multi-selection Setting with options override" type="multiSelection">

      <option map="aFeature/exampleSequence" displayName="someName" mapValue="someData"/>

    </setting>

  </feature>

  <data>

    <aFeature>

    <exampleSequence>

      <id>12</id>

      <someName>foo</someName>

      <someData>Real data is here!</someData>

    </exampleSequence>

    <exampleSequence>

      <id>34</id>

      <someName>bar</someName>

      <someData>I am not FOO!</someData>

    </exampleSequence>

    <selectionSetting map="aFeature/exampleSequence[@key='12']"/>

    <multiselectionSetting>0</multiselectionSetting>

    <multiselectionSetting map="aFeature/exampleSequence[@key='12']"/>

    <multiselectionSetting map="aFeature/exampleSequence[@key='34']"/>

    <multiselectionSettingOverride map="aFeature/exampleSequence[@key='12']"/>

    <multiselectionSettingOverride map="aFeature/exampleSequence[@key='34']"/>

    </aFeature>

  </data>

</configuration>

'''

class TestModuleGetters(unittest.TestCase):

    def test_get_reader_for_configuration(self):

        confread = persistentconfml.get_reader_for_elem("configuration")

        self.assertTrue(isinstance(confread, persistentconfml.ConfigurationReader))

    def test_get_writer_for_configuration(self):

        confread = persistentconfml.get_writer_for_class("Configuration")

        self.assertTrue(isinstance(confread, persistentconfml.ConfigurationWriter))

    def test_get_elemname_from_string(self):

        self.assertEquals(persistentconfml.get_elemname("{http://www.s60.com/xml/confml/1}configuration")[0],"http://www.s60.com/xml/confml/1")

        self.assertEquals(persistentconfml.get_elemname("{http://www.s60.com/xml/confml/1}configuration")[1],"configuration")

    def test_get_elemname_from_element_tree(self):

        root = ElementTree.fromstring(simplerootxml)

        for elem in root.getiterator():

            (namespace,elemname) = persistentconfml.get_elemname(elem.tag)

        self.assertEquals(elemname,"include")

    def test_loads(self):

        config = persistentconfml.loads(simplerootxml)

        self.assertEquals(config.get_name(),"simple")

    def test_dumps(self):

        config = api.Configuration("test.confml")

        config.include_configuration('path/to/config.confml')

        dump = persistentconfml.dumps(config)

        elem = ElementTree.fromstring(dump)

        self.assertEquals(elem.get('name'),"test_confml")

class TestConfigurationParser(unittest.TestCase):

    def tearDown(self):

        if os.path.exists(os.path.join(ROOT_PATH,'temp')):

            shutil.rmtree(os.path.join(ROOT_PATH,'temp'))

    def test_load_simple(self):

        reader = persistentconfml.get_reader_for_elem("configuration")

        obj = reader.loads(ElementTree.fromstring(simplerootxml))

        self.assertEquals(obj.get_ref(),'simple')

        self.assertEquals(obj.id,None)

        self.assertEquals(obj._list(),['platform__s60__confml__test_confml'])

    def test_load_new_include_confml(self):

        reader = persistentconfml.get_reader_for_elem("configuration")

        obj = reader.loads(ElementTree.fromstring(newincludexml))

        self.assertEquals(obj._list(),['platform__s60__confml__test_confml'])

    def test_load_complexrootxml(self):

        reader = persistentconfml.get_reader_for_elem("configuration")

        obj = reader.loads(ElementTree.fromstring(complexrootxml))

        self.assertEquals(obj._list(),['platform__s60__confml__test_confml',

                                        'platform__jallaa__confml__root_confml', 

                                        'configB__confml__configB_confml', 

                                        'ncp33__prod__confml__root_confml'])

    def test_load_morestuff(self):

        reader = persistentconfml.get_reader_for_elem("configuration")

        obj = reader.loads(ElementTree.fromstring(morestuff))

        self.assertEquals(obj.id, "conf_id")

        self.assertEquals(obj._list(),['_meta','_desc','platform__s60__confml__root_confml', 'ncp11__confml__jallaa_confml', 'ncp11__prodX__confml__root_confml', 'regional__japan__confml__root_confml'])

        met = obj.meta

        self.assertEquals(obj.meta[2].value,'Variant1 creator')

        self.assertEquals(obj.meta[3].value,'somestorage:somelocation_123/and/path')

        self.assertEquals(obj.meta[4].value,'proto_b2')        

        self.assertEquals(obj.meta[0].tag,'configuration-property')

        self.assertEquals(obj.meta[0].value, None)

        self.assertEquals(obj.meta[0].ns,'http://www.nokia.com/xml/cpf-id/1')

        self.assertEquals(obj.meta[0].attrs,{"name": "coreplat_name", "value": "abc_123"})        

        self.assertEquals(obj.desc,'This is a configuration for Product1 Region1 Variant1 ')

    def test_load_morestuff_and_remove_included_configuration(self):

        reader = persistentconfml.get_reader_for_elem("configuration")

        obj = reader.loads(ElementTree.fromstring(morestuff))

        self.assertEquals(obj.list_configurations(),['platform/s60/confml/root.confml', 'ncp11/confml/jallaa.confml', 'ncp11/prodX/confml/root.confml', 'regional/japan/confml/root.confml'])

        obj.remove_configuration('platform/s60/confml/root.confml')

        self.assertEquals(obj.list_configurations(),['ncp11/confml/jallaa.confml', 'ncp11/prodX/confml/root.confml', 'regional/japan/confml/root.confml'])

        for configname in obj.list_configurations():

            obj.remove_configuration(configname)

        self.assertEquals(obj.list_configurations(),[])

    def test_load_actualconfml(self):

        reader = persistentconfml.get_reader_for_elem("configuration")

        obj = reader.loads(ElementTree.fromstring(actualconfml))