RUN-4098: migrate s 3 logstorage from v 1 to v 2 by edbaltra · Pull Request #62 · rundeck-plugins/rundeck-s3-log-plugin

edbaltra · 2026-01-30T16:50:39Z

JIRA ticket: https://pagerduty.atlassian.net/browse/RUN-4098

This pull request migrates the S3LogFileStoragePlugin from AWS SDK v1 to AWS SDK v2, modernizing the codebase and improving maintainability. The migration required significant changes to how S3 clients are configured, credentials are handled, and S3 operations are performed. The update also improves error handling and configuration validation.

Key changes include:

AWS SDK v2 Migration:

Replaced all AWS SDK v1 imports and usages (such as AmazonS3, AWSCredentials, and related classes) with AWS SDK v2 equivalents (such as S3Client, AwsCredentialsProvider, etc.) throughout S3LogFileStoragePlugin.java.
Refactored client initialization to use the new S3Client and AWS SDK v2 credential providers, including support for static credentials, credentials files, and the default provider chain. [1] [2]
Updated all S3 operations (store, retrieve, delete, metadata checks) to use SDK v2 request/response objects and error handling (S3Client, PutObjectRequest, HeadObjectRequest, S3Exception, etc.). [1] [2] [3] [4] [5]

Configuration and Validation Improvements:

Added explicit validation for AWS region names and improved error messages for misconfiguration.
Improved bucket and path configuration validation, ensuring required parameters are set and valid.

Metadata Handling:

Updated metadata creation and handling to use simple Map<String, String> instead of AWS SDK v1's ObjectMetadata.

Dependency Management:

Added awsSdkBomVersion=2.31.0 to gradle.properties to track the new AWS SDK v2 dependency version.

These changes collectively bring the plugin up to date with current AWS SDK best practices and lay the groundwork for future enhancements.

This commit migrates the plugin from AWS SDK v1 (com.amazonaws) to AWS SDK v2 (software.amazon.awssdk). ## Changes Made: ### Dependencies (build.gradle & gradle.properties): - Added AWS SDK v2 BOM version 2.31.0 - Replaced aws-java-sdk-s3:1.12.777 with software.amazon.awssdk:s3 - Replaced aws-java-sdk-sts:1.12.777 with software.amazon.awssdk:sts - Added BOM platform dependency to both implementation and pluginLibs configurations ### Core Plugin Code (S3LogFileStoragePlugin.java): - Updated all AWS SDK imports from v1 to v2 - Removed AWSCredentials interface implementation - Changed AmazonS3 client field to S3Client - Rewrote initialize() method: - Credential handling now uses AwsCredentialsProvider with three methods: * StaticCredentialsProvider for access key/secret key * Custom properties file reader for credentials file * DefaultCredentialsProvider for IAM roles - Region handling changed from RegionUtils to Region.of() - Client builder pattern used to configure all options upfront - S3Configuration used for path style access - Endpoint override via URI instead of setEndpoint() - Added warning for signature v2 (not supported in v2) - Migrated createS3Client() methods with credential provider support - Migrated isPathAvailable(): - GetObjectMetadataRequest → HeadObjectRequest - ObjectMetadata → HeadObjectResponse - AmazonS3Exception → S3Exception - Migrated createObjectMetadata() to return Map<String, String> - Migrated storePath(): - Changed signature to accept content length and metadata map - Uses PutObjectRequest builder with RequestBody - S3Exception instead of AmazonClientException - Migrated retrievePath(): - GetObject → ResponseInputStream<GetObjectResponse> - Uses ResponseTransformer.toInputStream() - Migrated deleteFile(): - Uses DeleteObjectRequest builder - Updated getAmazonS3() → getS3Client() ### Build Status: ✅ Plugin compiles successfully ✅ JAR builds successfully (12MB) ⚠️ Unit tests not migrated yet (require AWS SDK v2 updates) ### Breaking Changes: - Signature V2 no longer supported (logs warning, uses V4) - Method signature changes for internal methods - getAmazonS3() renamed to getS3Client() 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

