summaryrefslogtreecommitdiffstats
path: root/sangria-lazy/src/test/java/com/tavianator/sangria/lazy/LazyTest.java
blob: 8bea02d494a767848eae95dcbbdf4aaff6b95b80 (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
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/****************************************************************************
 * Sangria                                                                  *
 * Copyright (C) 2014 Tavian Barnes <tavianator@tavianator.com>             *
 *                                                                          *
 * 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 com.tavianator.sangria.lazy;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.*;
import javax.inject.Inject;
import javax.inject.Qualifier;

import com.google.inject.AbstractModule;
import com.google.inject.Binding;
import com.google.inject.CreationException;
import com.google.inject.Guice;
import com.google.inject.Injector;
import com.google.inject.Key;
import com.google.inject.Module;
import com.google.inject.spi.DefaultBindingTargetVisitor;
import com.google.inject.spi.Element;
import com.google.inject.spi.Elements;
import org.junit.Test;

import static com.tavianator.sangria.test.SangriaMatchers.*;
import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;

/**
 * Tests for {@link Lazy} injection.
 *
 * @author Tavian Barnes (tavianator@tavianator.com)
 * @version 1.2
 * @since 1.2
 */
public class LazyTest {
    @Retention(RetentionPolicy.RUNTIME)
    @Qualifier
    private @interface Simple {
    }

    private interface Abstract {
    }

    private static class Concrete implements Abstract {
        static final ThreadLocal<Integer> INSTANCES = new ThreadLocal<Integer>() {
            @Override
            protected Integer initialValue() {
                return 0;
            }
        };

        @Inject
        Concrete() {
            INSTANCES.set(INSTANCES.get() + 1);
        }
    }

    private static class HasConcrete {
        final Lazy<Concrete> lazy;

        @Inject
        HasConcrete(Lazy<Concrete> lazy) {
            this.lazy = lazy;
        }
    }

    private static class HasQualifiedAbstract {
        @Inject @Simple Lazy<Abstract> lazy;
    }

    @Test
    public void testJustInTime() {
        testHasConcrete(Guice.createInjector());
    }

    @Test
    public void testExplicitBindings() {
        testHasConcrete(Guice.createInjector(new AbstractModule() {
            @Override
            protected void configure() {
                binder().requireExplicitBindings();

                bind(HasConcrete.class);

                bind(Concrete.class);
                LazyBinder.create(binder())
                        .bind(Concrete.class);
            }
        }));
    }

    @Test
    public void testBestPractices() {
        Module module = new AbstractModule() {
            @Override
            protected void configure() {
                bind(HasConcrete.class);

                bind(Concrete.class);
                LazyBinder.create(binder())
                        .bind(Concrete.class);
            }
        };
        assertThat(module, is(atomic()));
        assertThat(module, followsBestPractices());
    }

    private void testHasConcrete(Injector injector) {
        int before = Concrete.INSTANCES.get();

        HasConcrete hasConcrete = injector.getInstance(HasConcrete.class);
        assertThat(Concrete.INSTANCES.get(), equalTo(before));

        Concrete instance = hasConcrete.lazy.get();
        assertThat(Concrete.INSTANCES.get(), equalTo(before + 1));

        Concrete instance2 = hasConcrete.lazy.get();
        assertThat(instance2, sameInstance(instance));
        assertThat(Concrete.INSTANCES.get(), equalTo(before + 1));

        HasConcrete hasConcrete2 = injector.getInstance(HasConcrete.class);
        assertThat(Concrete.INSTANCES.get(), equalTo(before + 1));

        Concrete instance3 = hasConcrete2.lazy.get();
        assertThat(instance3, not(sameInstance(instance)));
        assertThat(Concrete.INSTANCES.get(), equalTo(before + 2));
    }

    @Test
    public void testBindSeparately() {
        testQualifiedAbstract(Guice.createInjector(new AbstractModule() {
            @Override
            protected void configure() {
                bind(Abstract.class)
                        .annotatedWith(Simple.class)
                        .to(Concrete.class);

                LazyBinder.create(binder())
                        .bind(Abstract.class)
                        .annotatedWith(Simple.class);
            }
        }));
    }

    @Test
    public void testBindTogether() {
        testQualifiedAbstract(Guice.createInjector(new AbstractModule() {
            @Override
            protected void configure() {
                LazyBinder.create(binder())
                        .bind(Abstract.class)
                        .annotatedWith(Simple.class)
                        .to(Concrete.class);
            }
        }));
    }

    private void testQualifiedAbstract(Injector injector) {
        int before = Concrete.INSTANCES.get();

        HasQualifiedAbstract hasQualifiedAbstract = injector.getInstance(HasQualifiedAbstract.class);
        assertThat(Concrete.INSTANCES.get(), equalTo(before));

        Abstract instance = hasQualifiedAbstract.lazy.get();
        assertThat(Concrete.INSTANCES.get(), equalTo(before + 1));

        Abstract instance2 = hasQualifiedAbstract.lazy.get();
        assertThat(instance2, sameInstance(instance2));
        assertThat(Concrete.INSTANCES.get(), equalTo(before + 1));

        HasQualifiedAbstract hasQualifiedAbstract2 = injector.getInstance(HasQualifiedAbstract.class);
        assertThat(Concrete.INSTANCES.get(), equalTo(before + 1));

        Abstract instance3 = hasQualifiedAbstract2.lazy.get();
        assertThat(instance3, not(sameInstance(instance)));
        assertThat(Concrete.INSTANCES.get(), equalTo(before + 2));
    }

    @Test(expected = CreationException.class)
    public void testMissingBinding() {
        Guice.createInjector(new AbstractModule() {
            @Override
            protected void configure() {
                LazyBinder.create(binder())
                        .bind(Abstract.class);
            }
        });
    }

    @Test(expected = CreationException.class)
    public void testMissingQualifiedBinding() {
        Guice.createInjector(new AbstractModule() {
            @Override
            protected void configure() {
                LazyBinder.create(binder())
                        .bind(Abstract.class)
                        .annotatedWith(Simple.class);
            }
        });
    }

    private static class TestVisitor<T> extends DefaultBindingTargetVisitor<T, Boolean> implements LazyBindingVisitor<T, Boolean> {
        @Override
        public Boolean visit(LazyBinding<? extends T> binding) {
            assertThat(binding.getTargetKey().equals(new Key<Abstract>(Simple.class) { }), is(true));
            return true;
        }

        @Override
        protected Boolean visitOther(Binding<? extends T> binding) {
            return false;
        }
    }

    private <T> boolean visit(Binding<T> binding) {
        return binding.acceptTargetVisitor(new TestVisitor<T>());
    }

    @Test
    public void testExtensionSpi() {
        Module module = new AbstractModule() {
            @Override
            protected void configure() {
                // TODO: Expose the SPI for unqualified bindings
                LazyBinder.create(binder())
                        .bind(Abstract.class)
                        .annotatedWith(Simple.class)
                        .to(Concrete.class);
            }
        };

        List<Element> elements = Elements.getElements(module);

        int passed = 0;
        for (Element element : elements) {
            if (element instanceof Binding) {
                if (visit((Binding<?>)element)) {
                    ++passed;
                }
            }
        }
        assertThat(passed, equalTo(1));

        Injector injector = Guice.createInjector(Elements.getModule(elements));
        assertThat(visit(injector.getBinding(new Key<Lazy<Abstract>>(Simple.class) { })), is(true));
        assertThat(visit(injector.getBinding(new Key<Abstract>(Simple.class) { })), is(false));
        assertThat(visit(injector.getBinding(new Key<Concrete>() { })), is(false));
    }
}