Add logging and credentials validation (#3)

Signed-off-by: Oleksandr Vyshniak <ext-oleksandr.vyshniak@here.com>

Author: molekyla

src/main/java/com/here/platform/artifact/gradle/CredentialsResolver.java

@@ -18,14 +18,16 @@
  */
 package com.here.platform.artifact.gradle;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.io.*;
 import java.util.Properties;
 
 import static org.apache.http.util.TextUtils.isEmpty;
 
 /**
  * Resolves credentials based on system configuration. Credentials precedence:
- * <p>
  * <ol>
  * <li>-DhereCredentialsFile system property
  * <li>HERE_CREDENTIALS_FILE environment variable
@@ -35,14 +37,20 @@
  */
 public class CredentialsResolver {
 
+    public static final String ACCESS_KEY_ID = "here.access.key.id";
+    public static final String ACCESS_KEY_SECRET = "here.access.key.secret";
+    public static final String TOKEN_ENDPOINT_URL = "here.token.endpoint.url";
+    public static final String CLIENT_ID = "here.client.id";
+
+    private static final Logger LOG = LoggerFactory.getLogger(CredentialsResolver.class);
+
     private static final String HERE_CREDENTIALS_PROPERTY = "hereCredentialsFile";
     private static final String HERE_CREDENTIALS_STRING_ENV = "HERE_CREDENTIALS_STRING";
     private static final String HERE_CREDENTIALS_PATH = ".here/credentials.properties";
     private static final String HERE_CREDENTIALS_ENV = "HERE_CREDENTIALS_FILE";
 
     /**
      * Resolve credentials based on a precedence:
-     * <p>
      * <ol>
      * <li>-DhereCredentialsFile system property
      * <li>HERE_CREDENTIALS_FILE environment variable
@@ -64,14 +72,24 @@ public Properties resolveCredentials() {
         } else {
             loadCredentialsFromFile(properties, new File(System.getProperty("user.home"), HERE_CREDENTIALS_PATH));
         }
+        validateCredentials(properties);
         return properties;
     }
 
     private File resolveFile() {
         File file = null;
         String systemPropertyFile = System.getProperty(HERE_CREDENTIALS_PROPERTY);
-        if (isEmpty(systemPropertyFile)) {
+        if (!isEmpty(systemPropertyFile)) {
+            LOG
+                .debug("Found property file value at System Property {}: {}", HERE_CREDENTIALS_PROPERTY,
+                    systemPropertyFile);
+        } else {
             systemPropertyFile = System.getenv(HERE_CREDENTIALS_ENV);
+            if (!isEmpty(systemPropertyFile)) {
+                LOG
+                    .debug("Found property file at Environment Property {}: {}", HERE_CREDENTIALS_ENV,
+                        systemPropertyFile);
+            }
         }
         if (!isEmpty(systemPropertyFile)) {
             file = new File(systemPropertyFile);
@@ -80,22 +98,44 @@ private File resolveFile() {
     }
 
     private void loadCredentialsFromFile(Properties properties, File file) {
+        LOG.debug("Using here credentials file: {}", file.getAbsolutePath());
         if (file.exists() && file.canRead()) {
+            LOG.debug("Attempting to read credentials file at: {}", file.getAbsolutePath());
             try (InputStream in = new FileInputStream(file)) {
                 properties.load(in);
             } catch (IOException exp) {
+                LOG.error("Unable to read client credentials at {}", file.getAbsolutePath(), exp);
                 throw new RuntimeException("Unable to read client credentials at " + file.getAbsolutePath(), exp);
             }
+        } else {
+            LOG.warn("Unable to read configured file: {}", file.getAbsolutePath());
         }
     }
 
     private void loadCredentialsFromString(Properties properties, String credentialsString) {
+        LOG.debug("Attempting to create credentials from environment variable");
         ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(credentialsString.getBytes());
         try {
             properties.load(byteArrayInputStream);
         } catch (IOException exp) {
+            LOG
+                .error("Unable to create client credentials from environment variable {}", HERE_CREDENTIALS_STRING_ENV,
+                    exp);
             throw new RuntimeException(
                 "Unable to create client credentials from environment variable " + HERE_CREDENTIALS_STRING_ENV, exp);
         }
     }
+
+    void validateCredentials(Properties properties) {
+        propertyMustExists(properties, ACCESS_KEY_ID);
+        propertyMustExists(properties, ACCESS_KEY_SECRET);
+        propertyMustExists(properties, TOKEN_ENDPOINT_URL);
+        propertyMustExists(properties, CLIENT_ID);
+    }
+
+    private void propertyMustExists(Properties properties, String propertyName) {
+        if (properties.getProperty(propertyName) == null) {
+            throw new RuntimeException("Credentials don't contain the property: " + propertyName);
+        }
+    }
 }

src/test/java/com/here/platform/artifact/gradle/CredentialsResolverTest.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright (C) 2019-2025 HERE Europe B.V.
+ *
+ * Licensed 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+package com.here.platform.artifact.gradle;
+
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+
+import java.util.Properties;
+
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class CredentialsResolverTest {
+
+    private CredentialsResolver credentialsResolver = new CredentialsResolver();
+
+    @Test
+    public void testValidateCredentials() {
+        Properties hereCredentialsMock = mock(Properties.class);
+        Mockito.when(hereCredentialsMock.getProperty(eq("here.token.endpoint.url"))).thenReturn("someUrl");
+        Mockito.when(hereCredentialsMock.getProperty(eq("here.access.key.id"))).thenReturn("accessKey");
+        Mockito.when(hereCredentialsMock.getProperty(eq("here.access.key.secret"))).thenReturn("accessKeySecret");
+        Mockito.when(hereCredentialsMock.getProperty(eq("here.client.id"))).thenReturn("clientId");
+        credentialsResolver.validateCredentials(hereCredentialsMock);
+    }
+
+    @Test
+    public void testValidateCredentialsWithoutEndpointUrl() {
+        Properties hereCredentialsMock = mock(Properties.class);
+        Mockito.when(hereCredentialsMock.getProperty(eq("here.access.key.id"))).thenReturn("accessKey");
+        Mockito.when(hereCredentialsMock.getProperty(eq("here.access.key.secret"))).thenReturn("accessKeySecret");
+        Mockito.when(hereCredentialsMock.getProperty(eq("here.client.id"))).thenReturn("clientId");
+        RuntimeException exception = assertThrows(RuntimeException.class,
+            () -> credentialsResolver.validateCredentials(hereCredentialsMock));
+        assertEquals("Credentials don't contain the property: here.token.endpoint.url", exception.getMessage());
+    }
+
+}