Feature: custom server file location

apollo-core/src/main/java/com/ctrip/framework/foundation/internals/constant/PathConstants.java

@@ -0,0 +1,68 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.ctrip.framework.foundation.internals.constant;
+
+import com.ctrip.framework.foundation.internals.util.PathUtils;
+import java.nio.file.Path;
+
+/**
+ * @author wang
+ */
+public interface PathConstants {
+
+  interface ResolvedPaths {
+
+    /**
+     * Default value {@code /opt/settings/server.properties} on linux or {@code
+     * C:/opt/settings/server.properties} on windows
+     */
+    Path SERVER_PROPERTIES = PathUtils
+        .resolve(SystemPropertyKeys.APOLLO_OPT, EnvironmentKeys.APOLLO_OPT,
+            DefaultValuesOnLinux.APOLLO_OPT, DefaultValuesOnWindows.APOLLO_OPT)
+        .resolve("settings")
+        .resolve("server.properties");
+  }
+
+  interface DefaultValuesOnLinux {
+
+    String APOLLO_OPT = "/opt";
+  }
+
+  interface DefaultValuesOnWindows {
+
+    String APOLLO_OPT = "C:/opt";
+  }
+
+  /**
+   * key in {@link System#getProperty(String)}
+   */
+  interface SystemPropertyKeys {
+
+    String APOLLO_OPT = "APOLLO_OPT";
+  }
+
+  /**
+   * key in {@link System#getenv(String)}
+   */
+  interface EnvironmentKeys {
+
+    String APOLLO_OPT = "apollo.opt";
+  }
+
+}

apollo-core/src/main/java/com/ctrip/framework/foundation/internals/provider/DefaultServerProvider.java

@@ -1,5 +1,24 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
 package com.ctrip.framework.foundation.internals.provider;
 
