summaryrefslogtreecommitdiff
path: root/tests/testables/src/android/testing/DexmakerShareClassLoaderRule.java
blob: 7057a90c7672d0ed10148b18cf5894c9f7aecf6f (plain)
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
/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed 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.
 */

package android.testing;

import android.util.Log;

import com.android.internal.annotations.VisibleForTesting;

import libcore.util.SneakyThrow;

import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;

import java.util.ConcurrentModificationException;


/**
 * Runs the test such that mocks created in it don't use a dedicated classloader.
 *
 * This allows mocking package-private methods.
 *
 * WARNING: This is absolutely incompatible with running tests in parallel!
 */
public class DexmakerShareClassLoaderRule implements TestRule {

    private static final String TAG = "ShareClassloaderRule";
    @VisibleForTesting
    static final String DEXMAKER_SHARE_CLASSLOADER_PROPERTY = "dexmaker.share_classloader";

    private static Thread sOwningThread = null;

    @Override
    public Statement apply(Statement base, Description description) {
        return apply(base::evaluate).toStatement();
    }

    /**
     * Runs the runnable such that mocks created in it don't use a dedicated classloader.
     *
     * This allows mocking package-private methods.
     *
     * WARNING: This is absolutely incompatible with running tests in parallel!
     */
    public static void runWithDexmakerShareClassLoader(Runnable r) {
        try {
            apply(r::run).run();
        } catch (Throwable t) {
            SneakyThrow.sneakyThrow(t);
        }
    }

    /**
     * Returns a statement that first makes sure that only one thread at the time is modifying
     * the property. Then actually sets the property, and runs the statement.
     */
    private static <T extends Throwable> ThrowingRunnable<T> apply(ThrowingRunnable<T> r) {
        return wrapInMutex(wrapInSetAndClearProperty(r));
    }

    private static <T extends Throwable> ThrowingRunnable<T> wrapInSetAndClearProperty(
            ThrowingRunnable<T> r) {
        return () -> {
            final String previousValue = System.getProperty(DEXMAKER_SHARE_CLASSLOADER_PROPERTY);
            try {
                System.setProperty(DEXMAKER_SHARE_CLASSLOADER_PROPERTY, "true");
                r.run();
            } finally {
                if (previousValue != null) {
                    System.setProperty(DEXMAKER_SHARE_CLASSLOADER_PROPERTY, previousValue);
                } else {
                    System.clearProperty(DEXMAKER_SHARE_CLASSLOADER_PROPERTY);
                }
            }
        };
    }

    /**
     * Runs the given statement, and while doing so prevents other threads from running statements.
     */
    private static <T extends Throwable> ThrowingRunnable<T> wrapInMutex(ThrowingRunnable<T> r) {
        return () -> {
            final boolean isOwner;
            synchronized (DexmakerShareClassLoaderRule.class) {
                isOwner = (sOwningThread == null);
                if (isOwner) {
                    sOwningThread = Thread.currentThread();
                } else if (sOwningThread != Thread.currentThread()) {
                    final RuntimeException e = new ConcurrentModificationException(
                            "Tried to set dexmaker.share_classloader from " + Thread.currentThread()
                                    + ", but was already set from " + sOwningThread);
                    // Also log in case exception gets swallowed.
                    Log.e(TAG, e.getMessage(), e);
                    throw e;
                }
            }
            try {
                r.run();
            } finally {
                synchronized (DexmakerShareClassLoaderRule.class) {
                    if (isOwner) {
                        sOwningThread = null;
                    }
                }
            }
        };
    }

    private interface ThrowingRunnable<T extends Throwable> {
        void run() throws T;

        default Statement toStatement() {
            return new Statement() {
                @Override
                public void evaluate() throws Throwable {
                    ThrowingRunnable.this.run();
                }
            };
        }
    }
}