tests.js

'use strict';

const assert = require('assert');
const punycode = require('../punycode.js');

const testData = {
	'strings': [
		{
			'description': 'a single basic code point',
			'decoded': 'Bach',
			'encoded': 'Bach-'
		},
		{
			'description': 'a single non-ASCII character',
			'decoded': '\xFC',
			'encoded': 'tda'
		},
		{
			'description': 'multiple non-ASCII characters',
			'decoded': '\xFC\xEB\xE4\xF6\u2665',
			'encoded': '4can8av2009b'
		},
		{
			'description': 'mix of ASCII and non-ASCII characters',
			'decoded': 'b\xFCcher',
			'encoded': 'bcher-kva'
		},
		{
			'description': 'long string with both ASCII and non-ASCII characters',
			'decoded': 'Willst du die Bl\xFCthe des fr\xFChen, die Fr\xFCchte des sp\xE4teren Jahres',
			'encoded': 'Willst du die Blthe des frhen, die Frchte des spteren Jahres-x9e96lkal'
		},
		// https://tools.ietf.org/html/rfc3492#section-7.1
		{
			'description': 'Arabic (Egyptian)',
			'decoded': '\u0644\u064A\u0647\u0645\u0627\u0628\u062A\u0643\u0644\u0645\u0648\u0634\u0639\u0631\u0628\u064A\u061F',
			'encoded': 'egbpdaj6bu4bxfgehfvwxn'
		},
		{
			'description': 'Chinese (simplified)',
			'decoded': '\u4ED6\u4EEC\u4E3A\u4EC0\u4E48\u4E0D\u8BF4\u4E2d\u6587',
			'encoded': 'ihqwcrb4cv8a8dqg056pqjye'
		},
		{
			'description': 'Chinese (traditional)',
			'decoded': '\u4ED6\u5011\u7232\u4EC0\u9EBD\u4E0D\u8AAA\u4E2D\u6587',
			'encoded': 'ihqwctvzc91f659drss3x8bo0yb'
		},
		{
			'description': 'Czech',
			'decoded': 'Pro\u010Dprost\u011Bnemluv\xED\u010Desky',
			'encoded': 'Proprostnemluvesky-uyb24dma41a'
		},
		{
			'description': 'Hebrew',
			'decoded': '\u05DC\u05DE\u05D4\u05D4\u05DD\u05E4\u05E9\u05D5\u05D8\u05DC\u05D0\u05DE\u05D3\u05D1\u05E8\u05D9\u05DD\u05E2\u05D1\u05E8\u05D9\u05EA',
			'encoded': '4dbcagdahymbxekheh6e0a7fei0b'
		},
		{
			'description': 'Hindi (Devanagari)',
			'decoded': '\u092F\u0939\u0932\u094B\u0917\u0939\u093F\u0928\u094D\u0926\u0940\u0915\u094D\u092F\u094B\u0902\u0928\u0939\u0940\u0902\u092C\u094B\u0932\u0938\u0915\u0924\u0947\u0939\u0948\u0902',
			'encoded': 'i1baa7eci9glrd9b2ae1bj0hfcgg6iyaf8o0a1dig0cd'
		},
		{
			'description': 'Japanese (kanji and hiragana)',
			'decoded': '\u306A\u305C\u307F\u3093\u306A\u65E5\u672C\u8A9E\u3092\u8A71\u3057\u3066\u304F\u308C\u306A\u3044\u306E\u304B',
			'encoded': 'n8jok5ay5dzabd5bym9f0cm5685rrjetr6pdxa'
		},
		{
			'description': 'Korean (Hangul syllables)',
			'decoded': '\uC138\uACC4\uC758\uBAA8\uB4E0\uC0AC\uB78C\uB4E4\uC774\uD55C\uAD6D\uC5B4\uB97C\uC774\uD574\uD55C\uB2E4\uBA74\uC5BC\uB9C8\uB098\uC88B\uC744\uAE4C',
			'encoded': '989aomsvi5e83db1d2a355cv1e0vak1dwrv93d5xbh15a0dt30a5jpsd879ccm6fea98c'
		},
		/**
		 * As there's no way to do it in JavaScript, Punycode.js doesn't support
		 * mixed-case annotation (which is entirely optional as per the RFC).
		 * So, while the RFC sample string encodes to:
		 * `b1abfaaepdrnnbgefbaDotcwatmq2g4l`
		 * Without mixed-case annotation it has to encode to:
		 * `b1abfaaepdrnnbgefbadotcwatmq2g4l`
		 * https://github.com/mathiasbynens/punycode.js/issues/3
		 */
		{
			'description': 'Russian (Cyrillic)',
			'decoded': '\u043F\u043E\u0447\u0435\u043C\u0443\u0436\u0435\u043E\u043D\u0438\u043D\u0435\u0433\u043E\u0432\u043E\u0440\u044F\u0442\u043F\u043E\u0440\u0443\u0441\u0441\u043A\u0438',
			'encoded': 'b1abfaaepdrnnbgefbadotcwatmq2g4l'
		},
		{
			'description': 'Spanish',
			'decoded': 'Porqu\xE9nopuedensimplementehablarenEspa\xF1ol',
			'encoded': 'PorqunopuedensimplementehablarenEspaol-fmd56a'
		},
		{
			'description': 'Vietnamese',
			'decoded': 'T\u1EA1isaoh\u1ECDkh\xF4ngth\u1EC3ch\u1EC9n\xF3iti\u1EBFngVi\u1EC7t',
			'encoded': 'TisaohkhngthchnitingVit-kjcr8268qyxafd2f1b9g'
		},
		{
			'decoded': '3\u5E74B\u7D44\u91D1\u516B\u5148\u751F',
			'encoded': '3B-ww4c5e180e575a65lsy2b'
		},
		{
			'decoded': '\u5B89\u5BA4\u5948\u7F8E\u6075-with-SUPER-MONKEYS',
			'encoded': '-with-SUPER-MONKEYS-pc58ag80a8qai00g7n9n'
		},
		{
			'decoded': 'Hello-Another-Way-\u305D\u308C\u305E\u308C\u306E\u5834\u6240',
			'encoded': 'Hello-Another-Way--fc4qua05auwb3674vfr0b'
		},
		{
			'decoded': '\u3072\u3068\u3064\u5C4B\u6839\u306E\u4E0B2',
			'encoded': '2-u9tlzr9756bt3uc0v'
		},
		{
			'decoded': 'Maji\u3067Koi\u3059\u308B5\u79D2\u524D',
			'encoded': 'MajiKoi5-783gue6qz075azm5e'
		},
		{
			'decoded': '\u30D1\u30D5\u30A3\u30FCde\u30EB\u30F3\u30D0',
			'encoded': 'de-jg4avhby1noc0d'
		},
		{
			'decoded': '\u305D\u306E\u30B9\u30D4\u30FC\u30C9\u3067',
			'encoded': 'd9juau41awczczp'
		},
		/**
		 * This example is an ASCII string that breaks the existing rules for host
		 * name labels. (It's not a realistic example for IDNA, because IDNA never
		 * encodes pure ASCII labels.)
		 */
		{
			'description': 'ASCII string that breaks the existing rules for host-name labels',
			'decoded': '-> $1.00 <-',
			'encoded': '-> $1.00 <--'
		}
	],
	'ucs2': [
		// Every Unicode symbol is tested separately. These are just the extra
		// tests for symbol combinations:
		{
			'description': 'Consecutive astral symbols',
			'decoded': [127829, 119808, 119558, 119638],
			'encoded': '\uD83C\uDF55\uD835\uDC00\uD834\uDF06\uD834\uDF56'
		},
		{
			'description': 'U+D800 (high surrogate) followed by non-surrogates',
			'decoded': [55296, 97, 98],
			'encoded': '\uD800ab'
		},
		{
			'description': 'U+DC00 (low surrogate) followed by non-surrogates',
			'decoded': [56320, 97, 98],
			'encoded': '\uDC00ab'
		},
		{
			'description': 'High surrogate followed by another high surrogate',
			'decoded': [0xD800, 0xD800],
			'encoded': '\uD800\uD800'
		},
		{
			'description': 'Unmatched high surrogate, followed by a surrogate pair, followed by an unmatched high surrogate',
			'decoded': [0xD800, 0x1D306, 0xD800],
			'encoded': '\uD800\uD834\uDF06\uD800'
		},
		{
			'description': 'Low surrogate followed by another low surrogate',
			'decoded': [0xDC00, 0xDC00],
			'encoded': '\uDC00\uDC00'
		},
		{
			'description': 'Unmatched low surrogate, followed by a surrogate pair, followed by an unmatched low surrogate',
			'decoded': [0xDC00, 0x1D306, 0xDC00],
			'encoded': '\uDC00\uD834\uDF06\uDC00'
		}
	],
	'domains': [
		{
			'decoded': 'ma\xF1ana.com',
			'encoded': 'xn--maana-pta.com'
		},
		{ // https://github.com/mathiasbynens/punycode.js/issues/17
			'decoded': 'example.com.',
			'encoded': 'example.com.'
		},
		{
			'decoded': 'b\xFCcher.com',
			'encoded': 'xn--bcher-kva.com'
		},
		{
			'decoded': 'caf\xE9.com',
			'encoded': 'xn--caf-dma.com'
		},
		{
			'decoded': 'ÜBER.COM',
			'encoded': 'xn--BER-ska.COM'
		},
		{
			'decoded': 'sPhÈRè.com',
			'encoded': 'xn--sPhR-nka7q.com'
		},
		{
			'decoded': '\u2603-\u2318.com',
			'encoded': 'xn----dqo34k.com'
		},
		{
			'decoded': '\uD400\u2603-\u2318.com',
			'encoded': 'xn----dqo34kn65z.com'
		},
		{
			'description': 'Emoji',
			'decoded': '\uD83D\uDCA9.la',
			'encoded': 'xn--ls8h.la'
		},
		{
			'description': 'Non-printable ASCII',
			'decoded': '\0\x01\x02foo.bar',
			'encoded': '\0\x01\x02foo.bar'
		},
		{
			'description': 'Email address',
			'decoded': '\u0434\u0436\u0443\u043C\u043B\u0430@\u0434\u0436p\u0443\u043C\u043B\u0430\u0442\u0435\u0441\u0442.b\u0440\u0444a',
			'encoded': '\u0434\u0436\u0443\u043C\u043B\u0430@xn--p-8sbkgc5ag7bhce.xn--ba-lmcq'
		},
		{ // https://github.com/mathiasbynens/punycode.js/pull/115
			'decoded': 'foo\x7F.example',
			'encoded': 'foo\x7F.example'
		}
	],
	'separators': [
		{
			'description': 'Using U+002E as separator',
			'decoded': 'ma\xF1ana\x2Ecom',
			'encoded': 'xn--maana-pta.com'
		},
		{
			'description': 'Using U+3002 as separator',
			'decoded': 'ma\xF1ana\u3002com',
			'encoded': 'xn--maana-pta.com'
		},
		{
			'description': 'Using U+FF0E as separator',
			'decoded': 'ma\xF1ana\uFF0Ecom',
			'encoded': 'xn--maana-pta.com'
		},
		{
			'description': 'Using U+FF61 as separator',
			'decoded': 'ma\xF1ana\uFF61com',
			'encoded': 'xn--maana-pta.com'
		}
	]
};

