feat: clean up and add more test for individual case with custom path

Author: tmkhanh

graphql-spring-boot-test/src/main/java/com/graphql/spring/boot/test/GraphQLTestTemplate.java

@@ -12,6 +12,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.function.IntFunction;
 import lombok.Getter;
 import lombok.NonNull;
 import org.springframework.beans.factory.annotation.Value;
@@ -313,24 +314,36 @@ public GraphQLResponse postMultipart(String query, String variables) {
    * will be a part of multipart request. GraphQL Servlet will use <i>map</i> part to walk through
    * variables.files and validate the request in combination with other binary file parts
    *
-   * <p>-------------- request beginning ---------------
+   * <p>----------------------------dummyid
    *
-   * <p>operations: { "query": "mutation($files:[Upload]!) {uploadFiles(files:$files)}",
-   * "operationName": "uploadFiles", "variables": { "files": [null, null] } }
+   * <p>Content-Disposition: form-data; name="operations"
    *
-   * <p>-----------------------------------------------
+   * <p>{ "query": "mutation($files:[Upload]!) {uploadFiles(files:$files)}", "operationName":
+   * "uploadFiles", "variables": { "files": [null, null] } }
+   *
+   * <p>----------------------------dummyid
+   *
+   * <p>Content-Disposition: form-data; name="map"
    *
    * <p>map: { "1":["variables.files.0"], "2":["variables.files.1"] }
    *
-   * <p>-----------------------------------------------
+   * <p>----------------------------dummyid
+   *
+   * <p>Content-Disposition: form-data; name="1"; filename="file1.pdf"
+   *
+   * <p>Content-Type: application/octet-stream
+   *
+   * <p>--file 1 binary code--
+   *
+   * <p>----------------------------dummyid
    *
-   * <p>1: --file 1 binary code--
+   * <p>Content-Disposition: form-data; name="2"; filename="file2.pdf"
    *
-   * <p>-----------------------------------------------
+   * <p>Content-Type: application/octet-stream
    *
    * <p>2: --file 2 binary code--
    *
-   * <p>-------------- request end ---------------------
+   * <p>
    *
    * @param graphqlResource path to the classpath resource containing the GraphQL query
    * @param variables the input variables for the GraphQL query
@@ -344,12 +357,39 @@ public GraphQLResponse postFiles(
       String graphqlResource, ObjectNode variables, List<ClassPathResource> files)
       throws IOException {
 
+    return postFiles(
+        graphqlResource, variables, files, index -> String.format("variables.files.%d", index));
+  }
+
+  /**
+   * Handle the multipart files upload request to GraphQL servlet
+   *
+   * @param graphqlResource path to the classpath resource containing the GraphQL query
+   * @param variables the input variables for the GraphQL query
+   * @param files ClassPathResource instance for each file that will be uploaded to GraphQL server.
+   *     When Spring RestTemplate processes the request, it will automatically produce a valid part
+   *     representing given file inside multipart request (including size, submittedFileName, etc.)
+   * @param pathFunc function to generate the path to file inside variables. For example:
+   *     <ul>
+   *       <li>index -> String.format("variables.files.%d", index) for multiple files
+   *       <li>index -> "variables.file" for single file
+   *     </ul>
+   *
+   * @return {@link GraphQLResponse} containing the result of query execution
+   * @throws IOException if the resource cannot be loaded from the classpath
+   */
+  public GraphQLResponse postFiles(
+      String graphqlResource,
+      ObjectNode variables,
+      List<ClassPathResource> files,
+      IntFunction<String> pathFunc)
+      throws IOException {
     MultiValueMap<String, Object> values = new LinkedMultiValueMap<>();
     MultiValueMap<String, Object> map = new LinkedMultiValueMap<>();
 
     for (int i = 0; i < files.size(); i++) {
       String valueKey = String.valueOf(i + 1); // map value and part index starts at 1
-      map.add(valueKey, String.format("variables.files.%d", i));
+      map.add(valueKey, pathFunc.apply(i));
 
       values.add(valueKey, files.get(i));
     }

graphql-spring-boot-test/src/test/java/com/graphql/spring/boot/test/GraphQLTestTemplateIntegrationTest.java

@@ -31,11 +31,13 @@ class GraphQLTestTemplateIntegrationTest {
   private static final String QUERY_WITH_VARIABLES = "query-with-variables.graphql";
   private static final String COMPLEX_TEST_QUERY = "complex-query.graphql";
   private static final String MULTIPLE_QUERIES = "multiple-queries.graphql";
-  private static final String UPLOAD_MUTATION = "upload-files.graphql";
+  private static final String UPLOAD_FILES_MUTATION = "upload-files.graphql";
+  private static final String UPLOAD_FILE_MUTATION = "upload-file.graphql";
   private static final String INPUT_STRING_VALUE = "input-value";
   private static final String INPUT_STRING_NAME = "input";
   private static final String INPUT_HEADER_NAME = "headerName";
   private static final String FILES_STRING_NAME = "files";
+  private static final String UPLOADING_FILE_STRING_NAME = "uploadingFile";
   private static final String TEST_HEADER_NAME = "x-test";
   private static final String TEST_HEADER_VALUE = String.valueOf(UUID.randomUUID());
   private static final String FOO = "FOO";
@@ -47,6 +49,7 @@ class GraphQLTestTemplateIntegrationTest {
   private static final String DATA_FIELD_QUERY_WITH_HEADER = "$.data.queryWithHeader";
   private static final String DATA_FIELD_DUMMY = "$.data.dummy";
   private static final String DATA_FILE_UPLOAD_FILES = "$.data.uploadFiles";
+  private static final String DATA_FILE_UPLOAD_FILE = "$.data.uploadFile";
   private static final String OPERATION_NAME_WITH_VARIABLES = "withVariable";
   private static final String OPERATION_NAME_TEST_QUERY_1 = "testQuery1";
   private static final String OPERATION_NAME_TEST_QUERY_2 = "testQuery2";
@@ -246,10 +249,29 @@ void testPerformWithFileUploads() throws IOException {
         fileNames.stream().map(ClassPathResource::new).collect(Collectors.toList());
     // WHEN - THEN
     graphQLTestTemplate
-        .postFiles(UPLOAD_MUTATION, variables, testUploadFiles)
+        .postFiles(UPLOAD_FILES_MUTATION, variables, testUploadFiles)
         .assertThatNoErrorsArePresent()
         .assertThatField(DATA_FILE_UPLOAD_FILES)
         .asListOf(String.class)
         .isEqualTo(fileNames);
   }
+
+  @Test
+  @DisplayName("Test perform with individual file upload and custom path.")
+  void testPerformWithIndividualFileUpload() throws IOException {
+    // GIVEN
+    final ObjectNode variables = objectMapper.createObjectNode();
+    variables.put(UPLOADING_FILE_STRING_NAME, objectMapper.valueToTree(null));
+
+    List<String> fileNames = List.of("multiple-queries.graphql");
+    List<ClassPathResource> testUploadFiles =
+        fileNames.stream().map(ClassPathResource::new).collect(Collectors.toList());
+    // WHEN - THEN
+    graphQLTestTemplate
+        .postFiles(UPLOAD_FILE_MUTATION, variables, testUploadFiles, index -> "variables.file")
+        .assertThatNoErrorsArePresent()
+        .assertThatField(DATA_FILE_UPLOAD_FILE)
+        .asString()
+        .isEqualTo(fileNames.get(0));
+  }
 }

graphql-spring-boot-test/src/test/java/com/graphql/spring/boot/test/beans/DummyMutation.java

@@ -24,4 +24,9 @@ public List<String> uploadFiles(List<Part> files, DataFetchingEnvironment env) {
     List<Part> actualFiles = env.getArgument("files");
     return actualFiles.stream().map(Part::getSubmittedFileName).collect(Collectors.toList());
   }
+
+  public String uploadFile(Part file, DataFetchingEnvironment env) {
+    Part actualFile = env.getArgument("file");
+    return actualFile.getSubmittedFileName();
+  }
 }

graphql-spring-boot-test/src/test/resources/test-schema.graphqls

@@ -23,4 +23,5 @@ type Query {
 
 type Mutation {
     uploadFiles(files: [Upload]!): [String!]
+    uploadFile(file: Upload): String!
 }

graphql-spring-boot-test/src/test/resources/upload-file.graphql

@@ -0,0 +1,3 @@
+mutation($file: Upload) {
+    uploadFile(file: $file)
+}