xml-tests.ts

// Code get from the test file of http://github.com/dylang/node-xml

import * as xml from "xml";

interface Tester {
  is(a: any, b: any): void;
  same(a: any, b: any): void;
  plan(id: number): void;
  ok(a: any): void;
}

function test(c: string, f: (t: Tester) => void) {
  return;
}

test('no elements', t => {
    t.is(xml(), '');
    t.is(xml([]), '');
    t.is(xml('test'), 'test');
    t.is(xml('scotch & whisky'), 'scotch & whisky');
    t.is(xml('bob\'s escape character'), 'bob's escape character');
});

test('simple options', t => {
    t.is(xml([{a: {}}]), '<a/>');
    t.is(xml([{a: null}]), '<a/>');
    t.is(xml([{a: []}]), '<a></a>');
    t.is(xml([{a: -1}]), '<a>-1</a>');
    t.is(xml([{a: false}]), '<a>false</a>');
    t.is(xml([{a: 'test'}]), '<a>test</a>');
    t.is(xml({a: {}}), '<a/>');
    t.is(xml({a: null}), '<a/>');
    t.is(xml({a: []}), '<a></a>');
    t.is(xml({a: -1}), '<a>-1</a>');
    t.is(xml({a: false}), '<a>false</a>');
    t.is(xml({a: 'test'}), '<a>test</a>');
    t.is(xml([{a: 'test'}, {b: 123}, {c: -0.5}]), '<a>test</a><b>123</b><c>-0.5</c>');
});

test('deeply nested objects', t => {
    t.is(xml([{a: [{b: [{c: 1}, {c: 2}, {c: 3}]}]}]), '<a><b><c>1</c><c>2</c><c>3</c></b></a>');
});

test('indents property', t => {
    t.is(xml([{a: [{b: [{c: 1}, {c: 2}, {c: 3}]}]}], true), '<a>\n    <b>\n        <c>1</c>\n        <c>2</c>\n        <c>3</c>\n    </b>\n</a>');
    t.is(xml([{a: [{b: [{c: 1}, {c: 2}, {c: 3}]}]}], '  '), '<a>\n  <b>\n    <c>1</c>\n    <c>2</c>\n    <c>3</c>\n  </b>\n</a>');
    t.is(xml([{a: [{b: [{c: 1}, {c: 2}, {c: 3}]}]}], '\t'), '<a>\n\t<b>\n\t\t<c>1</c>\n\t\t<c>2</c>\n\t\t<c>3</c>\n\t</b>\n</a>');
    t.is(xml({guid: [{_attr: {premalink: true}}, 'content']}, true), '<guid premalink="true">content</guid>');
});

test('supports xml attributes', t => {
    t.is(xml([{b: {_attr: {}}}]), '<b/>');
    t.is(xml([{
        a: {
            _attr: {
                attribute1: 'some value',
                attribute2: 12345
            }
        }
    }]), '<a attribute1="some value" attribute2="12345"/>');
    t.is(xml([{
        a: [{
            _attr: {
                attribute1: 'some value',
                attribute2: 12345
            }
        }]
    }]), '<a attribute1="some value" attribute2="12345"></a>');
    t.is(xml([{
        a: [{
            _attr: {
                attribute1: 'some value',
                attribute2: 12345
            }
        }, 'content']
    }]), '<a attribute1="some value" attribute2="12345">content</a>');
});

test('supports cdata', t => {
    t.is(xml([{a: {_cdata: 'This is some <strong>CDATA</strong>'}}]), '<a><![CDATA[This is some <strong>CDATA</strong>]]></a>');
    t.is(xml([{
        a: {
            _attr: {attribute1: 'some value', attribute2: 12345},
            _cdata: 'This is some <strong>CDATA</strong>'
        }
    }]), '<a attribute1="some value" attribute2="12345"><![CDATA[This is some <strong>CDATA</strong>]]></a>');
    t.is(
        xml([{a: {_cdata: 'This is some <strong>CDATA</strong> with ]]> and then again ]]>'}}]),
        '<a><![CDATA[This is some <strong>CDATA</strong> with ]]]]><![CDATA[> and then again ]]]]><![CDATA[>]]></a>');
});

test('supports encoding', t => {
    t.is(xml([{
        a: [{
            _attr: {
                anglebrackets: 'this is <strong>strong</strong>',
                url: 'http://google.com?s=opower&y=fun'
            }
        }, 'text']
    }]), '<a anglebrackets="this is &lt;strong&gt;strong&lt;/strong&gt;" url="http://google.com?s=opower&amp;y=fun">text</a>');
});

test('supports stream interface', t => {
    const elem = xml.element({_attr: {decade: '80s', locale: 'US'}});
    const xmlStream = xml({toys: elem}, {stream: true});
    const results = ['<toys decade="80s" locale="US">', '<toy>Transformers</toy>', '<toy><name>He-man</name></toy>', '<toy>GI Joe</toy>', '</toys>'];

    elem.push({toy: 'Transformers'});
    elem.push({toy: [{name: 'He-man'}]});
    elem.push({toy: 'GI Joe'});
    elem.close();

    xmlStream.on('data', (stanza: any[]) => {
        t.is(stanza, results.shift());
    });

    return new Promise( (resolve, reject) => {
        xmlStream.on('close', () => {
            t.same(results, []);
            resolve();
        });
        xmlStream.on('error', reject);
    });
});

test('streams end properly', t => {
    const elem = xml.element({ _attr: { decade: '80s', locale: 'US'} });
    const xmlStream = xml({ toys: elem }, { stream: true });

    let gotData = false;

    t.plan(7);

    elem.push({ toy: 'Transformers' });
    elem.push({ toy: 'GI Joe' });
    elem.push({ toy: [{name: 'He-man'}] });
    elem.close();

    xmlStream.on('data',  (data: any) => {
        t.ok(data);
        gotData = true;
    });

    xmlStream.on('end',  () => {
        t.ok(gotData);
    });

    return new Promise( (resolve, reject) => {
        xmlStream.on('close',  () => {
            t.ok(gotData);
            resolve();
        });
        xmlStream.on('error', reject);
    });
});

test('xml declaration options', t => {
    t.is(xml([{a: 'test'}], {declaration: true}), '<?xml version="1.0" encoding="UTF-8"?><a>test</a>');
    t.is(xml([{a: 'test'}], {declaration: {encoding: 'foo'}}), '<?xml version="1.0" encoding="foo"?><a>test</a>');
    t.is(xml([{a: 'test'}], {declaration: {standalone: 'yes'}}), '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><a>test</a>');
    t.is(xml([{a: 'test'}], {declaration: false}), '<a>test</a>');
    t.is(xml([{a: 'test'}], {declaration: true, indent: '\n'}), '<?xml version="1.0" encoding="UTF-8"?>\n<a>test</a>');
    t.is(xml([{a: 'test'}], {}), '<a>test</a>');
});