#!/usr/bin/python
# Copyright (c) 2005 by Mark T. Holder, Florida State University. (see end of file)
from PIPRes.util.ui_xml import *
from PIPRes.util.io import cipresGetLogger
from cStringIO import StringIO
import unittest
_LOG = cipresGetLogger('pipres.util.test_ui_xml')

class CipresUI_XML_Test(unittest.TestCase):
    def testRoundtrip(self):
        a = StringIO(ridcm3XML)
        readUICmdParamGroupFromXMLObj(a)

ridcm3XML = """<?xml version="1.0" encoding="UTF-8"?>
<service-command-panel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="CipresCommandLanguage.xsd" label="RID3">
        <cmd-params name="LimitRecursionBy">
                <datatype>Excl</datatype>
                <is-mandatory>false</is-mandatory>
                <label>Limit Recursion by</label>
                <tool-tip-text>Specifies which method to use for limiting recursion</tool-tip-text>
                <list-item>
                        <value>none</value>
                        <display>No taxa-based recursion limit</display>
                </list-item>
                <list-item is-default="true">
                        <value>MaxTaxaSubsetSize</value>
                        <display>Taxa Subset Size</display>
                </list-item>
                <list-item>
                        <value>MaxTaxaSubsetPercent</value>
                        <display>Percent Taxa Subset Size</display>
                </list-item>
                <code-template>$LimitRecursionBy</code-template>
                <cmd-params name="MaxTaxaSubsetSize">
                        <datatype>Integer</datatype>
                        <is-mandatory>false</is-mandatory>
                        <label>Max Taxa Subset Size</label>
                        <default-value>20</default-value>
                        <tool-tip-text>Specifies the maximum size of taxa subsets for small tree inference.  The algorithm will decompose taxa subsets until either Max Taxa Subset Size or Max Recursion Levels are acheived.</tool-tip-text>
                        <code-template>SetMaxTaxaSubsetSize=$MaxTaxaSubsetSize;</code-template>
                        <test test-name="unnamed-0">
                                <left-operand>$MaxTaxaSubsetSize</left-operand>
                                <operator>greater_than</operator>
                                <right-operand>3</right-operand>
                        </test>
                        <test test-name="unnamed-1">
                                <left-operand>$LimitRecursionBy</left-operand>
                                <operator>equals</operator>
                                <right-operand>MaxTaxaSubsetSize</right-operand>
                        </test>
                        <requirement-test-expression>unnamed-0</requirement-test-expression>
                        <requirement-test-expression-message>the "Max Taxa Subset Size" setting must be greater than 3</requirement-test-expression-message>
                        <availability-test-expression>unnamed-1</availability-test-expression>
                        <availability-test-expression-message>the "Limit Recursion by" setting must equal MaxTaxaSubsetSize</availability-test-expression-message>
                </cmd-params>
                <cmd-params name="MaxTaxaSubsetPercent">
                        <datatype>Float</datatype>
                        <is-mandatory>false</is-mandatory>
                        <label>Percent Taxa Subset Size</label>
                        <default-value>75</default-value>
                        <tool-tip-text>Specifies the maximum size of taxa subsets for small tree inference as a percentage of the total number of characters.  The algorithm will decompose taxa into subsets until the subset is no bigger than 'Max Taxa Percent' or Max Recursion Levels are acheived.</tool-tip-text>
                        <code-template>SetMaxTaxaSubsetPercent=$MaxTaxaSubsetPercent;</code-template>
                        <test test-name="unnamed-2">
                                <left-operand>$MaxTaxaSubsetPercent</left-operand>
                                <operator>greater_than</operator>
                                <right-operand>0</right-operand>
                        </test>
                        <test test-name="unnamed-3">
                                <left-operand>$MaxTaxaSubsetPercent</left-operand>
                                <operator>less_or_equal</operator>
                                <right-operand>100</right-operand>
                        </test>
                        <test test-name="unnamed-4">
                                <left-operand>$LimitRecursionBy</left-operand>
                                <operator>equals</operator>
                                <right-operand>MaxTaxaSubsetPercent</right-operand>
                        </test>
                        <requirement-test-expression>(unnamed-2 and unnamed-3)</requirement-test-expression>
                        <requirement-test-expression-message>'Max Taxa Percent' must be a decimal number greater than 0 (e.g. 25.5 means 25.5 %)</requirement-test-expression-message>
                        <availability-test-expression>unnamed-4</availability-test-expression>
                        <availability-test-expression-message>the "Limit Recursion by" setting must equal MaxTaxaSubsetPercent</availability-test-expression-message>
                </cmd-params>
        </cmd-params>
        <cmd-params name="MaxRecursionLevels">
                <datatype>Integer</datatype>
                <is-mandatory>false</is-mandatory>
                <label>Max Recursion Levels</label>
                <tool-tip-text>Specifies the recursion levels for decomposing taxa subsets prior to small tree inference.  The algorithm will decompose taxa subsets until either Max Taxa Subset Size or Max Recursion Levels are acheived</tool-tip-text>
                <code-template>SetMaxRecursionLevels=$MaxRecursionLevels;</code-template>
                <test test-name="unnamed-5">
                        <left-operand>$MaxRecursionLevels</left-operand>
                        <operator>greater_or_equal</operator>
                        <right-operand>0</right-operand>
                </test>
                <requirement-test-expression>unnamed-5</requirement-test-expression>
                <requirement-test-expression-message>the "Max Recursion Levels" setting must be greater than or equal to 0</requirement-test-expression-message>
        </cmd-params>
        <cmd-params name="MaxIterations">
                <datatype>Integer</datatype>
                <is-mandatory>false</is-mandatory>
                <label>Max # Iterations</label>
                <default-value>2</default-value>
                <tool-tip-text>Specifies the maximum number of iterations.  The algorithm will continue until either the Max # Iterations or Max Analysis Time is acheived</tool-tip-text>
                <code-template>SetMaxIterations=$MaxIterations;</code-template>
                <test test-name="unnamed-6">
                        <left-operand>$MaxIterations</left-operand>
                        <operator>greater_than</operator>
                        <right-operand>0</right-operand>
                </test>
                <requirement-test-expression>unnamed-6</requirement-test-expression>
                <requirement-test-expression-message>the "Max # Iterations" setting must be greater than 0</requirement-test-expression-message>
        </cmd-params>
        <cmd-params name="MaxAnalysisTime">
                <datatype>Integer</datatype>
                <is-mandatory>false</is-mandatory>
                <label>Max Analysis Time (hr)</label>
                <default-value>1000000</default-value>
                <tool-tip-text>Specifies the maximum analysis time.  The algorithm will continue until either the Max # Iterations or Max Analysis Time is acheived</tool-tip-text>
                <code-template>SetMaxAnalysisTime=$MaxAnalysisTime;</code-template>
                <test test-name="unnamed-7">
                        <left-operand>$MaxAnalysisTime</left-operand>
                        <operator>greater_than</operator>
                        <right-operand>0</right-operand>
                </test>
                <requirement-test-expression>unnamed-7</requirement-test-expression>
                <requirement-test-expression-message>the "Max Analysis Time (hr)" setting must be greater than 0</requirement-test-expression-message>
        </cmd-params>
        <cmd-params name="TreeDecompModule">
                <datatype>Excl</datatype>
                <repository-iD>IDL:CipresIDL_api1/TreeDecompose:1.0</repository-iD>
                <is-mandatory>true</is-mandatory>
                <label>Tree Decomposer Module</label>
                <tool-tip-text>Specifies the module to employ for Tree Decomposition</tool-tip-text>
                <code-template>SetTreeDecompModule=$TreeDecompModule</code-template>
        </cmd-params>
        <cmd-params name="LargeTreeInferenceModule">
                <datatype>Excl</datatype>
                <repository-iD>IDL:CipresIDL_api1/TreeImprove:1.0</repository-iD>
                <is-mandatory>true</is-mandatory>
                <label>Large Tree Inference Module</label>
                <tool-tip-text>Specifies the module to employ for large (full) tree inference</tool-tip-text>
                <list-item>
                        <value>none</value>
                        <display>No large tree inference</display>
                </list-item>
                <code-template>SetLargeTreeInferenceModule=$LargeTreeInferenceModule</code-template>
        </cmd-params>
        <cmd-params name="SmallTreeInferenceModule">
                <datatype>Excl</datatype>
                <repository-iD>IDL:CipresIDL_api1/TreeImprove:1.0</repository-iD>
                <is-mandatory>true</is-mandatory>
                <label>Small Tree Inference Module</label>
                <tool-tip-text>Specifies the module to employ for tree inference for subsets of the taxa</tool-tip-text>
                <code-template>SetSmallTreeInferenceModule=$SmallTreeInferenceModule</code-template>
        </cmd-params>
        <cmd-params name="TreeMergeModule">
                <datatype>Excl</datatype>
                <repository-iD>IDL:CipresIDL_api1/TreeMerge:1.0</repository-iD>
                <is-mandatory>true</is-mandatory>
                <label>Tree Merge Module</label>
                <tool-tip-text>Specifies the module to employ for tree merger (the supertree step)</tool-tip-text>
                <code-template>SetTreeMergeModule=$TreeMergeModule</code-template>
        </cmd-params>
        <cmd-params name="TreeRefineModule">
                <datatype>Excl</datatype>
                <repository-iD>IDL:CipresIDL_api1/TreeRefine:1.0</repository-iD>
                <is-mandatory>true</is-mandatory>
                <label>Tree Refine Module</label>
                <tool-tip-text>Specifies the module to employ for tree refining (merged trees often have polytomies)</tool-tip-text>
                <code-template>SetTreeRefineModule=$TreeRefineModule</code-template>
        </cmd-params>
</service-command-panel>
"""
if __name__ == '__main__':
    import os
    if 'CIPRES_TEST_UI' in os.environ:
        unittest.main()

#    This file is part of the PIPRes library
#    The PIPRes library is free software; you can redistribute it
#    and/or modify it under the terms of the GNU Lesser General
#    Public License as published by the Free Software Foundation;
#    either version 2.1 of the License, or (at your option) any later
#    version.
#
#    This library is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU Lesser General Public License for more details.
#
#    You should have received a copy of the GNU Lesser General Public
#    License along with this library; if not, write to the Free
#    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
#    MA 02111-1307, USA