describe('punycode.ucs2.decode', function() {
	for (const object of testData.ucs2) {
		it(object.description, function() {
			assert.deepEqual(
				punycode.ucs2.decode(object.encoded),
				object.decoded,
				object.description
			);
		});
	}
	it('throws RangeError: Illegal input >= 0x80 (not a basic code point)', function() {
		assert.throws(
			function() {
				punycode.decode('\x81-');
			},
			RangeError
		);
	});
	it('throws RangeError: Overflow: input needs wider integers to process', function() {
		assert.throws(
			function() {
				punycode.decode('\x81');
			},
			RangeError
		);
	});
});

describe('punycode.ucs2.encode', function() {
	for (const object of testData.ucs2) {
		it(object.description, function() {
			assert.deepEqual(
				punycode.ucs2.encode(object.decoded),
				object.encoded
			);
		});
	}
	const codePoints = [0x61, 0x62, 0x63];
	const result = punycode.ucs2.encode(codePoints);
	it('does not mutate argument array', function() {
		assert.deepEqual(result, 'abc');
		assert.deepEqual(codePoints, [0x61, 0x62, 0x63]);
	});
});

describe('punycode.decode', function() {
	for (const object of testData.strings) {
		it(object.description || object.encoded, function() {
			assert.deepEqual(
				punycode.decode(object.encoded),
				object.decoded
			);
		});
	}
	it('handles uppercase Z', function() {
		assert.deepEqual(punycode.decode('ZZZ'), '\u7BA5');
	});
	it('throws RangeError: Invalid input', function() {
		assert.throws(
			function() {
				punycode.decode('ls8h=');
			},
			RangeError
		);
	});
});

