MessageBundleTaskTest.java :  » XML » nlstools » com » google » nlstools » Java Open Source

package com.google.nlstools;

import com.google.nlstools.formats.MBJSONPersistencer;
import com.google.nlstools.formats.MBXMLPersistencer;
import com.google.nlstools.model.MBBundle;
import com.google.nlstools.model.MBBundles;
import com.google.nlstools.model.MBEntry;
import com.google.nlstools.model.MBText;
import com.google.nlstools.tasks.MessageBundleTask;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import org.apache.tools.ant.Project;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;

/**
 * MessageBundleTask Tester.
 *
 * @author ${USER}
 * @version 1.0
 * @since <pre>06/14/2007</pre>
 */
public class MessageBundleTaskTest extends TestCase {
    public MessageBundleTaskTest(String name) {
        super(name);
    }

    public void testMBTextConverter() throws Exception {
        String xml = "<bundles>\n" +
                "  <bundle baseName=\"Example\">\n" +
                "    <entry key=\"key2\">\n" +
                "      <text locale=\"de\">anderer Wert</text>\n" + "    </entry>\n" +
                "  </bundle>\n" + "</bundles>";
        MBBundles bundles0 = (MBBundles) MBXMLPersistencer.getXstream().fromXML(xml);
        assertEquals("anderer Wert",
                bundles0.getBundles().get(0).getEntries().get(0).getText("de").getValue());

        xml = "<bundles>\n" +
                "  <bundle baseName=\"Example\">\n" +
                "    <entry key=\"key2\">\n" +
                "      <text locale=\"de\">  <value>anderer Wert</value>  </text>\n" +
                "      <text locale=\"en\"></text>\n" + "    </entry>\n" +
                "  </bundle>\n" + "</bundles>";
        bundles0 = (MBBundles) MBXMLPersistencer.getXstream().fromXML(xml);
        assertEquals("anderer Wert",
                bundles0.getBundles().get(0).getEntries().get(0).getText("de").getValue());

        MBBundles bundles = createBundles();
        xml = MBXMLPersistencer.getXstream().toXML(bundles);
        MBBundles bundles2 = (MBBundles) MBXMLPersistencer.getXstream().fromXML(xml);
        assertEquals(1, bundles2.getBundles().size());
        MBBundle bundle = bundles2.getBundles().get(0);
        assertEquals(2, bundle.getEntries().size());
        MBEntry entry = bundle.getEntries().get(0);
        assertEquals("key1", entry.getKey());
        assertEquals(2, entry.getTexts().size());
        MBText text = entry.getText("en");
        assertEquals("An example", text.getValue());
    }

    public void testSaveExampleXML() throws Exception {
        MBBundles bundles = createBundles();

        MBXMLPersistencer p = new MBXMLPersistencer();
        p.save(bundles, new File("target/example.xml"));

        MBJSONPersistencer p2 = new MBJSONPersistencer(true);
        p2.save(bundles, new File("target/example-json.js"));
    }

    private MBBundles createBundles() {
        MBBundles bundles = new MBBundles();
        MBBundle bundle = new MBBundle();
        bundle.setBaseName("Example");
        bundle.setInterfaceName("com.viaboxx.I_Example");
        MBEntry entry = new MBEntry();
        entry.setKey("key1");
        MBText text = new MBText();
        text.setLocale("de");
        text.setValue("Beispieltext mit ");
        entry.getTexts().add(text);
        text = new MBText();
        text.setLocale("en");
        text.setValue("An example");
        entry.getTexts().add(text);
        bundle.getEntries().add(entry);

        entry = new MBEntry();
        entry.setKey("key2");
        text = new MBText();
        text.setLocale("de");
        text.setValue("anderer Wert");
        entry.getTexts().add(text);
        bundle.getEntries().add(entry);

        bundles.getBundles().add(bundle);
        return bundles;
    }

    public void testGenerate() throws Exception {
        MessageBundleTask task = new MessageBundleTask();
        task.setProject(new Project());
        task.setBundles("example/example.xml");
        task.setOverwrite(true);
        task.setDeleteOldFiles(false);
        task.setPropertyPath("target/out-properties");
        task.setJsonPath("target/out-json");
        task.setSourcePath("target/out-src");
        task.setWriteProperties("true");
        task.setWriteJson("true");
        task.setWriteInterface("true");
        task.execute();
    }

    public void testThatNewlinesAreEscapedByDefault() throws Exception {
        MessageBundleTask task = setupTaskForBundles("example/newLineExample.xml");
        task.execute();

        String result = readFileAsString("target/out-properties/NewLineExample_en.properties");
        assertTrue(result.contains("\\\\n"));
    }

    public void testThatNewlinesAreEscapedWhenConfigured() throws Exception {
        MessageBundleTask task = setupTaskForBundles("example/newLineExample.xml");
        task.setPreserveNewlines(true);
        task.execute();

        String result = readFileAsString("target/out-properties/NewLineExample_en.properties");
        assertFalse(result.contains("\\\\n"));
    }

    public void testThatOnlyAllowedLocalesAreWrittenWhenFilterIsSet() {
        MessageBundleTask task = setupTaskForBundles("example/multiLocaleExample.xml");
        task.setAllowedLocales("en;de");
        task.execute();

        for (String locale : new String[]{"fi", "es"}) {
            File outFile = new File("target/out-properties/MultiLocaleExample_" + locale + ".properties");
            assertFalse("Locale '" + locale + "' should NOT have been written", outFile.exists());
        }

        for (String locale : new String[]{"de", "en"}) {
            File outFile = new File("target/out-properties/MultiLocaleExample_" + locale + ".properties");
            assertTrue("Locale '" + locale + "' should have been written", outFile.exists());
        }


        task.execute();


    }

    private MessageBundleTask setupTaskForBundles(String bundles) {
        MessageBundleTask task = new MessageBundleTask();
        task.setProject(new Project());
        task.setBundles(bundles);
        task.setOverwrite(true);
        task.setDeleteOldFiles(false);
        task.setPropertyPath("target/out-properties");
        task.setJsonPath("target/out-json");
        task.setSourcePath("target/out-src");
        task.setWriteProperties("true");
        task.setWriteJson("true");
        task.setWriteInterface("true");
        return task;
    }


    public static Test suite() {
        return new TestSuite(MessageBundleTaskTest.class);
    }

    private static String readFileAsString(String filePath) throws java.io.IOException {
        byte[] buffer = new byte[(int) new File(filePath).length()];
        BufferedInputStream f = null;
        try {
            f = new BufferedInputStream(new FileInputStream(filePath));
            f.read(buffer);
        } finally {
            if (f != null) try {
                f.close();
            } catch (IOException ignored) {
            }
        }
        return new String(buffer);
    }
}