Deprecate all MD-SAL APIs
[controller.git] / opendaylight / md-sal / mdsal-trace / dom-impl / src / test / java / org / opendaylight / controller / md / sal / trace / tests / TracingBrokerTest.java
1 /*
2  * Copyright (c) 2017 Red Hat, Inc. and others. All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.md.sal.trace.tests;
9
10 import static com.google.common.truth.Truth.assertThat;
11 import static java.nio.charset.StandardCharsets.UTF_8;
12 import static java.util.Collections.singletonList;
13 import static org.mockito.Mockito.RETURNS_DEEP_STUBS;
14 import static org.mockito.Mockito.mock;
15
16 import java.io.ByteArrayOutputStream;
17 import java.io.PrintStream;
18 import org.junit.Test;
19 import org.opendaylight.controller.md.sal.binding.test.DataBrokerTestModule;
20 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
21 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
22 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
23 import org.opendaylight.controller.md.sal.trace.dom.impl.TracingBroker;
24 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsaltrace.rev160908.Config;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsaltrace.rev160908.ConfigBuilder;
27
28 /**
29  * Test of {@link TracingBroker}.
30  *
31  * @author Michael Vorburger.ch
32  */
33 @Deprecated
34 public class TracingBrokerTest {
35
36     @Test
37     public void testEnd2End() {
38         DataBrokerTestModule wiring = new DataBrokerTestModule(true);
39         wiring.getDataBroker(); // required so DataBrokerTestModule creates the DOMDataBroker
40         DOMDataBroker realDomBroker = wiring.getDOMDataBroker();
41         TracingBroker tracingDomBroker = new TracingBroker("Test", realDomBroker, new ConfigBuilder()
42                 // CONTROLLER-1877: configure it like the default/initial mdsaltrace_config.xml in mdsal-trace-api
43                 .setTransactionDebugContextEnabled(true)
44                 .setWriteWatches(singletonList("/this/will/never/exist"))
45                 .setRegistrationWatches(singletonList("/this/will/never/exist"))
46                 .build(),
47                 wiring.getBindingToNormalizedNodeCodec());
48         tracingDomBroker.newWriteOnlyTransaction().cancel();
49     }
50
51     @Test
52     @SuppressWarnings({ "resource", "unused" }) // Finding resource leaks is the point of this test
53     public void testPrintOpenTransactions() {
54         DOMDataBroker domDataBroker = mock(DOMDataBroker.class, RETURNS_DEEP_STUBS);
55         Config config = new ConfigBuilder().setTransactionDebugContextEnabled(true).build();
56         BindingNormalizedNodeSerializer codec = mock(BindingNormalizedNodeSerializer.class);
57         TracingBroker tracingBroker = new TracingBroker("mock", domDataBroker, config, codec);
58
59         for (int i = 0; i < 3; i++) {
60             DOMDataReadWriteTransaction tx = tracingBroker.newReadWriteTransaction();
61         }
62         DOMDataReadWriteTransaction anotherTx = tracingBroker.newReadWriteTransaction();
63
64         DOMTransactionChain txChain = tracingBroker.createTransactionChain(null);
65         DOMDataReadWriteTransaction txFromChain = txChain.newReadWriteTransaction();
66
67         ByteArrayOutputStream baos = new ByteArrayOutputStream();
68         PrintStream ps = new PrintStream(baos);
69         boolean printReturnValue = tracingBroker.printOpenTransactions(ps, 1);
70         String output = new String(baos.toByteArray(), UTF_8);
71
72         assertThat(printReturnValue).isTrue();
73         // Assert expectations about stack trace
74         assertThat(output).contains("testPrintOpenTransactions(TracingBrokerTest.java");
75         assertThat(output).doesNotContain(TracingBroker.class.getName());
76
77         String previousLine = "";
78         for (String line : output.split("\n")) {
79             if (line.contains("(...")) {
80                 assertThat(previousLine.contains("(...)")).isFalse();
81             }
82             previousLine = line;
83         }
84
85         // assert that the sorting works - the x3 is shown before the x1
86         assertThat(output).contains("  DataBroker : newReadWriteTransaction()\n    3x");
87
88         // We don't do any verify/times on the mocks,
89         // because the main point of the test is just to verify that
90         // printOpenTransactions runs through without any exceptions
91         // (e.g. it used to have a ClassCastException).
92     }
93
94 }