libxml2/testcatalog.c

/*
 * testcatalog.c: C program to run libxml2 catalog.c unit tests
 *
 * To compile on Unixes:
 * cc -o testcatalog `xml2-config --cflags` testcatalog.c `xml2-config --libs` -lpthread
 *
 * See Copyright for the status of this software.
 *
 * Author: Daniel Garcia <dani@danigm.net>
 */


#include "libxml.h"
#include <stdio.h>
#include <string.h>

#ifdef LIBXML_CATALOG_ENABLED
#include <libxml/catalog.h>

/* Test catalog resolve uri with recursive catalog */
static int
testRecursiveDelegateUri(void) {
    int ret = 0;
    const char *cat = "test/catalogs/catalog-recursive.xml";
    const char *entity = "/foo.ent";
    xmlChar *resolved = NULL;

    xmlInitParser();
    xmlLoadCatalog(cat);

    /* This should trigger recursive error */
    resolved = xmlCatalogResolveURI(BAD_CAST entity);
    if (resolved != NULL) {
        fprintf(stderr, "CATALOG-FAILURE: Catalog %s entity should fail to resolve\n", entity);
        ret = 1;
    }
    xmlCatalogCleanup();

    return ret;
}

/* Test parsing repeated NextCatalog */
static int
testRepeatedNextCatalog(void) {
    int ret = 0;
    int i = 0;
    const char *cat = "test/catalogs/repeated-next-catalog.xml";
    const char *entity = "/foo.ent";
    xmlDocPtr doc = NULL;
    xmlNodePtr node = NULL;

    xmlInitParser();

    xmlLoadCatalog(cat);
    /* To force the complete recursive load */
    xmlCatalogResolveURI(BAD_CAST entity);
    /**
     * Ensure that the doc doesn't contain the same nextCatalog
     */
    doc = xmlCatalogDumpDoc();
    xmlCatalogCleanup();

    if (doc == NULL) {
        fprintf(stderr, "CATALOG-FAILURE: Failed to dump the catalog\n");
        return 1;
    }

    /* Just the root "catalog" node with a series of nextCatalog */
    node = xmlDocGetRootElement(doc);
    node = node->children;
    for (i=0; node != NULL; node=node->next, i++) {}
    if (i > 1) {
        fprintf(stderr, "CATALOG-FAILURE: Found %d nextCatalog entries and should be 1\n", i);
        ret = 1;
    }

    xmlFreeDoc(doc);

    return ret;
}

/*
 * Test a nextCatalog entry which lacks the mandatory 'catalog' attribute
 * See https://gitlab.gnome.org/GNOME/libxml2/-/issues/1143
 */
static int
testNextCatalogMissingAttr(void) {
    int ret = 0;
    int i = 0;
    const char *cat = "test/catalogs/next-catalog-missing-attr.xml";
    const char *sysId = "http://www.oasis-open.org/docbook/xml/4.1.2/dbpoolx.mod";
    const char *expect = "/usr/share/xml/docbook/xml/4.1.2/dbpoolx.mod";
    xmlChar *resolved = NULL;
    xmlDocPtr doc = NULL;
    xmlNodePtr node = NULL;

    xmlInitParser();

    xmlLoadCatalog(cat);
    /*
     * The malformed nextCatalog must be ignored, the valid one must still
     * be followed. This also forces the complete recursive load.
     */
    resolved = xmlCatalogResolveSystem(BAD_CAST sysId);
    if ((resolved == NULL) || (strcmp((char *) resolved, expect) != 0)) {
        fprintf(stderr, "CATALOG-FAILURE: %s resolved to %s, expected %s\n",
                sysId, resolved == NULL ? "NULL" : (char *) resolved, expect);
        ret = 1;
    }
    if (resolved != NULL)
        xmlFree(resolved);

    /**
     * Ensure that only the valid nextCatalog was recorded
     */
    doc = xmlCatalogDumpDoc();
    xmlCatalogCleanup();

    if (doc == NULL) {
        fprintf(stderr, "CATALOG-FAILURE: Failed to dump the catalog\n");
        return 1;
    }

    /* Just the root "catalog" node with a single nextCatalog */
    node = xmlDocGetRootElement(doc);
    node = node->children;
    for (i=0; node != NULL; node=node->next, i++) {}
    if (i != 1) {
        fprintf(stderr, "CATALOG-FAILURE: Found %d nextCatalog entries and should be 1\n", i);
        ret = 1;
    }

    xmlFreeDoc(doc);

    return ret;
}

/*
 * Test repeated call to xmlCatalogResolveURI
 * See https://gitlab.gnome.org/GNOME/libxml2/-/work_items/1125
 */
static int
testRepeatedResolveURI(void) {
    int ret = 0;
    const char *cat = "test/catalogs/stylesheet.xml";
    const char *uri = "http://www.oasis-open.org/committes/tr.xsl";
    xmlDocPtr doc = NULL;

    xmlChar *call1 = NULL;
    xmlChar *call2 = NULL;

    xmlInitParser();
    xmlLoadCatalog(cat);

    call1 = xmlCatalogResolveURI(BAD_CAST uri);
    call2 = xmlCatalogResolveURI(BAD_CAST uri);

    xmlCatalogCleanup();
    xmlFreeDoc(doc);

    /* Ensure that both calls returns the same */

    if (call1 == NULL && call2 == NULL) {
        ret = 0;
    } else if (call1 == NULL || call2 == NULL) {
        fprintf(stderr,
                "CATALOG-FAILURE: Different output for the "
                "same resolve call %s != %s\n",
                call1, call2);
        ret = 1;
    } else if (strcmp((char*)call1, (char*)call2) != 0) {
        fprintf(stderr,
                "CATALOG-FAILURE: Different output for the "
                "same resolve call %s != %s\n",
                call1, call2);
        ret = 1;
    }


    if (call1)
        xmlFree(call1);
    if (call2)
        xmlFree(call2);

    return ret;
}

int
main(void) {
    int err = 0;

    err |= testRecursiveDelegateUri();
    err |= testRepeatedNextCatalog();
    err |= testNextCatalogMissingAttr();
    err |= testRepeatedResolveURI();

    return err;
}
#else
/* No catalog, so everything okay */
int
main(void) {
    return 0;
}
#endif