Merge pull request #1397 from zhangzheng88/mockserver

Mockserver

apollo-mockserver/pom.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <parent>
+    <artifactId>apollo</artifactId>
+    <groupId>com.ctrip.framework.apollo</groupId>
+    <version>1.1.0-SNAPSHOT</version>
+  </parent>
+  <modelVersion>4.0.0</modelVersion>
+
+  <artifactId>apollo-mockserver</artifactId>
+
+  <dependencies>
+    <dependency>
+      <groupId>com.ctrip.framework.apollo</groupId>
+      <artifactId>apollo-client</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>com.squareup.okhttp3</groupId>
+      <artifactId>mockwebserver</artifactId>
+      <version>3.11.0</version>
+    </dependency>
+    <dependency>
+      <groupId>com.squareup.okhttp3</groupId>
+      <artifactId>okhttp</artifactId>
+      <version>3.11.0</version>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter</artifactId>
+      <version>1.3.8.RELEASE</version>
+      <scope>provided</scope>
+    </dependency>
+  </dependencies>
+
+</project>

apollo-mockserver/src/main/java/com/ctrip/framework/apollo/mockserver/EmbeddedApollo.java

+package com.ctrip.framework.apollo.mockserver;
+
+import com.ctrip.framework.apollo.core.MetaDomainConsts;
+import com.ctrip.framework.apollo.core.dto.ApolloConfig;
+import com.ctrip.framework.apollo.core.dto.ApolloConfigNotification;
+import com.ctrip.framework.apollo.core.dto.ServiceDTO;
+import com.ctrip.framework.apollo.core.spi.MetaServerProvider;
+import com.ctrip.framework.apollo.core.utils.ResourceUtils;
+import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.ImmutableSet;
+import com.google.gson.Gson;
+import com.google.gson.reflect.TypeToken;
+import java.io.IOException;
+import java.lang.reflect.Type;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+import java.util.Set;
+import java.util.stream.Collectors;
+import okhttp3.mockwebserver.Dispatcher;
+import okhttp3.mockwebserver.MockResponse;
+import okhttp3.mockwebserver.MockWebServer;
+import okhttp3.mockwebserver.RecordedRequest;
+import org.junit.rules.ExternalResource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Create by zhangzheng on 8/22/18
+ * Email:zhangzheng@youzan.com
+ */
+public class EmbeddedApollo extends ExternalResource {
+
+  private Gson gson = new Gson();
+  private Logger logger = LoggerFactory.getLogger(EmbeddedApollo.class);
+  private Type notificationType = new TypeToken<List<ApolloConfigNotification>>(){}.getType();
+
+  private String listenningUrl;
+  private MockWebServer server;
+
+
+  @Override
+  protected void before() throws Throwable {
+    server = new MockWebServer();
+    final Dispatcher dispatcher = new Dispatcher() {
+      @Override
+      public MockResponse dispatch(RecordedRequest request) throws InterruptedException {
+        if (request.getPath().startsWith("/services/config")) {
+
+          return new MockResponse().setResponseCode(200)
+              .setBody(mockConfigServiceAddr(listenningUrl));
+        } else if (request.getPath().startsWith("/notifications/v2")) {
+          String notifications = request.getRequestUrl().queryParameter("notifications");
+          MockResponse response = new MockResponse().setResponseCode(200).setBody(mockLongPollBody(notifications));
+          return response;
+        } else if (request.getPath().startsWith("/configs")) {
+          List<String> pathSegments = request.getRequestUrl().pathSegments();
+          String appId = pathSegments.get(1);
+          String cluster = pathSegments.get(2);
+          String namespace = pathSegments.get(3);
+          return new MockResponse().setResponseCode(200)
+              .setBody(loadConfigFor(namespace));
+        }
+        return new MockResponse().setResponseCode(404);
+      }
+    };
+
+    server.setDispatcher(dispatcher);
+    server.start();
+    //指定apollo的metaserver地址为localhost
+    int port = server.getPort();
+    this.listenningUrl = "http://localhost:"+port;
+
+    MockedMetaServerProvider.setAddress(listenningUrl);
+
+    System.setProperty("apollo.longPollingInitialDelayInMills","1");
+
+    super.before();
+  }
+
+  @Override
+  protected void after() {
+    try {
+      server.close();
+    } catch (IOException e) {
+      logger.error("stop apollo server error", e);
+    }
+  }
+
+
+  private String loadConfigFor(String namespace){
+    String filename = String.format("mockdata-%s.properties", namespace);
+    final Properties prop = ResourceUtils.readConfigFile(filename, new Properties());
+    Map<String,String> configurations = prop.stringPropertyNames().stream().collect(
+        Collectors.toMap(key -> key, key -> prop.getProperty(key)));
+    ApolloConfig apolloConfig = new ApolloConfig("someAppId", "someCluster",namespace,"someReleaseKey");
+
+    Map<String,String> mergedConfigurations = mergeModifyByUser(namespace, configurations);
+    apolloConfig.setConfigurations(mergedConfigurations);
+    return gson.toJson(apolloConfig);
+  }
+
+
+  private String mockLongPollBody(String notificationsStr){
+    List<ApolloConfigNotification> oldNotifications = gson.fromJson(notificationsStr, notificationType);
+    List<ApolloConfigNotification> newNotifications = new ArrayList<>();
+    for(ApolloConfigNotification noti: oldNotifications){
+      newNotifications.add(new ApolloConfigNotification(noti.getNamespaceName(), noti.getNotificationId()+1));
+    }
+    return gson.toJson(newNotifications);
+  }
+
+  private String mockConfigServiceAddr(String addr){
+    ServiceDTO serviceDTO = new ServiceDTO();
+    serviceDTO.setAppName("someAppName");
+    serviceDTO.setInstanceId("someInstanceId");
+    serviceDTO.setHomepageUrl(addr);
+    return gson.toJson(Arrays.asList(serviceDTO));
+  }
+
+  /**
+   * 合并用户对namespace的修改
+   * @param configurations
+   * @return
+   */
+  private Map<String,String> mergeModifyByUser(String namespace
+      , Map<String,String> configurations){
+    if(addedPropertyOfNamespace.containsKey(namespace)){
+      configurations.putAll(addedPropertyOfNamespace.get(namespace));
+    }
+    if(deletedKeysOfNamespace.containsKey(namespace)){
+      for(String k: deletedKeysOfNamespace.get(namespace)){
+        configurations.remove(k);
+      }
+    }
+    return configurations;
+  }
+
+
+  private Map<String,Map<String,String>> addedPropertyOfNamespace = new HashMap<>();
+  public void addOrModifyPropery(String namespace, String someKey, String someValue) {
+    if(addedPropertyOfNamespace.containsKey(namespace)){
+      addedPropertyOfNamespace.get(namespace).put(someKey, someValue);
+    }else{
+      addedPropertyOfNamespace.put(namespace, ImmutableMap.of(someKey, someValue));
+    }
+  }
+  private Map<String,Set<String>> deletedKeysOfNamespace = new HashMap<>();
+  public void delete(String namespace, String someKey) {
+    if(deletedKeysOfNamespace.containsKey(namespace)){
+      deletedKeysOfNamespace.get(namespace).add(someKey);
+    }else{
+      deletedKeysOfNamespace.put(namespace, ImmutableSet.of(someKey));
+    }
+  }
+
+
+}