Copilot

Pull request overview

This PR migrates the S3LogFileStoragePlugin from AWS SDK v1 to AWS SDK v2 and updates the tests and build configuration accordingly, while also tightening configuration validation and modernizing the S3 interaction patterns.

Changes:

Replace all AWS SDK v1 S3 types/usages in S3LogFileStoragePlugin with AWS SDK v2 equivalents (S3Client, HeadObjectRequest, PutObjectRequest, GetObjectRequest, S3Exception, SdkClientException, RequestBody, etc.), and introduce a configurable S3Client builder using v2 credential providers.
Refactor and extend tests around credentials, region/endpoint handling, metadata, availability checks, and store/retrieve/delete operations using a new MockS3Client, removing the large v1-specific FailS3 test harness.
Update Gradle configuration to use the AWS SDK v2 BOM and S3/STS modules via awsSdkBomVersion, aligning plugin packaging (pluginLibs) with the new dependency set.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`src/main/java/org/rundeck/plugins/S3LogFileStoragePlugin.java`	Migrates the core S3 log storage implementation from AWS SDK v1 to v2 (client creation, credential handling, head/get/put/delete operations, and metadata handling), adds region-name validation against `software.amazon.awssdk.regions.Region`, and adapts path/bucket validation while preserving plugin behavior.
`src/test/java/org/rundeck/plugins/S3LogFileStoragePluginTest.java`	Updates existing tests to exercise the SDK v2-based implementation, including new assertions for credentials-file validation messages, region validation, metadata contents, and exception messages, and rewrites S3 behavior expectations to work through `MockS3Client`.
`src/test/java/org/rundeck/plugins/MockS3Client.java`	Introduces a focused SDK v2-style `S3Client` mock that simulates `headObject`, `getObject`, `putObject`, and `deleteObject` behaviors (including error paths and recorded parameters) for deterministic testing of the plugin without AWS.
`src/test/java/org/rundeck/plugins/FailS3.java`	Removes the large AWS SDK v1–specific `AbstractAmazonS3` test stub in favor of the leaner `MockS3Client` tailored to the v2 API.
`build.gradle`	Replaces v1 `aws-java-sdk-s3`/`aws-java-sdk-sts` dependencies with the AWS SDK v2 BOM and `software.amazon.awssdk:s3`/`software.amazon.awssdk:sts` modules for both `implementation` and `pluginLibs`, excluding `slf4j` and Jackson to avoid conflicts.
`gradle.properties`	Adds the `awsSdkBomVersion` property (set to `2.33.13`) to control the AWS SDK v2 BOM version used in the build.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-30T17:39:27Z

src/main/java/org/rundeck/plugins/S3LogFileStoragePlugin.java

+            logger.warn("Signature V2 is not supported in AWS SDK v2. Using Signature V4 instead.");
+        }
+        if (isSignatureV4Enforced()) {
+            logger.debug("Signature V4 is enforced by default in AWS SDK v2");


The useSigV2 and forceSigV4 plugin properties are now effectively no-ops under AWS SDK v2 (the client always uses Signature V4, and this code only logs when those flags are set), but the @PluginProperty descriptions still imply they control the signature behavior. To avoid confusing users, consider updating the property descriptions (or marking them as deprecated) to explain that Signature V2 is no longer supported and Signature V4 is always used by the SDK.

Suggested change

logger.warn("Signature V2 is not supported in AWS SDK v2. Using Signature V4 instead.");

}

if (isSignatureV4Enforced()) {

logger.debug("Signature V4 is enforced by default in AWS SDK v2");

logger.warn("The 'useSigV2' property is deprecated and ignored: Signature V2 is not supported in AWS SDK v2; Signature V4 is always used instead.");

}