+import com.ctrip.framework.foundation.internals.constant.PathConstants.ResolvedPaths;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.InputStream;
@@ -16,20 +35,16 @@
 
 public class DefaultServerProvider implements ServerProvider {
   private static final Logger logger = LoggerFactory.getLogger(DefaultServerProvider.class);
-  private static final String SERVER_PROPERTIES_LINUX = "/opt/settings/server.properties";
-  private static final String SERVER_PROPERTIES_WINDOWS = "C:/opt/settings/server.properties";
 
   private String m_env;
   private String m_dc;
 
-  private Properties m_serverProperties = new Properties();
+  private final Properties m_serverProperties = new Properties();
 
   @Override
   public void initialize() {
     try {
-      String path = Utils.isOSWindows() ? SERVER_PROPERTIES_WINDOWS : SERVER_PROPERTIES_LINUX;
-
-      File file = new File(path);
+      File file = ResolvedPaths.SERVER_PROPERTIES.toFile();
       if (file.exists() && file.canRead()) {
         logger.info("Loading {}", file.getAbsolutePath());
         FileInputStream fis = new FileInputStream(file);

apollo-core/src/main/java/com/ctrip/framework/foundation/internals/util/ConfigUtils.java

@@ -0,0 +1,55 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.ctrip.framework.foundation.internals.util;
+
+import com.google.common.base.Strings;
+
+/**
+ * resolve the config.
+ *
+ * @author wxq
+ */
+public class ConfigUtils {
+
+  /**
+   * Gets the value indicated by the specified key.
+   *
+   * @param keyInSystemProperty the name of the system property
+   * @param keyInEnvironment    the name of the environment variable
+   * @return the string value of the variable, or <code>null</code> if the variable is not defined
+   * in the system property or the system environment
+   */
+  public static String getValue(String keyInSystemProperty, String keyInEnvironment) {
+    // Get from System Property
+    final String valueInSystemProperty = System.getProperty(keyInSystemProperty);
+    if (!Strings.isNullOrEmpty(valueInSystemProperty)) {
+      // return if value exists
+      return valueInSystemProperty;
+    }
+
+    // Get from OS environment variable
+    final String valueInEnvironment = System.getenv(keyInEnvironment);
+    if (!Strings.isNullOrEmpty(valueInEnvironment)) {
+      // return if value exists
+      return valueInEnvironment;
+    }
+
+    return null;
+  }
+}

apollo-core/src/main/java/com/ctrip/framework/foundation/internals/util/PathUtils.java

@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.ctrip.framework.foundation.internals.util;
+
+import com.ctrip.framework.foundation.internals.Utils;
+import com.google.common.base.Strings;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+/**
+ * resolve path.
+ *
+ * @author wxq
+ */
+public class PathUtils {
+
+  public static Path resolve(String keyInSystemProperty, String keyInEnvironment,
+      String defaultValueOnLinux, String defaultValueOnWindows) {
+    String value = ConfigUtils.getValue(keyInSystemProperty, keyInEnvironment);
+    if (!Strings.isNullOrEmpty(value)) {
+      return Paths.get(value);
+    }
+
+    // default path
+    return Utils.isOSWindows() ? Paths.get(defaultValueOnWindows) : Paths.get(defaultValueOnLinux);
+  }
+}

apollo-core/src/test/java/com/ctrip/framework/foundation/internals/util/ConfigUtilsTest.java

@@ -0,0 +1,57 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.ctrip.framework.foundation.internals.util;
+
+import static org.junit.Assert.*;
+
+import static com.ctrip.framework.foundation.internals.util.ConfigUtilsTest.SystemPropertyKeys.KEY;
+import static com.ctrip.framework.foundation.internals.util.ConfigUtilsTest.SystemPropertyValues.CUSTOM_VALUE;
+
+import org.junit.After;
+import org.junit.Test;
+
+public class ConfigUtilsTest {
+
+  @After
+  public void tearDown() {
+    System.clearProperty(KEY);
+  }
+
+  @Test
+  public void testGetValue_null() {
+    assertNull(ConfigUtils.getValue(KEY, "nothing"));
+  }
+
+  @Test
+  public void testGetValue_custom() {
+    System.setProperty(KEY, CUSTOM_VALUE);
+    String value = ConfigUtils.getValue(KEY, "nothing");
+    assertEquals(CUSTOM_VALUE, value);
+  }
+
+  protected static class SystemPropertyKeys {
+
+    static final String KEY = "system.property.key.2020.11.28";
+  }
+
+  protected static class SystemPropertyValues {
+
+    static final String CUSTOM_VALUE = "/simple/custom/path";
+  }
+}

apollo-core/src/test/java/com/ctrip/framework/foundation/internals/util/PathUtilsTest.java

@@ -0,0 +1,59 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.ctrip.framework.foundation.internals.util;
+
+import static com.ctrip.framework.foundation.internals.util.PathUtilsTest.SystemPropertyKeys.PATH_KEY;
+import static com.ctrip.framework.foundation.internals.util.PathUtilsTest.SystemPropertyValues.CUSTOM_VALUE;
+import static com.ctrip.framework.foundation.internals.util.PathUtilsTest.SystemPropertyValues.DEFAULT_VALUE;
+import static org.junit.Assert.*;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import org.junit.After;
+import org.junit.Test;
+
+public class PathUtilsTest {
+
+  @After
+  public void tearDown() {
+    System.clearProperty(PATH_KEY);
+  }
+
+  @Test
+  public void testResolveWithDefaultValue() {
+    Path path = PathUtils.resolve(PATH_KEY, "nothing", DEFAULT_VALUE, DEFAULT_VALUE);
+    assertEquals(Paths.get(DEFAULT_VALUE), path);
+  }
+
+  @Test
+  public void testResolveWithCustomValue() {
+    System.setProperty(PATH_KEY, CUSTOM_VALUE);
+    Path path = PathUtils.resolve(PATH_KEY, "nothing", DEFAULT_VALUE, DEFAULT_VALUE);
+    assertEquals(Paths.get(CUSTOM_VALUE), path);
+  }
+
+  protected static class SystemPropertyKeys {
+    static final String PATH_KEY = "system.property.key.2020.11.28";
+  }
+
+  protected static class SystemPropertyValues {
+    static final String CUSTOM_VALUE = "/simple/custom/path";
+    static final String DEFAULT_VALUE = "/simple/default/path";
+  }
+}