Add initial version of documentation
[portal/nonrtric-controlpanel.git] / webapp-backend / src / test / java / org / oransc / portal / nonrtric / controlpanel / ControlPanelTestServer.java
1 /*-
2  * ========================LICENSE_START=================================
3  * O-RAN-SC
4  * %%
5  * Copyright (C) 2019 AT&T Intellectual Property
6  * Modifications Copyright (C) 2020 Nordix Foundation
7  * %%
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  *      http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  * ========================LICENSE_END===================================
20  */
21 package org.oransc.portal.nonrtric.controlpanel;
22
23 import java.lang.invoke.MethodHandles;
24
25 import org.junit.jupiter.api.Test;
26 import org.junit.jupiter.api.condition.EnabledIfSystemProperty;
27 import org.junit.jupiter.api.extension.ExtendWith;
28 import org.slf4j.Logger;
29 import org.slf4j.LoggerFactory;
30 import org.springframework.boot.test.context.SpringBootTest;
31 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
32 import org.springframework.test.context.junit.jupiter.SpringExtension;
33
34 /**
35  * This class supports front-end web development. Placing this class in the test
36  * area allows excluding the mock configuration classes and the Mockito
37  * dependencies from the packaged version of the app.
38  *
39  * To launch a development server set the environment variable as listed below.
40  * This runs a Spring-Boot server with mock back-end beans, and keeps the server
41  * alive for manual testing. Supply this JVM argument:
42  *
43  * <pre>
44  * -Dorg.org.oransc.portal.nonrtric.controlpanel=mock
45  * </pre>
46  */
47 @ExtendWith(SpringExtension.class)
48 @SpringBootTest(webEnvironment = WebEnvironment.DEFINED_PORT)
49 public class ControlPanelTestServer {
50
51     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
52
53     /*
54      * Keeps the test server alive forever. Use a guard so this test is never run by
55      * Jenkins.
56      */
57     @SuppressWarnings("squid:S2699") // To avoid warning about missing assertion.
58     @EnabledIfSystemProperty(named = "org.oransc.portal.nonrtric.controlpanel", matches = "mock")
59     @Test
60     public void keepServerAlive() {
61         logger.warn("Keeping server alive!");
62         try {
63             synchronized (this) {
64                 this.wait();
65             }
66         } catch (Exception ex) {
67             logger.warn(ex.toString());
68         }
69     }
70 }