xref: /aosp_15_r20/external/apache-xml/test/tests/extensions/java/javaRedir1.java (revision 1212f9a0ffdc28482b8821715d2222bf16dc14e2)

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.
 */

// explicitly packageless

import org.apache.qetest.CheckService;
import org.apache.qetest.Logger;
import org.apache.qetest.xsl.StylesheetDatalet;
import org.apache.qetest.xsl.TestableExtension;
import org.apache.qetest.xsl.XHTFileCheckService;

import java.io.File;
import java.util.Hashtable;

/**
 * Extension for testing xml-xalan/samples/extensions.
 */
public class javaRedir1 extends TestableExtension
{
    /** Note: no actual extension methods here; this class just does validation.  */

    //// Implementations of TestableExtension
    /** Copied from javaRedir1.xml[/doc/foo/@file].  */
    public static final String REDIR_NAME = "javaRedir1a-from-build-extensions.out";

    /**
     * Perform and log any pre-transformation info.
     * @return true if OK; false if any fatal error occoured
     * @param datalet Datalet of current stylesheet test
     */
    public static boolean preCheck(Logger logger, StylesheetDatalet datalet)
    {
        logger.logMsg(Logger.TRACEMSG, "javaRedir1.preCheck");
        return true;
    }


    /**
     * Perform and log any post-transformation info.
     *
     * The extension should validate that it's extension was
     * properly called; we also validate output file(s).
     *
     * @param logger Logger to dump any info to
     * @param datalet Datalet of current stylesheet test
     */
    public static void postCheck(Logger logger, StylesheetDatalet datalet)
    {
        logger.logMsg(Logger.TRACEMSG, "javaRedir1.postCheck");

        // First, validate the normal output file the normal way
        CheckService fileChecker = (CheckService)datalet.options.get("fileCheckerImpl");
        // Supply default value
        if (null == fileChecker)
            fileChecker = new XHTFileCheckService();
        if (Logger.PASS_RESULT
            != fileChecker.check(logger,
                                 new File(datalet.outputName),
                                 new File(datalet.goldName),
                                 "Extension test of " + datalet.getDescription())
           )
        {
            // Log a custom element with all the file refs first
            // Closely related to viewResults.xsl select='fileref"
            //@todo check that these links are valid when base
            //  paths are either relative or absolute!
            Hashtable attrs = new Hashtable();
            attrs.put("idref", (new File(datalet.inputName)).getName());
            attrs.put("inputName", datalet.inputName);
            attrs.put("xmlName", datalet.xmlName);
            attrs.put("outputName", datalet.outputName);
            attrs.put("goldName", datalet.goldName);
            logger.logElement(Logger.STATUSMSG, "fileref", attrs, "Extension test file references");
        }
        // Now, also validate the redirected output!
        // Calculate location of gold redir file
        String goldRedir = (new File(datalet.goldName)).getParent()
                           + File.separator + REDIR_NAME;

        // Calculate location of actual redir file
        String outRedir = (new File(datalet.outputName)).getParent()
                          + File.separator + REDIR_NAME;

        // Then check just with actual file name to the constructed
        //  gold name; don't bother with extra logging
        fileChecker.check(logger,
                          new File(outRedir),
                          new File(goldRedir),
                          "Redir-Extension test of " + datalet.getDescription());
    }


    /**
     * Description of what this extension does.
     * @return String description of extension
     */
    public static String getDescription()
    {
        return "No extension methods - just validation";
    }
}