vid-automation/src/main/java/vid/automation/test/services/SimulatorApi.java

   1 package vid.automation.test.services;
   2
   3 import static java.util.stream.Collectors.toList;
   4 import static org.testng.Assert.assertEquals;
   5 import static vid.automation.test.services.DropTestApiField.dropFieldCloudOwnerFromString;
   6 import static vid.automation.test.services.DropTestApiField.dropTestApiFieldFromString;
   7
   8 import com.fasterxml.jackson.databind.DeserializationFeature;
   9 import com.google.common.collect.ImmutableList;
  10 import com.google.common.collect.ImmutableMap;
  11 import java.net.URI;
  12 import java.util.Collection;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.function.Function;
  16 import java.util.function.UnaryOperator;
  17 import java.util.stream.Collectors;
  18 import javax.ws.rs.client.Client;
  19 import javax.ws.rs.client.ClientBuilder;
  20 import javax.ws.rs.client.Entity;
  21 import javax.ws.rs.client.WebTarget;
  22 import javax.ws.rs.core.GenericType;
  23 import javax.ws.rs.core.MediaType;
  24 import javax.ws.rs.core.Response;
  25 import org.glassfish.jersey.client.ClientProperties;
  26 import org.glassfish.jersey.jackson.internal.jackson.jaxrs.json.JacksonJaxbJsonProvider;
  27 import org.glassfish.jersey.jackson.internal.jackson.jaxrs.json.JacksonJsonProvider;
  28 import org.glassfish.jersey.uri.internal.JerseyUriBuilder;
  29 import org.onap.simulator.presetGenerator.presets.BasePresets.BasePreset;
  30 import org.onap.simulator.presetGenerator.presets.model.RegistrationRequest;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33 import org.springframework.http.HttpStatus;
  34 import vid.automation.test.utils.ReadFile;
  35
  36 public class SimulatorApi {
  37
  38     public enum RegistrationStrategy {
  39         APPEND, CLEAR_THEN_SET
  40     }
  41
  42     private static final Logger logger = LoggerFactory.getLogger(SimulatorApi.class);
  43
  44     /*
  45     these classes are partial representation of org.mockserver.model.HttpRequest.
  46     We can not use HttpRequest since it contains Map with NottableString and jackson throw the following error :
  47     com.fasterxml.jackson.databind.JsonMappingException: Can not find a (Map) Key deserializer for type
  48      [simple type, class org.mockserver.model.NottableString]
  49     */
  50     public static class StringWrapper {
  51         public String value;
  52     }
  53
  54     public static class RecordedHeaders {
  55         public StringWrapper name;
  56         public List<StringWrapper> values;
  57     }
  58
  59     public static class HttpRequest {
  60         public StringWrapper path;
  61         public List<RecordedHeaders> headers;
  62     }
  63
  64     public static class RecordedRequests {
  65         public String path;
  66         public Map<String, List<String>> headers;
  67
  68         public RecordedRequests(String path, Map<String, List<String>> headers) {
  69             this.path = path;
  70             this.headers = headers;
  71         }
  72
  73         public RecordedRequests() {
  74         }
  75     }
  76
  77     private static final URI uri; //uri for registration
  78     private static final URI simulationUri; //uri for getting simulated responses
  79     private static final Client client;
  80
  81     private static final List<UnaryOperator<String>> presetStringPostProccessors =
  82             ImmutableList.of(dropTestApiFieldFromString(), dropFieldCloudOwnerFromString());
  83
  84     static {
  85         String host = System.getProperty("SIM_HOST", System.getProperty("VID_HOST", "127.0.0.1"));
  86         Integer port = Integer.valueOf(System.getProperty("SIM_PORT", System.getProperty("VID_PORT", "8080"))); //port for registration
  87         uri = new JerseyUriBuilder().host(host).port(port).scheme("http").path("vidSimulator").build();
  88         client = ClientBuilder.newClient();
  89         client.property(ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION, true);
  90         //registering jacksonJsonProvider for avoiding exceptions like :
  91         // org.glassfish.jersey.message.internal.MessageBodyProviderNotFoundException:
  92         // MessageBodyWriter not found for media type=application/json
  93         JacksonJsonProvider jacksonJsonProvider = new JacksonJaxbJsonProvider();
  94         jacksonJsonProvider.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
  95         client.register(jacksonJsonProvider);
  96
  97         Integer simulationPort = Integer.valueOf(System.getProperty("SIMULATION_PORT", "1080")); //port getting simulated responses
  98         simulationUri = new JerseyUriBuilder().host(host).port(simulationPort).scheme("http").build();
  99     }
 100
 101     public static URI getSimulationUri() {
 102         return simulationUri;
 103     }
 104
 105     public static void registerExpectation(String expectationFilename, RegistrationStrategy registrationStrategy) {
 106         registerExpectation(expectationFilename, ImmutableMap.<String, Object>of(), registrationStrategy);
 107     }
 108
 109     public static void registerExpectation(RegistrationStrategy strategy, String... expectationTemplateFilenames) {
 110         registerExpectation(expectationTemplateFilenames, ImmutableMap.of(), strategy);
 111     }
 112
 113     public static void registerExpectation(String[] expectationTemplateFilenames, ImmutableMap<String, Object> templateParams, RegistrationStrategy strategy) {
 114         if (strategy.equals(RegistrationStrategy.CLEAR_THEN_SET)) {
 115             clearRegistrations();
 116         }
 117         for (String expectationTemplateFilename: expectationTemplateFilenames) {
 118             registerExpectation(expectationTemplateFilename, templateParams, RegistrationStrategy.APPEND);
 119         }
 120     }
 121
 122     public static void registerExpectation(String expectationTemplateFilename, ImmutableMap<String, Object> templateParams, RegistrationStrategy registrationStrategy) {
 123
 124         String content = ReadFile.loadResourceAsString("registration_to_simulator/" + expectationTemplateFilename);
 125
 126         for (Map.Entry<String, Object> templateParam : templateParams.entrySet()) {
 127             content = content.replaceAll(templateParam.getKey(), templateParam.getValue().toString());
 128         }
 129
 130         registerToSimulatorAndAssertSuccess(expectationTemplateFilename, content, registrationStrategy);
 131
 132     }
 133
 134     public static void registerExpectationFromPreset(BasePreset preset, RegistrationStrategy registrationStrategy) {
 135         RegistrationRequest content = preset.generateScenario();
 136         registerToSimulatorAndAssertSuccess(preset.getClass().getCanonicalName(), content, registrationStrategy);
 137     }
 138
 139     public static void registerExpectationFromPresetsCollections(Collection<Collection<BasePreset>> presets, RegistrationStrategy registrationStrategy) {
 140         registerExpectationFromPresets(presets.stream()
 141                 .flatMap(Collection::stream)
 142                 .collect(toList()), registrationStrategy);
 143     }
 144
 145     public static void registerExpectationFromPresets(Collection<BasePreset> presets, RegistrationStrategy registrationStrategy) {
 146         if (registrationStrategy == RegistrationStrategy.CLEAR_THEN_SET) {
 147             clearRegistrations();
 148         }
 149         presets.forEach(
 150                 preset-> {
 151                     try {registerToSimulatorAndAssertSuccess(preset.getClass().getCanonicalName(), preset.generateScenario());}
 152                     catch (Throwable e) {
 153                         throw new RuntimeException("Failed to register preset "+preset.getClass().getName(), e);
 154                     }
 155                 }
 156         );
 157     }
 158
 159 //    public static List<HttpRequest> retrieveRecordedRequests() {
 160 //        Response response = client.target(uri).path("retrieveRecordedRequests").request().get();
 161 //        return response.readEntity(new GenericType<List<HttpRequest>>(){});
 162 //    }
 163
 164     /*
 165         This method return counter of requests that has been sent to simulator.
 166         The key of the map is a path, and the value is counter
 167      */
 168     public static Map<String, Long> retrieveRecordedRequestsPathCounter() {
 169         List<HttpRequest> httpRequests =  retrieveRecordedHttpRequests();
 170         return httpRequests.stream().map(x->x.path.value).collect(
 171                 Collectors.groupingBy(Function.identity(), Collectors.counting()));
 172     }
 173
 174     private static List<HttpRequest> retrieveRecordedHttpRequests() {
 175         Response response = client.target(uri).path("retrieveRecordedRequests").request().get();
 176         return response.readEntity(new GenericType<List<HttpRequest>>(){});
 177     }
 178
 179     public static List<RecordedRequests> retrieveRecordedRequests() {
 180         List<HttpRequest> rawRequests =  retrieveRecordedHttpRequests();
 181         return rawRequests.stream().map(request->new RecordedRequests(
 182             request.path.value,
 183             request.headers.stream().collect(
 184                 Collectors.toMap(
 185                     x->x.name.value,
 186                     x->x.values.stream().map(y->y.value).collect(toList())))
 187         )).collect(toList());
 188     }
 189
 190     private static void registerToSimulatorAndAssertSuccess(String name, Object content, RegistrationStrategy registrationStrategy) {
 191         if (registrationStrategy == RegistrationStrategy.CLEAR_THEN_SET) {
 192             clearRegistrations();
 193         }
 194         registerToSimulatorAndAssertSuccess(name, content);
 195     }
 196
 197     private static void registerToSimulatorAndAssertSuccess(String name, Object content) {
 198         logger.info("Setting {}", name);
 199
 200         content = postProccessContent(content);
 201
 202         Response response = createSimulatorRegistrationWebTarget().request(MediaType.APPLICATION_JSON_TYPE).post(Entity.json(content));
 203         assertEquals(response.getStatus(), HttpStatus.OK.value());
 204     }
 205
 206     private static Object postProccessContent(Object content) {
 207         if (content instanceof String) {
 208             for (UnaryOperator<String> presetStringPostProccessor : presetStringPostProccessors) {
 209                 content = presetStringPostProccessor.apply((String) content);
 210             }
 211         }
 212
 213         return content;
 214     }
 215
 216     public static void clearExpectations() {
 217         clearRegistrations();
 218     }
 219
 220     private static void clearRegistrations() {
 221         logger.info("Clearing Registrations");
 222         Response response = createSimulatorRegistrationWebTarget().request().delete();
 223         assertEquals(response.getStatus(), HttpStatus.OK.value());
 224     }
 225
 226     private static WebTarget createSimulatorRegistrationWebTarget() {
 227         return client.target(uri).path("registerToVidSimulator");
 228     }
 229
 230     public static void clearAll() {
 231         WebTarget webTarget = createSimulatorRegistrationWebTarget();
 232         webTarget.request().delete();
 233     }
 234 }