Add required property to defineConditionKeys to be used for serviceResolvedConditionKeys

docs/source-2.0/aws/aws-iam.rst

@@ -432,6 +432,11 @@ Each condition key structure supports the following members:
       - ``string``
       - A relative URL path that defines more information about the condition key
         within a set of IAM-related documentation.
+    * - required
+      - ``boolean``
+      - Defines whether a service resolved condition key is required. Not 
+        applicable to request resolved condition keys as the native 
+        @required trait must be used on the field directly.
 
 .. code-block:: smithy
 
@@ -448,7 +453,14 @@ Each condition key structure supports the following members:
             type: "String"
             documentation: "The Bar string"
             externalDocumentation: "http://example.com"
-        })
+        },
+        "myservice:Baz": {
+            type: "String"
+            documentation: "The Baz string"
+            externalDocumentation: "http://baz.com"
+            required: true
+        }
+    )
     service MyService {
         version: "2017-02-11"
         resources: [MyResource]

smithy-aws-iam-traits/src/main/java/software/amazon/smithy/aws/iam/traits/ConditionKeyDefinition.java

@@ -17,6 +17,8 @@
 
 import java.util.Objects;
 import java.util.Optional;
+
+import software.amazon.smithy.model.node.BooleanNode;
 import software.amazon.smithy.model.node.Node;
 import software.amazon.smithy.model.node.ObjectNode;
 import software.amazon.smithy.model.node.StringNode;
@@ -29,17 +31,25 @@ public final class ConditionKeyDefinition implements ToNode, ToSmithyBuilder<Con
     private static final String DOCUMENTATION = "documentation";
     private static final String EXTERNAL_DOCUMENTATION = "externalDocumentation";
     private static final String RELATIVE_DOCUMENTATION = "relativeDocumentation";
+    private static final String REQUIRED = "required";
 
     private final String type;
     private final String documentation;
     private final String externalDocumentation;
     private final String relativeDocumentation;
 
+    /**
+     * Whether a service resolved condition key is required
+     * Not applicable to request resolved condition key as the native @required trait must be used
+     **/
+    private final boolean required;
+
     private ConditionKeyDefinition(Builder builder) {
         type = SmithyBuilder.requiredState(TYPE, builder.type);
         documentation = builder.documentation;
         externalDocumentation = builder.externalDocumentation;
         relativeDocumentation = builder.relativeDocumentation;
+        required = builder.required;
     }
 
     public static Builder builder() {
@@ -56,6 +66,8 @@ public static ConditionKeyDefinition fromNode(Node value) {
                 .ifPresent(builder::externalDocumentation);
         objectNode.getStringMember(RELATIVE_DOCUMENTATION).map(StringNode::getValue)
                 .ifPresent(builder::relativeDocumentation);
+        objectNode.getBooleanMember(REQUIRED).map(BooleanNode::getValue)
+                .ifPresent(builder::required);
 
         return builder.build();
     }
@@ -91,13 +103,16 @@ public Optional<String> getRelativeDocumentation() {
         return Optional.ofNullable(relativeDocumentation);
     }
 
+    public Optional<Boolean> getRequired() { return Optional.ofNullable(required); }
+
     @Override
     public SmithyBuilder<ConditionKeyDefinition> toBuilder() {
         return builder()
                 .documentation(documentation)
                 .externalDocumentation(externalDocumentation)
                 .relativeDocumentation(relativeDocumentation)
-                .type(type);
+                .type(type)
+                .required(required);
     }
 
     @Override
@@ -107,6 +122,7 @@ public Node toNode() {
                 .withOptionalMember(DOCUMENTATION, getDocumentation().map(Node::from))
                 .withOptionalMember(EXTERNAL_DOCUMENTATION, getExternalDocumentation().map(Node::from))
                 .withOptionalMember(RELATIVE_DOCUMENTATION, getRelativeDocumentation().map(Node::from))
+                .withOptionalMember(REQUIRED, getRequired().map(Node::from))
                 .build();
     }
 
@@ -122,7 +138,8 @@ public boolean equals(Object o) {
         return Objects.equals(type, that.type)
                && Objects.equals(documentation, that.documentation)
                && Objects.equals(externalDocumentation, that.externalDocumentation)
-               && Objects.equals(relativeDocumentation, that.relativeDocumentation);
+               && Objects.equals(relativeDocumentation, that.relativeDocumentation)
+               && Objects.equals(required, that.required);
     }
 
     @Override
@@ -135,6 +152,7 @@ public static final class Builder implements SmithyBuilder<ConditionKeyDefinitio
         private String documentation;
         private String externalDocumentation;
         private String relativeDocumentation;
+        private boolean required;
 
         @Override
         public ConditionKeyDefinition build() {
@@ -160,5 +178,10 @@ public Builder relativeDocumentation(String relativeDocumentation) {
             this.relativeDocumentation = relativeDocumentation;
             return this;
         }
+
+        public Builder required(boolean required) {
+            this.required = required;
+            return this;
+        }
     }
 }

smithy-aws-iam-traits/src/main/resources/META-INF/smithy/aws.iam.smithy

@@ -119,6 +119,10 @@ structure ConditionKeyDefinition {
     /// A relative URL path that defines more information about the condition key
     /// within a set of IAM-related documentation.
     relativeDocumentation: String
+
+    // Whether a service resolved condition key is required
+    // Not applicable to request resolved condition key as the native @required trait must be used
+    required: Boolean
 }
 
 /// Contains information about a resource an IAM action can be authorized against.

smithy-aws-iam-traits/src/test/java/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTraitTest.java

@@ -0,0 +1,38 @@
+package software.amazon.smithy.aws.iam.traits;
+
+import org.junit.jupiter.api.Test;
+import software.amazon.smithy.model.Model;
+import software.amazon.smithy.model.shapes.Shape;
+import software.amazon.smithy.model.shapes.ShapeId;
+
+import java.util.Collections;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.contains;
+import static org.hamcrest.Matchers.equalTo;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.equalTo;
+
+
+public class DefineConditionKeysTraitTest {
+    @Test
+    public void loadsFromModel() {
+        Model result = Model.assembler()
+                .discoverModels(getClass().getClassLoader())
+                .addImport(getClass().getResource("define-condition-keys.smithy"))
+                .assemble()
+                .unwrap();
+
+        Shape shape = result.expectShape(ShapeId.from("smithy.example#MyService"));
+        DefineConditionKeysTrait trait = shape.expectTrait(DefineConditionKeysTrait.class);
+        assertEquals(3,trait.getConditionKeys().size());
+        assertFalse(trait.getConditionKey("myservice:Bar").get().getRequired().get());
+        assertFalse(trait.getConditionKey("myservice:Foo").get().getRequired().get());
+        assertTrue(trait.getConditionKey("myservice:Baz").get().getRequired().get());
+    }
+}

smithy-aws-iam-traits/src/test/resources/software/amazon/smithy/aws/iam/traits/define-condition-keys.smithy

@@ -0,0 +1,30 @@
+$version: "2"
+
+namespace smithy.example
+
+use aws.api#service
+use aws.iam#defineConditionKeys
+
+@service(sdkId: "My Value", arnNamespace: "myservice")
+@defineConditionKeys(
+    "myservice:Bar": {
+        type: "String"
+        documentation: "The Bar string"
+        externalDocumentation: "http://example.com"
+    },
+    "myservice:Baz": {
+        type: "String"
+        documentation: "The Baz string"
+        externalDocumentation: "http://baz.com"
+        required: true
+    }
+    "myservice:Foo": {
+        type: "String"
+        documentation: "The Foo string"
+        externalDocumentation: "http://foo.com"
+        required: false
+    }
+)
+service MyService {
+    version: "2017-02-11"
+}

smithy-aws-iam-traits/src/test/resources/software/amazon/smithy/aws/iam/traits/errorfiles/define-conditionkeys-norequired.smithy

@@ -0,0 +1,18 @@
+$version: "2"
+
+namespace smithy.example
+
+use aws.api#service
+use aws.iam#defineConditionKeys
+
+@service(sdkId: "My Value", arnNamespace: "myservice")
+@defineConditionKeys(
+    "myservice:Bar": {
+        type: "String"
+        documentation: "The Bar string"
+        externalDocumentation: "http://example.com"
+    })
+service MyService {
+    version: "2017-02-11"
+}
+

smithy-aws-iam-traits/src/test/resources/software/amazon/smithy/aws/iam/traits/errorfiles/define-conditionkeys-required-booleancheck.errors

@@ -0,0 +1,2 @@
+[DANGER] -: Syntactic shape ID `trues` does not resolve to a valid shape ID: `smithy.example#trues`. Did you mean to quote this string? Are you missing a model file? | SyntacticShapeIdTarget
+[ERROR] smithy.example#MyService: Error creating trait `aws.iam#defineConditionKeys`: Expected `required` to be a boolean; found string | Model

smithy-aws-iam-traits/src/test/resources/software/amazon/smithy/aws/iam/traits/errorfiles/define-conditionkeys-required-booleancheck.smithy

@@ -0,0 +1,19 @@
+$version: "2"
+
+namespace smithy.example
+
+use aws.api#service
+use aws.iam#defineConditionKeys
+
+@service(sdkId: "My Value", arnNamespace: "myservice")
+@defineConditionKeys(
+    "myservice:Bar": {
+        type: "String"
+        documentation: "The Bar string"
+        externalDocumentation: "http://example.com"
+        required: trues
+    })
+service MyService {
+    version: "2017-02-11"
+}
+

smithy-aws-iam-traits/src/test/resources/software/amazon/smithy/aws/iam/traits/errorfiles/define-conditionkeys-required.smithy

@@ -0,0 +1,19 @@
+$version: "2"
+
+namespace smithy.example
+
+use aws.api#service
+use aws.iam#defineConditionKeys
+
+@service(sdkId: "My Value", arnNamespace: "myservice")
+@defineConditionKeys(
+    "myservice:Bar": {
+        type: "String"
+        documentation: "The Bar string"
+        externalDocumentation: "http://example.com"
+        required: true
+    })
+service MyService {
+    version: "2017-02-11"
+}
+