#54 Required fields in nested definitions are being reported as breaking when they are not

Author: galovics

swagger-brake/src/main/java/io/redskap/swagger/brake/core/model/Schema.java

@@ -12,7 +12,6 @@
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.ToString;
-import org.apache.commons.lang3.BooleanUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.tuple.Pair;
 import org.springframework.util.CollectionUtils;
@@ -107,11 +106,38 @@ public Set<String> getRequiredAttributeNames() {
         if (CollectionUtils.isEmpty(schemaAttrs)) {
             schemaAttrs = Optional.ofNullable(schema).map(Schema::getSchemaAttributes).orElse(Collections.emptySet());
         }
-        return internalGetAttributeData(schemaAttrs, "", SchemaAttribute::isRequired)
-            .stream()
-            .filter(p -> BooleanUtils.isTrue(p.getRight()))
-            .map(Pair::getLeft)
-            .collect(toSet());
+        Map<String, Boolean> attributeRequiredMap = internalGetAttributeData(schemaAttrs, "", SchemaAttribute::isRequired)
+                .stream()
+                .collect(toMap(Pair::getLeft, Pair::getRight));
+        Set<String> result = new HashSet<>();
+        for (Map.Entry<String, Boolean> entry : attributeRequiredMap.entrySet()) {
+            String attributeName = entry.getKey();
+            Boolean attributeIsRequired = entry.getValue();
+            if (attributeName.contains(".")) {
+                boolean hierarchicallyNotRequired = false;
+                List<String> pieces = Arrays.asList(attributeName.split("\\."));
+                for (int i = 0; i < pieces.size(); i++) {
+                    StringJoiner stringJoiner = new StringJoiner(".");
+                    pieces.subList(0, i + 1).forEach(stringJoiner::add);
+                    String attrToSearchFor = stringJoiner.toString();
+                    Boolean isRequired = attributeRequiredMap.get(attrToSearchFor);
+                    if (!isRequired) {
+                        hierarchicallyNotRequired = true;
+                        break;
+                    }
+                }
+                if (!hierarchicallyNotRequired) {
+                    if (attributeIsRequired) {
+                        result.add(attributeName);
+                    }
+                }
+            } else {
+                if (attributeIsRequired) {
+                    result.add(attributeName);
+                }
+            }
+        }
+        return result;
     }
 
     /**

swagger-brake/src/test/java/io/redskap/swagger/brake/integration/v2/request/OptionalRequestParameterAddedIntTest.java

@@ -0,0 +1,27 @@
+package io.redskap.swagger.brake.integration.v2.request;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.Collection;
+
+import io.redskap.swagger.brake.core.BreakingChange;
+import io.redskap.swagger.brake.integration.AbstractSwaggerBrakeIntTest;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.test.context.junit4.SpringRunner;
+
+
+
+@RunWith(SpringRunner.class)
+public class OptionalRequestParameterAddedIntTest extends AbstractSwaggerBrakeIntTest {
+    @Test
+    public void testOptionalRequestParameterAddedWorksCorrectly() {
+        // given
+        String oldApiPath = "swaggers/v2/request/optionalparameteradded/swagger_v1.yaml";
+        String newApiPath = "swaggers/v2/request/optionalparameteradded/swagger_v2.yaml";
+        // when
+        Collection<BreakingChange> result = execute(oldApiPath, newApiPath);
+        // then
+        assertThat(result).isEmpty();
+    }
+}

swagger-brake/src/test/resources/swaggers/v2/request/optionalparameteradded/swagger_v1.yaml

@@ -0,0 +1,48 @@
+swagger: '2.0'
+info:
+  description: ABC
+  version: 1.0.5
+  title: Swagger Petstore
+  termsOfService: 'http://swagger.io/terms/'
+host: petstore.swagger.io
+basePath: /v2
+schemes:
+  - https
+  - http
+paths:
+  /pet/uploadImage:
+    put:
+      tags:
+        - pet
+      summary: Update an existing pet
+      description: ''
+      operationId: updatePet
+      parameters:
+        - in: body
+          name: body
+          description: Pet object that needs to be added to the store
+          required: true
+          schema:
+            $ref: '#/definitions/Pet'
+      responses:
+        '400':
+          description: Invalid ID supplied
+definitions:
+  Pet:
+    type: object
+    required:
+      - id
+      - breed
+    properties:
+      id:
+        type: integer
+        format: int64
+      breed:
+        $ref: '#/definitions/Breed'
+  Breed:
+    type: object
+    required:
+      - name
+    properties:
+      name:
+        type: string

swagger-brake/src/test/resources/swaggers/v2/request/optionalparameteradded/swagger_v2.yaml

@@ -0,0 +1,66 @@
+swagger: '2.0'
+info:
+  description: ABC
+  version: 1.0.5
+  title: Swagger Petstore
+  termsOfService: 'http://swagger.io/terms/'
+host: petstore.swagger.io
+basePath: /v2
+schemes:
+  - https
+  - http
+paths:
+  /pet/uploadImage:
+    put:
+      tags:
+        - pet
+      summary: Update an existing pet
+      description: ''
+      operationId: updatePet
+      parameters:
+        - in: body
+          name: body
+          description: Pet object that needs to be added to the store
+          required: true
+          schema:
+            $ref: '#/definitions/Pet'
+      responses:
+        '400':
+          description: Invalid ID supplied
+definitions:
+  Pet:
+    type: object
+    required:
+      - id
+      - breed
+    properties:
+      id:
+        type: integer
+        format: int64
+      petFood:
+        $ref: '#/definitions/PetFood'
+      breed:
+        $ref: '#/definitions/Breed'
+  PetFood:
+    type: object
+    required:
+      - name
+    properties:
+      name:
+        type: string
+  Breed:
+    type: object
+    required:
+      - name
+    properties:
+      name:
+        type: string
+      details:
+        $ref: '#/definitions/BreedDetails'
+  BreedDetails:
+    type: object
+    required:
+      - weight
+    properties:
+      weight:
+        type: integer