apollo-mockserver/src/main/java/com/ctrip/framework/apollo/mockserver/MockedMetaServerProvider.java

+package com.ctrip.framework.apollo.mockserver;
+
+import com.ctrip.framework.apollo.core.enums.Env;
+import com.ctrip.framework.apollo.core.spi.MetaServerProvider;
+
+/**
+ * Create by zhangzheng on 8/23/18
+ * Email:zhangzheng@youzan.com
+ */
+public class MockedMetaServerProvider implements MetaServerProvider{
+
+  private static String address;
+
+  public static void setAddress(String addr){
+    address = addr;
+  }
+
+  @Override
+  public String getMetaServerAddress(Env targetEnv) {
+    return address;
+  }
+
+  @Override
+  public int getOrder() {
+    return HIGHEST_PRECEDENCE;
+  }
+}

apollo-mockserver/src/main/resources/META-INF/services/com.ctrip.framework.apollo.core.spi.MetaServerProvider

+com.ctrip.framework.apollo.mockserver.MockedMetaServerProvider

apollo-mockserver/src/test/java/com/ctrip/framework/apollo/mockserver/SpringIntegrationTest.java

+package com.ctrip.framework.apollo.mockserver;
+
+import com.ctrip.framework.apollo.enums.PropertyChangeType;
+import com.ctrip.framework.apollo.mockserver.SpringIntegrationTest.TestConfiguration;
+import com.ctrip.framework.apollo.model.ConfigChangeEvent;
+import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
+import com.ctrip.framework.apollo.spring.annotation.EnableApolloConfig;
+import static org.junit.Assert.*;
+
+import com.google.common.util.concurrent.SettableFuture;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.test.SpringApplicationConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+/**
+ * Create by zhangzheng on 8/16/18
+ * Email:zhangzheng@youzan.com
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@SpringApplicationConfiguration(classes = TestConfiguration.class)
+public class SpringIntegrationTest {
+  @Autowired
+  TestBean testBean;
+
+  @ClassRule
+  public static EmbeddedApollo embeddedApollo = new EmbeddedApollo();
+
+  @Test
+  @DirtiesContext
+  public void testPropertyInject(){
+    assertEquals("value1", testBean.key1);
+    assertEquals("value2", testBean.key2);
+  }
+
+  @Test
+  @DirtiesContext
+  public void testListenerTriggeredByAdd() throws InterruptedException, ExecutionException, TimeoutException {
+    String otherNamespace = "othernamespace";
+    embeddedApollo.addOrModifyPropery(otherNamespace,"someKey","someValue");
+    ConfigChangeEvent changeEvent = testBean.futureData.get(5000, TimeUnit.MILLISECONDS);
+    assertEquals(otherNamespace, changeEvent.getNamespace());
+    assertEquals("someValue", changeEvent.getChange("someKey").getNewValue());
+  }
+
+  @Test
+  @DirtiesContext
+  public void testListenerTriggeredByDel()
+      throws InterruptedException, ExecutionException, TimeoutException {
+    String otherNamespace = "othernamespace";
+    embeddedApollo.delete(otherNamespace, "key1");
+    ConfigChangeEvent changeEvent = testBean.futureData.get(5000, TimeUnit.MILLISECONDS);
+    assertEquals(otherNamespace, changeEvent.getNamespace());
+    assertEquals(PropertyChangeType.DELETED, changeEvent.getChange("key1").getChangeType());
+  }
+
+
+
+
+
+
+
+
+  @EnableApolloConfig("application")
+  @Configuration
+  static class TestConfiguration{
+    @Bean
+    public TestBean testBean(){
+      return new TestBean();
+    }
+  }
+
+  static class TestBean{
+    @Value("${key1:default}")
+    String key1;
+    @Value("${key2:default}")
+    String key2;
+
+    SettableFuture<ConfigChangeEvent> futureData = SettableFuture.create();
+
+    @ApolloConfigChangeListener("othernamespace")
+    private void onChange(ConfigChangeEvent changeEvent) {
+      futureData.set(changeEvent);
+    }
+  }
+
+
+}

apollo-mockserver/src/test/resources/mockdata-application.properties

+key1=value1
+key2=value2

apollo-mockserver/src/test/resources/mockdata-othernamespace.properties

+key1=othervalue1
+key2=othervalue2

pom.xml

@@ -103,6 +103,7 @@
 		<module>apollo-portal</module>
 		<module>apollo-assembly</module>
 		<module>apollo-demo</module>
+		<module>apollo-mockserver</module>
 	</modules>
 
 	<dependencyManagement>