File: RecordClassTest.java

package info (click to toggle)
openjdk-21 21.0.8%2B9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 823,976 kB
  • sloc: java: 5,613,338; xml: 1,643,607; cpp: 1,296,296; ansic: 420,291; asm: 404,850; objc: 20,994; sh: 15,271; javascript: 11,245; python: 6,895; makefile: 2,362; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (170 lines) | stat: -rw-r--r-- 6,150 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
 * Copyright (c) 2019, 2020, 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
 * @bug 8246774
 * @summary Basic tests for serializing and deserializing record classes
 * @run testng RecordClassTest
 * @run testng/othervm/java.security.policy=empty_security.policy RecordClassTest
 */

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectInputStream;
import java.io.ObjectOutput;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamClass;
import java.io.Serializable;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import static java.lang.System.out;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.fail;

/**
 * Serializes and deserializes record classes. Ensures that the SUID is 0.
 */
public class RecordClassTest {

    record Foo () implements Serializable { }

    record Bar (int x) implements Serializable {
        private static final long serialVersionUID = 987654321L;
    }

    record Baz (Foo foo, Bar bar, int i) implements Serializable {  }

    interface ThrowingExternalizable extends Externalizable {
        default void writeExternal(ObjectOutput out) {
            fail("should not reach here");
        }
        default void readExternal(ObjectInput in) {
            fail("should not reach here");
        }
    }

    record Wibble () implements ThrowingExternalizable {
        private static final long serialVersionUID = 12345678L;
    }

    record Wobble (long l) implements ThrowingExternalizable { }

    record Wubble (Wobble wobble, Wibble wibble, String s) implements ThrowingExternalizable { }

    @DataProvider(name = "recordClasses")
    public Object[][] recordClasses() {
        return new Object[][] {
            new Object[] { Foo.class    , 0L         },
            new Object[] { Bar.class    , 987654321L },
            new Object[] { Baz.class    , 0L         },
            new Object[] { Wibble.class , 12345678L  },
            new Object[] { Wobble.class , 0L         },
            new Object[] { Wubble.class , 0L         },
        };
    }

    /** Tests that the serialized and deserialized instances are equal. */
    @Test(dataProvider = "recordClasses")
    public void testClassSerialization(Class<?> recordClass, long unused)
        throws Exception
    {
        out.println("\n---");
        out.println("serializing : " + recordClass);
        var deserializedClass = serializeDeserialize(recordClass);
        out.println("deserialized: " + deserializedClass);
        assertEquals(recordClass, deserializedClass);
        assertEquals(deserializedClass, recordClass);
    }

    /** Tests that the SUID is always 0 unless explicitly declared. */
    @Test(dataProvider = "recordClasses")
    public void testSerialVersionUID(Class<?> recordClass, long expectedUID) {
        out.println("\n---");
        ObjectStreamClass osc = ObjectStreamClass.lookup(recordClass);
        out.println("ObjectStreamClass::lookup  : " + osc);
        assertEquals(osc.getSerialVersionUID(), expectedUID);

        osc = ObjectStreamClass.lookupAny(recordClass);
        out.println("ObjectStreamClass::lookupAny: " + osc);
        assertEquals(osc.getSerialVersionUID(), expectedUID);
    }

    // --- not Serializable

    record NotSerializable1() { }

    record NotSerializable2(int x) { }

    record NotSerializable3<T>(T t) { }

    @DataProvider(name = "notSerRecordClasses")
    public Object[][] notSerRecordClasses() {
        return new Object[][] {
            new Object[] { NotSerializable1.class },
            new Object[] { NotSerializable2.class },
            new Object[] { NotSerializable3.class },
        };
    }

    /** Tests that the generated SUID is always 0 for all non-Serializable record classes. */
    @Test(dataProvider = "notSerRecordClasses")
    public void testSerialVersionUIDNonSer(Class<?> recordClass) {
        out.println("\n---");
        ObjectStreamClass osc = ObjectStreamClass.lookup(recordClass);
        out.println("ObjectStreamClass::lookup  : " + osc);
        assertEquals(osc, null);

        osc = ObjectStreamClass.lookupAny(recordClass);
        out.println("ObjectStreamClass::lookupAny: " + osc);
        assertEquals(osc.getSerialVersionUID(), 0L);
    }

    // --- infra

    static <T> byte[] serialize(T obj) throws IOException {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        ObjectOutputStream oos = new ObjectOutputStream(baos);
        oos.writeObject(obj);
        oos.close();
        return baos.toByteArray();
    }

    @SuppressWarnings("unchecked")
    static <T> T deserialize(byte[] streamBytes)
        throws IOException, ClassNotFoundException
    {
        ByteArrayInputStream bais = new ByteArrayInputStream(streamBytes);
        ObjectInputStream ois  = new ObjectInputStream(bais);
        return (T) ois.readObject();
    }

    static <T> T serializeDeserialize(T obj)
        throws IOException, ClassNotFoundException
    {
        return deserialize(serialize(obj));
    }
}