The DryRun field in EC2 APIs is no longer hidden by the SDK through customization and is now exposed

[joviegas]

The DryRun field in EC2 APIs is no longer hidden by the SDK through customization and is now exposed

Motivation and Context

• Address EC2 Dry-Runs #76
• AWS SDK Java 2.x did not expose dryRun since 1.x had a special API to check the dryRun Status
• Checked with other language SDKs and found that none of the SDK handle dryRun in a special way.
• As mentioned in the Java Doc of the dryRun user will need to check the error response

Sample Code on how a USER can Write a generic API to check isDryRunComplete

Sync Client

import java.util.function.Supplier;
import org.junit.jupiter.api.Test;
import software.amazon.awssdk.awscore.exception.AwsErrorDetails;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.ec2.model.Ec2Exception;
import software.amazon.awssdk.services.ec2.model.Ec2Response;
import software.amazon.awssdk.testutils.service.AwsIntegrationTestBase;


    private boolean isDryRunComplete(Supplier<Ec2Response> dryRunOp) {
        Ec2Response ec2Response = null;
        try {
            ec2Response = dryRunOp.get();
        } catch (Ec2Exception exception) {
            AwsErrorDetails awsErrorDetails = exception.awsErrorDetails();
            if ("AuthFailure".equals(awsErrorDetails.errorCode())) {
                return false;
            }
            if ("DryRunOperation".equals(awsErrorDetails.errorCode())) {
                return true;
            }
            throw exception;
        }
        throw new IllegalStateException("Unable to get dryRun status for ec2Response:  " + ec2Response);
    }

    @Test
    public void dryRunSuccessTest() {
        boolean isDryRunComplete = isDryRunComplete(
            () -> ec2Client.describeRegions(r -> r.regionNames(Region.US_EAST_1.id())
                                                  .dryRun(true)
            )
        );
        assertThat(isDryRunComplete).isTrue();

    }

Async Cient

        // Write a handle and check the Exception that is caught
        Boolean isDryRunComplete = asyncClient.describeRegions(r -> r.regionNames(Region.US_EAST_1.id())
                                                                     .dryRun(true))
                                              .handle((resp, e) -> isDryRunCompleted(e))
                                              .join();

    private static Boolean isDryRunCompleted(Throwable exceptionCaught) {
        if(exceptionCaught.getCause() instanceof Ec2Exception){
            Ec2Exception exception = (Ec2Exception) exceptionCaught.getCause();
            AwsErrorDetails awsErrorDetails = exception.awsErrorDetails();
            if ("AuthFailure".equals(awsErrorDetails.errorCode())) {
                return false;
            }
            if ("DryRunOperation".equals(awsErrorDetails.errorCode())) {
                return true;
            }
        }
        throw new IllegalStateException(exceptionCaught.getCause());
    }

Java Doc as generated after exposing the field

        /**
         * <p>
         * Checks whether you have the required permissions for the action, without actually making the request, and
         * provides an error response. If you have the required permissions, the error response is
         * <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.
         * </p>
         * 
         * @param dryRun
         *        Checks whether you have the required permissions for the action, without actually making the request,
         *        and provides an error response. If you have the required permissions, the error response is
         *        <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder dryRun(Boolean dryRun);

Modifications

• Removed customization

Testing

• Tested on integ with both failure and success cases

Screenshots (if appropriate)

License

• I confirm that this pull request can be released under the Apache 2 license

[zoewangg]

Do we need to check in this integ test since technically this is more like testing the service, rather than the SDK.

[joviegas]

Done , removed the Test cases and added the code in description

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information