if (isSignatureV4Enforced()) {

logger.debug("The 'forceSigV4' property is deprecated and has no effect: AWS SDK v2 always uses Signature V4 for S3 requests.");

Copilot · 2026-01-30T17:39:28Z

src/main/java/org/rundeck/plugins/S3LogFileStoragePlugin.java

            HashMap<String, Object> expected = new HashMap<>();
            expected.put(metaKey(META_EXECID), context.get(META_ID_FOR_LOGSTORE));


In deleteFile, the expected metadata map is constructed but never used, which adds noise and can mislead future readers into thinking there is some metadata-based delete verification. If no metadata check is intended here, you can safely remove the expected map; otherwise, consider wiring it into a precondition check before issuing the delete.

Suggested change

HashMap<String, Object> expected = new HashMap<>();

expected.put(metaKey(META_EXECID), context.get(META_ID_FOR_LOGSTORE));

Copilot · 2026-01-30T17:39:28Z

src/main/java/org/rundeck/plugins/S3LogFileStoragePlugin.java

+        // Configure S3-specific options (path style access)
+        if (isPathStyle()) {
+            clientBuilder.serviceConfiguration(
+                    S3Configuration.builder()
+                            .pathStyleAccessEnabled(true)
+                            .build());


The new path-style configuration using S3Configuration.builder().pathStyleAccessEnabled(true) is not covered by tests, and the previous tests that exercised setPathStyle(true) behavior were removed. It would be good to add a unit test that verifies that enabling pathStyle on the plugin results in a client configured for path-style access (e.g., by inspecting the constructed client or a wrapper) to ensure this behavior doesn’t regress.

Copilot · 2026-01-30T17:39:28Z

gradle.properties

 # Main dependency versions
 rundeckVersion=5.16.0-20251006
 awsSdkVersion=1.12.777
+awsSdkBomVersion=2.33.13


The PR description states that awsSdkBomVersion is being set to 2.31.0, but the actual value here is 2.33.13. Please update either the description or this property so they are consistent, or briefly call out the intentional discrepancy.

Copilot · 2026-01-30T17:39:28Z

src/test/java/org/rundeck/plugins/S3LogFileStoragePluginTest.java

-        private Region region;
-        private String endpoint;
-        private S3Object getObject;
+    class testS3 extends MockS3Client {


testS3 should be made static, since the enclosing instance is not used.

Suggested change

class testS3 extends MockS3Client {

static class testS3 extends MockS3Client {

Copilot · 2026-01-30T17:39:29Z

src/main/java/org/rundeck/plugins/S3LogFileStoragePlugin.java

+        }
+
+        // Set region or endpoint
+        if (null == getEndpoint() || "".equals(getEndpoint().trim())) {


Inefficient comparison to empty string, check for zero length instead.

edbaltra and others added 4 commits January 30, 2026 13:26

Unit testing

7693a5a

Fixed part of unit tests

7b9ee26

Fixed Unit tests

c1346ca

edbaltra changed the title ~~Run 4098 migrate s 3 logstorage from v 1 to v 2~~ RUN-4098: migrate s 3 logstorage from v 1 to v 2 Jan 30, 2026

updated SDK to avoid Snyk issue

540f7ab

edbaltra marked this pull request as ready for review January 30, 2026 17:30

Copilot AI review requested due to automatic review settings January 30, 2026 17:30

Copilot started reviewing on behalf of edbaltra January 30, 2026 17:30 View session

Copilot AI reviewed Jan 30, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RUN-4098: migrate s 3 logstorage from v 1 to v 2#62

RUN-4098: migrate s 3 logstorage from v 1 to v 2#62
edbaltra wants to merge 5 commits intomasterfrom
RUN-4098-migrate-s-3-logstorage-from-v-1-to-v-2

edbaltra commented Jan 30, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		HashMap<String, Object> expected = new HashMap<>();
		expected.put(metaKey(META_EXECID), context.get(META_ID_FOR_LOGSTORE));

	class testS3 extends MockS3Client {
	static class testS3 extends MockS3Client {

Conversation

edbaltra commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

edbaltra commented Jan 30, 2026 •

edited

Loading