Migrate "testng" package to Kotlin, add Java tests

Author: afranken

testsupport/testng/src/main/java/com/adobe/testing/s3mock/testng/package-info.java

@@ -13,40 +13,36 @@
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
+package com.adobe.testing.s3mock.testng
 
-package com.adobe.testing.s3mock.testng;
-
-import com.adobe.testing.s3mock.testsupport.common.S3MockStarter;
+import com.adobe.testing.s3mock.testsupport.common.S3MockStarter
 
 /**
- * Singleton extending {@link com.adobe.testing.s3mock.testsupport.common.S3MockStarter}.
+ * Singleton extending [S3MockStarter].
+ *
  *
- * <p>Used in the {@link com.adobe.testing.s3mock.testng.S3MockListener} to start
- * {@link com.adobe.testing.s3mock.S3MockApplication} when TestNG starts running the suites and to
- * stop when TestNG has run all the suites</p>
+ * Used in the [S3MockListener] to start
+ * [com.adobe.testing.s3mock.S3MockApplication] when TestNG starts running the suites and to
+ * stop when TestNG has run all the suites
  */
-public class S3Mock extends S3MockStarter {
-
-  private static final S3Mock INSTANCE = new S3Mock();
-
-  private S3Mock() {
-    super(null);
+class S3Mock private constructor() : S3MockStarter(null) {
+  fun bootstrap() {
+    start()
   }
 
-  /**
-   * Returns an instance of S3Mock.
-   *
-   * @return an instance of S3Mock
-   */
-  public static S3Mock getInstance() {
-    return INSTANCE;
+  fun terminate() {
+    stop()
   }
 
-  void bootstrap() {
-    start();
-  }
+  companion object {
+    /**
+     * Returns an instance of S3Mock.
+     *
+     * @return an instance of S3Mock
+     */
+    private val _instance: S3Mock = S3Mock()
 
-  void terminate() {
-    stop();
+    @JvmStatic
+    fun getInstance(): S3Mock = _instance
   }
 }

testsupport/testng/src/main/kotlin/com/adobe/testing/s3mock/testng/S3Mock.kt

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2017-2021 Adobe.
+ *  Copyright 2017-2025 Adobe.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -13,46 +13,42 @@
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
+package com.adobe.testing.s3mock.testng
 
-package com.adobe.testing.s3mock.testng;
-
-import org.testng.IExecutionListener;
+import org.testng.IExecutionListener
 
 /**
  * TestNG listener to start and stop the S3Mock Application. After the tests, the S3Mock is
  * stopped.
  *
  * <h2>Configuring through testng.xml file</h2>
  * <pre>
- * {@code <?xml version="1.0" encoding="UTF-8"?>
+ * `<?xml version="1.0" encoding="UTF-8"?>
  * <!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
  * <suite name="TestNG Listener Example">
- *  <listeners>
- *      <listener class-name="com.adobe.testing.s3mock.testng.S3ExecutionListener" />
- *  </listeners>
+ * <listeners>
+ * <listener class-name="com.adobe.testing.s3mock.testng.S3ExecutionListener" />
+ * </listeners>
  *
- *  <test name="TestNG Sample Test" preserve-order="true">
- *      <classes>
- *          <class name="SampleS3MockTest">
- *              <methods>
- *                  <include name="test1"/>
- *              </methods>
- *          </class>
- *      </classes>
- *  </test>
+ * <test name="TestNG Sample Test" preserve-order="true">
+ * <classes>
+ * <class name="SampleS3MockTest">
+ * <methods>
+ * <include name="test1"/>
+ * </methods>
+ * </class>
+ * </classes>
+ * </test>
  * </suite>
- * }
- * </pre>
+` *
+</pre> *
  */
-public class S3MockListener implements IExecutionListener {
-
-  @Override
-  public void onExecutionStart() {
-    S3Mock.getInstance().bootstrap();
+class S3MockListener : IExecutionListener {
+  override fun onExecutionStart() {
+    S3Mock.getInstance().bootstrap()
   }
 
-  @Override
-  public void onExecutionFinish() {
-    S3Mock.getInstance().terminate();
+  override fun onExecutionFinish() {
+    S3Mock.getInstance().terminate()
   }
 }

testsupport/testng/src/main/kotlin/com/adobe/testing/s3mock/testng/S3MockListener.kt

@@ -0,0 +1,76 @@
+/*
+ *  Copyright 2017-2025 Adobe.
+ *
+ *  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.
+ */
+
+package com.adobe.testing.s3mock.testng;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.adobe.testing.s3mock.util.DigestUtil;
+import java.io.File;
+import java.nio.file.Files;
+import org.testng.annotations.Test;
+import software.amazon.awssdk.core.sync.RequestBody;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.model.CreateBucketRequest;
+import software.amazon.awssdk.services.s3.model.GetObjectRequest;
+import software.amazon.awssdk.services.s3.model.PutObjectRequest;
+
+@Test
+public class S3MockListenerXmlConfigurationJavaTest {
+
+  private static final String BUCKET_NAME = "my-demo-test-bucket";
+  private static final String UPLOAD_FILE_NAME = "src/test/resources/sampleFile.txt";
+
+  private final S3Client s3Client = S3Mock.getInstance().createS3ClientV2();
+
+  /**
+   * Creates a bucket, stores a file, downloads the file again and compares checksums.
+   *
+   * @throws Exception if FileStreams can not be read
+   */
+  @Test
+  public void shouldUploadAndDownloadObject() throws Exception {
+    var uploadFile = new File(UPLOAD_FILE_NAME);
+
+    s3Client.createBucket(CreateBucketRequest.builder().bucket(BUCKET_NAME).build());
+    s3Client.putObject(
+        PutObjectRequest
+            .builder()
+            .bucket(BUCKET_NAME)
+            .key(uploadFile.getName())
+            .build(),
+        RequestBody.fromFile(uploadFile)
+    );
+
+    var s3Object = s3Client.getObject(
+        GetObjectRequest
+            .builder()
+            .bucket(BUCKET_NAME)
+            .key(uploadFile.getName())
+            .build()
+    );
+
+    var uploadFileIs = Files.newInputStream(uploadFile.toPath());
+    var uploadDigest = DigestUtil.hexDigest(uploadFileIs);
+    var downloadedDigest = DigestUtil.hexDigest(s3Object);
+    uploadFileIs.close();
+    s3Object.close();
+
+    assertThat(uploadDigest)
+        .as("Up- and downloaded Files should have equal digests")
+        .isEqualTo(downloadedDigest);
+  }
+}

testsupport/testng/src/test/java/com/adobe/testing/s3mock/testng/S3MockListenerXmlConfigurationJavaTest.java

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-     Copyright 2017-2019 Adobe.
+     Copyright 2017-2025 Adobe.
 
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
@@ -29,6 +29,11 @@
           <include name="shouldUploadAndDownloadObject"/>
         </methods>
       </class>
+      <class name="com.adobe.testing.s3mock.testng.S3MockListenerXmlConfigurationJavaTest">
+        <methods>
+          <include name="shouldUploadAndDownloadObject"/>
+        </methods>
+      </class>
     </classes>
   </test>
 </suite>