main/src/test/java/org/onap/policy/pap/main/rest/CommonPapRestServer.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019 AT&T Intellectual Property.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.pap.main.rest;
  23
  24 import static org.junit.Assert.assertEquals;
  25 import static org.junit.Assert.assertTrue;
  26
  27 import java.io.File;
  28 import java.io.FileOutputStream;
  29 import java.nio.charset.StandardCharsets;
  30 import java.security.SecureRandom;
  31 import java.util.Properties;
  32 import java.util.function.Function;
  33 import javax.net.ssl.SSLContext;
  34 import javax.ws.rs.client.Client;
  35 import javax.ws.rs.client.ClientBuilder;
  36 import javax.ws.rs.client.Invocation;
  37 import javax.ws.rs.client.WebTarget;
  38 import javax.ws.rs.core.MediaType;
  39 import javax.ws.rs.core.Response;
  40 import org.glassfish.jersey.client.ClientProperties;
  41 import org.glassfish.jersey.client.authentication.HttpAuthenticationFeature;
  42 import org.junit.After;
  43 import org.junit.AfterClass;
  44 import org.junit.Before;
  45 import org.junit.BeforeClass;
  46 import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
  47 import org.onap.policy.common.endpoints.http.server.HttpServletServer;
  48 import org.onap.policy.common.gson.GsonMessageBodyHandler;
  49 import org.onap.policy.common.utils.network.NetworkUtil;
  50 import org.onap.policy.common.utils.services.Registry;
  51 import org.onap.policy.pap.main.PapConstants;
  52 import org.onap.policy.pap.main.PolicyPapException;
  53 import org.onap.policy.pap.main.parameters.CommonTestData;
  54 import org.onap.policy.pap.main.startstop.Main;
  55 import org.onap.policy.pap.main.startstop.PapActivator;
  56 import org.powermock.reflect.Whitebox;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 /**
  61  * Class to perform unit test of {@link PapRestServer}.
  62  *
  63  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  64  */
  65 public class CommonPapRestServer {
  66
  67     private static final Logger LOGGER = LoggerFactory.getLogger(CommonPapRestServer.class);
  68
  69     private static String KEYSTORE = System.getProperty("user.dir") + "/src/test/resources/ssl/policy-keystore";
  70
  71     public static final String NOT_ALIVE = "not alive";
  72     public static final String ALIVE = "alive";
  73     public static final String SELF = "self";
  74     public static final String NAME = "Policy PAP";
  75     public static final String ENDPOINT_PREFIX = "policy/pap/v1/";
  76
  77     private static int port;
  78     protected static String httpsPrefix;
  79
  80     private static Main main;
  81
  82     private boolean activatorWasAlive;
  83
  84     /**
  85      * Allocates a port for the server, writes a config file, and then starts Main.
  86      *
  87      * @throws Exception if an error occurs
  88      */
  89     @BeforeClass
  90     public static void setUpBeforeClass() throws Exception {
  91         port = NetworkUtil.allocPort();
  92
  93         httpsPrefix = "https://localhost:" + port + "/";
  94
  95         makeConfigFile();
  96
  97         HttpServletServer.factory.destroy();
  98         TopicEndpoint.manager.shutdown();
  99
 100         CommonTestData.newDb();
 101
 102         startMain();
 103     }
 104
 105     /**
 106      * Stops Main.
 107      */
 108     @AfterClass
 109     public static void teardownAfterClass() {
 110         try {
 111             stopMain();
 112
 113         } catch (PolicyPapException exp) {
 114             LOGGER.error("cannot stop main", exp);
 115         }
 116     }
 117
 118     /**
 119      * Set up.
 120      *
 121      * @throws Exception if an error occurs
 122      */
 123     @Before
 124     public void setUp() throws Exception {
 125         // restart, if not currently running
 126         if (main == null) {
 127             startMain();
 128         }
 129
 130         activatorWasAlive = Registry.get(PapConstants.REG_PAP_ACTIVATOR, PapActivator.class).isAlive();
 131     }
 132
 133     /**
 134      * Restores the activator's "alive" state.
 135      */
 136     @After
 137     public void tearDown() {
 138         markActivator(activatorWasAlive);
 139     }
 140
 141     /**
 142      * Verifies that an endpoint appears within the swagger response.
 143      *
 144      * @param endpoint the endpoint of interest
 145      * @throws Exception if an error occurs
 146      */
 147     protected void testSwagger(final String endpoint) throws Exception {
 148         final Invocation.Builder invocationBuilder = sendFqeRequest(httpsPrefix + "swagger.yaml", true);
 149         final String resp = invocationBuilder.get(String.class);
 150
 151         assertTrue(resp.contains(ENDPOINT_PREFIX + endpoint + ":"));
 152     }
 153
 154     /**
 155      * Makes a parameter configuration file.
 156      *
 157      * @throws Exception if an error occurs
 158      */
 159     private static void makeConfigFile() throws Exception {
 160         String json = new CommonTestData().getPapParameterGroupAsString(port);
 161
 162         File file = new File("src/test/resources/parameters/TestConfigParams.json");
 163         file.deleteOnExit();
 164
 165         try (FileOutputStream output = new FileOutputStream(file)) {
 166             output.write(json.getBytes(StandardCharsets.UTF_8));
 167         }
 168     }
 169
 170     /**
 171      * Starts the "Main".
 172      *
 173      * @throws Exception if an error occurs
 174      */
 175     private static void startMain() throws Exception {
 176         Registry.newRegistry();
 177
 178         // make sure port is available
 179         if (NetworkUtil.isTcpPortOpen("localhost", port, 1, 1L)) {
 180             throw new IllegalStateException("port " + port + " is still in use");
 181         }
 182
 183         final Properties systemProps = System.getProperties();
 184         systemProps.put("javax.net.ssl.keyStore", KEYSTORE);
 185         systemProps.put("javax.net.ssl.keyStorePassword", "Pol1cy_0nap");
 186         System.setProperties(systemProps);
 187
 188         final String[] papConfigParameters = { "-c", "src/test/resources/parameters/TestConfigParams.json" };
 189
 190         main = new Main(papConfigParameters);
 191
 192         if (!NetworkUtil.isTcpPortOpen("localhost", port, 6, 10000L)) {
 193             throw new IllegalStateException("server is not listening on port " + port);
 194         }
 195     }
 196
 197     /**
 198      * Stops the "Main".
 199      *
 200      * @throws Exception if an error occurs
 201      */
 202     private static void stopMain() throws PolicyPapException {
 203         if (main != null) {
 204             Main main2 = main;
 205             main = null;
 206
 207             main2.shutdown();
 208         }
 209     }
 210
 211     /**
 212      * Mark the activator as dead, but leave its REST server running.
 213      */
 214     protected void markActivatorDead() {
 215         markActivator(false);
 216     }
 217
 218     private void markActivator(boolean wasAlive) {
 219         Object manager = Whitebox.getInternalState(Registry.get(PapConstants.REG_PAP_ACTIVATOR, PapActivator.class),
 220                         "serviceManager");
 221         Whitebox.setInternalState(manager, "running", wasAlive);
 222     }
 223
 224     /**
 225      * Verifies that unauthorized requests fail.
 226      *
 227      * @param endpoint the target end point
 228      * @param sender function that sends the requests to the target
 229      * @throws Exception if an error occurs
 230      */
 231     protected void checkUnauthRequest(final String endpoint, Function<Invocation.Builder, Response> sender)
 232                     throws Exception {
 233         assertEquals(Response.Status.UNAUTHORIZED.getStatusCode(),
 234                         sender.apply(sendNoAuthRequest(endpoint)).getStatus());
 235     }
 236
 237     /**
 238      * Sends a request to an endpoint.
 239      *
 240      * @param endpoint the target endpoint
 241      * @return a request builder
 242      * @throws Exception if an error occurs
 243      */
 244     protected Invocation.Builder sendRequest(final String endpoint) throws Exception {
 245         return sendFqeRequest(httpsPrefix + ENDPOINT_PREFIX + endpoint, true);
 246     }
 247
 248     /**
 249      * Sends a request to an endpoint, without any authorization header.
 250      *
 251      * @param endpoint the target endpoint
 252      * @return a request builder
 253      * @throws Exception if an error occurs
 254      */
 255     protected Invocation.Builder sendNoAuthRequest(final String endpoint) throws Exception {
 256         return sendFqeRequest(httpsPrefix + ENDPOINT_PREFIX + endpoint, false);
 257     }
 258
 259     /**
 260      * Sends a request to a fully qualified endpoint.
 261      *
 262      * @param fullyQualifiedEndpoint the fully qualified target endpoint
 263      * @param includeAuth if authorization header should be included
 264      * @return a request builder
 265      * @throws Exception if an error occurs
 266      */
 267     protected Invocation.Builder sendFqeRequest(final String fullyQualifiedEndpoint, boolean includeAuth)
 268                     throws Exception {
 269         final SSLContext sc = SSLContext.getInstance("TLSv1.2");
 270         sc.init(null, NetworkUtil.getAlwaysTrustingManager(), new SecureRandom());
 271         final ClientBuilder clientBuilder =
 272                         ClientBuilder.newBuilder().sslContext(sc).hostnameVerifier((host, session) -> true);
 273         final Client client = clientBuilder.build();
 274
 275         client.property(ClientProperties.METAINF_SERVICES_LOOKUP_DISABLE, "true");
 276         client.register(GsonMessageBodyHandler.class);
 277
 278         if (includeAuth) {
 279             final HttpAuthenticationFeature feature = HttpAuthenticationFeature.basic("healthcheck", "zb!XztG34");
 280             client.register(feature);
 281         }
 282
 283         final WebTarget webTarget = client.target(fullyQualifiedEndpoint);
 284
 285         return webTarget.request(MediaType.APPLICATION_JSON);
 286     }
 287 }