/* * Copyright (C) 2011 The Libphonenumber Authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.google.i18n.phonenumbers; import com.google.i18n.phonenumbers.Phonemetadata.NumberFormat; import com.google.i18n.phonenumbers.Phonemetadata.PhoneMetadata; import com.google.i18n.phonenumbers.Phonemetadata.PhoneNumberDesc; import junit.framework.TestCase; import org.w3c.dom.Element; import org.xml.sax.InputSource; import org.xml.sax.SAXException; import java.io.IOException; import java.io.StringReader; import java.util.regex.PatternSyntaxException; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; /** * Unit tests for BuildMetadataFromXml.java * * @author Philippe Liard */ public class BuildMetadataFromXmlTest extends TestCase { // Helper method that outputs a DOM element from a XML string. private static Element parseXmlString(String xmlString) throws ParserConfigurationException, SAXException, IOException { DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance(); DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder(); InputSource inputSource = new InputSource(); inputSource.setCharacterStream(new StringReader(xmlString)); return documentBuilder.parse(inputSource).getDocumentElement(); } // Tests validateRE(). public void testValidateRERemovesWhiteSpaces() { String input = " hello world "; // Should remove all the white spaces contained in the provided string. assertEquals("helloworld", BuildMetadataFromXml.validateRE(input, true)); // Make sure it only happens when the last parameter is set to true. assertEquals(" hello world ", BuildMetadataFromXml.validateRE(input, false)); } public void testValidateREThrowsException() { String invalidPattern = "["; // Should throw an exception when an invalid pattern is provided independently of the last // parameter (remove white spaces). try { BuildMetadataFromXml.validateRE(invalidPattern, false); fail(); } catch (PatternSyntaxException e) { // Test passed. } try { BuildMetadataFromXml.validateRE(invalidPattern, true); fail(); } catch (PatternSyntaxException e) { // Test passed. } } public void testValidateRE() { String validPattern = "[a-zA-Z]d{1,9}"; // The provided pattern should be left unchanged. assertEquals(validPattern, BuildMetadataFromXml.validateRE(validPattern, false)); } // Tests getNationalPrefix(). public void testGetNationalPrefix() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element territoryElement = parseXmlString(xmlInput); assertEquals("00", BuildMetadataFromXml.getNationalPrefix(territoryElement)); } // Tests loadTerritoryTagMetadata(). public void testLoadTerritoryTagMetadata() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "" + ""; Element territoryElement = parseXmlString(xmlInput); PhoneMetadata.Builder phoneMetadata = BuildMetadataFromXml.loadTerritoryTagMetadata("33", territoryElement, "0", ""); assertEquals(33, phoneMetadata.getCountryCode()); assertEquals("2", phoneMetadata.getLeadingDigits()); assertEquals("00", phoneMetadata.getInternationalPrefix()); assertEquals("0011", phoneMetadata.getPreferredInternationalPrefix()); assertEquals("0", phoneMetadata.getNationalPrefixForParsing()); assertEquals("9$1", phoneMetadata.getNationalPrefixTransformRule()); assertEquals("0", phoneMetadata.getNationalPrefix()); assertEquals(" x", phoneMetadata.getPreferredExtnPrefix()); assertTrue(phoneMetadata.getMainCountryForCode()); assertTrue(phoneMetadata.isLeadingZeroPossible()); } public void testLoadTerritoryTagMetadataSetsBooleanFieldsToFalseByDefault() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element territoryElement = parseXmlString(xmlInput); PhoneMetadata.Builder phoneMetadata = BuildMetadataFromXml.loadTerritoryTagMetadata("33", territoryElement, "", ""); assertFalse(phoneMetadata.getMainCountryForCode()); assertFalse(phoneMetadata.isLeadingZeroPossible()); } public void testLoadTerritoryTagMetadataSetsNationalPrefixForParsingByDefault() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element territoryElement = parseXmlString(xmlInput); PhoneMetadata.Builder phoneMetadata = BuildMetadataFromXml.loadTerritoryTagMetadata("33", territoryElement, "00", ""); // When unspecified, nationalPrefixForParsing defaults to nationalPrefix. assertEquals("00", phoneMetadata.getNationalPrefix()); assertEquals(phoneMetadata.getNationalPrefix(), phoneMetadata.getNationalPrefixForParsing()); } public void testLoadTerritoryTagMetadataWithRequiredAttributesOnly() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element territoryElement = parseXmlString(xmlInput); // Should not throw any exception. BuildMetadataFromXml.loadTerritoryTagMetadata("33", territoryElement, "", ""); } // Tests loadInternationalFormat(). public void testLoadInternationalFormat() throws ParserConfigurationException, SAXException, IOException { String intlFormat = "$1 $2"; String xmlInput = "" + intlFormat + ""; Element numberFormatElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); String nationalFormat = ""; assertTrue(BuildMetadataFromXml.loadInternationalFormat(metadata, numberFormatElement, nationalFormat)); assertEquals(intlFormat, metadata.getIntlNumberFormat(0).getFormat()); } public void testLoadInternationalFormatWithBothNationalAndIntlFormatsDefined() throws ParserConfigurationException, SAXException, IOException { String intlFormat = "$1 $2"; String xmlInput = "" + intlFormat + ""; Element numberFormatElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); String nationalFormat = "$1"; assertTrue(BuildMetadataFromXml.loadInternationalFormat(metadata, numberFormatElement, nationalFormat)); assertEquals(intlFormat, metadata.getIntlNumberFormat(0).getFormat()); } public void testLoadInternationalFormatExpectsOnlyOnePattern() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element numberFormatElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); // Should throw an exception as multiple intlFormats are provided. try { BuildMetadataFromXml.loadInternationalFormat(metadata, numberFormatElement, ""); fail(); } catch (RuntimeException e) { // Test passed. } } public void testLoadInternationalFormatUsesNationalFormatByDefault() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element numberFormatElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); String nationalFormat = "$1 $2 $3"; assertFalse(BuildMetadataFromXml.loadInternationalFormat(metadata, numberFormatElement, nationalFormat)); assertEquals(nationalFormat, metadata.getIntlNumberFormat(0).getFormat()); } // Tests loadNationalFormat(). public void testLoadNationalFormat() throws ParserConfigurationException, SAXException, IOException { String nationalFormat = "$1 $2"; String xmlInput = String.format("%s", nationalFormat); Element numberFormatElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); NumberFormat.Builder numberFormat = NumberFormat.newBuilder(); assertEquals(nationalFormat, BuildMetadataFromXml.loadNationalFormat(metadata, numberFormatElement, numberFormat)); } public void testLoadNationalFormatRequiresFormat() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element numberFormatElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); NumberFormat.Builder numberFormat = NumberFormat.newBuilder(); try { BuildMetadataFromXml.loadNationalFormat(metadata, numberFormatElement, numberFormat); fail(); } catch (RuntimeException e) { // Test passed. } } public void testLoadNationalFormatExpectsExactlyOneFormat() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element numberFormatElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); NumberFormat.Builder numberFormat = NumberFormat.newBuilder(); try { BuildMetadataFromXml.loadNationalFormat(metadata, numberFormatElement, numberFormat); fail(); } catch (RuntimeException e) { // Test passed. } } // Tests loadAvailableFormats(). public void testLoadAvailableFormats() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "" + " " + " " + " $1 $2 $3" + " " + " " + ""; Element element = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); BuildMetadataFromXml.loadAvailableFormats(metadata, "AE", element, "0", ""); assertEquals("($1)", metadata.getNumberFormat(0).getNationalPrefixFormattingRule()); assertEquals("0 $CC ($1)", metadata.getNumberFormat(0).getDomesticCarrierCodeFormattingRule()); assertEquals("$1 $2 $3", metadata.getNumberFormat(0).getFormat()); } public void testLoadAvailableFormatsPropagatesCarrierCodeFormattingRule() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "" + " " + " " + " $1 $2 $3" + " " + " " + ""; Element element = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); BuildMetadataFromXml.loadAvailableFormats(metadata, "AE", element, "0", ""); assertEquals("($1)", metadata.getNumberFormat(0).getNationalPrefixFormattingRule()); assertEquals("0 $CC ($1)", metadata.getNumberFormat(0).getDomesticCarrierCodeFormattingRule()); assertEquals("$1 $2 $3", metadata.getNumberFormat(0).getFormat()); } public void testLoadAvailableFormatsSetsProvidedNationalPrefixFormattingRule() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "" + " " + " $1 $2 $3" + " " + ""; Element element = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); BuildMetadataFromXml.loadAvailableFormats(metadata, "AE", element, "", "($1)"); assertEquals("($1)", metadata.getNumberFormat(0).getNationalPrefixFormattingRule()); } public void testLoadAvailableFormatsClearsIntlFormat() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "" + " " + " $1 $2 $3" + " " + ""; Element element = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); BuildMetadataFromXml.loadAvailableFormats(metadata, "AE", element, "0", "($1)"); assertEquals(0, metadata.intlNumberFormatSize()); } public void testLoadAvailableFormatsHandlesMultipleNumberFormats() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "" + " " + " $1 $2 $3" + " $1-$2" + " " + ""; Element element = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); BuildMetadataFromXml.loadAvailableFormats(metadata, "AE", element, "0", "($1)"); assertEquals("$1 $2 $3", metadata.getNumberFormat(0).getFormat()); assertEquals("$1-$2", metadata.getNumberFormat(1).getFormat()); } public void testLoadInternationalFormatDoesNotSetIntlFormatWhenNA() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "NA"; Element numberFormatElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); String nationalFormat = "$1 $2"; BuildMetadataFromXml.loadInternationalFormat(metadata, numberFormatElement, nationalFormat); assertEquals(0, metadata.intlNumberFormatSize()); } // Tests setLeadingDigitsPatterns(). public void testSetLeadingDigitsPatterns() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "" + "12" + ""; Element numberFormatElement = parseXmlString(xmlInput); NumberFormat.Builder numberFormat = NumberFormat.newBuilder(); BuildMetadataFromXml.setLeadingDigitsPatterns(numberFormatElement, numberFormat); assertEquals("1", numberFormat.getLeadingDigitsPattern(0)); assertEquals("2", numberFormat.getLeadingDigitsPattern(1)); } // Tests getNationalPrefixFormattingRuleFromElement(). public void testGetNationalPrefixFormattingRuleFromElement() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element element = parseXmlString(xmlInput); assertEquals("0$1", BuildMetadataFromXml.getNationalPrefixFormattingRuleFromElement(element, "0")); } // Tests getDomesticCarrierCodeFormattingRuleFromElement(). public void testGetDomesticCarrierCodeFormattingRuleFromElement() throws ParserConfigurationException, SAXException, IOException { String xmlInput = ""; Element element = parseXmlString(xmlInput); assertEquals("0$CC $1", BuildMetadataFromXml.getDomesticCarrierCodeFormattingRuleFromElement(element, "0")); } // Tests isValidNumberType(). public void testIsValidNumberTypeWithInvalidInput() { assertFalse(BuildMetadataFromXml.isValidNumberType("invalidType")); } // Tests processPhoneNumberDescElement(). public void testProcessPhoneNumberDescElementWithInvalidInput() throws ParserConfigurationException, SAXException, IOException { PhoneNumberDesc.Builder generalDesc = PhoneNumberDesc.newBuilder(); Element territoryElement = parseXmlString(""); PhoneNumberDesc.Builder phoneNumberDesc; phoneNumberDesc = BuildMetadataFromXml.processPhoneNumberDescElement( generalDesc, territoryElement, "invalidType"); assertEquals("NA", phoneNumberDesc.getPossibleNumberPattern()); assertEquals("NA", phoneNumberDesc.getNationalNumberPattern()); } public void testProcessPhoneNumberDescElementMergesWithGeneralDesc() throws ParserConfigurationException, SAXException, IOException { PhoneNumberDesc.Builder generalDesc = PhoneNumberDesc.newBuilder(); generalDesc.setPossibleNumberPattern("\\d{6}"); Element territoryElement = parseXmlString(""); PhoneNumberDesc.Builder phoneNumberDesc; phoneNumberDesc = BuildMetadataFromXml.processPhoneNumberDescElement( generalDesc, territoryElement, "fixedLine"); assertEquals("\\d{6}", phoneNumberDesc.getPossibleNumberPattern()); } public void testProcessPhoneNumberDescElementOverridesGeneralDesc() throws ParserConfigurationException, SAXException, IOException { PhoneNumberDesc.Builder generalDesc = PhoneNumberDesc.newBuilder(); generalDesc.setPossibleNumberPattern("\\d{8}"); String xmlInput = "" + " \\d{6}" + ""; Element territoryElement = parseXmlString(xmlInput); PhoneNumberDesc.Builder phoneNumberDesc; phoneNumberDesc = BuildMetadataFromXml.processPhoneNumberDescElement( generalDesc, territoryElement, "fixedLine"); assertEquals("\\d{6}", phoneNumberDesc.getPossibleNumberPattern()); } public void testProcessPhoneNumberDescElementHandlesLiteBuild() throws ParserConfigurationException, SAXException, IOException { try { BuildMetadataFromXml.setLiteBuild(true); PhoneNumberDesc.Builder generalDesc = PhoneNumberDesc.newBuilder(); String xmlInput = "" + " 01 01 01 01" + ""; Element territoryElement = parseXmlString(xmlInput); PhoneNumberDesc.Builder phoneNumberDesc; phoneNumberDesc = BuildMetadataFromXml.processPhoneNumberDescElement( generalDesc, territoryElement, "fixedLine"); assertEquals("", phoneNumberDesc.getExampleNumber()); } finally { // Restore the lite build parameter to its default value (false) to avoid potential // side-effects in other tests. BuildMetadataFromXml.setLiteBuild(false); } } public void testProcessPhoneNumberDescOutputsExampleNumberByDefault() throws ParserConfigurationException, SAXException, IOException { PhoneNumberDesc.Builder generalDesc = PhoneNumberDesc.newBuilder(); String xmlInput = "" + " 01 01 01 01" + ""; Element territoryElement = parseXmlString(xmlInput); PhoneNumberDesc.Builder phoneNumberDesc; phoneNumberDesc = BuildMetadataFromXml.processPhoneNumberDescElement( generalDesc, territoryElement, "fixedLine"); assertEquals("01 01 01 01", phoneNumberDesc.getExampleNumber()); } public void testProcessPhoneNumberDescRemovesWhiteSpacesInPatterns() throws ParserConfigurationException, SAXException, IOException { PhoneNumberDesc.Builder generalDesc = PhoneNumberDesc.newBuilder(); String xmlInput = "" + " \t \\d { 6 } " + ""; Element countryElement = parseXmlString(xmlInput); PhoneNumberDesc.Builder phoneNumberDesc; phoneNumberDesc = BuildMetadataFromXml.processPhoneNumberDescElement( generalDesc, countryElement, "fixedLine"); assertEquals("\\d{6}", phoneNumberDesc.getPossibleNumberPattern()); } // Tests loadGeneralDesc(). public void testLoadGeneralDescSetsSameMobileAndFixedLinePattern() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "" + " \\d{6}" + " \\d{6}" + ""; Element territoryElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); // Should set sameMobileAndFixedPattern to true. BuildMetadataFromXml.loadGeneralDesc(metadata, territoryElement); assertTrue(metadata.isSameMobileAndFixedLinePattern()); } public void testLoadGeneralDescSetsAllDescriptions() throws ParserConfigurationException, SAXException, IOException { String xmlInput = "" + " \\d{1}" + " \\d{2}" + " \\d{3}" + " \\d{4}" + " \\d{5}" + " \\d{6}" + " \\d{7}" + " \\d{8}" + " \\d{9}" + " \\d{10}" + ""; Element territoryElement = parseXmlString(xmlInput); PhoneMetadata.Builder metadata = PhoneMetadata.newBuilder(); BuildMetadataFromXml.loadGeneralDesc(metadata, territoryElement); assertEquals("\\d{1}", metadata.getFixedLine().getNationalNumberPattern()); assertEquals("\\d{2}", metadata.getMobile().getNationalNumberPattern()); assertEquals("\\d{3}", metadata.getPager().getNationalNumberPattern()); assertEquals("\\d{4}", metadata.getTollFree().getNationalNumberPattern()); assertEquals("\\d{5}", metadata.getPremiumRate().getNationalNumberPattern()); assertEquals("\\d{6}", metadata.getSharedCost().getNationalNumberPattern()); assertEquals("\\d{7}", metadata.getPersonalNumber().getNationalNumberPattern()); assertEquals("\\d{8}", metadata.getVoip().getNationalNumberPattern()); assertEquals("\\d{9}", metadata.getUan().getNationalNumberPattern()); } }