Ngrok v3 (#62)

* authToken related classes polish

* Added support for Ngrok v3, added option to still use v2 by enabling `ngrok.legacy` config prop, removed ngrok archive urls from configuration

* Closing #56

* Updated docs

* Updated docs [skip ci]

Author: kilmajster

README.md

@@ -32,7 +32,8 @@
 
 ## What this starter gives to you?
 This starter will automatically download Ngrok binary corresponding to your 
-operating system (Windows, Linux, OSX or even Docker) and then cache it into `home_directory/.ngrok2`. 
+operating system (Windows, Linux, OSX or even Docker) and then cache it into `home_directory/.ngrok3`. 
+If Ngrok binary is already present in the PATH, download will be skipped.
 Then every time you will run your Spring Boot application, Ngrok will 
 automatically build http tunnel pointing to your springs web server, and you will get pretty logs 
 with the remote links, just like it's done below 👇
@@ -48,7 +49,7 @@ Code of demo application available [here](https://github.com/kilmajster/demo).
 <dependency>
   <groupId>io.github.kilmajster</groupId>
   <artifactId>ngrok-spring-boot-starter</artifactId>
-  <version>0.6.0</version>
+  <version>0.7.0</version>
 </dependency>
 ```
 
@@ -76,12 +77,13 @@ If you got already configured auth token in your ngrok config file there is no n
 > What will happen now?
 >
 > If you are using default spring configuration of server port, which is `8080`, then ngrok will 
-> be downloaded, extracted and cached into user default directory(eg. `/home/user/.ngrok2`) and then executed
+> be downloaded, extracted and cached into user default directory(eg. `/home/user/.ngrok3`) and then executed
 > on application startup, so final command executed in background as child process, should look like:
 > ```bash
-> /home/user/.ngrok2/ngrok http 8080
+> /home/user/.ngrok3/ngrok http 8080
 > ```
 > if you are using different server port, it will be picked up automatically from `server.port` property.
+> If ngrok binary is already present in path, download will be skipped 
 
 ### ⚙️ Advanced configuration
 #### `ngrok.config` - ngrok configuration file(s)
@@ -95,9 +97,9 @@ ngrok.config=/home/user/custom-ngrok-config.yml;/home/user/another-ngrok-config.
 ```
 then generated ngrok command, should look like this:
 ```bash
-/home/user/.ngrok2/ngrok http -config /home/user/custom-ngrok-config.yml 8080
+/home/user/.ngrok3/ngrok http -config /home/user/custom-ngrok-config.yml 8080
 # or for multiple configs, could be something like this:
-/home/user/.ngrok2/ngrok http -config /home/user/custom-ngrok-config.yml -config /home/user/another-ngrok-config.yml 8080
+/home/user/.ngrok3/ngrok http -config /home/user/custom-ngrok-config.yml -config /home/user/another-ngrok-config.yml 8080
 ```
 ###### configuration from Classpath
 If you prefer to keep ngrok configuration file inside your app, just add it as resource file and prefix `ngrok.config` property
@@ -112,39 +114,35 @@ example:
 ```properties
 # to run default behavior
 ngrok.command=http 8080
-# should result with command = /home/user/.ngrok2/ngrok http 8000
+# should result with command = /home/user/.ngrok3/ngrok http 8000
 
 # or some more specific
 ngrok.command=http -region=us -hostname=dev.example.com 8000
-# should be = /home/user/.ngrok2/ngrok http -region=us -hostname=dev.example.com 8000
+# should be = /home/user/.ngrok3/ngrok http -region=us -hostname=dev.example.com 8000
 ```
 
 ##### Optional properties & descriptions
 ```properties
+# if you want to use ngrok v2
+ngrok.legacy=true
+
+# if you want to force download ngrok binary instead of using local one even if it's present in the PATH
+ngrok.useFromPath=false
+
 # if you've got already running Ngrok instance somewhere else, you can specify its host & port, whoch defaults are:
 ngrok.host=http://127.0.0.1
 ngrok.port=4040
 
 # if you want to use Ngrok directory location different than default, which are:
-#  - for Windows C:\Users\user\.ngrok2
-#  - for unix systems ~/.ngrok2
+#  - for Windows C:\Users\user\.ngrok3
+#  - for unix systems ~/.ngrok3
 # use ngrok.directory property, like below:
 ngrok.directory=C:\\Users\\user\\Desktop\\ngrok
 
 # if for some reason Ngrok starting takes longer than really quick, you can override time 
 # of waiting for ngrok startup:
 ngrok.waitForStartup.millis=3000
 
-# if for some reason Ngrok binary file address has changed you can override it 
-# by property corresponding to your OS
-ngrok.binary.windows32=https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-windows-386.zip
-ngrok.binary.linux32=https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-386.zip
-ngrok.binary.osx32=https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-darwin-386.zip
-
-ngrok.binary.windows=https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-windows-amd64.zip
-ngrok.binary.linux=https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip
-ngrok.binary.osx=https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-darwin-amd64.zip
-
 # or just specify custom location as fallback:
 ngrok.binary.custom=http://not-exist.com/custom-ngrok-platform-bsd-arm-sth.zip
 ```

pom.xml

@@ -75,10 +75,11 @@
 
         <commons-io.version>2.11.0</commons-io.version>
         <commons-lang3.version>3.12.0</commons-lang3.version>
-        <jackson-dataformat-yaml.version>2.13.2</jackson-dataformat-yaml.version>
+        <commons-compress.version>1.21</commons-compress.version>
+        <jackson-dataformat-yaml.version>2.13.4</jackson-dataformat-yaml.version>
         <vavr.version>0.10.4</vavr.version>
 
-        <spring-cloud-contract-wiremock.version>3.1.1</spring-cloud-contract-wiremock.version>
+        <spring-cloud-contract-wiremock.version>3.1.4</spring-cloud-contract-wiremock.version>
     </properties>
 
     <dependencies>
@@ -130,6 +131,12 @@
             <version>${commons-lang3.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-compress</artifactId>
+            <version>${commons-compress.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>

src/main/java/ngrok/NgrokRunner.java

@@ -11,16 +11,17 @@
 import ngrok.os.NgrokBinaryProvider;
 import ngrok.os.NgrokPlatformDetector;
 import ngrok.os.NgrokSystemCommandExecutor;
-import ngrok.util.NgrokDownloader;
+import ngrok.download.NgrokDownloader;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.boot.web.context.WebServerInitializedEvent;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.event.EventListener;
 import org.springframework.core.task.TaskExecutor;
 
-import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
+import java.util.Objects;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 /**
  * For details see <a href="https://github.com/kilmajster/ngrok-spring-boot-starter">docs</a>.
@@ -62,9 +63,13 @@ public void run(WebServerInitializedEvent event) throws NgrokDownloadException,
                     tunnels = ngrokApiClient.listTunnels(port);
                 } else {
                     NgrokTunnel httpsTunnel = ngrokApiClient.startTunnel(port, "http", applicationName + "-http-" + port);
-                    log.info("New Ngrok tunnel added -> [ {}: {} ]", httpsTunnel.getName(), httpsTunnel.getPublicUrl());
+                    if (Objects.nonNull(httpsTunnel)) {
+                        log.info("New Ngrok tunnel added -> [ {}: {} ]", httpsTunnel.getName(), httpsTunnel.getPublicUrl());
+                    }
                     NgrokTunnel httpTunnel = ngrokApiClient.tunnelDetail(applicationName + "-http-" + port + " (http)");
-                    log.info("New Ngrok tunnel added -> [ {}: {} ]", httpTunnel.getName(), httpTunnel.getPublicUrl());
+                    if (Objects.nonNull(httpTunnel)) {
+                        log.info("New Ngrok tunnel added -> [ {}: {} ]", httpTunnel.getName(), httpTunnel.getPublicUrl());
+                    }
                     tunnels = listOf(httpTunnel, httpsTunnel);
                 }
             }
@@ -95,7 +100,7 @@ private void configureAuthToken() {
 
     @SafeVarargs
     private static <T> List<T> listOf(T... args) {
-        return new ArrayList<>(Arrays.asList(args));
+        return Stream.of(args).filter(Objects::nonNull).collect(Collectors.toList());
     }
 
     private void downloadAndExtractNgrokBinary() {

src/main/java/ngrok/configuration/NgrokAuthTokenUtil.java

@@ -22,12 +22,12 @@ public class NgrokAuthTokenUtil {
     private static final ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
 
     public static Optional<String> getAuthToken(final String ngrokYamlConfigPath, final String ngrokDirectory) {
-        final String defaultNgrokConfigFilePath = ngrokDirectory + File.separator + "ngrok.yml";
+        final String defaultNgrokConfigFilePath = ngrokDirectory + File.separator + NgrokConfiguration.NGROK_CONFIG_FILE_NAME;
         boolean defaultConfigFileExist = Files.exists(Paths.get(defaultNgrokConfigFilePath));
         if (defaultConfigFileExist) {
             String authToken = readNgrokConfig(defaultNgrokConfigFilePath).getAuthToken();
             if (Objects.nonNull(authToken)) {
-                return Optional.ofNullable(authToken);
+                return Optional.of(authToken);
             }
         }
 
@@ -44,7 +44,7 @@ private static NgrokYamlConfigModel readNgrokConfig(String path) {
 
     @Data
     @NoArgsConstructor
-    public static class NgrokYamlConfigModel {
+    private static class NgrokYamlConfigModel {
         @JsonAlias("authtoken")
         private String authToken;
     }

src/main/java/ngrok/configuration/NgrokAutoConfiguration.java

@@ -4,10 +4,13 @@
 import ngrok.NgrokComponent;
 import ngrok.NgrokRunner;
 import ngrok.api.NgrokApiClient;
+import ngrok.download.NgrokArchiveUrlProvider;
+import ngrok.download.NgrokLegacyV2ArchiveUrls;
+import ngrok.download.NgrokV3ArchiveUrls;
 import ngrok.os.NgrokBinaryProvider;
 import ngrok.os.NgrokPlatformDetector;
 import ngrok.os.NgrokSystemCommandExecutor;
-import ngrok.util.NgrokDownloader;
+import ngrok.download.NgrokDownloader;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.ApplicationEventPublisher;
@@ -39,4 +42,9 @@ public NgrokRunner ngrokRunner(
                 ngrokConfigurationProvider, ngrokDownloader, ngrokPlatformDetector, ngrokSystemCommandExecutor,
                 ngrokExecutor, applicationName);
     }
+
+    @Bean
+    public NgrokArchiveUrlProvider ngrokArchiveUrlProvider(NgrokConfiguration ngrokConfiguration) {
+        return ngrokConfiguration.isLegacy() ? new NgrokLegacyV2ArchiveUrls() : new NgrokV3ArchiveUrls();
+    }
 }

src/main/java/ngrok/configuration/NgrokConfiguration.java

@@ -4,8 +4,12 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import ngrok.NgrokComponent;
+import ngrok.exception.NgrokMalformedConfigurationException;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
+import org.springframework.context.annotation.Configuration;
+
+import java.util.Objects;
 
 @Getter
 @Setter
@@ -16,12 +20,25 @@ public class NgrokConfiguration {
 
     public static final String NGROK_ENABLED = "ngrok.enabled";
     public static final String NGROK_CONFIG_FILES_SEPARATOR = ";";
+    public static final String NGROK_CONFIG_FILE_NAME = "ngrok.yml";
+    public static final String NGROK_DIRECTORY_NAME = ".ngrok3";
+    public static final String NGROK_LEGACY_DIRECTORY_NAME = ".ngrok2";
 
     /**
      * Enable ngrok
      */
     private Boolean enabled;
 
+    /**
+     * If true, ngrok v2 will be used.
+     */
+    private boolean legacy;
+
+    /**
+     * If ngrok binary is present in PATH, use it.
+     */
+    private boolean useFromPath = true;
+
     /**
      * Property for personal Ngrok authToken, it can be found here - https://dashboard.ngrok.com/get-started/your-authtoken
      */
@@ -59,51 +76,8 @@ public class NgrokConfiguration {
     private Long startupDelay = 3000L;
 
     /**
-     * Set the binary download URL
+     * Url of custom Ngrok binary archive
      */
-    @NestedConfigurationProperty
-    private NgrokBinary binary = new NgrokBinary();
-
-    @Getter
-    @Setter
-    @NoArgsConstructor
-    public static class NgrokBinary {
-
-        /**
-         * Windows 64 bit binary
-         */
-        private String windows = "https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-windows-amd64.zip";
-
-        /**
-         * Linux 64 bit binary
-         */
-        private String linux = "https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip";
-
-        /**
-         * OSX 64 bit binary
-         */
-        private String osx = "https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-darwin-amd64.zip";
-
-        /**
-         * Windows 32 bit binary
-         */
-        private String windows32 = "https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-windows-386.zip";
-
-        /**
-         * Linux 32 bit binary
-         */
-        private String linux32 = "https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-386.zip";
-
-        /**
-         * OSX 32 bit binary
-         */
-        private String osx32 = "https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-darwin-386.zip";
-
-        /**
-         * Custom url to download ngrok binary from (independent from system)
-         */
-        private String custom;
-
-    }
+    private String customArchiveUrl;
 
 }

src/main/java/ngrok/download/NgrokArchiveUrlProvider.java

@@ -0,0 +1,20 @@
+package ngrok.download;
+
+import ngrok.NgrokComponent;
+
+@NgrokComponent
+public interface NgrokArchiveUrlProvider {
+
+    String getWindows();
+
+    String getLinux();
+
+    String getOsx();
+
+    String getWindows32();
+
+    String getLinux32();
+
+    String getOsx32();
+
+}

src/main/java/ngrok/util/NgrokDownloader.java renamed to src/main/java/ngrok/download/NgrokDownloader.java

@@ -1,4 +1,4 @@
-package ngrok.util;
+package ngrok.download;
 
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -21,6 +21,7 @@
 @RequiredArgsConstructor
 public class NgrokDownloader {
 
+    private final NgrokArchiveUrlProvider ngrokArchiveUrlProvider;
     private final NgrokConfiguration ngrokConfiguration;
     private final NgrokPlatformDetector platformDetector;
 
@@ -30,8 +31,8 @@ public void downloadAndExtractNgrokTo(String destinationPath) throws NgrokDownlo
     }
 
     private String downloadNgrokTo(String destinationPath) throws NgrokDownloadException {
-        String zipFileName = getFileNameFromUrl(getBinaryUrl());
-        String destinationFile = FilenameUtils.concat(destinationPath, zipFileName);
+        String archiveFileName = getFileNameFromUrl(getBinaryUrl());
+        String destinationFile = FilenameUtils.concat(destinationPath, archiveFileName);
 
         if (Files.exists(Paths.get(destinationFile))) {
             log.info("Skipping downloading, cached archive available at {}", destinationFile);
@@ -65,24 +66,21 @@ private String getFileNameFromUrl(String url) {
         return url.substring(getBinaryUrl().lastIndexOf("/") + 1);
     }
 
-    public String getBinaryUrl() {
-
-        final NgrokConfiguration.NgrokBinary ngrokBinary = ngrokConfiguration.getBinary();
-
-        if (StringUtils.isNotBlank(ngrokBinary.getCustom())) {
-            return ngrokBinary.getCustom();
+    private String getBinaryUrl() {
+        if (StringUtils.isNotBlank(ngrokConfiguration.getCustomArchiveUrl())) {
+            return ngrokConfiguration.getCustomArchiveUrl();
         }
 
         if (platformDetector.isWindows()) {
-            return platformDetector.is64bitOS() ? ngrokBinary.getWindows() : ngrokBinary.getWindows32();
+            return platformDetector.is64bitOS() ? ngrokArchiveUrlProvider.getWindows() : ngrokArchiveUrlProvider.getWindows32();
         }
 
         if (platformDetector.isMacOS()) {
-            return platformDetector.is64bitOS() ? ngrokBinary.getOsx() : ngrokBinary.getOsx32();
+            return platformDetector.is64bitOS() ? ngrokArchiveUrlProvider.getOsx() : ngrokArchiveUrlProvider.getOsx32();
         }
 
         if (platformDetector.isLinux()) {
-            return platformDetector.is64bitOS() ? ngrokBinary.getLinux() : ngrokBinary.getLinux32();
+            return platformDetector.is64bitOS() ? ngrokArchiveUrlProvider.getLinux() : ngrokArchiveUrlProvider.getLinux32();
         }
 
         throw new NgrokDownloadException("Unsupported OS");