describe('punycode.encode', function() {
	for (const object of testData.strings) {
		it(object.description || object.decoded, function() {
			assert.deepEqual(
				punycode.encode(object.decoded),
				object.encoded
			);
		});
	}
});

describe('punycode.toUnicode', function() {
	for (const object of testData.domains) {
		it(object.description || object.encoded, function() {
			assert.deepEqual(
				punycode.toUnicode(object.encoded),
				object.decoded
			);
		});
	}
	for (const object of testData.strings) {
		it('does not convert names (or other strings) that don\'t start with `xn--`', function() {
			assert.deepEqual(
				punycode.toUnicode(object.encoded),
				object.encoded
			);
			assert.deepEqual(
				punycode.toUnicode(object.decoded),
				object.decoded
			);
		});
	}
});

describe('punycode.toASCII', function() {
	for (const object of testData.domains) {
		it(object.description || object.decoded, function() {
			assert.deepEqual(
				punycode.toASCII(object.decoded),
				object.encoded
			);
		});
	}
	for (const object of testData.strings) {
		it('does not convert domain names (or other strings) that are already in ASCII', function() {
			assert.deepEqual(
				punycode.toASCII(object.encoded),
				object.encoded
			);
		});
	}
	for (const object of testData.separators) {
		it('supports IDNA2003 separators for backwards compatibility', function() {
			assert.deepEqual(
				punycode.toASCII(object.decoded),
				object.encoded
			);
		});
	}
});