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 = getSimulatorHost();
  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 = getSimulatedResponsesPort();
  98         simulationUri = new JerseyUriBuilder().host(host).port(simulationPort).scheme("http").build();
  99     }
 100
 101     public static String getSimulatorHost() {
 102         return System.getProperty("SIM_HOST", System.getProperty("VID_HOST", "127.0.0.1"));
 103     }
 104
 105     public static Integer getSimulatedResponsesPort() {
 106         return Integer.valueOf(System.getProperty("SIMULATION_PORT", "1080"));
 107     }
 108
 109     public static URI getSimulationUri() {
 110         return simulationUri;
 111     }
 112
 113     public static void registerExpectation(String expectationFilename, RegistrationStrategy registrationStrategy) {
 114         registerExpectation(expectationFilename, ImmutableMap.<String, Object>of(), registrationStrategy);
 115     }
 116
 117     public static void registerExpectation(RegistrationStrategy strategy, String... expectationTemplateFilenames) {
 118         registerExpectation(expectationTemplateFilenames, ImmutableMap.of(), strategy);
 119     }
 120
 121     public static void registerExpectation(String[] expectationTemplateFilenames, ImmutableMap<String, Object> templateParams, RegistrationStrategy strategy) {
 122         if (strategy.equals(RegistrationStrategy.CLEAR_THEN_SET)) {
 123             clearRegistrations();
 124         }
 125         for (String expectationTemplateFilename: expectationTemplateFilenames) {
 126             registerExpectation(expectationTemplateFilename, templateParams, RegistrationStrategy.APPEND);
 127         }
 128     }
 129
 130     public static void registerExpectation(String expectationTemplateFilename, ImmutableMap<String, Object> templateParams, RegistrationStrategy registrationStrategy) {
 131
 132         String content = ReadFile.loadResourceAsString("registration_to_simulator/" + expectationTemplateFilename);
 133
 134         for (Map.Entry<String, Object> templateParam : templateParams.entrySet()) {
 135             content = content.replaceAll(templateParam.getKey(), templateParam.getValue().toString());
 136         }
 137
 138         registerToSimulatorAndAssertSuccess(expectationTemplateFilename, content, registrationStrategy);
 139
 140     }
 141
 142     public static void registerExpectationFromPreset(BasePreset preset, RegistrationStrategy registrationStrategy) {
 143         RegistrationRequest content = preset.generateScenario();
 144         registerToSimulatorAndAssertSuccess(preset.getClass().getCanonicalName(), content, registrationStrategy);
 145     }
 146
 147     public static void registerExpectationFromPresetsCollections(Collection<Collection<BasePreset>> presets, RegistrationStrategy registrationStrategy) {
 148         registerExpectationFromPresets(presets.stream()
 149                 .flatMap(Collection::stream)
 150                 .collect(toList()), registrationStrategy);
 151     }
 152
 153     public static void registerExpectationFromPresets(Collection<BasePreset> presets, RegistrationStrategy registrationStrategy) {
 154         if (registrationStrategy == RegistrationStrategy.CLEAR_THEN_SET) {
 155             clearRegistrations();
 156         }
 157         presets.forEach(
 158                 preset-> {
 159                     try {registerToSimulatorAndAssertSuccess(preset.getClass().getCanonicalName(), preset.generateScenario());}
 160                     catch (Throwable e) {
 161                         throw new RuntimeException("Failed to register preset "+preset.getClass().getName(), e);
 162                     }
 163                 }
 164         );
 165     }
 166
 167 //    public static List<HttpRequest> retrieveRecordedRequests() {
 168 //        Response response = client.target(uri).path("retrieveRecordedRequests").request().get();
 169 //        return response.readEntity(new GenericType<List<HttpRequest>>(){});
 170 //    }
 171
 172     /*
 173         This method return counter of requests that has been sent to simulator.
 174         The key of the map is a path, and the value is counter
 175      */
 176     public static Map<String, Long> retrieveRecordedRequestsPathCounter() {
 177         List<HttpRequest> httpRequests =  retrieveRecordedHttpRequests();
 178         return httpRequests.stream().map(x->x.path.value).collect(
 179                 Collectors.groupingBy(Function.identity(), Collectors.counting()));
 180     }
 181
 182     private static List<HttpRequest> retrieveRecordedHttpRequests() {
 183         Response response = client.target(uri).path("retrieveRecordedRequests").request().get();
 184         return response.readEntity(new GenericType<List<HttpRequest>>(){});
 185     }
 186
 187     public static List<RecordedRequests> retrieveRecordedRequests() {
 188         List<HttpRequest> rawRequests =  retrieveRecordedHttpRequests();
 189         return rawRequests.stream().map(request->new RecordedRequests(
 190             request.path.value,
 191             request.headers.stream().collect(
 192                 Collectors.toMap(
 193                     x->x.name.value,
 194                     x->x.values.stream().map(y->y.value).collect(toList())))
 195         )).collect(toList());
 196     }
 197
 198     private static void registerToSimulatorAndAssertSuccess(String name, Object content, RegistrationStrategy registrationStrategy) {
 199         if (registrationStrategy == RegistrationStrategy.CLEAR_THEN_SET) {
 200             clearRegistrations();
 201         }
 202         registerToSimulatorAndAssertSuccess(name, content);
 203     }
 204
 205     private static void registerToSimulatorAndAssertSuccess(String name, Object content) {
 206         logger.info("Setting {}", name);
 207
 208         content = postProccessContent(content);
 209
 210         Response response = createSimulatorRegistrationWebTarget().request(MediaType.APPLICATION_JSON_TYPE).post(Entity.json(content));
 211         assertEquals(response.getStatus(), HttpStatus.OK.value());
 212     }
 213
 214     private static Object postProccessContent(Object content) {
 215         if (content instanceof String) {
 216             for (UnaryOperator<String> presetStringPostProccessor : presetStringPostProccessors) {
 217                 content = presetStringPostProccessor.apply((String) content);
 218             }
 219         }
 220
 221         return content;
 222     }
 223
 224     public static void clearExpectations() {
 225         clearRegistrations();
 226     }
 227
 228     private static void clearRegistrations() {
 229         logger.info("Clearing Registrations");
 230         Response response = createSimulatorRegistrationWebTarget().request().delete();
 231         assertEquals(response.getStatus(), HttpStatus.OK.value());
 232     }
 233
 234     private static WebTarget createSimulatorRegistrationWebTarget() {
 235         return client.target(uri).path("registerToVidSimulator");
 236     }
 237
 238     public static void clearAll() {
 239         WebTarget webTarget = createSimulatorRegistrationWebTarget();
 240         webTarget.request().delete();
 241     }
 242 }