Added support for ngrok authToken (#61)

* Added support for ngrok authToken

* added auth token to test app

* test fixes

* CI tests

* Fixes automation tests

* CI fix

* CI fix vNEXT

* CI fix vNEXT

* CI fix vNEXT

* CI fix vNEXT

* CI fix vNEXT

* CI fix vNEXT

* CI fix vNEXT

* dependencies versions bump

* added docs about authToken

Author: kilmajster

.github/scripts/set-current-starter-version-macos.sh

@@ -15,7 +15,7 @@
 	<description>Dummy app for tests</description>
 	<properties>
 		<java.version>11</java.version>
-		<ngrok-spring-boot-starter.version>ci-version-placeholder</ngrok-spring-boot-starter.version>
+		<ngrok-spring-boot-starter.version>SNAPSHOT</ngrok-spring-boot-starter.version>
 	</properties>
 	<dependencies>
 		<dependency>

.github/scripts/set-current-starter-version.sh

@@ -20,17 +20,12 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-@SpringBootTest(
-        webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT,
-        properties = {
-                "ngrok.enabled=true"
-        }
-)
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
 @ExtendWith(OutputCaptureExtension.class)
 class AppTests {
 
     private final static Logger log = LoggerFactory.getLogger(AppTests.class);
-    private static final int WAIT_FOR_STARTUP_SECONDS = 30;
+    private static final int WAIT_FOR_STARTUP_SECONDS = 90;
     private static final String HTTPS_NGROK_TUNNEL_REGEX = "(https:\\/\\/)?(([^.]+)\\.)?ngrok\\.io";
 
     @Test

.github/test-app/pom.xml

@@ -0,0 +1,2 @@
+ngrok.enabled=true
+

.github/test-app/src/test/java/io/github/kilmajster/AppTests.java

@@ -19,12 +19,10 @@ jobs:
       - name: Silent install main project
         run: mvn --batch-mode --no-transfer-progress install -Dmaven.test.skip=true
 
-      - name: Install xmllint
-        run: brew install xmlstarlet
-
-      - name: Set current starter version in test-app
-        working-directory: ./.github/scripts/
-        run: sh set-current-starter-version-macos.sh
+      - name: Add ngrok auth token application.properties
+        run: |
+          printf ${{secrets.NGROK_AUTH_TOKEN_PROPERTY}} >> .github/test-app/src/test/resources/application.properties
+        shell: bash
 
       - name: Run automation tests with latest ngrok-spring-boot-starter version on test-app
         working-directory: ./.github/test-app/

.github/test-app/src/test/resources/application.properties

@@ -19,12 +19,10 @@ jobs:
       - name: Silent install main project
         run: mvn --batch-mode --no-transfer-progress install -Dmaven.test.skip=true
 
-      - name: Install xmllint
-        run: sudo apt-get install libxml2-utils
-
-      - name: Set current starter version in test-app
-        working-directory: ./.github/scripts/
-        run: sh set-current-starter-version.sh
+      - name: Add ngrok auth token application.properties
+        run: |
+          printf ${{secrets.NGROK_AUTH_TOKEN_PROPERTY}} >> .github/test-app/src/test/resources/application.properties
+        shell: bash
 
       - name: Run automation tests with latest ngrok-spring-boot-starter version on test-app
         working-directory: ./.github/test-app/

.github/workflows/automation-test-macos.yml

@@ -19,9 +19,10 @@ jobs:
       - name: Silent install main project
         run: mvn --batch-mode --no-transfer-progress install -DskipTests
 
-      - name: Set current starter version in test-app
-        working-directory: ./.github/scripts/
-        run: sh set-current-starter-version.sh
+      - name: Add ngrok auth token application.properties
+        run: |
+          printf ${{secrets.NGROK_AUTH_TOKEN_PROPERTY}} >> .github/test-app/src/test/resources/application.properties
+        shell: bash
 
       - name: Run automation tests with latest ngrok-spring-boot-starter version on test-app
         working-directory: ./.github/test-app/

.github/workflows/automation-test-ubuntu.yml

@@ -59,19 +59,19 @@ compile('io.github.kilmajster:ngrok-spring-boot-starter:0.5.0')
 
 ##  Configuration
 ### 🚀 Minimal configuration
-#### `ngrok.enabled` - one required configuration property
+#### `ngrok.enabled`
 For simple http tunneling to springs default server port, **only one configuration property is required**. 
 There are many ways to provide spring config, for `application.property` based one, it will be:
 ```properties
 ngrok.enabled=true
 ```
-or yaml:
-```yaml
-ngrok:
-  enabled: true
+
+#### `ngrok.authToken`
+Ngrok requires `authToken` to be defined, to obtain one visit https://dashboard.ngrok.com/get-started/your-authtoken and then add it like below:
+```properties
+ngrok.authToken=<YOUR PERSONAL AUTH TOKEN>
 ```
-or you can pass java execution attribute, like: `java -jar your-app.jar --ngrok.enabled=true`, 
-or with spring-boot plugin `mvn spring-boot:run -Dspring-boot.run.arguments="--ngrok.enabled=true"`, or any other way 😊
+If you got already configured auth token in your ngrok config file there is no need to define this property.
 
 ✅ **All done, configuration is ready!** 
 
@@ -121,21 +121,6 @@ ngrok.command=http -region=us -hostname=dev.example.com 8000
 # should be = /home/user/.ngrok2/ngrok http -region=us -hostname=dev.example.com 8000
 ```
 
-## Ngrok API
-To access ngrok tunneling details you can use `NgrokApiClient` bean. Example below:
-```java
-@Autowired
-private NgrokApiClient ngrok;
-
-public void someMethod() {
-    # returns https tunnel URL or null in case ngrok is not running
-    String httpsTunnelUrl = ngrok.getHttpsTunnelUrl();
-
-    # returns http tunnel URL or null in case ngrok is not running
-    String httpTunnelUrl = ngrok.getHttpTunnelUrl();
-}
-```
-
 ##### Optional properties & descriptions
 ```properties
 # if you've got already running Ngrok instance somewhere else, you can specify its host & port, whoch defaults are:

.github/workflows/automation-test-windows.yml

@@ -59,7 +59,7 @@
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
-        <version>2.4.5</version>
+        <version>2.6.6</version>
         <relativePath/>
     </parent>
 
@@ -75,9 +75,10 @@
 
         <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>
         <vavr.version>0.10.4</vavr.version>
 
-        <spring-cloud-contract-wiremock.version>3.0.3</spring-cloud-contract-wiremock.version>
+        <spring-cloud-contract-wiremock.version>3.1.1</spring-cloud-contract-wiremock.version>
     </properties>
 
     <dependencies>
@@ -111,6 +112,12 @@
             <version>${vavr.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-yaml</artifactId>
+            <version>${jackson-dataformat-yaml.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>

README.md

@@ -51,6 +51,9 @@ public void run(WebServerInitializedEvent event) throws NgrokDownloadException,
                     downloadAndExtractNgrokBinary();
                     addPermissionsIfNeeded();
                 }
+
+                configureAuthTokenOrLogWarn();
+
                 startNgrok(port);
                 tunnels = ngrokApiClient.listTunnels(port);
             } else {
@@ -70,6 +73,26 @@ public void run(WebServerInitializedEvent event) throws NgrokDownloadException,
         });
     }
 
+    private void configureAuthTokenOrLogWarn() {
+        final String ngrokDirectory = ngrokBinaryProvider.getNgrokDirectoryOrDefault();
+        if (!ngrokConfigurationProvider.isAuthTokenConfigured(ngrokDirectory)) {
+            if (!ngrokConfigurationProvider.isAuthTokenPresent(ngrokDirectory)) {
+                log.warn("Ngrok auth token is missing! For your personal auth token visit https://dashboard.ngrok.com/get-started/your-authtoken " +
+                        "and then add it as ngrok.authToken=<YOUR AUTH TOKEN> to application.properties or to your ngrok configuration file.");
+            } else {
+                configureAuthToken();
+            }
+        }
+    }
+
+    private void configureAuthToken() {
+        String command = ngrokBinaryProvider.getNgrokBinaryFilePath()
+                + " authtoken "
+                + ngrokConfiguration.getAuthToken();
+
+        ngrokSystemCommandExecutor.execute(command);
+    }
+
     @SafeVarargs
     private static <T> List<T> listOf(T... args) {
         return new ArrayList<>(Arrays.asList(args));