test/java/util/Base64/TestBase64Golden.java

/*
 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * @test 4235519
 * @author Eric Wang <yiming.wang@oracle.com>
 * @summary tests java.util.Base64
 */

import java.io.BufferedReader;
import java.io.FileReader;
import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Base64;
import java.util.Base64.Decoder;
import java.util.Base64.Encoder;
import java.util.Objects;
import java.util.Random;

import sun.misc.BASE64Decoder;
import sun.misc.BASE64Encoder;

public class TestBase64Golden {

    public static void main(String[] args) throws Exception {
        test0(Base64Type.BASIC, Base64.getEncoder(), Base64.getDecoder(),
              "plain.txt", "baseEncode.txt");

        test0(Base64Type.URLSAFE, Base64.getUrlEncoder(), Base64.getUrlDecoder(),
              "plain.txt", "urlEncode.txt");

        test0(Base64Type.MIME, Base64.getMimeEncoder(), Base64.getMimeDecoder(),
              "plain.txt", "mimeEncode.txt");
        test1();
        test2();
    }

    public static void test0(Base64Type type, Encoder encoder, Decoder decoder,
                             String srcFile, String encodedFile) throws Exception {

        String[] srcLns = Files.readAllLines(Paths.get(SRCDIR, srcFile), DEF_CHARSET)
                               .toArray(new String[0]);
        String[] encodedLns = Files.readAllLines(Paths.get(SRCDIR, encodedFile),
                                                 DEF_CHARSET)
                                   .toArray(new String[0]);
        int lns = 0;
        for (String srcStr : srcLns) {
            String encodedStr = null;
            if (type != Base64Type.MIME) {
                encodedStr = encodedLns[lns++];
            } else {
                while (lns < encodedLns.length) {
                    String s = encodedLns[lns++];
                    if (s.length() == 0)
                        break;
                    if (encodedStr != null) {
                        encodedStr += DEFAULT_CRLF + s;
                    } else {
                        encodedStr = s;
                    }
                }
                if (encodedStr == null && srcStr.length() == 0) {
                    encodedStr = "";
                }
            }
            System.out.printf("%n    src[%d]: %s%n", srcStr.length(), srcStr);
            System.out.printf("encoded[%d]: %s%n", encodedStr.length(), encodedStr);

            byte[] srcArr = srcStr.getBytes(DEF_CHARSET);
            byte[] encodedArr = encodedStr.getBytes(DEF_CHARSET);

            ByteBuffer srcBuf = ByteBuffer.wrap(srcArr);
            ByteBuffer encodedBuf = ByteBuffer.wrap(encodedArr);
            byte[] resArr = new byte[encodedArr.length];

            // test int encode(byte[], byte[])
            int len = encoder.encode(srcArr, resArr);
            assertEqual(len, encodedArr.length);
            assertEqual(resArr, encodedArr);

            // test byte[] encode(byte[])
            resArr = encoder.encode(srcArr);
            assertEqual(resArr, encodedArr);

            // test ByteBuffer encode(ByteBuffer)
            int limit = srcBuf.limit();
            ByteBuffer resBuf = encoder.encode(srcBuf);
            assertEqual(srcBuf.position(), limit);
            assertEqual(srcBuf.limit(), limit);
            assertEqual(resBuf, encodedBuf);
            srcBuf.rewind(); // reset for next test

            // test encode(ByteBuffer, ByteBuffer, bytesOut)
            resBuf.clear();
            len = encoder.encode(srcBuf, resBuf, 0);
            assertEqual(len, encodedArr.length);
            assertEqual(srcBuf.position(), limit);
            assertEqual(srcBuf.limit(), limit);
            assertEqual(resBuf.position(), len);
            resBuf.flip();
            assertEqual(resBuf, encodedBuf);
            srcBuf.rewind();

            // test encode(ByteBuffer, ByteBuffer, bytesOut)[direct]
            ByteBuffer resBuf_d = ByteBuffer.allocateDirect(encodedArr.length);
            len = encoder.encode(srcBuf, resBuf_d, 0);
            assertEqual(len, encodedArr.length);
            assertEqual(srcBuf.position(), limit);
            assertEqual(srcBuf.limit(), limit);
            assertEqual(resBuf_d.position(), len);
            resBuf_d.flip();
            assertEqual(resBuf_d, encodedBuf);
            srcBuf.rewind();

            // test String encodeToString(byte[])
            String resEncodeStr = encoder.encodeToString(srcArr);
            assertEqual(resEncodeStr, encodedStr);

            // test int decode(byte[], byte[])
            resArr = new byte[srcArr.length];
            len = decoder.decode(encodedArr, resArr);
            assertEqual(len, srcArr.length);
            assertEqual(resArr, srcArr);

            // test byte[] decode(byte[])
            resArr = decoder.decode(encodedArr);
            assertEqual(resArr, srcArr);

            // test ByteBuffer decode(ByteBuffer)
            limit = encodedBuf.limit();
            resBuf = decoder.decode(encodedBuf);
            assertEqual(encodedBuf.position(), limit);
            assertEqual(encodedBuf.limit(), limit);
            assertEqual(resBuf, srcBuf);
            encodedBuf.rewind(); // reset for next test

            // test int decode(ByteBuffer, ByteBuffer)
            resBuf.clear();
            len = decoder.decode(encodedBuf, resBuf);
            assertEqual(len, srcArr.length);
            assertEqual(encodedBuf.position(), limit);
            assertEqual(encodedBuf.limit(), limit);
            assertEqual(resBuf.position(), len);
            resBuf.flip();
            assertEqual(resBuf, srcBuf);
            encodedBuf.rewind(); // reset for next test

            // test int decode(ByteBuffer, ByteBuffer)[direct]
            resBuf_d = ByteBuffer.allocateDirect(srcArr.length);
            len = decoder.decode(encodedBuf, resBuf_d);
            assertEqual(len, srcArr.length);
            assertEqual(encodedBuf.position(), limit);
            assertEqual(encodedBuf.limit(), limit);
            assertEqual(resBuf_d.position(), len);
            resBuf_d.flip();
            assertEqual(resBuf_d, srcBuf);
            encodedBuf.rewind(); // reset for next test

            // test byte[] decode(String)
            resArr = decoder.decode(encodedStr);
            assertEqual(resArr, srcArr);

            // test compatible with sun.misc.Base64Encoder
            if (type == Base64Type.MIME) {
                sun.misc.BASE64Encoder miscEncoder = new BASE64Encoder();
                sun.misc.BASE64Decoder miscDecoder = new BASE64Decoder();
                resArr = decoder.decode(miscEncoder.encode(srcArr));
                assertEqual(resArr, srcArr);

                resArr = encoder.encode(miscDecoder.decodeBuffer(encodedStr));
                assertEqual(new String(resArr, DEF_CHARSET), encodedStr);
            }
        }
    }

    private static void test1() throws Exception {
        byte[] src = new byte[6];
        new Random().nextBytes(src);

        ByteBuffer srcBuf = ByteBuffer.allocate(10);
        srcBuf.position(2);
        srcBuf.mark();
        srcBuf.limit(8);
        srcBuf.put(src);
        srcBuf.reset();

        ByteBuffer dstBuf = ByteBuffer.allocate((src.length + 2) / 3 * 4);
        Base64.getEncoder().encode(srcBuf, dstBuf, 0);
        dstBuf.rewind();
        byte[] dst = new byte[dstBuf.limit()];
        dstBuf.get(dst);
        System.out.printf("%n    src[%d]: %s%n", src.length, new String(src));
        System.out.printf("encoded[%d]: %s%n",   dst.length, new String(dst));
        assertEqual(src, Base64.getDecoder().decode(dst));

        dstBuf = ByteBuffer.allocateDirect((src.length + 2) / 3 * 4);
        srcBuf.reset();
        Base64.getEncoder().encode(srcBuf, dstBuf, 0);
        dstBuf.rewind();
        dst = new byte[dstBuf.limit()];
        dstBuf.get(dst);
        assertEqual(src, Base64.getDecoder().decode(dst));
    }

    private static void test2() throws Exception {
        byte[] src = new byte[] {
            46, -97, -35, -44, 127, -60, -39, -4, -112, 34, -57, 47, -14, 67,
            40, 18, 90, -59, 68, 112, 23, 121, -91, 94, 35, 49, 104, 17, 30,
            -80, -104, -3, -53, 27, 38, -72, -47, 113, -52, 18, 5, -126 };
        Encoder encoder = Base64.getMimeEncoder(49, new byte[] { 0x7e });
        byte[] encoded = encoder.encode(src);
        Decoder decoder = Base64.getMimeDecoder();
        byte[] decoded = decoder.decode(encoded);
        if (!Objects.deepEquals(src, decoded)) {
            throw new RuntimeException();
        }
    }

    // helper
    enum Base64Type {
        BASIC, URLSAFE, MIME
    }

    private static final String SRCDIR = System.getProperty("test.src", ".");
    private static final Charset DEF_CHARSET = StandardCharsets.US_ASCII;
    private static final String DEF_EXCEPTION_MSG =
        "Assertion failed! The result is not same as expected";
    private static final String DEFAULT_CRLF = "\r\n";

    private static void assertEqual(Object result, Object expect) {
        if (!Objects.deepEquals(result, expect)) {
            String resultStr = result.toString();
            String expectStr = expect.toString();
            if (result instanceof byte[]) {
                resultStr = new String((byte[]) result, DEF_CHARSET);
            }
            if (expect instanceof byte[]) {
                expectStr = new String((byte[]) expect, DEF_CHARSET);
            }
            throw new RuntimeException(DEF_EXCEPTION_MSG +
                " result: " + resultStr + " expected: " + expectStr);
        }
    }
}